GitLab CI/CD
GitLab CI/CD is the built-in continuous integration, delivery and deployment platform for GitLab. The CI/CD surface area within GitLab's REST API v4 covers pipelines, jobs, pipeline schedules, pipeline triggers, runners, agents, releases, environments, deployments, package and container registries, and the security/dependency scanners. GitLab also exposes a GraphQL API.
APIs
GitLab REST API v4 (CI/CD endpoints)
GitLab REST API v4. CI/CD-related endpoint families include /projects/:id/ pipelines, /projects/:id/jobs, /projects/:id/pipeline_schedules, /projects/:id/triggers, /runners, /pr...
GitLab GraphQL API
GitLab's GraphQL API at /api/graphql. Many CI/CD entities (Pipeline, CiJob, CiRunner, MergeRequest pipelines) are exposed via GraphQL queries and mutations.
Collections
GitLab API
OPENGraphQL
GitLab CI/CD GraphQL API
GitLab's GraphQL API at /api/graphql. Many CI/CD entities (Pipeline, CiJob, CiRunner, MergeRequest pipelines) are exposed via GraphQL queries and mutations.
GRAPHQLPricing Plans
Rate Limits
FinOps
Gitlab Ci Finops
FINOPSJSON Structure
Resources
Sources
opencollection: 1.0.0
info:
name: GitLab API
version: v4
items:
- info:
name: access_requests
type: folder
items:
- info:
name: Gets a list of access requests for a group.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/access_requests'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: This feature was introduced in GitLab 8.11.
- info:
name: Requests access for the authenticated user to a group.
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/groups/:id/access_requests'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user
docs: This feature was introduced in GitLab 8.11.
- info:
name: Approves an access request for the given user.
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/groups/:id/access_requests/:user_id/approve'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user
- name: user_id
value: ''
type: path
description: The user ID of the access requester
docs: This feature was introduced in GitLab 8.11.
- info:
name: Denies an access request for the given user.
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/groups/:id/access_requests/:user_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user
- name: user_id
value: ''
type: path
description: The user ID of the access requester
docs: This feature was introduced in GitLab 8.11.
- info:
name: Gets a list of access requests for a project.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/access_requests'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: This feature was introduced in GitLab 8.11.
- info:
name: Requests access for the authenticated user to a project.
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/access_requests'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user
docs: This feature was introduced in GitLab 8.11.
- info:
name: Approves an access request for the given user.
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/projects/:id/access_requests/:user_id/approve'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user
- name: user_id
value: ''
type: path
description: The user ID of the access requester
docs: This feature was introduced in GitLab 8.11.
- info:
name: Denies an access request for the given user.
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/access_requests/:user_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user
- name: user_id
value: ''
type: path
description: The user ID of the access requester
docs: This feature was introduced in GitLab 8.11.
- info:
name: award_emoji
type: folder
items:
- info:
name: List an awardable's emoji reactions for groups
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group
- name: epic_iid
value: ''
type: path
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji'
params:
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for groups
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji'
params:
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji'
params:
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: epic_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project
- name: issue_iid
value: ''
type: path
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji'
params:
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji'
params:
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji'
params:
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: issue_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project
- name: merge_request_iid
value: ''
type: path
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji'
params:
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji'
params:
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji'
params:
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: merge_request_iid
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project
- name: snippet_id
value: ''
type: path
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji'
params:
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: List an awardable's emoji reactions for projects
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji'
params:
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
- info:
name: Add a new emoji reaction
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji'
params:
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
- info:
name: Get a single emoji reaction
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of the emoji reaction.
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
- info:
name: Delete an emoji reaction
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_id'
params:
- name: award_id
value: ''
type: path
description: ID of an emoji reaction.
- name: id
value: ''
type: path
- name: snippet_id
value: ''
type: path
- name: note_id
value: ''
type: path
docs: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in
8.9
- info:
name: badges
type: folder
items:
- info:
name: Gets a list of group badges viewable by the authenticated user.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/badges'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: name
value: ''
type: query
description: Name for the badge
docs: This feature was introduced in GitLab 10.6.
- info:
name: Adds a badge to a group.
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/groups/:id/badges'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
docs: This feature was introduced in GitLab 10.6.
- info:
name: Preview a badge from a group.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/badges/render'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
- name: link_url
value: ''
type: query
description: URL of the badge link
- name: image_url
value: ''
type: query
description: URL of the badge image
docs: This feature was introduced in GitLab 10.6.
- info:
name: Gets a badge of a group.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
- name: badge_id
value: ''
type: path
description: The badge ID
docs: This feature was introduced in GitLab 10.6.
- info:
name: Updates a badge of a group.
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/groups/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
- name: badge_id
value: ''
type: path
docs: This feature was introduced in GitLab 10.6.
- info:
name: Removes a badge from the group.
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/groups/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the group owned by the authenticated user.
- name: badge_id
value: ''
type: path
description: The badge ID
docs: This feature was introduced in GitLab 10.6.
- info:
name: Gets a list of project badges viewable by the authenticated user.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/badges'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
- name: page
value: '1'
type: query
description: Current page number
- name: per_page
value: '20'
type: query
description: Number of items per page
- name: name
value: ''
type: query
description: Name for the badge
docs: This feature was introduced in GitLab 10.6.
- info:
name: Adds a badge to a project.
type: http
http:
method: POST
url: '{{baseUrl}}/api/v4/projects/:id/badges'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
docs: This feature was introduced in GitLab 10.6.
- info:
name: Preview a badge from a project.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/badges/render'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
- name: link_url
value: ''
type: query
description: URL of the badge link
- name: image_url
value: ''
type: query
description: URL of the badge image
docs: This feature was introduced in GitLab 10.6.
- info:
name: Gets a badge of a project.
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
- name: badge_id
value: ''
type: path
description: The badge ID
docs: This feature was introduced in GitLab 10.6.
- info:
name: Updates a badge of a project.
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/projects/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
- name: badge_id
value: ''
type: path
docs: This feature was introduced in GitLab 10.6.
- info:
name: Removes a badge from the project.
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/badges/:badge_id'
params:
- name: id
value: ''
type: path
description: The ID or URL-encoded path of the project owned by the authenticated user.
- name: badge_id
value: ''
type: path
description: The badge ID
docs: This feature was introduced in GitLab 10.6.
- info:
name: custom_attributes
type: folder
items:
- info:
name: getApiV4GroupsIdCustomAttributes
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/custom_attributes'
params:
- name: id
value: ''
type: path
docs: Get all custom attributes on a group
- info:
name: getApiV4GroupsIdCustomAttributesKey
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Get a custom attribute on a group
- info:
name: putApiV4GroupsIdCustomAttributesKey
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Set a custom attribute on a group
- info:
name: deleteApiV4GroupsIdCustomAttributesKey
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Delete a custom attribute on a group
- info:
name: getApiV4ProjectsIdCustomAttributes
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/custom_attributes'
params:
- name: id
value: ''
type: path
docs: Get all custom attributes on a project
- info:
name: getApiV4ProjectsIdCustomAttributesKey
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Get a custom attribute on a project
- info:
name: putApiV4ProjectsIdCustomAttributesKey
type: http
http:
method: PUT
url: '{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Set a custom attribute on a project
- info:
name: deleteApiV4ProjectsIdCustomAttributesKey
type: http
http:
method: DELETE
url: '{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key'
params:
- name: key
value: ''
type: path
description: The key of the custom attribute
- name: id
value: ''
type: path
docs: Delete a custom attribute on a project
- info:
name: groups
type: folder
items:
- info:
name: getApiV4Groups
type: http
http:
method: GET
url: '{{baseUrl}}/api/v4/groups'
params:
- name: statistics
value: ''
type: query
description: Include project statistics
- name: archived
value: ''
type: query
description: Limit by archived status
- name: skip_groups
value: ''
type: query
description: Array of group ids to exclude from list
- name: all_available
value:
# --- truncated at 32 KB (662 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/apis.yml