How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitLab CI/CD deploy_resources API

Operations about deploy_resources

GitLab CI/CD deploy_resources API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 24 operations across 13 paths, and defines 34 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

24 operations 13 paths 34 schemas 4 DELETE11 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD deploy_resources API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 24

Across 13 paths, the API surfaces 24 operations — 4 DELETE, 11 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

deploy_resources 24

Operations about deployresources

GET
/api/v4/groups/{id}/deploy_tokens
List group deploy tokens
getApiV4GroupsIdDeployTokens 4 params → 200401403404
POST
/api/v4/groups/{id}/deploy_tokens
Create a group deploy token
postApiV4GroupsIdDeployTokens 2 params → 201400401404
GET
/api/v4/groups/{id}/deploy_tokens/{token_id}
Get a group deploy token
getApiV4GroupsIdDeployTokensTokenId 2 params → 200401404
DELETE
/api/v4/groups/{id}/deploy_tokens/{token_id}
Delete a group deploy token
deleteApiV4GroupsIdDeployTokensTokenId 2 params → 204401404
GET
/api/v4/projects/{id}/deploy_keys
List deploy keys for project
getApiV4ProjectsIdDeployKeys 3 params → 200401404
POST
/api/v4/projects/{id}/deploy_keys
Add deploy key
postApiV4ProjectsIdDeployKeys 2 params → 201400401404
GET
/api/v4/projects/{id}/deploy_keys/{key_id}
Get a single deploy key
getApiV4ProjectsIdDeployKeysKeyId 2 params → 200401404
PUT
/api/v4/projects/{id}/deploy_keys/{key_id}
Update deploy key
putApiV4ProjectsIdDeployKeysKeyId 3 params → 200400401403404
DELETE
/api/v4/projects/{id}/deploy_keys/{key_id}
Delete deploy key
deleteApiV4ProjectsIdDeployKeysKeyId 2 params → 204401404
POST
/api/v4/projects/{id}/deploy_keys/{key_id}/enable
Enable a deploy key
postApiV4ProjectsIdDeployKeysKeyIdEnable 2 params → 201401404
GET
/api/v4/projects/{id}/deploy_tokens
List project deploy tokens
getApiV4ProjectsIdDeployTokens 4 params → 200401403404
POST
/api/v4/projects/{id}/deploy_tokens
Create a project deploy token
postApiV4ProjectsIdDeployTokens 2 params → 201400401404
GET
/api/v4/projects/{id}/deploy_tokens/{token_id}
Get a project deploy token
getApiV4ProjectsIdDeployTokensTokenId 2 params → 200401404
DELETE
/api/v4/projects/{id}/deploy_tokens/{token_id}
Delete a project deploy token
deleteApiV4ProjectsIdDeployTokensTokenId 2 params → 204401404
GET
/api/v4/projects/{id}/deployments
List project deployments
getApiV4ProjectsIdDeployments 11 params → 200400401404
POST
/api/v4/projects/{id}/deployments
Create a deployment
postApiV4ProjectsIdDeployments 2 params → 201400401404
GET
/api/v4/projects/{id}/deployments/{deployment_id}
Get a specific deployment
getApiV4ProjectsIdDeploymentsDeploymentId 2 params → 200401404
PUT
/api/v4/projects/{id}/deployments/{deployment_id}
Update a deployment
putApiV4ProjectsIdDeploymentsDeploymentId 3 params → 200400401403404
DELETE
/api/v4/projects/{id}/deployments/{deployment_id}
Delete a specific deployment
deleteApiV4ProjectsIdDeploymentsDeploymentId 2 params → 204403400
GET
/api/v4/projects/{id}/deployments/{deployment_id}/merge_requests
List of merge requests associated with a deployment
getApiV4ProjectsIdDeploymentsDeploymentIdMergeRequests 46 params → 200401404
POST
/api/v4/projects/{id}/deployments/{deployment_id}/approval
Approve or reject a blocked deployment
postApiV4ProjectsIdDeploymentsDeploymentIdApproval 3 params → 201
GET
/api/v4/deploy_keys
List all deploy keys
getApiV4DeployKeys 3 params → 200401403
POST
/api/v4/deploy_keys
Create a deploy key
postApiV4DeployKeys 1 param → 201400401403
GET
/api/v4/deploy_tokens
List all deploy tokens
getApiV4DeployTokens 3 params → 200401403

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are API_Entities_MergeRequestBasic (55 properties), API_Entities_Ci_Job (27 properties), API_Entities_User (27 properties), API_Entities_Commit (15 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
API_Entities_Ci_Runner
object
APIEntitiesCiRunner model
13 properties 12 required
API_Entities_ProtectedEnvironments_ApprovalRuleForSummary
object
8 properties 8 required
API_Entities_Ci_RunnerManager
object
APIEntitiesCiRunnerManager model
11 properties 11 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
API_Entities_IssuableTimeStats
object
APIEntitiesIssuableTimeStats model
4 properties 4 required
API_Entities_ProjectIdentity
object
7 properties 7 required
API_Entities_User
object
27 properties 21 required
postApiV4ProjectsIdDeployKeys
object
Add deploy key
4 properties 2 required
API_Entities_Milestone
object
13 properties 11 required
API_Entities_Ci_PipelineBasic
object
APIEntitiesCiPipelineBasic model
10 properties 10 required
postApiV4GroupsIdDeployTokens
object
Create a group deploy token
4 properties 2 required
API_Entities_Ci_JobArtifact
object
4 properties 4 required
postApiV4ProjectsIdDeploymentsDeploymentIdApproval
object
Approve or reject a blocked deployment
3 properties 1 required
putApiV4ProjectsIdDeployKeysKeyId
object
Update deploy key
2 properties
API_Entities_Deployments_ApprovalSummary
object
1 property 1 required
API_Entities_Commit
object
APIEntitiesCommit model
15 properties 15 required
API_Entities_Deployments_Approval
object
APIEntitiesDeploymentsApproval model
4 properties 4 required
API_Entities_EnvironmentBasic
object
APIEntitiesEnvironmentBasic model
6 properties 6 required
postApiV4DeployKeys
object
Create a deploy key
3 properties 2 required
API_Entities_MergeRequestBasic
object
APIEntitiesMergeRequestBasic model
55 properties 51 required
putApiV4ProjectsIdDeploymentsDeploymentId
object
Update a deployment
1 property 1 required
postApiV4ProjectsIdDeployments
object
Create a deployment
5 properties 5 required
postApiV4ProjectsIdDeployTokens
object
Create a project deploy token
4 properties 2 required
API_Entities_DeployTokenWithToken
object
APIEntitiesDeployTokenWithToken model
8 properties 8 required
API_Entities_DeployKeysProject
object
APIEntitiesDeployKeysProject model
12 properties 9 required
API_Entities_Ci_Job
object
APIEntitiesCiJob model
27 properties 24 required
API_Entities_Deployment
object
APIEntitiesDeployment model
10 properties 10 required
API_Entities_IssuableReferences
object
3 properties 3 required
API_Entities_DeploymentExtended
object
APIEntitiesDeploymentExtended model
13 properties 13 required
API_Entities_DeployKey
object
APIEntitiesDeployKey model
11 properties 8 required
API_Entities_Ci_JobArtifactFile
object
2 properties 2 required
API_Entities_TaskCompletionStatus
object
2 properties 2 required
API_Entities_DeployToken
object
APIEntitiesDeployToken model
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-deploy-resources-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
GitLab CI/CD access_requests API
GitLab CI/CD access_tokens API
GitLab CI/CD agents API
GitLab CI/CD alert_management API
GitLab CI/CD applications API
GitLab CI/CD attestations API
GitLab CI/CD audit_events API
GitLab CI/CD avatars API
GitLab CI/CD award_emoji API
GitLab CI/CD badges API
GitLab CI/CD batched_background_migrations API
Where this information came from

This is an independent, third-party profile of GitLab CI/CD deploy_resources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.