Deploy resources

Use this API to manage deploy keys, deploy tokens, and code deployments to GitLab environments.

List all deploy keys

GET /api/v4/deploy_keys

Lists all deploy keys for the instance.

Parameters

Name	Type	Description
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`public` Query	Boolean	Only return deploy keys that are public Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployKey
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—

Create a deploy key

POST /api/v4/deploy_keys

Creates a deploy key for the GitLab instance. Requires administrator access.

Request body (application/json)

Property	Type	Description
`expires_at`	String (date-time)	The expiration date of the SSH key in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
`key` Required	String	New deploy key
`title` Required	String	New deploy key’s title

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeployKey
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

List all deploy tokens

GET /api/v4/deploy_tokens

Lists all deploy tokens for the instance.

Parameters

Name	Type	Description
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`active` Query	Boolean	Limit by active status

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployToken
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—

List all group deploy tokens

GET /api/v4/groups/{id}/deploy_tokens

Lists all group deploy tokens.

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The ID or URL-encoded path of the group owned by the authenticated user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`active` Query	Boolean	Limit by active status

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployToken
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Create a group deploy token

POST /api/v4/groups/{id}/deploy_tokens

Creates a group deploy token.

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The ID or URL-encoded path of the group owned by the authenticated user

Request body (application/json)

