Operations about deploy_resources
swagger: '2.0'
info:
title: GitLab access_requests deploy_resources API
version: v4
description: Operations related to access requests
host: gitlab.com
produces:
- application/json
tags:
- name: deploy_resources
description: Operations about deploy_resources
paths:
/api/v4/groups/{id}/deploy_tokens:
get:
summary: List group deploy tokens
description: Get a list of a group's deploy tokens. This feature was introduced in GitLab 12.9.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated user
type: integer
format: int32
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: query
name: active
description: Limit by active status
type: boolean
required: false
responses:
'200':
description: List group deploy tokens
schema:
type: array
items:
$ref: '#/definitions/API_Entities_DeployToken'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4GroupsIdDeployTokens
post:
summary: Create a group deploy token
description: Creates a new deploy token for a group. This feature was introduced in GitLab 12.9.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated user
type: integer
format: int32
required: true
- name: postApiV4GroupsIdDeployTokens
in: body
required: true
schema:
$ref: '#/definitions/postApiV4GroupsIdDeployTokens'
responses:
'201':
description: Create a group deploy token
schema:
$ref: '#/definitions/API_Entities_DeployTokenWithToken'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: postApiV4GroupsIdDeployTokens
/api/v4/groups/{id}/deploy_tokens/{token_id}:
get:
summary: Get a group deploy token
description: 'Get a single group''s deploy token by ID. This feature was introduced in GitLab 14.9. '
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated user
type: integer
format: int32
required: true
- in: path
name: token_id
description: The ID of the deploy token
type: integer
format: int32
required: true
responses:
'200':
description: Get a group deploy token
schema:
$ref: '#/definitions/API_Entities_DeployToken'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4GroupsIdDeployTokensTokenId
delete:
summary: Delete a group deploy token
description: Removes a deploy token from the group. This feature was introduced in GitLab 12.9.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group owned by the authenticated user
type: integer
format: int32
required: true
- in: path
name: token_id
description: The ID of the deploy token
type: integer
format: int32
required: true
responses:
'204':
description: Delete a group deploy token
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: deleteApiV4GroupsIdDeployTokensTokenId
/api/v4/projects/{id}/deploy_keys:
get:
summary: List deploy keys for project
description: Get a list of a project's deploy keys.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
responses:
'200':
description: List deploy keys for project
schema:
type: array
items:
$ref: '#/definitions/API_Entities_DeployKeysProject'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeployKeys
post:
summary: Add deploy key
description: Creates a new deploy key for a project. If the deploy key already exists in another project, it's joined to the current project only if the original one is accessible by the same user.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- name: postApiV4ProjectsIdDeployKeys
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdDeployKeys'
responses:
'201':
description: Add deploy key
schema:
$ref: '#/definitions/API_Entities_DeployKeysProject'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: postApiV4ProjectsIdDeployKeys
/api/v4/projects/{id}/deploy_keys/{key_id}:
get:
summary: Get a single deploy key
description: Get a single key.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: key_id
description: The ID of the deploy key
type: integer
format: int32
required: true
responses:
'200':
description: Get a single deploy key
schema:
$ref: '#/definitions/API_Entities_DeployKeysProject'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeployKeysKeyId
put:
summary: Update deploy key
description: Updates a deploy key for a project.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: key_id
description: The ID of the deploy key
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdDeployKeysKeyId
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdDeployKeysKeyId'
responses:
'200':
description: Update deploy key
schema:
$ref: '#/definitions/API_Entities_DeployKey'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- deploy_resources
operationId: putApiV4ProjectsIdDeployKeysKeyId
delete:
summary: Delete deploy key
description: Removes a deploy key from the project. If the deploy key is used only for this project, it's deleted from the system.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: key_id
description: The ID of the deploy key
type: integer
format: int32
required: true
responses:
'204':
description: Delete deploy key
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: deleteApiV4ProjectsIdDeployKeysKeyId
/api/v4/projects/{id}/deploy_keys/{key_id}/enable:
post:
summary: Enable a deploy key
description: Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful. This feature was added in GitLab 8.11.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: key_id
description: The ID of the deploy key
type: integer
format: int32
required: true
responses:
'201':
description: Enable a deploy key
schema:
$ref: '#/definitions/API_Entities_DeployKey'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: postApiV4ProjectsIdDeployKeysKeyIdEnable
/api/v4/projects/{id}/deploy_tokens:
get:
summary: List project deploy tokens
description: Get a list of a project's deploy tokens. This feature was introduced in GitLab 12.9.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: query
name: active
description: Limit by active status
type: boolean
required: false
responses:
'200':
description: List project deploy tokens
schema:
type: array
items:
$ref: '#/definitions/API_Entities_DeployToken'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeployTokens
post:
summary: Create a project deploy token
description: Creates a new deploy token for a project. This feature was introduced in GitLab 12.9.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- name: postApiV4ProjectsIdDeployTokens
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdDeployTokens'
responses:
'201':
description: Create a project deploy token
schema:
$ref: '#/definitions/API_Entities_DeployTokenWithToken'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: postApiV4ProjectsIdDeployTokens
/api/v4/projects/{id}/deploy_tokens/{token_id}:
get:
summary: Get a project deploy token
description: Get a single project's deploy token by ID. This feature was introduced in GitLab 14.9.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: token_id
description: The ID of the deploy token
type: integer
format: int32
required: true
responses:
'200':
description: Get a project deploy token
schema:
$ref: '#/definitions/API_Entities_DeployToken'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeployTokensTokenId
delete:
summary: Delete a project deploy token
description: This feature was introduced in GitLab 12.9.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: token_id
description: The ID of the deploy token
type: integer
format: int32
required: true
responses:
'204':
description: Delete a project deploy token
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: deleteApiV4ProjectsIdDeployTokensTokenId
/api/v4/projects/{id}/deployments:
get:
summary: List project deployments
description: Get a list of deployments in a project. This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: query
name: order_by
description: Return deployments ordered by either one of `id`, `iid`, `created_at`, `updated_at` or `ref` fields. Default is `id`
type: string
default: id
enum:
- id
- iid
- created_at
- updated_at
- finished_at
required: false
- in: query
name: sort
description: Return deployments sorted in `asc` or `desc` order. Default is `asc`
type: string
default: asc
enum:
- asc
- desc
required: false
- in: query
name: updated_after
description: Return deployments updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
type: string
format: date-time
required: false
- in: query
name: updated_before
description: Return deployments updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
type: string
format: date-time
required: false
- in: query
name: finished_after
description: Return deployments finished after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
type: string
format: date-time
required: false
- in: query
name: finished_before
description: Return deployments finished before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)
type: string
format: date-time
required: false
- in: query
name: environment
description: The name of the environment to filter deployments by
type: string
required: false
- in: query
name: status
description: The status to filter deployments by. One of `created`, `running`, `success`, `failed`, `canceled`, or `blocked`
type: string
enum:
- created
- running
- success
- failed
- canceled
- skipped
- blocked
required: false
responses:
'200':
description: List project deployments
schema:
type: array
items:
$ref: '#/definitions/API_Entities_Deployment'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeployments
post:
summary: Create a deployment
description: This feature was introduced in GitLab 12.4.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- name: postApiV4ProjectsIdDeployments
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdDeployments'
responses:
'201':
description: Create a deployment
schema:
$ref: '#/definitions/API_Entities_DeploymentExtended'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: postApiV4ProjectsIdDeployments
/api/v4/projects/{id}/deployments/{deployment_id}:
get:
summary: Get a specific deployment
description: This feature was introduced in GitLab 8.11.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: deployment_id
description: The ID of the deployment
type: integer
format: int32
required: true
responses:
'200':
description: Get a specific deployment
schema:
$ref: '#/definitions/API_Entities_DeploymentExtended'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- deploy_resources
operationId: getApiV4ProjectsIdDeploymentsDeploymentId
put:
summary: Update a deployment
description: This feature was introduced in GitLab 12.4.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: deployment_id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdDeploymentsDeploymentId
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdDeploymentsDeploymentId'
responses:
'200':
description: Update a deployment
schema:
$ref: '#/definitions/API_Entities_DeploymentExtended'
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not found
tags:
- deploy_resources
operationId: putApiV4ProjectsIdDeploymentsDeploymentId
delete:
summary: Delete a specific deployment
description: Delete a specific deployment that is not currently the last deployment for an environment or in a running state. This feature was introduced in GitLab 15.3.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: path
name: deployment_id
description: The ID of the deployment
type: integer
format: int32
required: true
responses:
'204':
description: Deployment destroyed
'403':
description: Forbidden
'400':
description: '"Cannot destroy running deployment" or "Deployment currently deployed to environment"'
tags:
- deploy_resources
operationId: deleteApiV4ProjectsIdDeploymentsDeploymentId
/api/v4/projects/{id}/deployments/{deployment_id}/merge_requests:
get:
summary: List of merge requests associated with a deployment
description: Retrieves the list of merge requests shipped with a given deployment. This feature was introduced in GitLab 12.7.
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project owned by the authenticated user
type: string
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: path
name: deployment_id
description: The ID of the deployment
type: integer
format: int32
required: true
- in: query
name: author_id
description: Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`.
type: integer
format: int32
required: false
- in: query
name: author_username
description: Returns merge requests created by the given `username`. Mutually exclusive with `author_id`.
type: string
required: false
- in: query
name: assignee_id
description: Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee.
type: integer
format: int32
required: false
- in: query
name: assignee_username
description: Returns merge requests created by the given `username`. Mutually exclusive with `author_id`.
type: array
items:
type: string
required: false
- in: query
name: reviewer_username
description: 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. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8.
type: string
required: false
- in: query
name: labels
description: 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.
type: array
items:
type: string
required: false
- in: query
name: milestone
description: Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone.
type: string
required: false
- in: query
name: my_reaction_emoji
description: 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.
type: string
required: false
- in: query
name: reviewer_id
description: 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`.
type: integer
format: int32
required: false
- in: query
name: state
description: Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged`.
type: string
default: all
enum:
- opened
- closed
- locked
- merged
- all
required: false
- in: query
name: order_by
description: 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.
type: string
default: created_at
enum:
- created_at
- label_priority
- milestone_due
- popularity
- priority
- title
- updated_at
- merged_at
required: false
- in: query
name: sort
description: Returns merge requests sorted in `asc` or `desc` order.
type: string
default: desc
enum:
- asc
- desc
required: false
- in: query
name: with_labels_details
description: 'If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color`'
type: boolean
default: false
required: false
- in: query
name: with_merge_status_recheck
description: If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0.
type: boolean
default: false
required: false
- in: query
name: created_after
description: Returns merge requests created on or after the given time. Expected in ISO 8601 format.
type: string
format: date-time
required: false
example: '2019-03-15T08:00:00Z'
- in: query
name: created_before
description: Returns merge requests created on or before the given time. Expected in ISO 8601 format.
type: string
format: date-time
required: false
example: '2019-03-15T08:00:00Z'
- in: query
name: updated_after
description: Returns merge requests updated on or after the given time. Expected in ISO 8601 format.
type: string
format: date-time
required: false
example: '2019-03-15T08:00:00Z'
- in: query
name: updated_before
description: Returns merge requests updated on or before the given time. Expected in ISO 8601 format.
type: string
format: date-time
required: false
example: '2019-03-15T08:00:00Z'
- in: query
name: view
description: If simple, returns the `iid`, URL, title, description, and basic state of merge request
type: string
enum:
- simple
required: false
- in: query
name: scope
description: 'Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all`'
type: string
enum:
- created-by-me
- assigned-to-me
- created_by_me
- assigned_to_me
- reviews_for_me
- all
required: false
- in: query
name: source_branch
description: Returns merge requests with the given source branch
type: string
required: false
- in: query
name: source_project_id
description: Returns merge requests with the given source project id
type: integer
format: int32
required: false
- in: query
name: target_branch
description: Returns merge requests with the given target branch
type: string
required: false
- in: query
name: search
description: Search merge requests against their `title` and `description`.
type: string
required: false
- in: query
name: in
description: Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma.
type: string
required: false
example: title,description
- in: query
name: wip
description: 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.
type: string
enum:
- 'yes'
- 'no'
required: false
- in: query
name: draft
description: Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests.
type: boolean
required: false
- in: query
name: not[author_id]
description: '`<Negated>` Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`.'
type: integer
format: int32
required: false
- in: query
name: not[author_username]
description: '`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`.'
type: string
required: false
- in: query
name: not[assignee_id]
description: '`<Negated>` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee.'
type: integer
format: int32
required: false
- in: query
name: not[assignee_username]
description: '`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`.'
type: array
items:
type: string
required: false
- in: query
name: not[reviewer_username]
description: '`<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. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8.'
type: string
required: false
- in: query
name: not[labels]
description: '`<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.'
type: array
items:
type: string
required: false
- in: query
name: not[milestone]
description: '`<Negated>` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone.'
type: string
required: false
- in: query
name: not[my_reaction_emoji]
description: '`<Negated>` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-deploy-resources-api-openapi.yml