CI/CD templates API
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Use this API to retreive available CI/CD templates.
Users with the Guest role cannot access CI/CD templates. For more information, see project and group visibility.
List all CI/CD templates
Lists all GitLab CI/CD YAML templates.
GET /templates/gitlab_ci_ymls
Example request:
curl "https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls"
Example response:
[
{
"key": "5-Minute-Production-App",
"name": "5-Minute-Production-App"
},
{
"key": "Android",
"name": "Android"
},
{
"key": "Android-Fastlane",
"name": "Android-Fastlane"
},
{
"key": "Auto-DevOps",
"name": "Auto-DevOps"
},
{
"key": "Bash",
"name": "Bash"
},
{
"key": "C++",
"name": "C++"
},
{
"key": "Chef",
"name": "Chef"
},
{
"key": "Clojure",
"name": "Clojure"
},
{
"key": "Code-Quality",
"name": "Code-Quality"
},
{
"key": "Composer",
"name": "Composer"
},
{
"key": "Cosign",
"name": "Cosign"
},
{
"key": "Crystal",
"name": "Crystal"
},
{
"key": "Dart",
"name": "Dart"
},
{
"key": "Deploy-ECS",
"name": "Deploy-ECS"
},
{
"key": "Diffblue-Cover",
"name": "Diffblue-Cover"
},
{
"key": "Django",
"name": "Django"
},
{
"key": "Docker",
"name": "Docker"
},
{
"key": "Elixir",
"name": "Elixir"
},
{
"key": "Flutter",
"name": "Flutter"
},
{
"key": "Getting-Started",
"name": "Getting-Started"
}
]
Get details of a CI/CD template
Gets the details of a specific CI/CD template.
GET /templates/gitlab_ci_ymls/:key
Attribute | Type | Required | Description |
---|---|---|---|
key |
string | Yes | The key of the GitLab CI/CD YAML template |
Example request:
curl "https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls/Ruby"
Example response:
{
"name": "Ruby",
"content": "# This file is a template, and might need editing before it works on your project.\n# You can copy and paste this template into a new `.gitlab-ci.yml` file.\n# You should not add this template to an existing `.gitlab-ci.yml` file by using the `include:` keyword.\n#\n# To contribute improvements to CI/CD templates, please follow the Development guide at:\n# https://docs.gitlab.com/development/cicd/templates/\n# This specific template is located at:\n# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Ruby.gitlab-ci.yml\n\n# Official language image. Look for the different tagged releases at:\n# https://hub.docker.com/r/library/ruby/tags/\nimage: ruby:latest\n\n# Pick zero or more services to be used on all builds.\n# Only needed when using a docker container to run your tests in.\n# Check out: https://docs.gitlab.com/ee/ci/services/\nservices:\n - mysql:latest\n - redis:latest\n - postgres:latest\n\nvariables:\n POSTGRES_DB: database_name\n\n# Cache gems in between builds\ncache:\n key:\n files:\n - Gemfile.lock\n paths:\n - vendor/ruby\n\n# This is a basic example for a gem or script which doesn't use\n# services such as redis or postgres\nbefore_script:\n - ruby -v # Print out ruby version for debugging\n # Uncomment next line if your rails app needs a JS runtime:\n # - apt-get update -q && apt-get install nodejs -yqq\n - bundle config set --local deployment true\n - bundle config set --local path './vendor/ruby' # Install dependencies into ./vendor/ruby\n - bundle install -j $(nproc)\n\n# Optional - Delete if not using `rubocop`\nrubocop:\n script:\n - rubocop\n\nrspec:\n script:\n - rspec spec\n\nrails:\n variables:\n DATABASE_URL: \"postgresql://postgres:postgres@postgres:5432/$POSTGRES_DB\"\n script:\n - rails db:migrate\n - rails db:seed\n - rails test\n\n# This deploy job uses a simple deploy flow to Heroku, other providers, e.g. AWS Elastic Beanstalk\n# are supported too: https://github.com/travis-ci/dpl\ndeploy:\n stage: deploy\n environment: production\n script:\n - gem install dpl\n - dpl --provider=heroku --app=$HEROKU_APP_NAME --api-key=$HEROKU_PRODUCTION_KEY\n"
}