Property	Type	Description
`expires_at`	String (date-time)	Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`name` Required	String	New deploy token’s name
`scopes` Required	Array of strings	Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`
`username`	String	Username for deploy token. Default is `gitlab+deploy-token-{n}`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeployTokenWithToken
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve a group deploy token

GET /api/v4/groups/{id}/deploy_tokens/{token_id}

Get a single group’s deploy token by ID. This feature was introduced in GitLab 14.9.

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The ID or URL-encoded path of the group owned by the authenticated user
`token_id` Path, required	Integer	The ID of the deploy token

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployToken
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Delete a group deploy token

DELETE /api/v4/groups/{id}/deploy_tokens/{token_id}

Deletes a group deploy token.

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The ID or URL-encoded path of the group owned by the authenticated user
`token_id` Path, required	Integer	The ID of the deploy token

Responses

Code	Description	Schema
`204`	Resource deleted	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

List all deploy keys for project

GET /api/v4/projects/{id}/deploy_keys

Lists all deploy keys for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployKeysProject
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Add a deploy key for a project

POST /api/v4/projects/{id}/deploy_keys

Adds a deploy key for a specified project. If the deploy key already exists in another project, it is joined to the current project only if the original one is accessible by the same user.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user

Request body (application/json)

Property	Type	Description
`can_push`	Boolean	Can deploy key push to the project’s repository
`expires_at`	String (date-time)	The expiration date of the SSH key in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
`key` Required	String	New deploy key
`title` Required	String	New deploy key’s title

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeployKeysProject
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve a deploy key

GET /api/v4/projects/{id}/deploy_keys/{key_id}

Retrieves a specified deploy key.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`key_id` Path, required	Integer	The ID of the deploy key

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployKeysProject
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Update a deploy key

PUT /api/v4/projects/{id}/deploy_keys/{key_id}

Updates a deploy key for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`key_id` Path, required	Integer	The ID of the deploy key

Request body (application/json)

Property	Type	Description
`can_push`	Boolean	Can deploy key push to the project’s repository
`title`	String	New deploy key’s title

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployKey
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Delete deploy key

DELETE /api/v4/projects/{id}/deploy_keys/{key_id}

FE version

Removes a deploy key from the project. If the deploy key is used only for this project, it’s deleted from the system.

Parameters

Name	Type	Description
`key_id` Path, required	Integer	The ID of the deploy key
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Enable a deploy key

POST /api/v4/projects/{id}/deploy_keys/{key_id}/enable

Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`key_id` Path, required	Integer	The ID of the deploy key

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeployKey
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

List all project deploy tokens

GET /api/v4/projects/{id}/deploy_tokens

Lists all project deploy tokens.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`active` Query	Boolean	Limit by active status

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployToken
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Create a project deploy token

POST /api/v4/projects/{id}/deploy_tokens

Creates a project deploy token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user

Request body (application/json)

Property	Type	Description
`expires_at`	String (date-time)	Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`name` Required	String	New deploy token’s name
`scopes` Required	Array of strings	Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, `write_package_registry`, `read_virtual_registry`, or `write_virtual_registry`
`username`	String	Username for deploy token. Default is `gitlab+deploy-token-{n}`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeployTokenWithToken
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve a project deploy token

GET /api/v4/projects/{id}/deploy_tokens/{token_id}

Retrieves a project deploy token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`token_id` Path, required	Integer	The ID of the deploy token

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployToken
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Delete a project deploy token

DELETE /api/v4/projects/{id}/deploy_tokens/{token_id}

Deletes a project deploy token.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`token_id` Path, required	Integer	The ID of the deploy token

Responses

Code	Description	Schema
`204`	Resource deleted	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

List all project deployments

GET /api/v4/projects/{id}/deployments

Lists all deployments in a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`order_by` Query	String	Return deployments ordered by either one of `id`, `iid`, `created_at`, `updated_at` or `ref` fields. Default is `id` Allowed values: `id`, `iid`, `created_at`, `updated_at`, `finished_at` Default: `id`
`sort` Query	String	Return deployments sorted in `asc` or `desc` order. Default is `asc` Allowed values: `asc`, `desc` Default: `asc`
`updated_after` Query	String (date-time)	Return deployments updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`updated_before` Query	String (date-time)	Return deployments updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`finished_after` Query	String (date-time)	Return deployments finished after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`finished_before` Query	String (date-time)	Return deployments finished before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
`environment` Query	String	The name of the environment to filter deployments by
`status` Query	String	The status to filter deployments by. One of `created`, `running`, `success`, `failed`, `canceled`, or `blocked` Allowed values: `created`, `running`, `success`, `failed`, `canceled`, `skipped`, `blocked`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployment
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Create a deployment

POST /api/v4/projects/{id}/deployments

Creates a deployment.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user

Request body (application/json)

Property	Type	Description
`environment` Required	String	The name of the environment to create the deployment for
`ref` Required	String	The name of the branch or tag that is deployed
`sha` Required	String	The SHA of the commit that is deployed
`status` Required	String	The status of the deployment that is created. One of `running`, `success`, `failed`, or `canceled` Allowed values: `running`, `success`, `failed`, `canceled` Minimum length: `1`
`tag` Required	Boolean	A boolean that indicates if the deployed ref is a tag (`true`) or not (`false`)

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeploymentExtended
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve a deployment

GET /api/v4/projects/{id}/deployments/{deployment_id}

Retrieves a specified deployment.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`deployment_id` Path, required	Integer	The ID of the deployment

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeploymentExtended
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Update a deployment

PUT /api/v4/projects/{id}/deployments/{deployment_id}

Updates a specified deployment.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`deployment_id` Path, required	Integer	The ID of the deployment

Request body (application/json)

Property	Type	Description
`status` Required	String	The new status of the deployment. One of `running`, `success`, `failed`, or `canceled` Allowed values: `running`, `success`, `failed`, `canceled` Minimum length: `1`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeploymentExtended
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Delete a deployment

DELETE /api/v4/projects/{id}/deployments/{deployment_id}

Deletes a specified deployment that is not currently the last deployment for an environment or in a running state.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`deployment_id` Path, required	Integer	The ID of the deployment

Responses

Code	Description	Schema
`204`	Deployment destroyed	—
`400`	“Cannot destroy running deployment” or “Deployment currently deployed to environment”	—
`403`	Forbidden	—
`404`	Not Found	—

Approve or reject a deployment

POST /api/v4/projects/{id}/deployments/{deployment_id}/approval

Approves or rejects a protected deployment.

Parameters

Name	Type	Description
`deployment_id` Path, required	Integer	The ID of the deployment
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`comment`	String	A comment to go with the approval
`represented_as`	String	The user, group, or role represented by the approval
`status` Required	String	The status of the approval Allowed values: `approved`, `rejected` Minimum length: `1`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesDeploymentApproval
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

List all merge requests associated with a deployment

GET /api/v4/projects/{id}/deployments/{deployment_id}/merge_requests

Lists all merge requests shipped with a specified deployment.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project owned by the authenticated user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`deployment_id` Path, required	Integer	The ID of the deployment
`author_id` Query	Integer	Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `author_username`
`author_username` Query	String	Returns merge requests created by the given `username`. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Returns merge requests created by the given `username`. Mutually exclusive with `assignee_id`
`reviewer_username` Query	String	Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `reviewer_id`
`labels` Query	Array of strings	Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`milestone` Query	String	Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`my_reaction_emoji` Query	String	Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`reviewer_id` Query	Integer or string	Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`
`state` Query	String	Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged` Allowed values: `opened`, `closed`, `locked`, `merged`, `all` Default: `all`
`order_by` Query	String	Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8 Allowed values: `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at`, `merged_at` Default: `created_at`
`sort` Query	String	Returns merge requests sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`with_labels_details` Query	Boolean	If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color` Default: `false`
`with_merge_status_recheck` Query	Boolean	If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0 Default: `false`
`created_after` Query	String (date-time)	Returns merge requests created on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`created_before` Query	String (date-time)	Returns merge requests created on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_after` Query	String (date-time)	Returns merge requests updated on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_before` Query	String (date-time)	Returns merge requests updated on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_after` Query	String (date-time)	Returns merge requests merged on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_before` Query	String (date-time)	Returns merge requests merged on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`view` Query	String	If simple, returns the `iid`, URL, title, description, and basic state of merge request Allowed values: `simple`
`scope` Query	String	Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `reviews_for_me`, `all`
`source_branch` Query	String	Returns merge requests with the given source branch
`source_project_id` Query	Integer	Returns merge requests with the given source project id
`target_branch` Query	String	Returns merge requests with the given target branch
`search` Query	String	Search merge requests against their `title` and `description`
`in` Query	String	Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma Example: `title,description`
`wip` Query	String	Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests. Mutually exclusive with `draft` Allowed values: `yes`, `no`
`draft` Query	Boolean	Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests. Mutually exclusive with `wip`
`not` Query	Object	Returns merge requests that do not match the parameters supplied
`not[author_id]` Query	Integer	`<Negated>` Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer or string	`<Negated>` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[assignee_id]`
`not[reviewer_username]` Query	String	`<Negated>` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `not[reviewer_id]`
`not[labels]` Query	Array of strings	`<Negated>` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`not[milestone]` Query	String	`<Negated>` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`not[my_reaction_emoji]` Query	String	`<Negated>` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`not[reviewer_id]` Query	Integer	`<Negated>` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `not[reviewer_username]`
`deployed_before` Query	String (date-time)	Returns merge requests deployed before the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`deployed_after` Query	String (date-time)	Returns merge requests deployed after the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`environment` Query	String	Returns merge requests deployed to the given environment Example: `production`
`merge_user_id` Query	Integer	Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`
`merge_user_username` Query	String	Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

