GitLab Documentation

Validate the .gitlab-ci.yml (API)

Validate the .gitlab-ci.yml (API)

Introduced in GitLab 8.12.

Checks if your .gitlab-ci.yml file is valid.

POST /lint
Attribute Type Required Description
content string yes the .gitlab-ci.yaml content
curl --header "Content-Type: application/json" https://gitlab.example.com/api/v4/ci/lint --data '{"content": "{ \"image\": \"ruby:2.1\", \"services\": [\"postgres\"], \"before_script\": [\"gem install bundler\", \"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'

Be sure to copy paste the exact contents of .gitlab-ci.yml as YAML is very picky about indentation and spaces.

Example responses:

  • Valid content:

    {
      "status": "valid",
      "errors": []
    }
    
  • Invalid content:

    {
      "status": "invalid",
      "errors": [
        "variables config should be a hash of key value pairs"
      ]
    }
    
  • Without the content attribute:

    {
      "error": "content is missing"
    }
    

Was this helpful? Do you think that something is unclear? Use the comments area below and leave your feedback. For support and other enquiries, see getting help.