GitLab

GitLab Deploy resources API

Use this API to manage [deploy keys](https://docs.gitlab.com/user/project/deploy_keys/), [deploy tokens](https://docs.gitlab.com/user/project/deploy_tokens/), and [code deployments](https://docs.gitlab.com/ci/environments/deployments/) to GitLab environments.

Documentation GitHub OpenAPI

Operations 25

GET /api/v4/users/{user_id}/project_deploy_keys List all project deploy keys for a user #

GET /api/v4/projects/{id}/deployments List all project deployments #

POST /api/v4/projects/{id}/deployments Create a deployment #

GET /api/v4/projects/{id}/deployments/{deployment_id} Retrieve a deployment #

PUT /api/v4/projects/{id}/deployments/{deployment_id} Update a deployment #

DELETE /api/v4/projects/{id}/deployments/{deployment_id} Delete a deployment #

GET /api/v4/projects/{id}/deployments/{deployment_id}/merge_requests List all merge requests associated with a deployment #

POST /api/v4/projects/{id}/deployments/{deployment_id}/approval Approve or reject a deployment #

GET /api/v4/deploy_tokens List all deploy tokens #

GET /api/v4/projects/{id}/deploy_tokens List all project deploy tokens #

POST /api/v4/projects/{id}/deploy_tokens Create a project deploy token #

GET /api/v4/projects/{id}/deploy_tokens/{token_id} Retrieve a project deploy token #

DELETE /api/v4/projects/{id}/deploy_tokens/{token_id} Delete a project deploy token #

GET /api/v4/groups/{id}/deploy_tokens List all group deploy tokens #

POST /api/v4/groups/{id}/deploy_tokens Create a group deploy token #

GET /api/v4/groups/{id}/deploy_tokens/{token_id} Retrieve a group deploy token #

DELETE /api/v4/groups/{id}/deploy_tokens/{token_id} Delete a group deploy token #

GET /api/v4/deploy_keys List all deploy keys #

POST /api/v4/deploy_keys Create a deploy key #

GET /api/v4/projects/{id}/deploy_keys List all deploy keys for project #

POST /api/v4/projects/{id}/deploy_keys Add a deploy key for a project #

GET /api/v4/projects/{id}/deploy_keys/{key_id} Retrieve a deploy key #

PUT /api/v4/projects/{id}/deploy_keys/{key_id} Update a deploy key #

DELETE /api/v4/projects/{id}/deploy_keys/{key_id} Delete a deploy key #

POST /api/v4/projects/{id}/deploy_keys/{key_id}/enable Enable a deploy key #

Documentation

https://docs.gitlab.com/api/openapi/

https://docs.gitlab.com/api/issues/

https://docs.gitlab.com/api/rest/authentication/

https://docs.gitlab.com/api/merge_requests/

https://docs.gitlab.com/api/pipelines/

https://docs.gitlab.com/api/jobs/

https://docs.gitlab.com/api/runners/

https://docs.gitlab.com/api/users/

https://docs.gitlab.com/api/repositories/

https://docs.gitlab.com/api/commits/

https://docs.gitlab.com/api/branches/

https://docs.gitlab.com/api/tags/

https://docs.gitlab.com/api/releases/

https://docs.gitlab.com/api/environments/

https://docs.gitlab.com/api/deployments/

https://docs.gitlab.com/api/pipeline_schedules/

https://docs.gitlab.com/api/labels/

https://docs.gitlab.com/api/milestones/

https://docs.gitlab.com/api/notes/

https://docs.gitlab.com/api/snippets/

https://docs.gitlab.com/api/packages/

https://docs.gitlab.com/api/container_registry/

https://docs.gitlab.com/api/vulnerabilities/

https://docs.gitlab.com/api/deploy_keys/

https://docs.gitlab.com/api/protected_branches/

https://docs.gitlab.com/api/wikis/

https://docs.gitlab.com/api/events/

https://docs.gitlab.com/api/search/

https://docs.gitlab.com/api/namespaces/

https://docs.gitlab.com/api/groups/

https://docs.gitlab.com/api/projects/

https://docs.gitlab.com/api/applications/

https://docs.gitlab.com/api/avatar/

https://docs.gitlab.com/api/broadcast_messages/

https://docs.gitlab.com/api/bulk_imports/

https://docs.gitlab.com/api/settings/

https://docs.gitlab.com/api/metadata/

https://docs.gitlab.com/api/version/

https://docs.gitlab.com/api/rest/

https://docs.gitlab.com/api/api_resources/

https://docs.gitlab.com/security/rate_limits/

https://docs.gitlab.com/api/oauth2/

https://docs.gitlab.com/integration/oauth_provider/

https://docs.gitlab.com/user/project/integrations/webhooks.html

https://docs.gitlab.com/api/project_webhooks/

Specifications

https://artifacts.apis.io/gitlab/openapi/gitlab-deploy-resources-api-openapi.yml

https://artifacts.apis.io/gitlab/asyncapi/gitlab-webhooks-asyncapi.yml

Schemas & Data

https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-application-settings-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-node-status-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-site-status-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-application-setting-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-post-api-v4-geo-status-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-projects-id-request-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-cluster-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-batched-background-migration-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-ci-variable-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-dictionary-table-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-plan-limit-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-appearance-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-avatar-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-imports-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-import-schema.json

https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-metadata-schema.json

Other Resources

https://docs.gitlab.com/api/rest/third_party_clients/

Interactive Documentation

https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gitlab:gitlab-deploy-resources-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: GitLab REST Deploy resources API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:


# --- truncated at 32 KB (77 KB total) ---
# Full source: https://artifacts.apis.io/gitlab/openapi/gitlab-deploy-resources-api-openapi.yml