List all project deploy keys for a user

GET /api/v4/users/{user_id}/project_deploy_keys

Lists all project deploy keys accessible to a specified user.

Parameters

Name	Type	Description
`user_id` Path, required	String	The ID or username of the user
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDeployKey
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCiJob

Property	Type	Description
`allow_failure`	Boolean	—
`archived`	Boolean	Example: `false`
`artifacts`	Array of APIEntitiesCiJobArtifact	—
`artifacts_expire_at`	String (date-time)	Example: `2016-01-19T09:05:50.355Z`
`artifacts_file`	APIEntitiesCiJobArtifactFile	—
`commit`	APIEntitiesCommit	—
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`duration`	Number (float)	Time spent running Example: `0.465`
`erased_at`	String (date-time)	Example: `2015-12-24T18:00:29.728Z`
`failure_reason`	String	Example: `script_failure`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `deploy_to_production`
`pipeline`	APIEntitiesCiPipelineBasic	—
`project`	Object	—
`project.ci_job_token_scope_enabled`	String	Example: `false`
`queued_duration`	Number (float)	Time spent enqueued Example: `0.123`
`ref`	String	Example: `main`
`runner`	APIEntitiesCiRunner	—
`runner_manager`	APIEntitiesCiRunnerManager	—
`stage`	String	Example: `deploy`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `waiting_for_resource`
`tag`	Boolean	—
`tag_list`	Array of strings	Example: `["ubuntu18","docker runner"]`
`user`	APIEntitiesUser	—
`web_url`	String	Example: `https://example.com/foo/bar/-/jobs/1`

APIEntitiesCiJobArtifact

