Validate the .gitlab-ci.yml (API)

Introduced in GitLab 8.12.

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

POST /ci/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.6\", \"services\": [\"postgres\"], \"before_script\": [\"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"
}