Property	Type	Description
`file_format`	String	Allowed values: `raw`, `zip`, `gzip` Example: `zip`
`file_type`	String	Allowed values: `archive`, `metadata`, `trace`, `junit`, `sast`, `dependency_scanning`, `container_scanning`, `dast`, `codequality`, `license_scanning`, `performance`, `metrics`, `metrics_referee`, `network_referee`, `lsif`, `dotenv`, `cobertura`, `terraform`, `accessibility`, `cluster_applications`, `secret_detection`, `requirements`, `coverage_fuzzing`, `browser_performance`, `load_performance`, `api_fuzzing`, `cluster_image_scanning`, `cyclonedx`, `requirements_v2`, `annotations`, `repository_xray`, `jacoco`, `sarif` Example: `archive`
`filename`	String	Example: `artifacts.zip`
`size`	Integer	Example: `1000`

APIEntitiesCiJobArtifactFile

Property	Type	Description
`filename`	String	Example: `artifacts.zip`
`size`	Integer	Example: `1000`

APIEntitiesCiPipelineBasic

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`status`	String	Example: `success`
`updated_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`

APIEntitiesCiRunner

Property	Type	Description
`active`	Boolean	Example: `true`
`created_at`	String (date-time)	Example: `2025-05-03T00:00:00.000Z`
`created_by`	APIEntitiesUserBasic	—
`description`	String	Example: `test-1-20150125`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`is_shared`	Boolean	Example: `true`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`name`	String	Example: `test`
`online`	Boolean	Example: `true`
`paused`	Boolean	Example: `false`
`runner_type`	String	Allowed values: `instance_type`, `group_type`, `project_type` Example: `instance_type`
`status`	String	Example: `online`

APIEntitiesCiRunnerManager

Property	Type	Description
`architecture`	String	Example: `amd64`
`contacted_at`	String	Example: `2023-10-24T01:27:06.549Z`
`created_at`	String	Example: `2023-10-24T01:27:06.549Z`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`platform`	String	Example: `linux`
`revision`	String	Example: `91a27b2a`
`status`	String	Example: `online`
`system_id`	String	Example: `runner-1`
`version`	String	Example: `16.11.0`

APIEntitiesCommit

Property	Type	Description
`author_email`	String	Example: `john@example.com`
`author_name`	String	Example: `John Smith`
`authored_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committed_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committer_email`	String	Example: `jack@example.com`
`committer_name`	String	Example: `Jack Smith`
`created_at`	String (date-time)	Example: `2017-07-26T11:08:53.000+02:00`
`extended_trailers`	Object	Example: `{"Signed-off-by":["John Doe \u003cjohndoe@gitlab.com\u003e","Jane Doe \u003cjanedoe@gitlab.com\u003e"]}`
`id`	String	Example: `2695effb5807a22ff3d138d593fd856244e155e7`
`message`	String	Example: `Initial commit`
`parent_ids`	Array of strings	Example: `["2a4b78934375d7f53875269ffd4f45fd83a84ebe"]`
`short_id`	String	Example: `2695effb`
`title`	String	Example: `Initial commit`
`trailers`	Object	Example: `{"Merged-By":"Jane Doe janedoe@gitlab.com"}`
`web_url`	String	Example: `https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746`

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesDeployKey

Property	Type	Description
`created_at`	String (date-time)	Example: `2015-09-03T07:24:44.627Z`
`expires_at`	String (date-time)	Example: `2020-09-03T07:24:44.627Z`
`fingerprint`	String	Example: `4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9`
`fingerprint_sha256`	String	Example: `SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU`
`id`	Integer (int64)	Example: `1`
`key`	String	Example: `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==`
`last_used_at`	String (date-time)	Example: `2020-09-03T07:24:44.627Z`
`projects_with_readonly_access`	APIEntitiesProjectIdentity	—
`projects_with_write_access`	APIEntitiesProjectIdentity	—
`title`	String	Example: `Sample key 25`
`usage_type`	String	Example: `auth`

APIEntitiesDeployKeysProject

Property	Type	Description
`can_push`	Boolean	—
`created_at`	String (date-time)	Example: `2015-09-03T07:24:44.627Z`
`expires_at`	String (date-time)	Example: `2020-09-03T07:24:44.627Z`
`fingerprint`	String	Example: `4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9`
`fingerprint_sha256`	String	Example: `SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU`
`id`	Integer (int64)	Example: `1`
`key`	String	Example: `ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==`
`last_used_at`	String (date-time)	Example: `2020-09-03T07:24:44.627Z`
`projects_with_readonly_access`	APIEntitiesProjectIdentity	—
`projects_with_write_access`	APIEntitiesProjectIdentity	—
`title`	String	Example: `Sample key 25`
`usage_type`	String	Example: `auth`

APIEntitiesDeployment

Property	Type	Description
`created_at`	String (date-time)	Example: `2016-08-11T11:32:35.444Z`
`deployable`	APIEntitiesCiJob	—
`environment`	APIEntitiesEnvironmentBasic	—
`id`	Integer (int64)	Example: `41`
`iid`	Integer	Example: `1`
`ref`	String	Example: `main`
`sha`	String	Example: `99d03678b90d914dbb1b109132516d71a4a03ea8`
`status`	String	Example: `created`
`updated_at`	String (date-time)	Example: `2016-08-11T11:32:35.444Z`
`user`	APIEntitiesUserBasic	—

APIEntitiesDeploymentApproval

Property	Type	Description
`comment`	String	Example: `Looks good to me`
`created_at`	String (date-time)	Example: `2022-02-24T20:22:30.097Z`
`status`	String	Example: `approved`
`user`	APIEntitiesUserBasic	—

APIEntitiesDeploymentApprovalSummary

Property	Type	Description
`rules`	Array of APIEntitiesDeploymentApprovalSummaryRule	—

APIEntitiesDeploymentApprovalSummaryRule

Property	Type	Description
`access_level`	Integer	Example: `40`
`access_level_description`	String	Example: `Maintainers`
`deployment_approvals`	Array of APIEntitiesDeploymentApproval	—
`group_id`	Integer (int64)	Example: `3`
`required_approvals`	Integer	Example: `1`
`user_id`	Integer (int64)	Example: `2`

APIEntitiesDeploymentExtended

Property	Type	Description
`approval_summary`	APIEntitiesDeploymentApprovalSummary	—
`approvals`	Array of APIEntitiesDeploymentApproval	—
`created_at`	String (date-time)	Example: `2016-08-11T11:32:35.444Z`
`deployable`	APIEntitiesCiJob	—
`environment`	APIEntitiesEnvironmentBasic	—
`id`	Integer (int64)	Example: `41`
`iid`	Integer	Example: `1`
`pending_approval_count`	Integer	Example: `0`
`ref`	String	Example: `main`
`sha`	String	Example: `99d03678b90d914dbb1b109132516d71a4a03ea8`
`status`	String	Example: `created`
`updated_at`	String (date-time)	Example: `2016-08-11T11:32:35.444Z`
`user`	APIEntitiesUserBasic	—

APIEntitiesDeployToken

Property	Type	Description
`expired`	Boolean	—
`expires_at`	String (date-time)	Example: `2020-02-14T00:00:00.000Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `MyToken`
`revoked`	Boolean	—
`scopes`	Array	Example: `["read_repository"]`
`username`	String	Example: `gitlab+deploy-token-1`

APIEntitiesDeployTokenWithToken

Property	Type	Description
`expired`	Boolean	—
`expires_at`	String (date-time)	Example: `2020-02-14T00:00:00.000Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `MyToken`
`revoked`	Boolean	—
`scopes`	Array	Example: `["read_repository"]`
`token`	String	Example: `jMRvtPNxrn3crTAGukpZ`
`username`	String	Example: `gitlab+deploy-token-1`

APIEntitiesEnvironmentBasic

Property	Type	Description
`created_at`	String (date-time)	Example: `2019-05-25T18:55:13.252Z`
`external_url`	String	Example: `https://deploy.gitlab.example.com`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `deploy`
`slug`	String	Example: `deploy`
`updated_at`	String (date-time)	Example: `2019-05-25T18:55:13.252Z`

APIEntitiesIssuableReferences

Property	Type	Description
`full`	String	Example: `test&6`
`relative`	String	Example: `&6`
`short`	String	Example: `&6`

APIEntitiesIssuableTimeStats

Property	Type	Description
`human_time_estimate`	String	Example: `3h 30m`
`human_total_time_spent`	String	Example: `1h`
`time_estimate`	Integer	Example: `12600`
`total_time_spent`	Integer	Example: `3600`

APIEntitiesMergeRequestBasic

Property	Type	Description
`allow_collaboration`	Boolean	—
`allow_maintainer_to_push`	Boolean	—
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`blocking_discussions_resolved`	Boolean	—
`closed_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`closed_by`	APIEntitiesUserBasic	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`description_html`	String	—
`detailed_merge_status`	String	Example: `mergeable`
`discussion_locked`	Boolean	—
`downvotes`	Integer	—
`draft`	Boolean	—
`force_remove_source_branch`	Boolean	—
`has_conflicts`	Boolean	—
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	—
`imported_from`	String	Example: `bitbucket`
`labels`	Array of strings	—
`merge_after`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_commit_sha`	String	Example: `1234abcd`
`merge_status`	String	Example: `unchecked`
`merge_user`	APIEntitiesUserBasic	—
`merge_when_pipeline_succeeds`	Boolean	—
`merged_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merged_by`	APIEntitiesUserBasic	—
`milestone`	APIEntitiesMilestone	—
`prepared_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`project_id`	Integer (int64)	Example: `4`
`reference`	String	Example: `!1`
`references`	APIEntitiesIssuableReferences	—
`reviewers`	APIEntitiesUserBasic	—
`sha`	String	Example: `1234abcd`
`should_remove_source_branch`	Boolean	—
`source_branch`	String	—
`source_project_id`	Integer (int64)	—
`squash`	Boolean	—
`squash_commit_sha`	String	Example: `1234abcd`
`squash_on_merge`	Boolean	—
`state`	String	Example: `closed`
`target_branch`	String	—
`target_project_id`	Integer (int64)	—
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`title_html`	String	—
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `https://gitlab.example.com/my-group/my-project/-/merge_requests/1`
`work_in_progress`	Boolean	—

APIEntitiesMilestone

Property	Type	Description
`created_at`	String	—
`description`	String	—
`due_date`	String	—
`expired`	Boolean	—
`group_id`	String	—
`id`	Integer (int64)	—
`iid`	Integer (int64)	—
`project_id`	Integer (int64)	—
`start_date`	String	—
`state`	String	—
`title`	String	—
`updated_at`	String	—
`web_url`	String	—

APIEntitiesProjectIdentity

Property	Type	Description
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`description`	String	Example: `desc`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`

APIEntitiesTaskCompletionStatus

Property	Type	Description
`completed_count`	Integer	Example: `3`
`count`	Integer	Example: `5`

APIEntitiesUser

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`bio`	String	—
`bot`	Boolean	—
`created_at`	String	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`is_followed`	String	—
`job_title`	String	—
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`twitter`	String	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

List all deploy keys

Create a deploy key

List all deploy tokens

List all group deploy tokens

Create a group deploy token

Retrieve a group deploy token

Delete a group deploy token

List all deploy keys for project

Add a deploy key for a project

Retrieve a deploy key

Update a deploy key

Delete deploy key

Enable a deploy key

List all project deploy tokens

Create a project deploy token

Retrieve a project deploy token

Delete a project deploy token

List all project deployments

Create a deployment

Retrieve a deployment

Update a deployment

Delete a deployment

Approve or reject a deployment

List all merge requests associated with a deployment

List all project deploy keys for a user

Schemas

APIEntitiesCiJob

APIEntitiesCiJobArtifact

APIEntitiesCiJobArtifactFile

APIEntitiesCiPipelineBasic

APIEntitiesCiRunner

APIEntitiesCiRunnerManager

APIEntitiesCommit

APIEntitiesCustomAttribute

APIEntitiesDeployKey

APIEntitiesDeployKeysProject

APIEntitiesDeployment

APIEntitiesDeploymentApproval

APIEntitiesDeploymentApprovalSummary

APIEntitiesDeploymentApprovalSummaryRule

APIEntitiesDeploymentExtended

APIEntitiesDeployToken

APIEntitiesDeployTokenWithToken

APIEntitiesEnvironmentBasic

APIEntitiesIssuableReferences

APIEntitiesIssuableTimeStats

APIEntitiesMergeRequestBasic

APIEntitiesMilestone

APIEntitiesProjectIdentity

APIEntitiesTaskCompletionStatus

APIEntitiesUser

APIEntitiesUserBasic

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error