Development — entry 029 of 100

Gitlab

Verified Jul 2026

GitLab's REST API (with a parallel GraphQL API) covers projects, merge requests, CI/CD pipelines, issues, and container registries across GitLab.com SaaS and self-managed instances, returning JSON with cursor-style pagination headers. Authentication runs through personal, project, or group access tokens as well as OAuth2 apps; the docs consolidated off the old `/ee/api/` path onto a single `/api/` tree that now redirects there.

gitdevopsrepositoriesci-cdmerge-requests

Visit docs.gitlab.com ↗Read the docs ↗Pricing ↗Status ↗More Development

AuthenticationOAuthRequires an OAuth flow; expect app registration.

HTTPSSupportedTraffic is encrypted in transit.

CORSEnabledCallable directly from browser JavaScript.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSON, GraphQLResponses can be requested as JSON or GraphQL.

GreatAPIs Score

Score80out of 100

Authentication8/25OAuth flow required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats15/15Supports 2 response formats

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/gitlab/"><img src="https://greatapis.com/badge/gitlab.svg" alt="Scored 80 on greatapis.com"></a>

Auth quickstart

Register an app / run the OAuth flow to obtain a bearer token.
Send it as an Authorization headerAuthorization: Bearer <token>

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://gitlab.com

award_emoji32

Operations about award_emoji

GET/api/v4/groups/{id}/epics/{epic_iid}/award_emojiList all emoji reactions for an epic

Parameters

Name	In	Required	Type
`id`	path	yes	string
`epic_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for an epic	—
`404`	Not Found	—

POST/api/v4/groups/{id}/epics/{epic_iid}/award_emojiAdd an emoji reaction to an epic

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`epic_iid`	path	yes	integer

Request body

application/json — postApiV4GroupsIdEpicsEpicIidAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to an epic	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/groups/{id}/epics/{epic_iid}/award_emoji/{award_id}Retrieve an emoji reaction from an epic

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`epic_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from an epic	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/groups/{id}/epics/{epic_iid}/award_emoji/{award_id}Delete an emoji reaction from an epic

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`epic_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from an epic	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emojiList all emoji reactions for an epic comment

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer
`epic_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for an epic comment	—
`404`	Not Found	—

POST/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emojiAdd an emoji reaction to an epic comment

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`epic_iid`	path	yes	integer
`note_id`	path	yes	integer

Request body

application/json — postApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to an epic comment	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji/{award_id}Retrieve an emoji reaction from an epic comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`epic_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from an epic comment	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji/{award_id}Delete an emoji reaction from an epic comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`epic_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from an epic comment	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/award_emojiList all emoji reactions for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for an issue	—
`404`	Not Found	—

POST/api/v4/projects/{id}/issues/{issue_iid}/award_emojiAdd an emoji reaction to an issue

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to an issue	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id}Retrieve an emoji reaction from an issue

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from an issue	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id}Delete an emoji reaction from an issue

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from an issue	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emojiList all emoji reactions for an issue comment

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer
`issue_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for an issue comment	—
`404`	Not Found	—

POST/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emojiAdd an emoji reaction to an issue comment

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`issue_iid`	path	yes	integer
`note_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to an issue comment	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id}Retrieve an emoji reaction from an issue comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`issue_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from an issue comment	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id}Delete an emoji reaction from an issue comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`issue_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from an issue comment	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emojiList all emoji reactions for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for a merge request	—
`404`	Not Found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emojiAdd an emoji reaction to a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to a merge request	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id}Retrieve an emoji reaction from a merge request

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from a merge request	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id}Delete an emoji reaction from a merge request

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from a merge request	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emojiList all emoji reactions for a merge request comment

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for a merge request comment	—
`404`	Not Found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emojiAdd an emoji reaction to a merge request comment

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer
`note_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to a merge request comment	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id}Retrieve an emoji reaction from a merge request comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from a merge request comment	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id}Delete an emoji reaction from a merge request comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`merge_request_iid`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from a merge request comment	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/award_emojiList all emoji reactions for a snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for a snippet	—
`404`	Not Found	—

POST/api/v4/projects/{id}/snippets/{snippet_id}/award_emojiAdd an emoji reaction to a snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`snippet_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdSnippetsSnippetIdAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to a snippet	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}Retrieve an emoji reaction from a snippet

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from a snippet	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}Delete an emoji reaction from a snippet

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from a snippet	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emojiList all emoji reactions for a snippet comment

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer
`snippet_id`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all emoji reactions for a snippet comment	—
`404`	Not Found	—

POST/api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emojiAdd an emoji reaction to a snippet comment

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`snippet_id`	path	yes	integer
`note_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdSnippetsSnippetIdNotesNoteIdAwardEmoji (required)

Responses

Status	Description	Schema
`201`	Add an emoji reaction to a snippet comment	`API_Entities_AwardEmoji`
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id}Retrieve an emoji reaction from a snippet comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`snippet_id`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an emoji reaction from a snippet comment	`API_Entities_AwardEmoji`
`404`	Not Found	—

DELETE/api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id}Delete an emoji reaction from a snippet comment

Parameters

Name	In	Required	Type
`award_id`	path	yes	integer
`id`	path	yes	integer
`snippet_id`	path	yes	integer
`note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an emoji reaction from a snippet comment	—
`401`	Unauthorized	—
`404`	Not Found	—

badges12

Operations about badges

GET/api/v4/groups/{id}/badgesList all badges for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`name`	query	no	string

Responses

Status	Description	Schema
`200`	List all badges for a group	—

POST/api/v4/groups/{id}/badgesCreate a badge for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdBadges (required)

Responses

Status	Description	Schema
`201`	Create a badge for a group	`API_Entities_Badge`

GET/api/v4/groups/{id}/badges/renderRetrieve a badge preview for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`link_url`	query	yes	string
`image_url`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a badge preview for a group	`API_Entities_BasicBadgeDetails`

GET/api/v4/groups/{id}/badges/{badge_id}Retrieve a badge for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a badge for a group	`API_Entities_Badge`

PUT/api/v4/groups/{id}/badges/{badge_id}Update a badge for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdBadgesBadgeId (required)

Responses

Status	Description	Schema
`200`	Update a badge for a group	`API_Entities_Badge`

DELETE/api/v4/groups/{id}/badges/{badge_id}Delete a badge from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

GET/api/v4/projects/{id}/badgesList all badges for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`name`	query	no	string

Responses

Status	Description	Schema
`200`	List all badges for a project	—

POST/api/v4/projects/{id}/badgesCreate a badge for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdBadges (required)

Responses

Status	Description	Schema
`201`	Create a badge for a project	`API_Entities_Badge`

GET/api/v4/projects/{id}/badges/renderRetrieve a badge preview for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`link_url`	query	yes	string
`image_url`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a badge preview for a project	`API_Entities_BasicBadgeDetails`

GET/api/v4/projects/{id}/badges/{badge_id}Retrieve a badge for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a badge for a project	`API_Entities_Badge`

PUT/api/v4/projects/{id}/badges/{badge_id}Update a badge for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdBadgesBadgeId (required)

Responses

Status	Description	Schema
`200`	Update a badge for a project	`API_Entities_Badge`

DELETE/api/v4/projects/{id}/badges/{badge_id}Delete a badge from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`badge_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

custom_attributes8

Operations about custom_attributes

GET/api/v4/groups/{id}/custom_attributesList all custom attributes for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all custom attributes for a group	`API_Entities_CustomAttribute`

GET/api/v4/groups/{id}/custom_attributes/{key}Retrieve a custom attribute for a group

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a custom attribute for a group	`API_Entities_CustomAttribute`

PUT/api/v4/groups/{id}/custom_attributes/{key}Creates or updates a custom attribute for a group

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdCustomAttributesKey (required)

Responses

Status	Description	Schema
`200`	Creates or updates a custom attribute for a group	`API_Entities_CustomAttribute`

DELETE/api/v4/groups/{id}/custom_attributes/{key}Delete a custom attribute for a group

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a custom attribute for a group	—

GET/api/v4/projects/{id}/custom_attributesList all custom attributes for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all custom attributes for a project	`API_Entities_CustomAttribute`

GET/api/v4/projects/{id}/custom_attributes/{key}Retrieve a custom attribute for a project

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a custom attribute for a project	`API_Entities_CustomAttribute`

PUT/api/v4/projects/{id}/custom_attributes/{key}Creates or updates a custom attribute for a project

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdCustomAttributesKey (required)

Responses

Status	Description	Schema
`200`	Creates or updates a custom attribute for a project	`API_Entities_CustomAttribute`

DELETE/api/v4/projects/{id}/custom_attributes/{key}Delete a custom attribute for a project

Parameters

Name	In	Required	Type
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a custom attribute for a project	—

groups37

Operations about groups

GET/api/v4/groupsList all groups

Parameters

Name	In	Required	Type
`statistics`	query	no	boolean
`archived`	query	no	boolean
`skip_groups`	query	no	array
`all_available`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`owned`	query	no	boolean
`order_by`	query	no	string
`sort`	query	no	string
`min_access_level`	query	no	integer
`top_level_only`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`repository_storage`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all groups	—

POST/api/v4/groupsCreate a group

Request body

application/json — postApiV4Groups (required)

Responses

Status	Description	Schema
`201`	Create a group	`API_Entities_Group`

GET/api/v4/groups/{id}Retrieve a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`with_custom_attributes`	query	no	boolean
`with_projects`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a group	`API_Entities_GroupDetail`

PUT/api/v4/groups/{id}Update group attributes

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4GroupsId (required)

Responses

Status	Description	Schema
`200`	Update group attributes	`API_Entities_Group`

DELETE/api/v4/groups/{id}Schedule a group for deletion

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Accepted	—

POST/api/v4/groups/{id}/archiveArchive a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Archive a group	`API_Entities_Group`
`403`	Unauthenticated	—

GET/api/v4/groups/{id}/audit_events/{audit_event_id}Retrieve a group audit event

Parameters

Name	In	Required	Type
`audit_event_id`	path	yes	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group audit event	`API_Entities_AuditEvent`

GET/api/v4/groups/{id}/billable_membersList all billable group members

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`search`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	List all billable group members	`API_Entities_Member`

GET/api/v4/groups/{id}/descendant_groupsList all descendant groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`statistics`	query	no	boolean
`archived`	query	no	boolean
`skip_groups`	query	no	array
`all_available`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`owned`	query	no	boolean
`order_by`	query	no	string
`sort`	query	no	string
`min_access_level`	query	no	integer
`top_level_only`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`repository_storage`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all descendant groups	—

GET/api/v4/groups/{id}/groups/sharedList all shared groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`skip_groups`	query	no	array
`visibility`	query	no	string
`search`	query	no	string
`min_access_level`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all shared groups	—

GET/api/v4/groups/{id}/invited_groupsList all invited groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	no	array
`search`	query	no	string
`min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all invited groups	—

GET/api/v4/groups/{id}/issuesList all issues for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`with_labels_details`	query	no	boolean
`state`	query	no	string
`closed_by_id`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`due_date`	query	no	string
`issue_type`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`non_archived`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all issues for a group	`API_Entities_Issue`

GET/api/v4/groups/{id}/issues_statisticsRetrieve issues statistics for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve issues statistics for a group	—

GET/api/v4/groups/{id}/placeholder_reassignmentsRetrieve pending reassignments

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve pending reassignments	—

POST/api/v4/groups/{id}/placeholder_reassignmentsReassign placeholders

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdPlaceholderReassignments (required)

Responses

Status	Description	Schema
`201`	Reassign placeholders	—

POST/api/v4/groups/{id}/placeholder_reassignments/authorizeWorkhorse authorization for the reassignment CSV file

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Workhorse authorization for the reassignment CSV file	—

GET/api/v4/groups/{id}/projectsList all projects in a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`active`	query	no	boolean
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`simple`	query	no	boolean
`owned`	query	no	boolean
`starred`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`with_shared`	query	no	boolean
`include_subgroups`	query	no	boolean
`include_ancestor_groups`	query	no	boolean
`min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean
`with_security_reports`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all projects in a group	—

GET/api/v4/groups/{id}/projects/sharedList all shared projects

Parameters

Name	In	Required	Type
`id`	path	yes	string
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`simple`	query	no	boolean
`starred`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all shared projects	—

POST/api/v4/groups/{id}/projects/{project_id}Transfer a project to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`project_id`	path	yes	string

Responses

Status	Description	Schema
`201`	Transfer a project to a group	`API_Entities_GroupDetail`

GET/api/v4/groups/{id}/provisioned_usersList all provisioned users

Parameters

Name	In	Required	Type
`username`	query	no	string
`search`	query	no	string
`active`	query	no	boolean
`blocked`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all provisioned users	`API_Entities_UserPublic`

POST/api/v4/groups/{id}/restoreRestore a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Restore a group	—

GET/api/v4/groups/{id}/saml_usersList all SAML users

Parameters

Name	In	Required	Type
`username`	query	no	string
`search`	query	no	string
`active`	query	no	boolean
`blocked`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all SAML users	—

POST/api/v4/groups/{id}/shareAdd a group to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdShare (required)

Responses

Status	Description	Schema
`201`	Add a group to a group	`API_Entities_GroupDetail`

DELETE/api/v4/groups/{id}/share/{group_id}Remove a group from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`group_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

DELETE/api/v4/groups/{id}/shared_projects/{project_id}Remove a shared project from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`project_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Remove a shared project from a group	—
`400`	Bad request	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/groups/{id}/subgroupsList all subgroups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`statistics`	query	no	boolean
`archived`	query	no	boolean
`skip_groups`	query	no	array
`all_available`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`owned`	query	no	boolean
`order_by`	query	no	string
`sort`	query	no	string
`min_access_level`	query	no	integer
`top_level_only`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`repository_storage`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all subgroups	—

POST/api/v4/groups/{id}/transferTransfer a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdTransfer (required)

Responses

Status	Description	Schema
`201`	Transfer a group	—

GET/api/v4/groups/{id}/transfer_locationsList all transfer locations for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all transfer locations for a group	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdTransferToOrganization (required)

Responses

Status	Description	Schema
`201`	Transfer a group to an organization	`API_Entities_GroupDetail`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Group or Organization not found	—
`422`	Unprocessable entity	—

POST/api/v4/groups/{id}/unarchiveUnarchive a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Unarchive a group	`API_Entities_Group`
`403`	Unauthenticated	—

GET/api/v4/groups/{id}/uploadsList all uploads for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all uploads for a group	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/groups/{id}/uploadsUpload a file to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdUploads (required)

Responses

Status	Description	Schema
`201`	Upload a file to a group	`API_Entities_GroupUpload`
`400`	Bad request	—
`404`	Not found	—

POST/api/v4/groups/{id}/uploads/authorizeWorkhorse authorize the file upload

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the file upload	—
`404`	Not found	—

GET/api/v4/groups/{id}/uploads/{secret}/{filename}Download an uploaded file by secret and filename

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secret`	path	yes	string
`filename`	path	yes	string

Responses

Status	Description	Schema
`200`	Download an uploaded file by secret and filename	—
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/groups/{id}/uploads/{secret}/{filename}Delete an uploaded file by secret and filename

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secret`	path	yes	string
`filename`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete an uploaded file by secret and filename	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/groups/{id}/uploads/{upload_id}Download an uploaded file by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`upload_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Download an uploaded file by ID	—
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/groups/{id}/uploads/{upload_id}Delete an uploaded file by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`upload_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an uploaded file by ID	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

ldap1

Operations about ldaps

POST/api/v4/groups/{id}/ldap_syncSync a group with LDAP

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Sync a group with LDAP	—

audit_events1

Operations about audit_events

GET/api/v4/groups/{id}/audit_eventsList all group audit events

Parameters

Name	In	Required	Type
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all group audit events	—

keys5

Operations about keys

GET/api/v4/groups/{id}/ssh_certificatesGet a list of Groups::SshCertificate for a Group.

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all group SSH certificates	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	404 Not Found	—

POST/api/v4/groups/{id}/ssh_certificatesAdd a Groups::SshCertificate.

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4GroupsIdSshCertificates (required)

Responses

Status	Description	Schema
`201`	Add a group SSH certificate	`API_Entities_SshCertificate`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/groups/{id}/ssh_certificates/{ssh_certificates_id}Delete a group SSH certificate

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`ssh_certificates_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a group SSH certificate	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—

GET/api/v4/keysRetrieve user by SSH key fingerprint

Parameters

Name	In	Required	Type
`fingerprint`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve user by SSH key fingerprint	`API_Entities_UserWithAdmin`

GET/api/v4/keys/{id}Retrieve user by SSH key ID

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve user by SSH key ID	`API_Entities_SSHKeyWithUser`

runners16

Operations about runners

GET/api/v4/groups/{id}/runnersList all runners in a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`type`	query	no	string
`paused`	query	no	boolean
`status`	query	no	string
`tag_list`	query	no	array
`version_prefix`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all runners in a group	`API_Entities_Ci_Runner`
`400`	Scope contains invalid value	—
`403`	Forbidden	—

POST/api/v4/groups/{id}/runners/reset_registration_tokenReset the runner registration token for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Reset the runner registration token for a group	`API_Entities_Ci_ResetTokenResult`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Group Not Found	—

GET/api/v4/projects/{id}/runnersList project's runners

Parameters

Name	In	Required	Type
`id`	path	yes	string
`scope`	query	no	string
`type`	query	no	string
`paused`	query	no	boolean
`status`	query	no	string
`tag_list`	query	no	array
`version_prefix`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all runners for a project	`API_Entities_Ci_Runner`
`400`	Scope contains invalid value	—
`403`	No access granted	—

POST/api/v4/projects/{id}/runnersAssign a runner to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRunners (required)

Responses

Status	Description	Schema
`201`	Assign a runner to a project	`API_Entities_Ci_Runner`
`400`	Bad Request	—
`403`	No access granted	—
`404`	Runner not found	—

POST/api/v4/projects/{id}/runners/reset_registration_tokenReset the runner registration token for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Reset the runner registration token for a project	`API_Entities_Ci_ResetTokenResult`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Project Not Found	—

DELETE/api/v4/projects/{id}/runners/{runner_id}Unassign a runner from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`runner_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Unassign a runner from a project	`API_Entities_Ci_Runner`
`400`	Bad Request	—
`403`	You cannot unassign a runner from the owner project. Delete the runner instead	—
`404`	Runner not found	—
`412`	Precondition Failed	—

GET/api/v4/runnersList available runners

Parameters

Name	In	Required	Type
`scope`	query	no	string
`type`	query	no	string
`paused`	query	no	boolean
`status`	query	no	string
`tag_list`	query	no	array
`version_prefix`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all available runners	`API_Entities_Ci_Runner`
`400`	Scope contains invalid value	—
`401`	Unauthorized	—

GET/api/v4/runners/allList all runners

Parameters

Name	In	Required	Type
`scope`	query	no	string
`type`	query	no	string
`paused`	query	no	boolean
`status`	query	no	string
`tag_list`	query	no	array
`version_prefix`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all runners	`API_Entities_Ci_Runner`
`400`	Scope contains invalid value	—
`401`	Unauthorized	—

POST/api/v4/runners/reset_registration_tokenReset the runner registration token for the instance

Responses

Status	Description	Schema
`201`	Reset the runner registration token for the instance	`API_Entities_Ci_ResetTokenResult`
`403`	Forbidden	—

GET/api/v4/runners/{id}Retrieve details on a runner

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`include_projects`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve details on a runner	`API_Entities_Ci_RunnerDetails`
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—

PUT/api/v4/runners/{id}Update details of a runner

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4RunnersId (required)

Responses

Status	Description	Schema
`200`	Update a runner	`API_Entities_Ci_RunnerDetails`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—

DELETE/api/v4/runners/{id}Delete a runner

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a runner	`API_Entities_Ci_Runner`
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—
`412`	Precondition Failed	—

GET/api/v4/runners/{id}/jobsList all jobs processed by a runner

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`system_id`	query	no	string
`status`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`cursor`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all jobs processed by a runner	`API_Entities_Ci_JobBasicWithProject`
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—

GET/api/v4/runners/{id}/managersList all managers for a runner

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all managers for a runner	`API_Entities_Ci_RunnerManager`
`403`	Forbidden	—

GET/api/v4/runners/{id}/projectsList runner's projects

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Get projects associated with a runner	`API_Entities_BasicProjectDetails`
`401`	Unauthorized	—
`403`	No access granted	—
`404`	Runner not found	—

POST/api/v4/runners/{id}/reset_authentication_tokenReset runner's authentication token

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Reset an authentication token for a runner	`API_Entities_Ci_ResetTokenResult`
`403`	No access granted	—
`404`	Runner not found	—
`422`	Unprocessable Entity	—

packages_debian34

Operations about packages_debians

GET/api/v4/groups/{id}/-/debian_distributionsList all Debian group distributions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`codename`	query	no	string
`suite`	query	no	string
`origin`	query	no	string
`label`	query	no	string
`version`	query	no	string
`description`	query	no	string
`valid_time_duration_seconds`	query	no	integer
`components`	query	no	array
`architectures`	query	no	array

Responses

Status	Description	Schema
`200`	List all Debian group distributions	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/groups/{id}/-/debian_distributionsCreate a Debian group distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdDebianDistributions (required)

Responses

Status	Description	Schema
`201`	Create a Debian group distribution	`API_Entities_Packages_Debian_Distribution`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/debian_distributions/{codename}Retrieve a Debian group distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a Debian group distribution	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/groups/{id}/-/debian_distributions/{codename}Update a Debian group distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Request body

application/json — putApiV4GroupsIdDebianDistributionsCodename (required)

Responses

Status	Description	Schema
`200`	Update a Debian group distribution	`API_Entities_Packages_Debian_Distribution`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/groups/{id}/-/debian_distributions/{codename}Delete a Debian group distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string
`suite`	query	no	string
`origin`	query	no	string
`label`	query	no	string
`version`	query	no	string
`description`	query	no	string
`valid_time_duration_seconds`	query	no	integer
`components`	query	no	array
`architectures`	query	no	array

Responses

Status	Description	Schema
`202`	Delete a Debian group distribution	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/debian_distributions/{codename}/key.ascRetrieve a Debian group distribution key

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a Debian group distribution key	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/InReleaseThe signed Release file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The signed Release file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/ReleaseThe unsigned Release file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The unsigned Release file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/Release.gpgThe Release file signature

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The Release file signature	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/binary-{architecture}/PackagesThe binary files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string

Responses

Status	Description	Schema
`200`	The binary files index	—
`202`	The binary files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/binary-{architecture}/by-hash/SHA256/{file_sha256}The binary files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The binary files index by hash	—
`202`	The binary files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/debian-installer/binary-{architecture}/PackagesThe installer (udeb) binary files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string

Responses

Status	Description	Schema
`200`	The installer (udeb) binary files index	—
`202`	The installer (udeb) binary files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/debian-installer/binary-{architecture}/by-hash/SHA256/{file_sha256}

The installer (udeb) binary files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The installer (udeb) binary files index by hash	—
`202`	The installer (udeb) binary files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/source/SourcesThe source files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string

Responses

Status	Description	Schema
`200`	The source files index	—
`202`	The source files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/debian/dists/*distribution/{component}/source/by-hash/SHA256/{file_sha256}The source files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The source files index by hash	—
`202`	The source files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/groups/{id}/-/packages/debian/pool/{distribution}/{project_id}/{letter}/{package_name}/{package_version}/{file_name}

Download Debian package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`project_id`	path	yes	integer
`distribution`	path	yes	string
`letter`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Download Debian package	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/debian_distributionsList all Debian project distributions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`codename`	query	no	string
`suite`	query	no	string
`origin`	query	no	string
`label`	query	no	string
`version`	query	no	string
`description`	query	no	string
`valid_time_duration_seconds`	query	no	integer
`components`	query	no	array
`architectures`	query	no	array

Responses

Status	Description	Schema
`200`	List all Debian project distributions	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/debian_distributionsCreate a Debian project distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdDebianDistributions (required)

Responses

Status	Description	Schema
`201`	Create a Debian project distribution	`API_Entities_Packages_Debian_Distribution`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/debian_distributions/{codename}Retrieve a Debian project distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a Debian project distribution	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/debian_distributions/{codename}Update a Debian project distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Request body

application/json — putApiV4ProjectsIdDebianDistributionsCodename (required)

Responses

Status	Description	Schema
`200`	Update a Debian project distribution	`API_Entities_Packages_Debian_Distribution`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/debian_distributions/{codename}Delete a Debian project distribution

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string
`suite`	query	no	string
`origin`	query	no	string
`label`	query	no	string
`version`	query	no	string
`description`	query	no	string
`valid_time_duration_seconds`	query	no	integer
`components`	query	no	array
`architectures`	query	no	array

Responses

Status	Description	Schema
`202`	Delete a Debian project distribution	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/debian_distributions/{codename}/key.ascRetrieve a Debian project distribution key

Parameters

Name	In	Required	Type
`id`	path	yes	string
`codename`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a Debian project distribution key	`API_Entities_Packages_Debian_Distribution`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/InReleaseThe signed Release file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The signed Release file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/ReleaseThe unsigned Release file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The unsigned Release file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/Release.gpgThe Release file signature

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string

Responses

Status	Description	Schema
`200`	The Release file signature	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/binary-{architecture}/PackagesThe binary files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string

Responses

Status	Description	Schema
`200`	The binary files index	—
`202`	The binary files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/binary-{architecture}/by-hash/SHA256/{file_sha256}The binary files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The binary files index by hash	—
`202`	The binary files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/debian-installer/binary-{architecture}/PackagesThe installer (udeb) binary files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string

Responses

Status	Description	Schema
`200`	The installer (udeb) binary files index	—
`202`	The installer (udeb) binary files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/debian-installer/binary-{architecture}/by-hash/SHA256/{file_sha256}

The installer (udeb) binary files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`architecture`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The installer (udeb) binary files index by hash	—
`202`	The installer (udeb) binary files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/source/SourcesThe source files index

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string

Responses

Status	Description	Schema
`200`	The source files index	—
`202`	The source files index	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/dists/*distribution/{component}/source/by-hash/SHA256/{file_sha256}The source files index by hash

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	query	yes	string
`component`	path	yes	string
`file_sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The source files index by hash	—
`202`	The source files index by hash	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/debian/pool/{distribution}/{letter}/{package_name}/{package_version}/{file_name}Download a Debian package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`distribution`	path	yes	string
`letter`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a Debian package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/debian/{file_name}Upload a Debian package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesDebianFileName (required)

Responses

Status	Description	Schema
`201`	Upload a Debian package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/debian/{file_name}/authorizeAuthorize Debian package upload

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesDebianFileNameAuthorize (required)

Responses

Status	Description	Schema
`200`	Authorize Debian package upload	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

deploy_resources24

Operations about deploy_resources

GET/api/v4/deploy_keysList all deploy keys

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`public`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all deploy keys	—
`401`	Unauthorized	—
`403`	Forbidden	—

POST/api/v4/deploy_keysCreate a deploy key

Request body

application/json — postApiV4DeployKeys (required)

Responses

Status	Description	Schema
`201`	Create a deploy key	`API_Entities_DeployKey`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/deploy_tokensList all deploy tokens

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`active`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all deploy tokens	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/groups/{id}/deploy_tokensList all group deploy tokens

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer
`active`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all group deploy tokens	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/groups/{id}/deploy_tokensCreate a group deploy token

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4GroupsIdDeployTokens (required)

Responses

Status	Description	Schema
`201`	Create a group deploy token	`API_Entities_DeployTokenWithToken`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group deploy token	`API_Entities_DeployToken`
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/deploy_keysList all deploy keys for project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all deploy keys for project	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/deploy_keysAdd a deploy key for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdDeployKeys (required)

Responses

Status	Description	Schema
`201`	Add a deploy key for a project	`API_Entities_DeployKeysProject`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a deploy key	`API_Entities_DeployKeysProject`
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdDeployKeysKeyId (required)

Responses

Status	Description	Schema
`200`	Update a deploy key	`API_Entities_DeployKey`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/deploy_keys/{key_id}/enableEnable a deploy key

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Enable a deploy key	`API_Entities_DeployKey`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/deploy_tokensList all project deploy tokens

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`active`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all project deploy tokens	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/deploy_tokensCreate a project deploy token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdDeployTokens (required)

Responses

Status	Description	Schema
`201`	Create a project deploy token	`API_Entities_DeployTokenWithToken`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project deploy token	`API_Entities_DeployToken`
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/deploymentsList all project deployments

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`finished_after`	query	no	string
`finished_before`	query	no	string
`environment`	query	no	string
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all project deployments	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/deploymentsCreate a deployment

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdDeployments (required)

Responses

Status	Description	Schema
`201`	Create a deployment	`API_Entities_DeploymentExtended`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`deployment_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a deployment	`API_Entities_DeploymentExtended`
`401`	Unauthorized	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`deployment_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdDeploymentsDeploymentId (required)

Responses

Status	Description	Schema
`200`	Update a deployment	`API_Entities_DeploymentExtended`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`deployment_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Deployment destroyed	—
`400`	"Cannot destroy running deployment" or "Deployment currently deployed to environment"	—
`403`	Forbidden	—

POST/api/v4/projects/{id}/deployments/{deployment_id}/approvalApprove or reject a deployment

Parameters

Name	In	Required	Type
`id`	path	yes	string
`deployment_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdDeploymentsDeploymentIdApproval (required)

Responses

Status	Description	Schema
`201`	Approve or reject a deployment	`API_Entities_Deployments_Approval`

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

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`deployment_id`	path	yes	integer
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`reviewer_username`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`my_reaction_emoji`	query	no	string
`reviewer_id`	query	no	integer
`state`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`with_labels_details`	query	no	boolean
`with_merge_status_recheck`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`view`	query	no	string
`scope`	query	no	string
`source_branch`	query	no	string
`source_project_id`	query	no	integer
`target_branch`	query	no	string
`search`	query	no	string
`in`	query	no	string
`wip`	query	no	string
`draft`	query	no	boolean
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[reviewer_username]`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[my_reaction_emoji]`	query	no	string
`not[reviewer_id]`	query	no	integer
`deployed_before`	query	no	string
`deployed_after`	query	no	string
`environment`	query	no	string
`merge_user_id`	query	no	integer
`merge_user_username`	query	no	string

Responses

Status	Description	Schema
`200`	List all merge requests associated with a deployment	—
`401`	Unauthorized	—
`404`	Not found	—

avatars3

Operations about avatars

GET/api/v4/avatar

Parameters

Name	In	Required	Type
`email`	query	yes	string
`size`	query	no	integer

Responses

Status	Description	Schema
`200`	Return avatar url for a user	`API_Entities_Avatar`

GET/api/v4/groups/{id}/avatarDownload a group avatar

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a group avatar	—

GET/api/v4/projects/{id}/avatarDownload a project avatar

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a project avatar	—

group_import_and_export7

Operations about group_import_and_exports

POST/api/v4/groups/importCreate a group import

Responses

Status	Description	Schema
`202`	Create a group import	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`503`	Service unavailable	—

POST/api/v4/groups/import/authorizeWorkhorse authorize the group import upload

Responses

Status	Description	Schema
`201`	Workhorse authorize the group import upload	—

POST/api/v4/groups/{id}/exportCreate a group export

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Create a group export	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`429`	Too many requests	—
`503`	Service unavailable	—

GET/api/v4/groups/{id}/export/downloadRetrieve a group export download

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a group export download	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/groups/{id}/export_relationsSchedule a relations export for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdExportRelations (required)

Responses

Status	Description	Schema
`202`	Schedule a relations export for a group	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/groups/{id}/export_relations/downloadDownload a relations export for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	yes	string
`batched`	query	no	boolean
`batch_number`	query	no	integer

Responses

Status	Description	Schema
`200`	Download a relations export for a group	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/groups/{id}/export_relations/statusRetrieve the status of an relations export for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve the status of an relations export for a group	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

packages20

Operations about packages

GET/api/v4/groups/{id}/-/packages/maven/*path/{file_name}Download the maven package file at a group level

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string
`path`	query	yes	string

Responses

Status	Description	Schema
`200`	Download the maven package file at a group level	—
`302`	Download the maven package file at a group level	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/packagesList all packages for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`exclude_subgroups`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`package_type`	query	no	string
`package_name`	query	no	string
`package_version`	query	no	string
`include_versionless`	query	no	boolean
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all packages for a group	—
`401`	Unauthorized	—
`404`	Group Not Found	—

GET/api/v4/packages/maven/*path/{file_name}Download the maven package file at instance level

Parameters

Name	In	Required	Type
`file_name`	path	yes	string
`path`	query	yes	string

Responses

Status	Description	Schema
`200`	Download the maven package file at instance level	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packagesList all packages for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`package_type`	query	no	string
`package_name`	query	no	string
`package_version`	query	no	string
`include_versionless`	query	no	boolean
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all packages for a project	—
`403`	Forbidden	—
`404`	Project Not Found	—

GET/api/v4/projects/{id}/packages/generic/{package_name}/*package_version/(*path/){file_name}Download package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`file_name`	path	yes	string
`package_version`	query	yes	string
`path`	query	no	string

Responses

Status	Description	Schema
`200`	Download package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/generic/{package_name}/*package_version/(*path/){file_name}Upload package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesGenericPackageName*packageVersion(*path)FileName (required)

Responses

Status	Description	Schema
`200`	Upload package file	—
`201`	Upload package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/generic/{package_name}/*package_version/(*path/){file_name}/authorizeWorkhorse authorize generic package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesGenericPackageName*packageVersion(*path)FileNameAuthorize (required)

Responses

Status	Description	Schema
`200`	Workhorse authorize generic package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/go/*module_name/@v/listList

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	query	yes	string

Responses

Status	Description	Schema
`200`	List	—

GET/api/v4/projects/{id}/packages/go/*module_name/@v/{module_version}.infoVersion metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	query	yes	string
`module_version`	path	yes	string

Responses

Status	Description	Schema
`200`	Version metadata	`API_Entities_GoModuleVersion`

GET/api/v4/projects/{id}/packages/go/*module_name/@v/{module_version}.modDownload module file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	query	yes	string
`module_version`	path	yes	string

Responses

Status	Description	Schema
`200`	Download module file	—

GET/api/v4/projects/{id}/packages/go/*module_name/@v/{module_version}.zipDownload module source

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	query	yes	string
`module_version`	path	yes	string

Responses

Status	Description	Schema
`200`	Download module source	—

GET/api/v4/projects/{id}/packages/maven/*path/{file_name}Download the maven package file at a project level

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string
`path`	query	yes	string

Responses

Status	Description	Schema
`200`	Download the maven package file at a project level	—
`302`	Download the maven package file at a project level	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/maven/*path/{file_name}Upload the maven package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesMaven*pathFileName (required)

Responses

Status	Description	Schema
`200`	Upload the maven package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

PUT/api/v4/projects/{id}/packages/maven/*path/{file_name}/authorizeWorkhorse authorize the maven package file upload

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesMaven*pathFileNameAuthorize (required)

Responses

Status	Description	Schema
`200`	Workhorse authorize the maven package file upload	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/{package_id}Retrieve a project package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project package	`API_Entities_Package`
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/packages/{package_id}Delete a project package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a project package	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/{package_id}/package_filesList all package files

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	List all package files	—

DELETE/api/v4/projects/{id}/packages/{package_id}/package_files/{package_file_id}Delete a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_id`	path	yes	integer
`package_file_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a package file	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/packages/{package_id}/package_files/{package_file_id}/downloadDownload a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_id`	path	yes	integer
`package_file_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Download a package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/packages/{package_id}/pipelinesList all package pipelines

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`package_id`	path	yes	integer
`cursor`	query	no	string

Responses

Status	Description	Schema
`200`	List all package pipelines	`API_Entities_Package_Pipeline`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

invitations8

Operations about invitations

GET/api/v4/groups/{id}/invitationsList all pending invitations for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`query`	query	no	string

Responses

Status	Description	Schema
`200`	List all pending invitations for a group	—

POST/api/v4/groups/{id}/invitationsAdd a member to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdInvitations (required)

Responses

Status	Description	Schema
`201`	Add a member to a group	`API_Entities_Invitation`

PUT/api/v4/groups/{id}/invitations/{email}Update an invitation to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`email`	path	yes	string

Request body

application/json — putApiV4GroupsIdInvitationsEmail (required)

Responses

Status	Description	Schema
`200`	Update an invitation to a group	`API_Entities_Invitation`

DELETE/api/v4/groups/{id}/invitations/{email}Delete an invitation to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`email`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete an invitation to a group	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Could not delete invitation	—

GET/api/v4/projects/{id}/invitationsList all pending invitations for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`query`	query	no	string

Responses

Status	Description	Schema
`200`	List all pending invitations for a project	—

POST/api/v4/projects/{id}/invitationsAdd a member to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdInvitations (required)

Responses

Status	Description	Schema
`201`	Add a member to a project	`API_Entities_Invitation`

PUT/api/v4/projects/{id}/invitations/{email}Update an invitation to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`email`	path	yes	string

Request body

application/json — putApiV4ProjectsIdInvitationsEmail (required)

Responses

Status	Description	Schema
`200`	Update an invitation to a project	`API_Entities_Invitation`

DELETE/api/v4/projects/{id}/invitations/{email}Delete an invitation to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`email`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete an invitation to a project	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Could not delete invitation	—

members23

Operations about members

DELETE/api/v4/groups/{id}/billable_members/{user_id}Remove a billable member from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

GET/api/v4/groups/{id}/billable_members/{user_id}/indirectList all indirect memberships for a billable group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all indirect memberships for a billable group member	`API_Entities_BillableMembership`

GET/api/v4/groups/{id}/billable_members/{user_id}/membershipsList all memberships for a billable group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all memberships for a billable group member	`API_Entities_BillableMembership`

GET/api/v4/groups/{id}/membersList all direct members of a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`query`	query	no	string
`user_ids`	query	no	array
`skip_users`	query	no	array
`show_seat_info`	query	no	boolean
`with_saml_identity`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all direct members of a group	—

POST/api/v4/groups/{id}/membersAdd a member to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdMembers (required)

Responses

Status	Description	Schema
`201`	Add a member to a group	`API_Entities_Member`

GET/api/v4/groups/{id}/members/allList all members of a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`query`	query	no	string
`user_ids`	query	no	array
`show_seat_info`	query	no	boolean
`state`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all members of a group	—

GET/api/v4/groups/{id}/members/all/{user_id}Retrieve a group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group member	`API_Entities_Member`

POST/api/v4/groups/{id}/members/approve_allApprove all pending group members

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Approve all pending group members	—

PUT/api/v4/groups/{id}/members/{member_id}/approveApprove a group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`member_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Approve a group member	—

GET/api/v4/groups/{id}/members/{user_id}Retrieve a direct group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a direct group member	`API_Entities_Member`

PUT/api/v4/groups/{id}/members/{user_id}Update a group member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdMembersUserId (required)

Responses

Status	Description	Schema
`200`	Update a group member	`API_Entities_Member`

DELETE/api/v4/groups/{id}/members/{user_id}Remove a member from a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer
`skip_subresources`	query	no	boolean
`unassign_issuables`	query	no	boolean

Responses

Status	Description	Schema
`204`	Resource deleted	—

POST/api/v4/groups/{id}/members/{user_id}/overrideSet override flag for a member of a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Set override flag for a member of a group	`API_Entities_Member`

DELETE/api/v4/groups/{id}/members/{user_id}/overrideRemove an LDAP access level override

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Remove an LDAP access level override	`API_Entities_Member`

PUT/api/v4/groups/{id}/members/{user_id}/stateUpdate group membership state for a user

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdMembersUserIdState (required)

Responses

Status	Description	Schema
`200`	Update group membership state for a user	—

GET/api/v4/groups/{id}/pending_membersList all pending group members

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all pending group members	—

GET/api/v4/projects/{id}/membersList all direct members of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`query`	query	no	string
`user_ids`	query	no	array
`skip_users`	query	no	array
`show_seat_info`	query	no	boolean
`with_saml_identity`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all direct members of a project	—

POST/api/v4/projects/{id}/membersAdd a member to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdMembers (required)

Responses

Status	Description	Schema
`201`	Add a member to a project	`API_Entities_Member`

GET/api/v4/projects/{id}/members/allList all members of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`query`	query	no	string
`user_ids`	query	no	array
`show_seat_info`	query	no	boolean
`state`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all members of a project	—

GET/api/v4/projects/{id}/members/all/{user_id}Retrieve a project member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project member	`API_Entities_Member`

GET/api/v4/projects/{id}/members/{user_id}Retrieve a direct project member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a direct project member	`API_Entities_Member`

PUT/api/v4/projects/{id}/members/{user_id}Update a project member

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdMembersUserId (required)

Responses

Status	Description	Schema
`200`	Update a project member	`API_Entities_Member`

DELETE/api/v4/projects/{id}/members/{user_id}Remove a member from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer
`skip_subresources`	query	no	boolean
`unassign_issuables`	query	no	boolean

Responses

Status	Description	Schema
`204`	Resource deleted	—

packages_npm20

Operations about packages_npms

GET/api/v4/groups/{id}/-/packages/npm/*package_nameNPM registry metadata endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Ok	`API_Entities_NpmPackage`
`302`	Found (redirect)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/groups/{id}/-/packages/npm/-/npm/v1/security/advisories/bulkNPM registry bulk advisory endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/groups/{id}/-/packages/npm/-/npm/v1/security/audits/quickNPM registry quick audit endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/npm/-/package/*package_name/dist-tagsGet all tags for a given an NPM package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Get all tags for a given an NPM package	`API_Entities_NpmPackageTag`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/groups/{id}/-/packages/npm/-/package/*package_name/dist-tags/{tag}Create or Update the given tag for the given NPM package and version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag`	path	yes	string

Request body

application/json — putApiV4GroupsIdPackagesNpmPackage*packageNameDistTagsTag (required)

Responses

Status	Description	Schema
`204`	Create or Update the given tag for the given NPM package and version	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/groups/{id}/-/packages/npm/-/package/*package_name/dist-tags/{tag}Deletes the given tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`tag`	path	yes	string

Responses

Status	Description	Schema
`204`	Deletes the given tag	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/npm/*package_nameNPM registry metadata endpoint

Parameters

Name	In	Required	Type
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Ok	`API_Entities_NpmPackage`
`302`	Found (redirect)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/packages/npm/-/npm/v1/security/advisories/bulkNPM registry bulk advisory endpoint

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/packages/npm/-/npm/v1/security/audits/quickNPM registry quick audit endpoint

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/npm/-/package/*package_name/dist-tagsGet all tags for a given an NPM package

Parameters

Name	In	Required	Type
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Get all tags for a given an NPM package	`API_Entities_NpmPackageTag`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/packages/npm/-/package/*package_name/dist-tags/{tag}Create or Update the given tag for the given NPM package and version

Parameters

Name	In	Required	Type
`tag`	path	yes	string

Request body

application/json — putApiV4PackagesNpmPackage*packageNameDistTagsTag (required)

Responses

Status	Description	Schema
`204`	Create or Update the given tag for the given NPM package and version	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/packages/npm/-/package/*package_name/dist-tags/{tag}Deletes the given tag

Parameters

Name	In	Required	Type
`package_name`	query	yes	string
`tag`	path	yes	string

Responses

Status	Description	Schema
`204`	Deletes the given tag	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/npm/*package_nameNPM registry metadata endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Ok	`API_Entities_NpmPackage`
`302`	Found (redirect)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/npm/*package_name/-/*file_nameDownload the NPM tarball

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`file_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Download the NPM tarball	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/npm/-/npm/v1/security/advisories/bulkNPM registry bulk advisory endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/npm/-/npm/v1/security/audits/quickNPM registry quick audit endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Ok	—
`307`	Temporary Redirect	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/npm/-/package/*package_name/dist-tagsGet all tags for a given an NPM package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Get all tags for a given an NPM package	`API_Entities_NpmPackageTag`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/npm/-/package/*package_name/dist-tags/{tag}Create or Update the given tag for the given NPM package and version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesNpmPackage*packageNameDistTagsTag (required)

Responses

Status	Description	Schema
`204`	Create or Update the given tag for the given NPM package and version	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/packages/npm/-/package/*package_name/dist-tags/{tag}Deletes the given tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`tag`	path	yes	string

Responses

Status	Description	Schema
`204`	Deletes the given tag	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/npm/{package_name}Create or deprecate an NPM package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesNpmPackageName (required)

Responses

Status	Description	Schema
`200`	Create or deprecate an NPM package	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

packages_nuget26

Operations about packages_nugets

GET/api/v4/groups/{id}/-/packages/nuget/indexThe NuGet V3 Feed Service Index

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	The NuGet V3 Feed Service Index	`API_Entities_Nuget_ServiceIndex`
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/metadata/*package_name/*package_versionThe NuGet Metadata Service - Package name and version level

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`package_name`	query	yes	string
`package_version`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Metadata Service - Package name and version level	`API_Entities_Nuget_PackageMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/metadata/*package_name/indexThe NuGet Metadata Service - Package name level

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Metadata Service - Package name level	`API_Entities_Nuget_PackagesMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/queryThe NuGet Search Service

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`q`	query	no	string
`skip`	query	no	integer
`take`	query	no	integer
`prerelease`	query	no	boolean

Responses

Status	Description	Schema
`200`	The NuGet Search Service	`API_Entities_Nuget_SearchResults`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/symbolfiles/*file_name/*signature/*same_file_nameThe NuGet Symbol File Download Endpoint

Parameters

Name	In	Required	Type
`Symbolchecksum`	header	yes	string
`id`	path	yes	integer
`file_name`	query	yes	string
`signature`	query	yes	string
`same_file_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Symbol File Download Endpoint	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/v2The NuGet V2 Feed Service Index

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Service Index	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/nuget/v2/$metadataThe NuGet V2 Feed Package $metadata endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Package $metadata endpoint	—

PUT/api/v4/projects/{id}/packages/nugetUpload a NuGet v3 package file for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesNuget (required)

Responses

Status	Description	Schema
`201`	Upload a NuGet v3 package file for a project	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/packages/nuget/*package_name/*package_versionThe NuGet Package Delete endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`package_version`	query	yes	string

Responses

Status	Description	Schema
`204`	The NuGet Package Delete endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/nuget/authorizeThe NuGet Package Authorize endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Package Authorize endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/download/*package_name/*package_version/*package_filenameThe NuGet Content Service - content request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`package_version`	query	yes	string
`package_filename`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Content Service - content request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/download/*package_name/indexThe NuGet Content Service - index request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Content Service - index request	`API_Entities_Nuget_PackagesVersions`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/indexThe NuGet V3 Feed Service Index

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V3 Feed Service Index	`API_Entities_Nuget_ServiceIndex`
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/metadata/*package_name/*package_versionThe NuGet Metadata Service - Package name and version level

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string
`package_version`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Metadata Service - Package name and version level	`API_Entities_Nuget_PackageMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/metadata/*package_name/indexThe NuGet Metadata Service - Package name level

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Metadata Service - Package name level	`API_Entities_Nuget_PackagesMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/queryThe NuGet Search Service

Parameters

Name	In	Required	Type
`id`	path	yes	string
`q`	query	no	string
`skip`	query	no	integer
`take`	query	no	integer
`prerelease`	query	no	boolean

Responses

Status	Description	Schema
`200`	The NuGet Search Service	`API_Entities_Nuget_SearchResults`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/symbolfiles/*file_name/*signature/*same_file_nameThe NuGet Symbol File Download Endpoint

Parameters

Name	In	Required	Type
`Symbolchecksum`	header	yes	string
`id`	path	yes	string
`file_name`	query	yes	string
`signature`	query	yes	string
`same_file_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Symbol File Download Endpoint	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/nuget/symbolpackageUpload a NuGet symbol package file

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesNugetSymbolpackage (required)

Responses

Status	Description	Schema
`201`	Upload a NuGet symbol package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/nuget/symbolpackage/authorizeThe NuGet Symbol Package Authorize endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet Symbol Package Authorize endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/v2The NuGet V2 Feed Service Index

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Service Index	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/nuget/v2Upload a NuGet v2 package file for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesNugetV2 (required)

Responses

Status	Description	Schema
`201`	Upload a NuGet v2 package file for a project	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/nuget/v2/$metadataThe NuGet V2 Feed Package $metadata endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Package $metadata endpoint	—

PUT/api/v4/projects/{id}/packages/nuget/v2/authorizeThe NuGet V2 Feed Package Authorize endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Package Authorize endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{project_id}/packages/nuget/v2/FindPackagesByIdThe NuGet V2 Feed Find Packages by ID endpoint

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`id`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Find Packages by ID endpoint	—
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{project_id}/packages/nuget/v2/Packages$Id='*package_name',Version='*package_version'$The NuGet V2 Feed Single Package Metadata endpoint

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`package_name`	query	yes	string
`package_version`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Single Package Metadata endpoint	—
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{project_id}/packages/nuget/v2/PackagesThe NuGet V2 Feed Enumerate Packages endpoint

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`$filter`	query	yes	string

Responses

Status	Description	Schema
`200`	The NuGet V2 Feed Enumerate Packages endpoint	—
`400`	Bad Request	—
`404`	Not Found	—

packages_pypi8

Operations about packages_pypis

GET/api/v4/groups/{id}/-/packages/pypi/files/{sha256}/*file_identifierDownload a package file from a group

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`file_identifier`	query	yes	string
`sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a package file from a group	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/pypi/simpleList all packages for a group

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all packages for a group	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/groups/{id}/-/packages/pypi/simple/*package_nameThe PyPi Simple Group Package Endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The PyPi Simple Group Package Endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/pypiUpload a package

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPackagesPypi (required)

Responses

Status	Description	Schema
`201`	Upload a package	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

POST/api/v4/projects/{id}/packages/pypi/authorizeAuthorize the PyPi package upload from workhorse

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Authorize the PyPi package upload from workhorse	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/pypi/files/{sha256}/*file_identifierThe PyPi package download endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_identifier`	query	yes	string
`sha256`	path	yes	string

Responses

Status	Description	Schema
`200`	The PyPi package download endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/pypi/simpleList all packages for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all packages for a project	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/pypi/simple/*package_nameThe PyPi Simple Project Package Endpoint

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	The PyPi Simple Project Package Endpoint	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

access_tokens10

Operations about access_tokens

POST/api/v4/groups/{id}/access_tokens/self/rotateRotate a group access token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdAccessTokensSelfRotate (required)

Responses

Status	Description	Schema
`200`	Rotate a group access token	`API_Entities_ResourceAccessTokenWithToken`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`405`	Method not allowed	—

GET/api/v4/personal_access_tokensList all personal access tokens

Parameters

Name	In	Required	Type
`user_id`	query	no	integer
`revoked`	query	no	boolean
`state`	query	no	string
`created_before`	query	no	string
`created_after`	query	no	string
`last_used_before`	query	no	string
`last_used_after`	query	no	string
`expires_before`	query	no	string
`expires_after`	query	no	string
`search`	query	no	string
`sort`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all personal access tokens	—
`401`	Unauthorized	—

GET/api/v4/personal_access_tokens/selfRetrieve a personal access token

Responses

Status	Description	Schema
`200`	Retrieve a personal access token	`API_Entities_PersonalAccessTokenWithLastUsedIps`
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/personal_access_tokens/selfRevoke a personal access token

Responses

Status	Description	Schema
`204`	Revoke a personal access token	—
`400`	Bad Request	—

GET/api/v4/personal_access_tokens/self/associationsList all token associations

Parameters

Name	In	Required	Type
`min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all token associations	`API_Entities_PersonalAccessToken`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/personal_access_tokens/self/rotateRotate a personal access token

Request body

application/json — postApiV4PersonalAccessTokensSelfRotate (required)

Responses

Status	Description	Schema
`200`	Rotate a personal access token	`API_Entities_PersonalAccessTokenWithToken`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`405`	Method not allowed	—

GET/api/v4/personal_access_tokens/{id}Retrieve a personal access token

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a personal access token	`API_Entities_PersonalAccessTokenWithLastUsedIps`
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/personal_access_tokens/{id}Revoke a personal access token

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Revoke a personal access token	—
`400`	Bad Request	—

POST/api/v4/personal_access_tokens/{id}/rotateRotate a personal access token

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4PersonalAccessTokensIdRotate (required)

Responses

Status	Description	Schema
`201`	Rotate a personal access token	`API_Entities_PersonalAccessTokenWithToken`

POST/api/v4/projects/{id}/access_tokens/self/rotateRotate a project access token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdAccessTokensSelfRotate (required)

Responses

Status	Description	Schema
`200`	Rotate a project access token	`API_Entities_ResourceAccessTokenWithToken`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`405`	Method not allowed	—

search3

Operations about searches

GET/api/v4/groups/{id}/(-/)searchSearch on GitLab within a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	yes	string
`scope`	query	yes	string
`state`	query	no	string
`confidential`	query	no	boolean
`type`	query	no	array
`include_archived`	query	no	boolean
`fields`	query	no	array
`exclude_forks`	query	no	boolean
`num_context_lines`	query	no	integer
`regex`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Search on GitLab within a group	—

GET/api/v4/projects/{id}/(-/)searchSearch on GitLab within a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	yes	string
`scope`	query	yes	string
`ref`	query	no	string
`state`	query	no	string
`confidential`	query	no	boolean
`type`	query	no	array
`fields`	query	no	array
`num_context_lines`	query	no	integer
`regex`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Search on GitLab within a project	—

GET/api/v4/searchSearch an instance

Parameters

Name	In	Required	Type
`search`	query	yes	string
`scope`	query	yes	string
`state`	query	no	string
`confidential`	query	no	boolean
`type`	query	no	array
`include_archived`	query	no	boolean
`fields`	query	no	array
`exclude_forks`	query	no	boolean
`num_context_lines`	query	no	integer
`regex`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Search an instance	—

wikis12

Operations about wikis

GET/api/v4/groups/{id}/wikisList all wiki pages for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`with_content`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all wiki pages for a group	—
`404`	Not found	—

POST/api/v4/groups/{id}/wikisCreate a wiki page for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdWikis (required)

Responses

Status	Description	Schema
`201`	Create a wiki page for a group	`API_Entities_WikiPage`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/groups/{id}/wikis/attachmentsUpload an attachment to a group wiki

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdWikisAttachments (required)

Responses

Status	Description	Schema
`201`	Upload an attachment to a group wiki	`API_Entities_WikiAttachment`
`404`	Not found	—

GET/api/v4/groups/{id}/wikis/{slug}Retrieve a wiki page for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	string
`version`	query	no	string
`render_html`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a wiki page for a group	`API_Entities_WikiPage`
`404`	Not found	—

PUT/api/v4/groups/{id}/wikis/{slug}Update a wiki page for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	integer

Request body

application/json — putApiV4GroupsIdWikisSlug (required)

Responses

Status	Description	Schema
`200`	Update a wiki page for a group	`API_Entities_WikiPage`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/groups/{id}/wikis/{slug}Delete a wiki page for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a wiki page for a group	—
`400`	Validation error	—
`404`	Not found	—

GET/api/v4/projects/{id}/wikisList all wiki pages for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`with_content`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all wiki pages for a project	—
`404`	Not found	—

POST/api/v4/projects/{id}/wikisCreate a wiki page for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdWikis (required)

Responses

Status	Description	Schema
`201`	Create a wiki page for a project	`API_Entities_WikiPage`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/projects/{id}/wikis/attachmentsUpload an attachment to a project wiki

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdWikisAttachments (required)

Responses

Status	Description	Schema
`201`	Upload an attachment to a project wiki	`API_Entities_WikiAttachment`
`404`	Not found	—

GET/api/v4/projects/{id}/wikis/{slug}Retrieve a wiki page for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	string
`version`	query	no	string
`render_html`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a wiki page for a project	`API_Entities_WikiPage`
`404`	Not found	—

PUT/api/v4/projects/{id}/wikis/{slug}Update a wiki page for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdWikisSlug (required)

Responses

Status	Description	Schema
`200`	Update a wiki page for a project	`API_Entities_WikiPage`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/wikis/{slug}Delete a wiki page for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`slug`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a wiki page for a project	—
`400`	Validation error	—
`404`	Not found	—

alert_management5

Operations about alert_managements

GET/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_imagesList all metric images

Parameters

Name	In	Required	Type
`id`	path	yes	string
`alert_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all metric images	—
`404`	Not found	—

POST/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_imagesUpload a metric image

Parameters

Name	In	Required	Type
`id`	path	yes	string
`alert_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Upload a metric image	`API_Entities_MetricImage`
`403`	Forbidden	—

POST/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize

Parameters

Name	In	Required	Type
`id`	path	yes	string
`alert_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Workhorse authorize metric image file upload	—
`403`	Forbidden	—

PUT/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}Update a metric image

Parameters

Name	In	Required	Type
`id`	path	yes	string
`alert_iid`	path	yes	integer
`metric_image_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Update a metric image	`API_Entities_MetricImage`
`403`	Forbidden	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}Delete a metric image

Parameters

Name	In	Required	Type
`id`	path	yes	string
`alert_iid`	path	yes	integer
`metric_image_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a metric image	`API_Entities_MetricImage`
`403`	Forbidden	—
`422`	Unprocessable entity	—

branches8

Operations about branches

GET/api/v4/projects/{id}/repository/branchesList all repository branches

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`search`	query	no	string
`regex`	query	no	string
`sort`	query	no	string
`page_token`	query	no	string

Responses

Status	Description	Schema
`200`	List all repository branches	—
`404`	404 Project Not Found	—

POST/api/v4/projects/{id}/repository/branchesCreate a repository branch

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryBranches (required)

Responses

Status	Description	Schema
`201`	Create a repository branch	`API_Entities_Branch`
`400`	Failed to create branch	—

GET/api/v4/projects/{id}/repository/branches/{branch}Retrieve a repository branch

Parameters

Name	In	Required	Type
`id`	path	yes	string
`branch`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a repository branch	`API_Entities_Branch`
`404`	Branch Not Found	—

DELETE/api/v4/projects/{id}/repository/branches/{branch}Delete a repository branch

Parameters

Name	In	Required	Type
`id`	path	yes	string
`branch`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a repository branch	—
`404`	Branch Not Found	—

HEAD/api/v4/projects/{id}/repository/branches/{branch}

Parameters

Name	In	Required	Type
`id`	path	yes	string
`branch`	path	yes	string

Responses

Status	Description	Schema
`204`	No Content	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/repository/branches/{branch}/protect

Parameters

Name	In	Required	Type
`id`	path	yes	string
`branch`	path	yes	string

Request body

application/json — putApiV4ProjectsIdRepositoryBranchesBranchProtect (required)

Responses

Status	Description	Schema
`200`	Protect a single branch	`API_Entities_Branch`
`404`	404 Branch Not Found	—

PUT/api/v4/projects/{id}/repository/branches/{branch}/unprotect

Parameters

Name	In	Required	Type
`id`	path	yes	string
`branch`	path	yes	string

Responses

Status	Description	Schema
`200`	Unprotect a single branch	`API_Entities_Branch`
`404`	404 Project Not Found	—

DELETE/api/v4/projects/{id}/repository/merged_branchesDelete all merged branches

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	202 Accepted	—
`404`	404 Project Not Found	—

ci_catalog1

Operations about ci_catalogs

POST/api/v4/projects/{id}/catalog/publishPublish a new component project release as version to the CI/CD catalog

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdCatalogPublish (required)

Responses

Status	Description	Schema
`201`	Publish a new component project release as version to the CI/CD catalog	`API_Entities_Ci_Catalog_Resources_Version`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

job_artifacts8

Operations about job_artifacts

DELETE/api/v4/projects/{id}/artifactsDelete all job artifacts in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Delete all job artifacts in a project	—
`401`	Unauthorized	—
`403`	Forbidden	—
`409`	Conflict	—

GET/api/v4/projects/{id}/jobs/artifacts/{ref_name}/downloadRetrieve job artifacts

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref_name`	path	yes	string
`job`	query	yes	string
`job_token`	query	no	string
`search_recent_successful_pipelines`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve job artifacts	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobs/artifacts/{ref_name}/raw/*artifact_pathDownload a specific file from artifacts archive from a ref

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref_name`	path	yes	string
`job`	query	yes	string
`artifact_path`	query	yes	string
`job_token`	query	no	string
`search_recent_successful_pipelines`	query	no	boolean

Responses

Status	Description	Schema
`200`	Download a specific file from artifacts archive from a ref	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobs/{job_id}/artifactsDownload the artifacts archive from a job

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer
`job_token`	query	no	string

Responses

Status	Description	Schema
`200`	Download the artifacts archive from a job	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/jobs/{job_id}/artifactsDelete job artifacts

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete job artifacts	—
`401`	Unauthorized	—
`403`	Forbidden	—
`409`	Conflict	—

GET/api/v4/projects/{id}/jobs/{job_id}/artifacts/*artifact_pathDownload a specific file from artifacts archive

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer
`artifact_path`	query	yes	string
`job_token`	query	no	string

Responses

Status	Description	Schema
`200`	Download a specific file from artifacts archive	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/jobs/{job_id}/artifacts/keepRetain job artifacts

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Retain job artifacts	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobs/{job_id}/artifacts/treeList all files in an artifacts archive

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer
`path`	query	no	string
`recursive`	query	no	boolean
`job_token`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all files in an artifacts archive	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

ci_jobs8

Operations about ci_jobs

GET/api/v4/jobRetrieve a job by job token

Responses

Status	Description	Schema
`200`	Retrieve a job by job token	`API_Entities_Ci_Job`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobsList all jobs for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`scope`	query	no	array
`ref`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all jobs for a project	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobs/{job_id}Retrieve a job

Parameters

Name	In	Required	Type
`job_id`	path	yes	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a job	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/jobs/{job_id}/cancelCancel a job

Parameters

Name	In	Required	Type
`job_id`	path	yes	integer
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdJobsJobIdCancel (required)

Responses

Status	Description	Schema
`201`	Cancel a job	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/jobs/{job_id}/eraseErase a job

Parameters

Name	In	Required	Type
`job_id`	path	yes	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Erase a job	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—

POST/api/v4/projects/{id}/jobs/{job_id}/playRun a job

Parameters

Name	In	Required	Type
`job_id`	path	yes	integer
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdJobsJobIdPlay (required)

Responses

Status	Description	Schema
`200`	Run a job	`API_Entities_Ci_JobBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/jobs/{job_id}/retryRetry a job

Parameters

Name	In	Required	Type
`job_id`	path	yes	integer
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdJobsJobIdRetry (required)

Responses

Status	Description	Schema
`201`	Retry a job	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/jobs/{job_id}/traceGet a trace of a specific job of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`job_id`	path	yes	integer
`byte_offset`	query	no	integer
`byte_limit`	query	no	integer

Responses

Status	Description	Schema
`200`	Get a trace of a specific job of a project	`API_Entities_Ci_Job`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

secure_files5

Operations about secure_files

GET/api/v4/projects/{id}/secure_filesList all secure files for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all secure files for a project	`API_Entities_Ci_SecureFile`

POST/api/v4/projects/{id}/secure_filesCreate a secure file

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdSecureFiles (required)

Responses

Status	Description	Schema
`201`	Create a secure file	`API_Entities_Ci_SecureFile`
`400`	400 Bad Request	—

GET/api/v4/projects/{id}/secure_files/{secure_file_id}Retrieve details of a secure file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secure_file_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve details of a secure file	`API_Entities_Ci_SecureFile`
`404`	404 Not found	—

DELETE/api/v4/projects/{id}/secure_files/{secure_file_id}Delete a secure file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secure_file_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—
`404`	404 Not found	—

GET/api/v4/projects/{id}/secure_files/{secure_file_id}/downloadDownload a secure file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secure_file_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Download a secure file	—
`404`	404 Not found	—

pipelines14

Operations about pipelines

POST/api/v4/projects/{id}/pipelineCreate a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPipeline (required)

Responses

Status	Description	Schema
`201`	Create a pipeline	`API_Entities_Ci_Pipeline`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelinesList all project pipelines

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`scope`	query	no	string
`status`	query	no	string
`ref`	query	no	string
`sha`	query	no	string
`yaml_errors`	query	no	boolean
`username`	query	no	string
`updated_before`	query	no	string
`updated_after`	query	no	string
`created_before`	query	no	string
`created_after`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`source`	query	no	string
`name`	query	no	string

Responses

Status	Description	Schema
`200`	List all project pipelines	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/pipelines/latestRetrieve the latest pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve the latest pipeline	`API_Entities_Ci_PipelineWithMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}Retrieve a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a pipeline	`API_Entities_Ci_PipelineWithMetadata`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/pipelines/{pipeline_id}Delete a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Pipeline was deleted	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/bridgesList all bridge jobs by pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer
`scope`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all bridge jobs by pipeline	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipelines/{pipeline_id}/cancelCancel all jobs for a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Cancel all jobs for a pipeline	`API_Entities_Ci_Pipeline`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/jobsList all jobs by pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer
`include_retried`	query	no	boolean
`scope`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all jobs by pipeline	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/pipelines/{pipeline_id}/metadataUpdate pipeline metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdPipelinesPipelineIdMetadata (required)

Responses

Status	Description	Schema
`200`	Update pipeline metadata	`API_Entities_Ci_PipelineWithMetadata`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipelines/{pipeline_id}/retryRetry jobs in a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Retry jobs in a pipeline	`API_Entities_Ci_Pipeline`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/test_reportRetrieve a test report for a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a test report for a pipeline	`TestReportEntity`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/test_report_summaryRetrieve a test report summary for a pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a test report summary for a pipeline	`TestReportSummaryEntity`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/trigger_jobsList all trigger jobs by pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer
`scope`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all trigger jobs by pipeline	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipelines/{pipeline_id}/variablesList all pipeline variables

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all pipeline variables	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

pipeline_schedules12

Operations about pipeline_schedules

GET/api/v4/projects/{id}/pipeline_schedulesList all pipeline schedules

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`scope`	query	no	string

Responses

Status	Description	Schema
`200`	List all pipeline schedules	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipeline_schedulesCreate a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPipelineSchedules (required)

Responses

Status	Description	Schema
`201`	Create a pipeline schedule	`API_Entities_Ci_PipelineScheduleDetails`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}Retrieve a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a pipeline schedule	`API_Entities_Ci_PipelineScheduleDetails`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}Update a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId (required)

Responses

Status	Description	Schema
`200`	Update a pipeline schedule	`API_Entities_Ci_PipelineScheduleDetails`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}Delete a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a pipeline schedule	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`412`	Precondition Failed	—

GET/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/pipelinesList all pipelines triggered by a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`pipeline_schedule_id`	path	yes	integer
`scope`	query	no	string
`status`	query	no	string
`updated_before`	query	no	string
`updated_after`	query	no	string
`created_before`	query	no	string
`created_after`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	List all pipelines triggered by a pipeline schedule	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/playRun a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Run a pipeline schedule	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/take_ownershipCreate or update ownership of a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Create or update ownership of a pipeline schedule	`API_Entities_Ci_PipelineScheduleDetails`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variablesCreate a variable for a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariables (required)

Responses

Status	Description	Schema
`201`	Create a variable for a pipeline schedule	`API_Entities_Ci_Variable`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}Retrieve a variable for a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer
`key`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a variable for a pipeline schedule	`API_Entities_Ci_Variable`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}Update a variable for a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer
`key`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update a variable for a pipeline schedule	`API_Entities_Ci_Variable`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}Delete a variable for a pipeline schedule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`pipeline_schedule_id`	path	yes	integer
`key`	path	yes	string

Responses

Status	Description	Schema
`202`	Delete a variable for a pipeline schedule	`API_Entities_Ci_Variable`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

ci_triggers6

Operations about ci_triggers

POST/api/v4/projects/{id}/(ref/{ref}/)trigger/pipelineTrigger a pipeline with a token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref`	path	yes	string

Request body

application/json — postApiV4ProjectsId(refRef)triggerPipeline (required)

Responses

Status	Description	Schema
`201`	Trigger a pipeline with a token	`API_Entities_Ci_Pipeline`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/triggersList all project trigger tokens

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all project trigger tokens	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/triggersCreate a trigger token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdTriggers (required)

Responses

Status	Description	Schema
`201`	Create a trigger token	`API_Entities_Trigger`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/triggers/{trigger_id}Retrieve trigger token details

Parameters

Name	In	Required	Type
`id`	path	yes	string
`trigger_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve trigger token details	`API_Entities_Trigger`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/triggers/{trigger_id}Update a pipeline trigger token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`trigger_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdTriggersTriggerId (required)

Responses

Status	Description	Schema
`200`	Update a pipeline trigger token	`API_Entities_Trigger`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/triggers/{trigger_id}Delete a pipeline trigger token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`trigger_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a pipeline trigger token	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`412`	Precondition Failed	—

packages_cargo6

Operations about packages_cargos

GET/api/v4/projects/{id}/packages/cargo/1/{package_name}Get the sparse index for a Cargo crate (1-character name)

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Get the sparse index for a Cargo crate (1-character name)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/cargo/2/{package_name}Get the sparse index for a Cargo crate (2-character name)

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Get the sparse index for a Cargo crate (2-character name)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/cargo/3/{first_char}/{package_name}Get the sparse index for a Cargo crate (3-character name)

Parameters

Name	In	Required	Type
`id`	path	yes	string
`first_char`	path	yes	string
`package_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Get the sparse index for a Cargo crate (3-character name)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/cargo/config.jsonGet config.json

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Get config.json	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/packages/cargo/{package_name}/{package_version}/downloadDownload a Cargo crate

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a Cargo crate	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/cargo/{prefix_1}/{prefix_2}/{package_name}Get the sparse index for a Cargo crate (4+ character name)

Parameters

Name	In	Required	Type
`id`	path	yes	string
`prefix_1`	path	yes	string
`prefix_2`	path	yes	string
`package_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Get the sparse index for a Cargo crate (4+ character name)	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

commits12

Operations about commits

GET/api/v4/projects/{id}/repository/commitsList all repository commits

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref_name`	query	no	string
`since`	query	no	string
`until`	query	no	string
`path`	query	no	string
`follow`	query	no	boolean
`author`	query	no	string
`all`	query	no	boolean
`with_stats`	query	no	boolean
`first_parent`	query	no	boolean
`order`	query	no	string
`trailers`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`pagination`	query	no	string
`page_token`	query	no	string

Responses

Status	Description	Schema
`200`	List all repository commits	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/repository/commitsCreate a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryCommits (required)

Responses

Status	Description	Schema
`200`	Create a commit	`API_Entities_CommitDetail`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}Retrieve a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`stats`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a commit	`API_Entities_CommitDetail`
`404`	Not found	—

POST/api/v4/projects/{id}/repository/commits/{sha}/cherry_pickCherry-pick a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryCommitsShaCherryPick (required)

Responses

Status	Description	Schema
`200`	Cherry-pick a commit	`API_Entities_Commit`
`400`	Bad request	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/commentsList all commit comments

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`sha`	path	yes	string

Responses

Status	Description	Schema
`200`	List all commit comments	—
`404`	Not found	—

POST/api/v4/projects/{id}/repository/commits/{sha}/commentsCreate a comment on a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryCommitsShaComments (required)

Responses

Status	Description	Schema
`200`	Create a comment on a commit	`API_Entities_CommitNote`
`400`	Bad request	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/diffRetrieve a commit diff

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`unidiff`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a commit diff	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/merge_requestsList all merge requests associated with a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`state`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all merge requests associated with a commit	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/refsList all references a commit is pushed to

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`type`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all references a commit is pushed to	—
`404`	Not found	—

POST/api/v4/projects/{id}/repository/commits/{sha}/revertRevert a commit

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryCommitsShaRevert (required)

Responses

Status	Description	Schema
`200`	Revert a commit	`API_Entities_Commit`
`400`	Bad request	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/sequenceRetrieve a commit sequence

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`first_parent`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a commit sequence	`API_Entities_CommitSequence`
`404`	Not found	—

GET/api/v4/projects/{id}/repository/commits/{sha}/signatureRetrieve a commit signature

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a commit signature	`API_Entities_CommitSignature`
`404`	Not found	—

commit_statuses2

Operations about commit_statuses

GET/api/v4/projects/{id}/repository/commits/{sha}/statusesList all commit statuses

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string
`ref`	query	no	string
`stage`	query	no	string
`name`	query	no	string
`pipeline_id`	query	no	integer
`all`	query	no	boolean
`order_by`	query	no	string
`sort`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all commit statuses	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/statuses/{sha}Create or update a commit pipeline status

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Request body

application/json — postApiV4ProjectsIdStatusesSha (required)

Responses

Status	Description	Schema
`200`	Create or update a commit pipeline status	`API_Entities_CommitStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Another update to this commit status is in progress	—

packages_composer6

Operations about packages_composers

GET/api/v4/group/{id}/-/packages/composer/*package_nameComposer packages endpoint at group level for package versions metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Composer packages endpoint at group level for package versions metadata	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/group/{id}/-/packages/composer/p/{sha}List all packages for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Responses

Status	Description	Schema
`200`	List all packages for a group	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/group/{id}/-/packages/composer/p2/*package_nameComposer v2 packages p2 endpoint at group level for package versions metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Composer v2 packages p2 endpoint at group level for package versions metadata	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/group/{id}/-/packages/composer/packagesRetrieve repository URL templates

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve repository URL templates	—
`401`	Unauthorized	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/composerCreate a package

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPackagesComposer (required)

Responses

Status	Description	Schema
`201`	Create a package	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/composer/archives/*package_nameComposer package endpoint to download a package archive

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	query	yes	string
`package_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Composer package endpoint to download a package archive	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

packages_conan59

Operations about packages_conans

GET/api/v4/packages/conan/v1/conans/searchSearch for a Conan package

Parameters

Name	In	Required	Type
`q`	query	yes	string
`ignorecase`	query	no	boolean

Responses

Status	Description	Schema
`200`	Search for a Conan package	—
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}Retrieve a recipe snapshot

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe snapshot	`API_Entities_Packages_Conan_RecipeSnapshot`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}Delete a recipe and package

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a recipe and package	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/digestRetrieve a recipe manifest

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe manifest	`API_Entities_Packages_Conan_RecipeManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/download_urlsList all recipe download URLs

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe download URLs	`API_Entities_Packages_Conan_RecipeManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}

Retrieve a package snapshot

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package snapshot	`API_Entities_Packages_Conan_PackageSnapshot`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/digest

Retrieve a package manifest

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package manifest	`API_Entities_Packages_Conan_PackageManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/download_urls

List all package download URLs

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package download URLs	`API_Entities_Packages_Conan_PackageManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

POST

/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/upload_urls

List all package upload URLs

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package upload URLs	`API_Entities_Packages_Conan_UploadUrls`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/searchRetrieve package references metadata

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve package references metadata	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/upload_urlsList all recipe upload URLs

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe upload URLs	`API_Entities_Packages_Conan_UploadUrls`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}

Retrieve a recipe file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe file	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}

Upload a recipe file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4PackagesConanV1FilesPackageNamePackageVersionPackageUsernamePackageChannelRecipeRevisionExportFileName (required)

Responses

Status	Description	Schema
`200`	Upload a recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}/authorize

Workhorse authorize the Conan recipe file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}

Retrieve a package file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package file	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}

Upload a package file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4PackagesConanV1FilesPackageNamePackageVersionPackageUsernamePackageChannelRecipeRevisionPackageConanPackageReferencePackageRevisionFileName (required)

Responses

Status	Description	Schema
`200`	Upload a package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}/authorize

Workhorse authorize the Conan package file

Parameters

Name	In	Required	Type
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/pingVerify availability of a Conan repository

Responses

Status	Description	Schema
`200`	Verify availability of a Conan repository	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/users/authenticateRetrieve an authentication token

Responses

Status	Description	Schema
`200`	Retrieve an authentication token	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/packages/conan/v1/users/check_credentialsVerify authentication credentials

Responses

Status	Description	Schema
`200`	Verify authentication credentials	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v1/conans/searchSearch for a Conan package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`q`	query	yes	string
`ignorecase`	query	no	boolean

Responses

Status	Description	Schema
`200`	Search for a Conan package	—
`400`	Bad Request	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}Retrieve a recipe snapshot

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe snapshot	`API_Entities_Packages_Conan_RecipeSnapshot`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}Delete a recipe and package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a recipe and package	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/digest

Retrieve a recipe manifest

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe manifest	`API_Entities_Packages_Conan_RecipeManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/download_urls

List all recipe download URLs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe download URLs	`API_Entities_Packages_Conan_RecipeManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}

Retrieve a package snapshot

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package snapshot	`API_Entities_Packages_Conan_PackageSnapshot`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/digest

Retrieve a package manifest

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package manifest	`API_Entities_Packages_Conan_PackageManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/download_urls

List all package download URLs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package download URLs	`API_Entities_Packages_Conan_PackageManifest`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

POST

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/upload_urls

List all package upload URLs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package upload URLs	`API_Entities_Packages_Conan_UploadUrls`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/search

Retrieve package references metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve package references metadata	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST

/api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/upload_urls

List all recipe upload URLs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe upload URLs	`API_Entities_Packages_Conan_UploadUrls`
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}

Retrieve a recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe file	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}

Upload a recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesConanV1FilesPackageNamePackageVersionPackageUsernamePackageChannelRecipeRevisionExportFileName (required)

Responses

Status	Description	Schema
`200`	Upload a recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}/authorize

Workhorse authorize the Conan recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}

Retrieve a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package file	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}

Upload a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesConanV1FilesPackageNamePackageVersionPackageUsernamePackageChannelRecipeRevisionPackageConanPackageReferencePackageRevisionFileName (required)

Responses

Status	Description	Schema
`200`	Upload a package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}/authorize

Workhorse authorize the Conan package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v1/pingVerify availability of a Conan repository

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Verify availability of a Conan repository	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v1/users/authenticateRetrieve an authentication token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve an authentication token	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v1/users/check_credentialsVerify authentication credentials

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Verify authentication credentials	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v2/conans/searchSearch for a Conan package

Parameters

Name	In	Required	Type
`id`	path	yes	string
`q`	query	yes	string
`ignorecase`	query	no	boolean

Responses

Status	Description	Schema
`200`	Search for a Conan package	—
`400`	Bad Request	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/latest

Retrieve latest recipe revision

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve latest recipe revision	`API_Entities_Packages_Conan_Revision`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions

List all recipe revisions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe revisions	`API_Entities_Packages_Conan_RecipeRevisions`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}

Delete recipe revision

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete recipe revision	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files

List all recipe files

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string

Responses

Status	Description	Schema
`200`	List all recipe files	`API_Entities_Packages_Conan_FilesList`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name}

Retrieve a recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name}

Upload a recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesConanV2ConansPackageNamePackageVersionPackageUsernamePackageChannelRevisionsRecipeRevisionFilesFileName (required)

Responses

Status	Description	Schema
`200`	Upload a recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name}/authorize

Workhorse authorize the Conan recipe file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan recipe file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/latest

Retrieve latest package revision

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve latest package revision	`API_Entities_Packages_Conan_Revision`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions

List all package revisions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package revisions	`API_Entities_Packages_Conan_PackageRevisions`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

DELETE

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}

Delete a package revision

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a package revision	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files

List all package files

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package files	`API_Entities_Packages_Conan_FilesList`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name}

Retrieve a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name}

Upload a package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesConanV2ConansPackageNamePackageVersionPackageUsernamePackageChannelRevisionsRecipeRevisionPackagesConanPackageReferenceRevisionsPackageRevisionFilesFileName (required)

Responses

Status	Description	Schema
`200`	Upload a package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name}/authorize

Workhorse authorize the Conan package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string
`conan_package_reference`	path	yes	string
`package_revision`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the Conan package file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/search

Retrieve package references metadata by recipe revision

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string
`recipe_revision`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve package references metadata by recipe revision	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET

/api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/search

Retrieve package references metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_name`	path	yes	string
`package_version`	path	yes	string
`package_username`	path	yes	string
`package_channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve package references metadata	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v2/users/authenticateRetrieve an authentication token

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve an authentication token	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/conan/v2/users/check_credentialsVerify authentication credentials

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Verify authentication credentials	—
`401`	Unauthorized	—
`404`	Not Found	—

draft_notes7

Operations about draft_notes

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notesList all merge request draft notes

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all merge request draft notes	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notesCreate a draft note

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotes (required)

Responses

Status	Description	Schema
`201`	Create a draft note	`API_Entities_DraftNote`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/bulk_publishPublish all pending draft notes

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesBulkPublish (required)

Responses

Status	Description	Schema
`204`	Publish all pending draft notes	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}Retrieve a draft note

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`draft_note_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a draft note	`API_Entities_DraftNote`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}Update a draft note

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`draft_note_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId (required)

Responses

Status	Description	Schema
`200`	Update a draft note	`API_Entities_DraftNote`
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}Delete a draft note

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`draft_note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}/publishPublish a draft note

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`draft_note_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Publish a draft note	—
`401`	Unauthorized	—
`404`	Not found	—

error_tracking6

Operations about error_trackings

GET/api/v4/projects/{id}/error_tracking/client_keysList all project client keys

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all project client keys	—

POST/api/v4/projects/{id}/error_tracking/client_keysCreate a client key

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Create a client key	`API_Entities_ErrorTracking_ClientKey`

DELETE/api/v4/projects/{id}/error_tracking/client_keys/{key_id}Delete a client key

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/error_tracking/settingsRetrieve Error Tracking settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve Error Tracking settings for a project	`API_Entities_ErrorTracking_ProjectSetting`

PUT/api/v4/projects/{id}/error_tracking/settingsCreate Error Tracking settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdErrorTrackingSettings (required)

Responses

Status	Description	Schema
`200`	Create Error Tracking settings for a project	`API_Entities_ErrorTracking_ProjectSetting`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

PATCH/api/v4/projects/{id}/error_tracking/settingsUpdate Error Tracking settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — patchApiV4ProjectsIdErrorTrackingSettings (required)

Responses

Status	Description	Schema
`200`	Update Error Tracking settings for a project	`API_Entities_ErrorTracking_ProjectSetting`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

files8

Operations about files

GET/api/v4/projects/{id}/repository/files/{file_path}Retrieve a file from a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`ref`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a file from a repository	—

POST/api/v4/projects/{id}/repository/files/{file_path}Create a file in a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryFilesFilePath (required)

Responses

Status	Description	Schema
`201`	Create a file in a repository	—

PUT/api/v4/projects/{id}/repository/files/{file_path}Update a file in a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string

Request body

application/json — putApiV4ProjectsIdRepositoryFilesFilePath (required)

Responses

Status	Description	Schema
`200`	Update a file in a repository	—

DELETE/api/v4/projects/{id}/repository/files/{file_path}Delete a file in a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`branch`	query	yes	string
`commit_message`	query	yes	string
`start_branch`	query	no	string
`author_email`	query	no	string
`author_name`	query	no	string
`last_commit_id`	query	no	string

Responses

Status	Description	Schema
`204`	Delete a file in a repository	—

HEAD/api/v4/projects/{id}/repository/files/{file_path}Retrieve file metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`ref`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve file metadata	—

GET/api/v4/projects/{id}/repository/files/{file_path}/blameRetrieve file blame history from a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`ref`	query	yes	string
`range[start]`	query	yes	integer
`range[end]`	query	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve file blame history from a repository	`API_Entities_BlameRange`

HEAD/api/v4/projects/{id}/repository/files/{file_path}/blameRetrieve file blame metadata

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`ref`	query	yes	string

Responses

Status	Description	Schema
`200`	Retrieve file blame metadata	—

GET/api/v4/projects/{id}/repository/files/{file_path}/rawRetrieve a raw file from a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_path`	path	yes	string
`ref`	query	no	string
`lfs`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a raw file from a repository	—

packages_helm4

Operations about packages_helms

POST/api/v4/projects/{id}/packages/helm/api/{channel}/chartsUpload a chart

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`channel`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPackagesHelmApiChannelCharts (required)

Responses

Status	Description	Schema
`201`	Upload a chart	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/helm/api/{channel}/charts/authorizeAuthorize a chart upload from workhorse

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Authorize a chart upload from workhorse	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/helm/{channel}/charts/{file_name}.tgzDownload a chart

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`channel`	path	yes	string
`file_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a chart	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/helm/{channel}/index.yamlDownload a chart index

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`channel`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a chart index	—
`401`	Unauthorized	—
`403`	Forbidden	—

issues15

Operations about issues

GET/api/v4/issuesList all issues for the currently authenticated user

Parameters

Name	In	Required	Type
`with_labels_details`	query	no	boolean
`state`	query	no	string
`closed_by_id`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`due_date`	query	no	string
`issue_type`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`non_archived`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all issues for the currently authenticated user	`API_Entities_Issue`

GET/api/v4/issues/{id}Retrieve an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve an issue	`API_Entities_Issue`

GET/api/v4/issues_statisticsRetrieve issues statistics for the currently authenticated user

Parameters

Name	In	Required	Type
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve issues statistics for the currently authenticated user	—

POST/api/v4/projects/{id}/issues/{issue_iid}/add_spent_timeAdd spent time for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidAddSpentTime (required)

Responses

Status	Description	Schema
`201`	Add spent time for an issue	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/linksList all issue links

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all issue links	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/issues/{issue_iid}/linksCreate an issue link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidLinks (required)

Responses

Status	Description	Schema
`201`	Create an issue link	`API_Entities_IssueLink`
`400`	Bad Request	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/issues/{issue_iid}/links/{issue_link_id}Retrieve an issue link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer
`issue_link_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve an issue link	`API_Entities_IssueLink`
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/issues/{issue_iid}/links/{issue_link_id}Delete an issue link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer
`issue_link_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete an issue link	`API_Entities_IssueLink`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/participantsList all participants in an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all participants in an issue	`API_Entities_UserBasic`

GET/api/v4/projects/{id}/issues/{issue_iid}/related_merge_requestsList all merge requests related to an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all merge requests related to an issue	`API_Entities_MergeRequestBasic`

POST/api/v4/projects/{id}/issues/{issue_iid}/reset_spent_timeReset spent time for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Reset spent time for an issue	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/issues/{issue_iid}/reset_time_estimateReset the estimated time for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Reset the estimated time for an issue	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/issues/{issue_iid}/time_estimateSet the estimated time for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidTimeEstimate (required)

Responses

Status	Description	Schema
`201`	Set the estimated time for an issue	`API_Entities_IssuableTimeStats`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/time_statsRetrieve time tracking stats for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve time tracking stats for an issue	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/issues/{issue_iid}/user_agent_detailRetrieve user agent details for an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve user agent details for an issue	`API_Entities_UserAgentDetail`

metric_images5

Operations about metric_images

GET/api/v4/projects/{id}/issues/{issue_iid}/metric_imagesList all metric images for an incident

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all metric images for an incident	`API_Entities_IssuableMetricImage`

POST/api/v4/projects/{id}/issues/{issue_iid}/metric_imagesUpload a metric image for an incident

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidMetricImages (required)

Responses

Status	Description	Schema
`201`	Upload a metric image for an incident	`API_Entities_IssuableMetricImage`

POST/api/v4/projects/{id}/issues/{issue_iid}/metric_images/authorize

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Upload a metric image for an incident	—

PUT/api/v4/projects/{id}/issues/{issue_iid}/metric_images/{metric_image_id}Update a metric image for an incident

Parameters

Name	In	Required	Type
`id`	path	yes	string
`metric_image_id`	path	yes	integer
`issue_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIssuesIssueIidMetricImagesMetricImageId (required)

Responses

Status	Description	Schema
`200`	Update a metric image for an incident	`API_Entities_IssuableMetricImage`

DELETE/api/v4/projects/{id}/issues/{issue_iid}/metric_images/{metric_image_id}Delete a metric image from an incident

Parameters

Name	In	Required	Type
`id`	path	yes	string
`metric_image_id`	path	yes	integer
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Delete a metric image from an incident	`API_Entities_IssuableMetricImage`

merge_request_approvals6

Operations about merge_request_approvals

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_stateRetrieve approval details for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve approval details for a merge request	`API_Entities_MergeRequestApprovalState`

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/approvalsRetrieve approval state for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve approval state for a merge request	`API_Entities_MergeRequestApprovals`
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/approvalsChange approval-related configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidApprovals (required)

Responses

Status	Description	Schema
`201`	Change approval-related configuration	`API_Entities_ApprovalState`

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/approveApprove merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidApprove (required)

Responses

Status	Description	Schema
`201`	Approve merge request	`API_Entities_MergeRequestApprovals`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_approvalsReset approvals for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Reset approvals for a merge request	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/unapproveUnapprove a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Unapprove a merge request	`API_Entities_MergeRequestApprovals`
`401`	Unauthorized	—
`404`	Not found	—

gitlab_pages10

Operations about gitlab_pages

GET/api/v4/pages/domainsList all Pages domains

Parameters

Name	In	Required	Type
`domain`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all Pages domains	`API_Entities_PagesDomainBasic`

GET/api/v4/projects/{id}/pagesRetrieve Pages settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve Pages settings for a project	—
`401`	Unauthorized	—
`404`	Not Found	—

PATCH/api/v4/projects/{id}/pagesUpdate Pages settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — patchApiV4ProjectsIdPages (required)

Responses

Status	Description	Schema
`200`	Update Pages settings for a project	—
`401`	Unauthorized	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/pagesUnpublish Pages

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Unpublish Pages	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/pages/domainsList all Pages domains in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all Pages domains in a project	—

POST/api/v4/projects/{id}/pages/domainsCreate Pages domain

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPagesDomains (required)

Responses

Status	Description	Schema
`201`	Create Pages domain	`API_Entities_PagesDomain`

GET/api/v4/projects/{id}/pages/domains/{domain}Retrieve a Pages domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`domain`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a Pages domain	`API_Entities_PagesDomain`

PUT/api/v4/projects/{id}/pages/domains/{domain}Update Pages domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`domain`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPagesDomainsDomain (required)

Responses

Status	Description	Schema
`200`	Update Pages domain	—

DELETE/api/v4/projects/{id}/pages/domains/{domain}Delete Pages domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`domain`	path	yes	string

Responses

Status	Description	Schema
`204`	Resource deleted	—

PUT/api/v4/projects/{id}/pages/domains/{domain}/verifyVerify Pages domain

Parameters

Name	In	Required	Type
`id`	path	yes	string
`domain`	path	yes	string

Responses

Status	Description	Schema
`200`	Verify Pages domain	`API_Entities_PagesDomain`

events3

Operations about events

GET/api/v4/eventsList all events

Parameters

Name	In	Required	Type
`scope`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`action`	query	no	string
`target_type`	query	no	string
`before`	query	no	string
`after`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	List all events	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/eventsList all visible events for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`action`	query	no	string
`target_type`	query	no	string
`before`	query	no	string
`after`	query	no	string
`sort`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all visible events for a project	`API_Entities_Event`

GET/api/v4/users/{id}/eventsRetrieve contribution events for a user

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`action`	query	no	string
`target_type`	query	no	string
`before`	query	no	string
`after`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve contribution events for a user	—
`404`	Not found	—

hooks22

Operations about hooks

GET/api/v4/hooksList all system hooks

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all system hooks	—

POST/api/v4/hooksCreate a system hook

Request body

application/json — postApiV4Hooks (required)

Responses

Status	Description	Schema
`201`	Create a system hook	`API_Entities_Hook`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/hooks/{hook_id}Retrieve a system hook

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a system hook	`API_Entities_Hook`
`404`	Not found	—

POST/api/v4/hooks/{hook_id}Create a test run

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Create a test run	—

PUT/api/v4/hooks/{hook_id}Update a system hook

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer

Request body

application/json — putApiV4HooksHookId (required)

Responses

Status	Description	Schema
`200`	Update a system hook	`API_Entities_Hook`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/hooks/{hook_id}Delete a system hook

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a system hook	`API_Entities_Hook`
`404`	Not found	—

PUT/api/v4/hooks/{hook_id}/custom_headers/{key}Update a custom header

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string

Request body

application/json — putApiV4HooksHookIdCustomHeadersKey (required)

Responses

Status	Description	Schema
`200`	Update a custom header	—

DELETE/api/v4/hooks/{hook_id}/custom_headers/{key}Delete a custom header

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a custom header	—

PUT/api/v4/hooks/{hook_id}/url_variables/{key}Update a URL variable

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string

Request body

application/json — putApiV4HooksHookIdUrlVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update a URL variable	—

DELETE/api/v4/hooks/{hook_id}/url_variables/{key}Delete a URL variable

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a URL variable	—

GET/api/v4/projects/{id}/hooksList all webhooks for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all webhooks for a project	—

POST/api/v4/projects/{id}/hooksAdd a webhook to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdHooks (required)

Responses

Status	Description	Schema
`201`	Add a webhook to a project	`API_Entities_ProjectHook`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/hooks/{hook_id}Retrieve a project webhook

Parameters

Name	In	Required	Type
`id`	path	yes	string
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project webhook	`API_Entities_ProjectHook`
`404`	Not found	—

PUT/api/v4/projects/{id}/hooks/{hook_id}Update a project webhook

Parameters

Name	In	Required	Type
`id`	path	yes	string
`hook_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdHooksHookId (required)

Responses

Status	Description	Schema
`200`	Update a project webhook	`API_Entities_ProjectHook`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/hooks/{hook_id}Delete a project webhook

Parameters

Name	In	Required	Type
`id`	path	yes	string
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Not found	—

PUT/api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key}Update a custom header

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdHooksHookIdCustomHeadersKey (required)

Responses

Status	Description	Schema
`200`	Update a custom header	—

DELETE/api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key}Delete a custom header

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a custom header	—

GET/api/v4/projects/{id}/hooks/{hook_id}/eventsList all events

Parameters

Name	In	Required	Type
`status`	query	no	array
`per_page`	query	no	integer
`page`	query	no	integer
`id`	path	yes	integer
`hook_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all events	—
`400`	Bad request	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/hooks/{hook_id}/events/{hook_log_id}/resendResend a webhook event

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`hook_log_id`	path	yes	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Resend a webhook event	—
`404`	Not found	—
`422`	Unprocessable entity	—
`429`	Too many requests	—

POST/api/v4/projects/{id}/hooks/{hook_id}/test/{trigger}Trigger a test webhook

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`trigger`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Trigger a test webhook	—
`400`	Bad request	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—
`429`	Too many requests	—

PUT/api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key}Update a URL variable

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdHooksHookIdUrlVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update a URL variable	—

DELETE/api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key}Delete a URL variable

Parameters

Name	In	Required	Type
`hook_id`	path	yes	integer
`key`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a URL variable	—

projects_job_token_scope8

Operations about projects_job_token_scopes

GET/api/v4/projects/{id}/job_token_scopeRetrieve the CI/CD job token access settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the CI/CD job token access settings for a project	`API_Entities_ProjectJobTokenScope`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PATCH/api/v4/projects/{id}/job_token_scopeUpdate the CI/CD job token access settings for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — patchApiV4ProjectsIdJobTokenScope (required)

Responses

Status	Description	Schema
`204`	Update the CI/CD job token access settings for a project	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/job_token_scope/allowlistList all projects in a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all projects in a CI/CD job token allowlist	`API_Entities_BasicProjectDetails`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/job_token_scope/allowlistAdd a project to a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdJobTokenScopeAllowlist (required)

Responses

Status	Description	Schema
`201`	Add a project to a CI/CD job token allowlist	`API_Entities_BasicProjectDetails`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/job_token_scope/allowlist/{target_project_id}Delete a project from a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`target_project_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a project from a CI/CD job token allowlist	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/job_token_scope/groups_allowlistList all groups in a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all groups in a CI/CD job token allowlist	`API_Entities_BasicProjectDetails`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/job_token_scope/groups_allowlistAdd a group to a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdJobTokenScopeGroupsAllowlist (required)

Responses

Status	Description	Schema
`201`	Add a group to a CI/CD job token allowlist	`API_Entities_BasicGroupDetails`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/job_token_scope/groups_allowlist/{target_group_id}Delete a group from a CI/CD job token allowlist

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`target_group_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a group from a CI/CD job token allowlist	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

project_snapshots1

Operations about project_snapshots

GET/api/v4/projects/{id}/snapshotDownload snapshot of a Git repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`wiki`	query	no	boolean

Responses

Status	Description	Schema
`200`	Download snapshot of a Git repository	—
`401`	Unauthorized	—

snippets18

Operations about snippets

GET/api/v4/projects/{id}/snippetsList all snippets for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all snippets for a project	—
`404`	Not found	—

POST/api/v4/projects/{id}/snippetsCreate a project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdSnippets (required)

Responses

Status	Description	Schema
`201`	Create a project snippet	`API_Entities_ProjectSnippet`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/snippets/{snippet_id}Retrieve a project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project snippet	`API_Entities_ProjectSnippet`
`404`	Not found	—

PUT/api/v4/projects/{id}/snippets/{snippet_id}Update a project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdSnippetsSnippetId (required)

Responses

Status	Description	Schema
`200`	Update a project snippet	`API_Entities_ProjectSnippet`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/snippets/{snippet_id}Delete a project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a project snippet	—
`400`	Validation error	—
`404`	Not found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/files/{ref}/{file_path}/rawRetrieve snippet repository file content

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref`	path	yes	string
`file_path`	path	yes	string
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve snippet repository file content	`API_Entities_ProjectSnippet`
`404`	Not found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/rawRetrieve a raw project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a raw project snippet	`API_Entities_ProjectSnippet`
`404`	Not found	—

GET/api/v4/projects/{id}/snippets/{snippet_id}/user_agent_detailRetrieve user agent details for a project snippet

Parameters

Name	In	Required	Type
`id`	path	yes	string
`snippet_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve user agent details for a project snippet	`API_Entities_UserAgentDetail`
`404`	Not found	—

GET/api/v4/snippetsList all snippets for current user

Parameters

Name	In	Required	Type
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all snippets for current user	—
`404`	Not found	—

POST/api/v4/snippetsCreate a snippet

Request body

application/json — postApiV4Snippets (required)

Responses

Status	Description	Schema
`201`	Create a snippet	`API_Entities_PersonalSnippet`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/snippets/allList all snippets

Parameters

Name	In	Required	Type
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`repository_storage`	query	no	string

Responses

Status	Description	Schema
`200`	List all snippets	—
`404`	Not found	—

GET/api/v4/snippets/publicList all public snippets

Parameters

Name	In	Required	Type
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all public snippets	—
`404`	Not found	—

GET/api/v4/snippets/{id}Retrieve a snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a snippet	`API_Entities_PersonalSnippet`
`404`	Not found	—

PUT/api/v4/snippets/{id}Update snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4SnippetsId (required)

Responses

Status	Description	Schema
`200`	Update snippet	`API_Entities_PersonalSnippet`
`400`	Validation error	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/snippets/{id}Delete snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete snippet	`API_Entities_PersonalSnippet`
`400`	Validation error	—
`404`	Not found	—

GET/api/v4/snippets/{id}/files/{ref}/{file_path}/rawRetrieve snippet file content

Parameters

Name	In	Required	Type
`ref`	path	yes	string
`file_path`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve snippet file content	—
`404`	Not found	—

GET/api/v4/snippets/{id}/rawRetrieve a raw snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a raw snippet	—
`404`	Not found	—

GET/api/v4/snippets/{id}/user_agent_detailRetrieve user agent details for a snippet

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve user agent details for a snippet	`API_Entities_UserAgentDetail`
`404`	Not found	—

project_templates2

Operations about project_templates

GET/api/v4/projects/{id}/templates/{type}List all templates of a particular type

Parameters

Name	In	Required	Type
`id`	path	yes	string
`type`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all templates of a particular type	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/templates/{type}/{name}Retrieve a template of a particular type

Parameters

Name	In	Required	Type
`id`	path	yes	string
`type`	path	yes	string
`name`	path	yes	string
`source_template_project_id`	query	no	integer
`project`	query	no	string
`fullname`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve a template of a particular type	`API_Entities_License`
`401`	Unauthorized	—
`404`	Not found	—

protected_branches5

Operations about protected_branches

GET/api/v4/projects/{id}/protected_branchesList all protected branches

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`search`	query	no	string

Responses

Status	Description	Schema
`200`	List all protected branches	—
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

POST/api/v4/projects/{id}/protected_branchesProtect repository branches

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdProtectedBranches (required)

Responses

Status	Description	Schema
`201`	Protect repository branches	`API_Entities_ProtectedBranch`
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—
`409`	Protected branch 'main' already exists	—
`422`	name is missing	—

GET/api/v4/projects/{id}/protected_branches/{name}Retrieve a protected branch or wildcard protected branch

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a protected branch or wildcard protected branch	`API_Entities_ProtectedBranch`
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

PATCH/api/v4/projects/{id}/protected_branches/{name}Update a protected branch

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Request body

application/json — patchApiV4ProjectsIdProtectedBranchesName (required)

Responses

Status	Description	Schema
`200`	Update a protected branch	`API_Entities_ProtectedBranch`
`400`	400 Bad request	—
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—
`422`	Push access levels access level has already been taken	—

DELETE/api/v4/projects/{id}/protected_branches/{name}Unprotect repository branches

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`204`	Unprotect repository branches	—
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

protected_tags4

Operations about protected_tags

GET/api/v4/projects/{id}/protected_tagsList all protected tags

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all protected tags	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/{id}/protected_tagsProtect a repository tag

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdProtectedTags (required)

Responses

Status	Description	Schema
`201`	Protect a repository tag	`API_Entities_ProtectedTag`
`403`	Unauthenticated	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/protected_tags/{name}Retrieve a protected tag or wildcard protected tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a protected tag or wildcard protected tag	`API_Entities_ProtectedTag`
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/protected_tags/{name}Unprotect repository tags

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`204`	Unprotect repository tags	—
`403`	Unauthenticated	—
`404`	Not found	—
`412`	Precondition Failed	—

remote_mirrors7

Operations about remote_mirrors

GET/api/v4/projects/{id}/remote_mirrorsList all remote mirrors for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all remote mirrors for a project	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/remote_mirrorsCreate a push mirror

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRemoteMirrors (required)

Responses

Status	Description	Schema
`201`	Create a push mirror	`API_Entities_RemoteMirror`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/remote_mirrors/{mirror_id}Retrieve a remote mirror for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`mirror_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a remote mirror for a project	`API_Entities_RemoteMirror`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/remote_mirrors/{mirror_id}Update a remote mirror in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`mirror_id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdRemoteMirrorsMirrorId (required)

Responses

Status	Description	Schema
`200`	Update a remote mirror in a project	`API_Entities_RemoteMirror`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/remote_mirrors/{mirror_id}Delete a remote mirror from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`mirror_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a remote mirror from a project	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/remote_mirrors/{mirror_id}/public_keyRetrieve a public key for a remote mirror

Parameters

Name	In	Required	Type
`id`	path	yes	string
`mirror_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a public key for a remote mirror	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/remote_mirrors/{mirror_id}/syncForce push mirror update

Parameters

Name	In	Required	Type
`id`	path	yes	string
`mirror_id`	path	yes	string

Responses

Status	Description	Schema
`204`	Force push mirror update	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

repositories10

Operations about repositories

GET/api/v4/projects/{id}/repository/archiveRetrieve file archive from a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	query	no	string
`ref_type`	query	no	string
`format`	query	no	string
`path`	query	no	string
`include_lfs_blobs`	query	no	boolean
`exclude_paths`	query	no	array

Responses

Status	Description	Schema
`200`	Retrieve file archive from a repository	—

GET/api/v4/projects/{id}/repository/blobs/{sha}Retrieve a blob from a repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a blob from a repository	—

GET/api/v4/projects/{id}/repository/blobs/{sha}/rawRetrieve raw blob content

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve raw blob content	—

GET/api/v4/projects/{id}/repository/changelogGenerate changelog data

Parameters

Name	In	Required	Type
`id`	path	yes	string
`version`	query	yes	string
`from`	query	no	string
`to`	query	no	string
`date`	query	no	string
`trailer`	query	no	string
`config_file`	query	no	string
`config_file_ref`	query	no	string

Responses

Status	Description	Schema
`200`	Generate changelog data	`API_Entities_Changelog`

POST/api/v4/projects/{id}/repository/changelogAdd changelog data to file

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryChangelog (required)

Responses

Status	Description	Schema
`200`	Add changelog data to file	—

GET/api/v4/projects/{id}/repository/compareCompare branches, tags, or commits

Parameters

Name	In	Required	Type
`id`	path	yes	string
`from`	query	yes	string
`to`	query	yes	string
`from_project_id`	query	no	integer
`straight`	query	no	boolean
`unidiff`	query	no	boolean

Responses

Status	Description	Schema
`200`	Compare branches, tags, or commits	`API_Entities_Compare`

GET/api/v4/projects/{id}/repository/contributorsRetrieve contributors metrics

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`ref`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve contributors metrics	`API_Entities_Contributor`

GET/api/v4/projects/{id}/repository/healthRetrieve repository health statistics

Parameters

Name	In	Required	Type
`id`	path	yes	string
`generate`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve repository health statistics	`API_Entities_RepositoryHealth`

GET/api/v4/projects/{id}/repository/merge_baseRetrieve a merge base

Parameters

Name	In	Required	Type
`id`	path	yes	string
`refs`	query	yes	array

Responses

Status	Description	Schema
`200`	Retrieve a merge base	`API_Entities_Commit`

GET/api/v4/projects/{id}/repository/treeList all repository trees in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`ref`	query	no	string
`path`	query	no	string
`recursive`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`pagination`	query	no	string
`page_token`	query	no	string

Responses

Status	Description	Schema
`200`	List all repository trees in a project	`API_Entities_TreeObject`

resource_events4

Operations about resource_events

GET/api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_eventsList all project issue milestone events

Parameters

Name	In	Required	Type
`id`	path	yes	string
`eventable_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all project issue milestone events	—

GET/api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_events/{event_id}Retrieve an issue milestone event

Parameters

Name	In	Required	Type
`id`	path	yes	string
`event_id`	path	yes	string
`eventable_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an issue milestone event	`API_Entities_ResourceMilestoneEvent`
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_eventsList all project merge request milestone events

Parameters

Name	In	Required	Type
`id`	path	yes	string
`eventable_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all project merge request milestone events	—

GET/api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_events/{event_id}Retrieve a merge request milestone event

Parameters

Name	In	Required	Type
`id`	path	yes	string
`event_id`	path	yes	string
`eventable_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a merge request milestone event	`API_Entities_ResourceMilestoneEvent`
`404`	Not found	—

packages_rpm4

Operations about packages_rpms

POST/api/v4/projects/{id}/packages/rpmUpload a RPM package

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Upload a RPM package	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/rpm/*package_file_id/*file_nameDownload RPM package files

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_file_id`	query	yes	integer
`file_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Download RPM package files	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/rpm/authorizeAuthorize package upload from workhorse

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Authorize package upload from workhorse	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/rpm/repodata/*file_nameDownload repository metadata files

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	query	yes	string

Responses

Status	Description	Schema
`200`	Download repository metadata files	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

packages_rubygem6

Operations about packages_rubygems

GET/api/v4/projects/{id}/packages/rubygems/api/v1/dependenciesRetrieve dependencies

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`gems`	query	no	array

Responses

Status	Description	Schema
`200`	Retrieve dependencies	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/rubygems/api/v1/gemsUpload a gem

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdPackagesRubygemsApiV1Gems (required)

Responses

Status	Description	Schema
`201`	Upload a gem	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/rubygems/api/v1/gems/authorizeAuthorize a gem upload from workhorse

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Authorize a gem upload from workhorse	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/packages/rubygems/gems/{file_name}Download a gem file

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`file_name`	path	yes	file

Responses

Status	Description	Schema
`200`	Download a gem file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/rubygems/quick/Marshal.4.8/{file_name}Download a gemspec file

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`file_name`	path	yes	file

Responses

Status	Description	Schema
`200`	Download a gemspec file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/packages/rubygems/{file_name}Download the spec index file

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`file_name`	path	yes	file

Responses

Status	Description	Schema
`200`	Download the spec index file	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

submodules1

Operations about submodules

PUT/api/v4/projects/{id}/repository/submodules/{submodule}Update a submodule reference

Parameters

Name	In	Required	Type
`id`	path	yes	string
`submodule`	path	yes	string

Request body

application/json — putApiV4ProjectsIdRepositorySubmodulesSubmodule (required)

Responses

Status	Description	Schema
`200`	Update a submodule reference	`API_Entities_CommitDetail`
`400`	The repository is empty	—
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

attestations2

Operations about attestations

GET/api/v4/projects/{id}/attestations/{attestation_iid}/downloadRetrieve an attestation bundle

Parameters

Name	In	Required	Type
`id`	path	yes	string
`attestation_iid`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve an attestation bundle	—
`404`	Artifact SHA-256 not found	—

GET/api/v4/projects/{id}/attestations/{subject_digest}List all attestations for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`subject_digest`	path	yes	string

Responses

Status	Description	Schema
`200`	List all attestations for a project	`API_Entities_SupplyChain_Attestation`
`404`	Artifact SHA-256 not found	—

tags5

Operations about tags

GET/api/v4/projects/{id}/repository/tagsList all project repository tags

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sort`	query	no	string
`order_by`	query	no	string
`search`	query	no	string
`page_token`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all project repository tags	—
`403`	Unauthenticated	—
`404`	Not found	—
`422`	Unprocessable entity	—
`503`	Service unavailable	—

POST/api/v4/projects/{id}/repository/tagsCreate a tag

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRepositoryTags (required)

Responses

Status	Description	Schema
`201`	Create a tag	`API_Entities_Tag`
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/repository/tags/{tag_name}Retrieve a single repository tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a single repository tag	`API_Entities_Tag`
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/repository/tags/{tag_name}Delete a tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a tag	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—
`412`	Precondition failed	—

GET/api/v4/projects/{id}/repository/tags/{tag_name}/signatureRetrieve X.509 signature of a tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve X.509 signature of a tag	`API_Entities_TagSignature`
`404`	Not found	—

terraform18

Operations about terraforms

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}Retrieve latest version for a module

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve latest version for a module	`API_Entities_Terraform_ModuleVersion`
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/*module_versionGet details about specific version of a module

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string
`module_version`	query	yes	string

Responses

Status	Description	Schema
`200`	Get details about specific version of a module	`API_Entities_Terraform_ModuleVersion`
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/*module_version/downloadGet download location for specific version of a module

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string
`module_version`	query	yes	string

Responses

Status	Description	Schema
`204`	Get download location for specific version of a module	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/*module_version/fileDownload specific version of a module

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string
`module_version`	query	yes	string

Responses

Status	Description	Schema
`200`	Download specific version of a module	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/downloadRetrieve download URL for latest module version

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string

Responses

Status	Description	Schema
`302`	Retrieve download URL for latest module version	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/versionsList all available versions for a module

Parameters

Name	In	Required	Type
`module_namespace`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string

Responses

Status	Description	Schema
`200`	List all available versions for a module	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}Download the latest version of a module

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string
`terraform-get`	query	no	string

Responses

Status	Description	Schema
`204`	Download the latest version of a module	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/*module_versionDownload a specific version of a module

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string
`module_version`	query	yes	string
`terraform-get`	query	no	string

Responses

Status	Description	Schema
`204`	Download a specific version of a module	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/*module_version/fileUpload Terraform Module package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string

Responses

Status	Description	Schema
`201`	Upload Terraform Module package file	—
`400`	Invalid file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/*module_version/file/authorizeWorkhorse authorize Terraform Module package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`module_name`	path	yes	string
`module_system`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystem*moduleVersionFileAuthorize (required)

Responses

Status	Description	Schema
`200`	Workhorse authorize Terraform Module package file	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/terraform/state/{name}Get a Terraform state by its name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string
`ID`	query	no	string

Responses

Status	Description	Schema
`200`	Get a Terraform state by its name	—
`204`	Empty state	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Validation failure	—

POST/api/v4/projects/{id}/terraform/state/{name}Add a new Terraform state or update an existing one

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Request body

application/json — postApiV4ProjectsIdTerraformStateName (required)

Responses

Status	Description	Schema
`200`	Add a new Terraform state or update an existing one	—
`204`	No data provided	—
`403`	Forbidden	—
`413`	Request Entity Too Large	—
`422`	Validation failure	—

DELETE/api/v4/projects/{id}/terraform/state/{name}Delete a Terraform state of a certain name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a Terraform state of a certain name	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Validation failure	—

POST/api/v4/projects/{id}/terraform/state/{name}/authorizeAuthorize Terraform state upload

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Responses

Status	Description	Schema
`200`	Authorize Terraform state upload	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/terraform/state/{name}/lockLock a Terraform state of a certain name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string

Request body

application/json — postApiV4ProjectsIdTerraformStateNameLock (required)

Responses

Status	Description	Schema
`200`	Lock a Terraform state of a certain name	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Validation failure	—

DELETE/api/v4/projects/{id}/terraform/state/{name}/lockUnlock a Terraform state of a certain name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string
`ID`	query	no	string

Responses

Status	Description	Schema
`204`	Unlock a Terraform state of a certain name	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Validation failure	—

GET/api/v4/projects/{id}/terraform/state/{name}/versions/{serial}Get a Terraform state version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string
`serial`	path	yes	integer

Responses

Status	Description	Schema
`200`	Get a Terraform state version	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/terraform/state/{name}/versions/{serial}Delete a Terraform state version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`name`	path	yes	string
`serial`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a Terraform state version	—
`403`	Forbidden	—
`404`	Not found	—

batched_background_migrations4

Operations about batched_background_migrations

GET/api/v4/admin/batched_background_migrations

Parameters

Name	In	Required	Type
`database`	query	no	string
`job_class_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get the list of batched background migrations	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—

GET/api/v4/admin/batched_background_migrations/{id}

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`database`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve a batched background migration	`API_Entities_BatchedBackgroundMigration`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—

PUT/api/v4/admin/batched_background_migrations/{id}/pause

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4AdminBatchedBackgroundMigrationsIdPause (required)

Responses

Status	Description	Schema
`200`	Pause a batched background migration	`API_Entities_BatchedBackgroundMigration`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—
`422`	You can pause only `active` batched background migrations.	—

PUT/api/v4/admin/batched_background_migrations/{id}/resume

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4AdminBatchedBackgroundMigrationsIdResume (required)

Responses

Status	Description	Schema
`200`	Resume a batched background migration	`API_Entities_BatchedBackgroundMigration`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—
`422`	You can resume only `paused` batched background migrations.	—

batched_background_operations4

Operations about batched_background_operations

GET/api/v4/admin/batched_background_operationsGet the list of batched background operations

Parameters

Name	In	Required	Type
`database`	query	no	string
`job_class_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get the list of batched background operations	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—

GET/api/v4/admin/batched_background_operations/{id}Retrieve a batched background operation

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`database`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve a batched background operation	`API_Entities_BatchedBackgroundOperation`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—

PUT/api/v4/admin/batched_background_operations/{id}/restartRestart a batched background operation

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4AdminBatchedBackgroundOperationsIdRestart (required)

Responses

Status	Description	Schema
`200`	Restart a batched background operation	`API_Entities_BatchedBackgroundOperation`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—
`422`	You can restart only `stopped` operations.	—

PUT/api/v4/admin/batched_background_operations/{id}/stopStop a batched background operation

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4AdminBatchedBackgroundOperationsIdStop (required)

Responses

Status	Description	Schema
`200`	Stop a batched background operation	`API_Entities_BatchedBackgroundOperation`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—
`422`	You can stop only `queued`, `active` or `paused` operations.	—

database_dictionary2

Operations about database_dictionaries

GET/api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}

Parameters

Name	In	Required	Type
`database_name`	path	yes	string
`table_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve dictionary details	`API_Entities_Dictionary_Table`
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—

GET/api/v4/databases/{database_name}/dictionary/tablesList dictionary tables

Parameters

Name	In	Required	Type
`database_name`	path	yes	string
`table_size`	query	no	string

Responses

Status	Description	Schema
`200`	List dictionary tables	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—

migrations2

Operations about migrations

GET/api/v4/admin/migrations/pendingList all pending migrations

Parameters

Name	In	Required	Type
`database`	query	no	string

Responses

Status	Description	Schema
`200`	200 OK	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—

POST/api/v4/admin/migrations/{timestamp}/markUpdate status of a migration

Parameters

Name	In	Required	Type
`timestamp`	path	yes	integer

Request body

application/json — postApiV4AdminMigrationsTimestampMark (required)

Responses

Status	Description	Schema
`201`	201 Created	—
`401`	401 Unauthorized	—
`403`	403 Forbidden	—
`404`	404 Not found	—
`422`	You can mark only pending migrations	—

broadcast_messages5

Operations about broadcast_messages

GET/api/v4/broadcast_messagesList all broadcast messages

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all broadcast messages	`API_Entities_System_BroadcastMessage`

POST/api/v4/broadcast_messagesCreate a broadcast message

Request body

application/json — postApiV4BroadcastMessages (required)

Responses

Status	Description	Schema
`201`	Create a broadcast message	`API_Entities_System_BroadcastMessage`

GET/api/v4/broadcast_messages/{id}Retrieve a broadcast message

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a broadcast message	`API_Entities_System_BroadcastMessage`

PUT/api/v4/broadcast_messages/{id}Update a broadcast message

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4BroadcastMessagesId (required)

Responses

Status	Description	Schema
`200`	Update a broadcast message	`API_Entities_System_BroadcastMessage`

DELETE/api/v4/broadcast_messages/{id}Delete a broadcast message

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Delete a broadcast message	`API_Entities_System_BroadcastMessage`

applications4

Operations about applications

GET/api/v4/applicationsGet applications

Responses

Status	Description	Schema
`200`	Get applications	—
`401`	Unauthorized	—
`403`	Forbidden	—

POST/api/v4/applicationsCreate a new application

Request body

application/json — postApiV4Applications (required)

Responses

Status	Description	Schema
`200`	Create a new application	`API_Entities_ApplicationWithSecret`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

DELETE/api/v4/applications/{id}Delete an application

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an application	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/applications/{id}/renew-secretRenew an application secret

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Renew an application secret	`API_Entities_ApplicationWithSecret`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

imports9

Operations about imports

GET/api/v4/bulk_importsList all group or project migrations

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`sort`	query	no	string
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all group or project migrations	—
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/bulk_importsStart a group or project migration

Responses

Status	Description	Schema
`201`	Start a group or project migration	`API_Entities_BulkImport`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—
`503`	Service unavailable	—

GET/api/v4/bulk_imports/entitiesList all group or project migration entities

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`sort`	query	no	string
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all group or project migration entities	—
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/bulk_imports/{import_id}Retrieve a group or project migration

Parameters

Name	In	Required	Type
`import_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group or project migration	`API_Entities_BulkImport`
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/bulk_imports/{import_id}/cancelCancel a migration

Parameters

Name	In	Required	Type
`import_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Cancel a migration	`API_Entities_BulkImport`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/bulk_imports/{import_id}/entitiesList all group or project migration entities

Parameters

Name	In	Required	Type
`import_id`	path	yes	integer
`status`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all group or project migration entities	—
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/bulk_imports/{import_id}/entities/{entity_id}Retrieve a group or project migration entity

Parameters

Name	In	Required	Type
`import_id`	path	yes	integer
`entity_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group or project migration entity	`API_Entities_BulkImports`
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/bulk_imports/{import_id}/entities/{entity_id}/failuresList all failed import records for a migration entity

Parameters

Name	In	Required	Type
`import_id`	path	yes	integer
`entity_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all failed import records for a migration entity	`API_Entities_BulkImports_EntityFailure`
`401`	Unauthorized	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/import/github/gistsImport GitHub gists into GitLab snippets

Request body

application/json — postApiV4ImportGithubGists (required)

Responses

Status	Description	Schema
`202`	Import GitHub gists into GitLab snippets	—
`401`	Unauthorized	—
`422`	Unprocessable Entity	—
`429`	Too Many Requests	—

agents1

Operations about agents

GET/api/v4/job/allowed_agentsList all GitLab agents for Kubernetes by job token

Responses

Status	Description	Schema
`200`	List all GitLab agents for Kubernetes by job token	`API_Entities_Ci_Job`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

ci_runners6

Operations about ci_runners

POST/api/v4/runnersCreate a runner

Request body

application/json — postApiV4Runners (required)

Responses

Status	Description	Schema
`201`	Create a runner	`API_Entities_Ci_RunnerRegistrationDetails`
`400`	Bad Request	—
`403`	Forbidden	—
`410`	Gone	—

DELETE/api/v4/runnersDelete a runner by authentication token

Parameters

Name	In	Required	Type
`token`	query	yes	string

Responses

Status	Description	Schema
`204`	Resource deleted	—
`403`	Forbidden	—

DELETE/api/v4/runners/managersInternal endpoint that deletes a runner manager by authentication token and system ID.

Parameters

Name	In	Required	Type
`token`	query	yes	string
`system_id`	query	yes	string

Responses

Status	Description	Schema
`204`	Runner manager was deleted	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/runners/reset_authentication_tokenReset a runner authentication token with the current token

Request body

application/json — postApiV4RunnersResetAuthenticationToken (required)

Responses

Status	Description	Schema
`201`	Reset a runner authentication token with the current token	`API_Entities_Ci_ResetTokenResult`
`403`	Forbidden	—
`422`	Unprocessable Entity	—

GET/api/v4/runners/router/discoveryDiscover Job Router information

Responses

Status	Description	Schema
`200`	Discover Job Router information	`API_Entities_Ci_JobRouter_DiscoveryInformation`
`403`	403 Forbidden	—
`501`	501 Not Implemented	—

POST/api/v4/runners/verifyVerify authentication for a registered runner

Request body

application/json — postApiV4RunnersVerify (required)

Responses

Status	Description	Schema
`200`	Credentials are valid	`API_Entities_Ci_RunnerRegistrationDetails`
`403`	Forbidden	—
`422`	Runner is orphaned	—

jobs6

Operations about jobs

POST/api/v4/jobs/request

Request body

application/json — postApiV4JobsRequest (required)

Responses

Status	Description	Schema
`201`	Job was scheduled	`API_Entities_Ci_JobRequest_Response`
`204`	No job for Runner	—
`403`	Forbidden	—
`409`	Conflict	—
`422`	Runner is orphaned	—
`429`	Too Many Requests	—

PUT/api/v4/jobs/{id}

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4JobsId (required)

Responses

Status	Description	Schema
`200`	Job was updated	—
`202`	Update accepted	—
`400`	Unknown parameters	—
`403`	Forbidden	—
`409`	Conflict	—
`429`	Too Many Requests	—

GET/api/v4/jobs/{id}/artifacts

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`token`	query	no	string
`direct_download`	query	no	boolean

Responses

Status	Description	Schema
`200`	Download allowed	—
`302`	Found	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Artifact not found	—
`429`	Too Many Requests	—

POST/api/v4/jobs/{id}/artifacts

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4JobsIdArtifacts (required)

Responses

Status	Description	Schema
`201`	Upload a job artifact	—
`400`	Bad request	—
`403`	Forbidden	—
`405`	Artifacts support not enabled	—
`413`	File too large	—
`429`	Too Many Requests	—

POST/api/v4/jobs/{id}/artifacts/authorize

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4JobsIdArtifactsAuthorize (required)

Responses

Status	Description	Schema
`200`	Upload allowed	—
`403`	Forbidden	—
`405`	Artifacts support not enabled	—
`413`	File too large	—
`429`	Too Many Requests	—

PATCH/api/v4/jobs/{id}/trace

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — patchApiV4JobsIdTrace (required)

Responses

Status	Description	Schema
`202`	Trace was patched	—
`400`	Missing Content-Range header	—
`403`	Forbidden	—
`416`	Range not satisfiable	—
`429`	Too Many Requests	—

glql1

Operations about glqls

POST/api/v4/glqlExecute a GLQL query

Request body

application/json — postApiV4Glql (required)

Responses

Status	Description	Schema
`200`	Execute a GLQL query	`API_Entities_Glql_Result`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`429`	Too Many Requests	—
`500`	Internal server error	—

jira_forge_installation2

Operations about jira_forge_installations

PUT/api/v4/integrations/jira_forge/installationUpdate the GitLab for Jira (Forge) installation instance URL

Request body

application/json — putApiV4IntegrationsJiraForgeInstallation (required)

Responses

Status	Description	Schema
`200`	Update the GitLab for Jira (Forge) installation instance URL	`API_Entities_BasicSuccess`
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—

POST/api/v4/integrations/jira_forge/installation/forge_tokenRegister the GitLab for Jira (Forge) system token for direct dev-info sync

Responses

Status	Description	Schema
`201`	Register the GitLab for Jira (Forge) system token for direct dev-info sync	`API_Entities_BasicSuccess`
`401`	Unauthorized	—
`422`	Unprocessable entity	—

jira_forge_subscriptions3

Operations about jira_forge_subscriptions

GET/api/v4/integrations/jira_forge/subscriptionsList GitLab for Jira (Forge) namespace subscriptions

Responses

Status	Description	Schema
`200`	List GitLab for Jira (Forge) namespace subscriptions	`JiraConnect_SubscriptionEntity`
`401`	Unauthorized	—

POST/api/v4/integrations/jira_forge/subscriptionsCreate a GitLab for Jira (Forge) namespace subscription

Request body

application/json — postApiV4IntegrationsJiraForgeSubscriptions (required)

Responses

Status	Description	Schema
`201`	Create a GitLab for Jira (Forge) namespace subscription	`API_Entities_BasicSuccess`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/integrations/jira_forge/subscriptions/{id}Delete a GitLab for Jira (Forge) namespace subscription

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a GitLab for Jira (Forge) namespace subscription	`API_Entities_BasicSuccess`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

markdown1

Operations about markdowns

POST/api/v4/markdownRender Markdown content

Request body

application/json — postApiV4Markdown (required)

Responses

Status	Description	Schema
`201`	Render Markdown content	`API_Entities_Markdown`
`400`	Bad request	—
`401`	Unauthorized	—

namespaces8

Operations about namespaces

GET/api/v4/namespacesList all namespaces

Parameters

Name	In	Required	Type
`search`	query	no	string
`owned_only`	query	no	boolean
`top_level_only`	query	no	boolean
`full_path_search`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`requested_hosted_plan`	query	no	string

Responses

Status	Description	Schema
`200`	List all namespaces	—
`401`	Unauthorized	—

GET/api/v4/namespaces/storage/limit_exclusionsRetrieve all limit exclusions

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Retrieve all limit exclusions	`API_Entities_Namespaces_Storage_LimitExclusion`
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/namespaces/{id}Retrieve namespace details

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve namespace details	`API_Entities_Namespace`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/namespaces/{id}Update a namespace

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4NamespacesId (required)

Responses

Status	Description	Schema
`200`	Update a namespace	`API_Entities_Namespace`

GET/api/v4/namespaces/{id}/existsVerify namespace availability

Parameters

Name	In	Required	Type
`id`	path	yes	string
`parent_id`	query	no	integer

Responses

Status	Description	Schema
`200`	Verify namespace availability	`API_Entities_NamespaceExistence`
`401`	Unauthorized	—

GET/api/v4/namespaces/{id}/gitlab_subscriptionRetrieve namespace subscription

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve namespace subscription	`API_Entities_GitlabSubscription`

POST/api/v4/namespaces/{id}/storage/limit_exclusionCreates a storage limit exclusion for a Namespace

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — postApiV4NamespacesIdStorageLimitExclusion (required)

Responses

Status	Description	Schema
`201`	Creates a storage limit exclusion for a Namespace	`API_Entities_Namespaces_Storage_LimitExclusion`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/namespaces/{id}/storage/limit_exclusionRemoves a storage limit exclusion for a Namespace

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Removes a storage limit exclusion for a Namespace	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—

offline_transfers4

Operations about offline_transfers

GET/api/v4/offline_exportsList all offline transfer exports

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer
`sort`	query	no	string
`status`	query	no	string

Responses

Status	Description	Schema
`200`	List all offline transfer exports	—

POST/api/v4/offline_exportsStart a new offline transfer export

Request body

application/json — postApiV4OfflineExports (required)

Responses

Status	Description	Schema
`201`	Start a new offline transfer export	—

GET/api/v4/offline_exports/{id}Get offline transfer export details

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Get offline transfer export details	—

POST/api/v4/offline_importsStart a new offline transfer import

Request body

application/json — postApiV4OfflineImports (required)

Responses

Status	Description	Schema
`201`	Start a new offline transfer import	`API_Entities_BulkImport`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—
`429`	Too many requests	—

organizations2

Operations about organizations

POST/api/v4/organizationsCreate an organization

Request body

application/json — postApiV4Organizations (required)

Responses

Status	Description	Schema
`201`	Create an organization	`API_Entities_Organizations_Organization`

DELETE/api/v4/organizations/{id}Soft-delete an organization

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`202`	Soft-delete an organization	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

unleash5

Operations about unleashes

GET/api/v4/feature_flags/unleash/{project_id}

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`instance_id`	query	no	string
`app_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get Unleash features	—

GET/api/v4/feature_flags/unleash/{project_id}/client/features

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`instance_id`	query	no	string
`app_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get a list of features	—

POST/api/v4/feature_flags/unleash/{project_id}/client/metrics

Parameters

Name	In	Required	Type
`project_id`	path	yes	string

Request body

application/json — postApiV4FeatureFlagsUnleashProjectIdClientMetrics (required)

Responses

Status	Description	Schema
`201`	Report Unleash client metrics	—

POST/api/v4/feature_flags/unleash/{project_id}/client/register

Parameters

Name	In	Required	Type
`project_id`	path	yes	string

Request body

application/json — postApiV4FeatureFlagsUnleashProjectIdClientRegister (required)

Responses

Status	Description	Schema
`201`	Register Unleash client	—

GET/api/v4/feature_flags/unleash/{project_id}/featuresGet a list of features (v2 client support)

Parameters

Name	In	Required	Type
`project_id`	path	yes	string
`instance_id`	query	no	string
`app_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get a list of features (v2 client support)	—

usage_data7

Operations about usage_data

POST/api/v4/usage_data/increment_counterTrack usage data event

Request body

application/json — postApiV4UsageDataIncrementCounter (required)

Responses

Status	Description	Schema
`200`	Track usage data event	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/usage_data/increment_unique_users

Request body

application/json — postApiV4UsageDataIncrementUniqueUsers (required)

Responses

Status	Description	Schema
`200`	Track usage data event for the current user	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/usage_data/non_sql_metricsList all non-SQL metrics

Responses

Status	Description	Schema
`200`	List all non-SQL metrics	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/usage_data/queriesList all Service Ping SQL queries

Responses

Status	Description	Schema
`200`	List all Service Ping SQL queries	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/usage_data/service_pingRetrieve Service Ping payload

Responses

Status	Description	Schema
`200`	Retrieve Service Ping payload	—
`401`	401 Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/usage_data/track_eventTrack an internal GitLab event

Request body

application/json — postApiV4UsageDataTrackEvent (required)

Responses

Status	Description	Schema
`200`	Track an internal GitLab event	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/usage_data/track_eventsTrack multiple internal GitLab events

Request body

application/json — postApiV4UsageDataTrackEvents (required)

Responses

Status	Description	Schema
`200`	Track multiple internal GitLab events	—
`400`	Validation error	—
`401`	Unauthorized	—

metrics1

Operations about metrics

GET/api/v4/usage_data/metric_definitionsDownload metric definitions

Parameters

Name	In	Required	Type
`include_paths`	query	no	boolean

Responses

Status	Description	Schema
`200`	Download metric definitions	—
`401`	Unauthorized	—
`404`	Not found	—

users2

Operations about users

POST/api/v4/user/runnersCreate a runner owned by currently authenticated user

Request body

application/json — postApiV4UserRunners (required)

Responses

Status	Description	Schema
`201`	Create a runner owned by currently authenticated user	`API_Entities_Ci_RunnerRegistrationDetails`
`400`	Bad Request	—
`403`	Forbidden	—

GET/api/v4/user_countsReturn the user specific counts

Responses

Status	Description	Schema
`200`	Return the user specific counts	`API_Entities_UserCounts`
`401`	Unauthorized	—

instance3

Operations about instances

GET/api/v4/application/appearance

Responses

Status	Description	Schema
`200`	Get the current appearance	`API_Entities_Appearance`
`401`	Unauthorized	—
`403`	Forbidden	—

PUT/api/v4/application/appearance

Responses

Status	Description	Schema
`200`	Modify appearance	`API_Entities_Appearance`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/application/statisticsRetrieve application statistics

Responses

Status	Description	Schema
`200`	Retrieve application statistics	`API_Entities_ApplicationStatistics`
`401`	Unauthorized	—
`403`	Forbidden	—

project_topics6

Operations about project_topics

GET/api/v4/topicsList all topics

Parameters

Name	In	Required	Type
`search`	query	no	string
`without_projects`	query	no	boolean
`organization_id`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all topics	`API_Entities_Projects_Topic`

POST/api/v4/topicsCreate a project topic

Request body

application/json — postApiV4Topics (required)

Responses

Status	Description	Schema
`201`	Create a project topic	`API_Entities_Projects_Topic`

POST/api/v4/topics/mergeMerge topics

Request body

application/json — postApiV4TopicsMerge (required)

Responses

Status	Description	Schema
`201`	Merge topics	`API_Entities_Projects_Topic`

GET/api/v4/topics/{id}Retrieve a topic

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a topic	`API_Entities_Projects_Topic`

PUT/api/v4/topics/{id}Update a project topic

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4TopicsId (required)

Responses

Status	Description	Schema
`200`	Update a project topic	`API_Entities_Projects_Topic`

DELETE/api/v4/topics/{id}Delete a project topic

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

web_commits1

Operations about web_commits

GET/api/v4/web_commits/public_keyRetrieve the public signing key

Responses

Status	Description	Schema
`200`	Retrieve the public signing key	—
`404`	Public key not found.	—
`503`	The git server, Gitaly, is not available at this time. Please contact your administrator.	—

access_requests8

Operations related to access requests

GET/api/v4/groups/{id}/access_requestsList all access requests for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all access requests for a group	`API_Entities_AccessRequester`

POST/api/v4/groups/{id}/access_requestsRequest access to a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Request access to a group	`API_Entities_AccessRequester`

DELETE/api/v4/groups/{id}/access_requests/{user_id}Deny an access request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

PUT/api/v4/groups/{id}/access_requests/{user_id}/approveApprove an access request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdAccessRequestsUserIdApprove (required)

Responses

Status	Description	Schema
`201`	Approve an access request	`API_Entities_Member`

GET/api/v4/projects/{id}/access_requestsList all access requests for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all access requests for a project	`API_Entities_AccessRequester`

POST/api/v4/projects/{id}/access_requestsRequest access to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Request access to a project	`API_Entities_AccessRequester`

DELETE/api/v4/projects/{id}/access_requests/{user_id}Deny an access request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

PUT/api/v4/projects/{id}/access_requests/{user_id}/approveApprove an access request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`user_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdAccessRequestsUserIdApprove (required)

Responses

Status	Description	Schema
`201`	Approve an access request	`API_Entities_Member`

ci_lint2

Operations related to linting a CI config file

GET/api/v4/projects/{id}/ci/lintValidate existing CI/CD configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sha`	query	no	string
`content_ref`	query	no	string
`dry_run`	query	no	boolean
`include_jobs`	query	no	boolean
`ref`	query	no	string
`dry_run_ref`	query	no	string

Responses

Status	Description	Schema
`200`	Validate existing CI/CD configuration	`API_Entities_Ci_Lint_Result`
`404`	Not found	—

POST/api/v4/projects/{id}/ci/lintValidate a CI/CD configuration

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdCiLint (required)

Responses

Status	Description	Schema
`200`	Validate a CI/CD configuration	`API_Entities_Ci_Lint_Result`

ci_resource_groups5

Operations to manage job concurrency with resource groups

GET/api/v4/projects/{id}/resource_groupsList all resource groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all resource groups	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/resource_groups/{key}Retrieve a resource group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a resource group	`API_Entities_Ci_ResourceGroup`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/resource_groups/{key}Update a resource group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Request body

application/json — putApiV4ProjectsIdResourceGroupsKey (required)

Responses

Status	Description	Schema
`200`	Update a resource group	`API_Entities_Ci_ResourceGroup`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/resource_groups/{key}/current_jobRetrieve current job for a resource group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve current job for a resource group	`API_Entities_Ci_JobBasic`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/resource_groups/{key}/upcoming_jobsList all upcoming jobs for a resource group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all upcoming jobs for a resource group	—
`401`	Unauthorized	—
`404`	Not found	—

ci_variables15

Operations related to CI/CD variables

GET/api/v4/admin/ci/variablesList all instance variables

Parameters

Name	In	Required	Type
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all instance variables	`API_Entities_Ci_Variable`

POST/api/v4/admin/ci/variablesCreate instance variable

Request body

application/json — postApiV4AdminCiVariables (required)

Responses

Status	Description	Schema
`201`	Create instance variable	`API_Entities_Ci_Variable`
`400`	400 Bad Request	—

GET/api/v4/admin/ci/variables/{key}Retrieve instance variable details

Parameters

Name	In	Required	Type
`key`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve instance variable details	`API_Entities_Ci_Variable`
`404`	Instance Variable Not Found	—

PUT/api/v4/admin/ci/variables/{key}Update an instance variable

Parameters

Name	In	Required	Type
`key`	path	yes	string

Request body

application/json — putApiV4AdminCiVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update an instance variable	`API_Entities_Ci_Variable`
`404`	Instance Variable Not Found	—

DELETE/api/v4/admin/ci/variables/{key}Delete instance variable

Parameters

Name	In	Required	Type
`key`	path	yes	string

Responses

Status	Description	Schema
`204`	Instance Variable Not Found	—

GET/api/v4/groups/{id}/variablesList all group variables

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all group variables	`API_Entities_Ci_Variable`

POST/api/v4/groups/{id}/variablesCreate a group variable

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdVariables (required)

Responses

Status	Description	Schema
`201`	Create a group variable	`API_Entities_Ci_Variable`
`400`	400 Bad Request	—

GET/api/v4/groups/{id}/variables/{key}Retrieve details of a group variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve details of a group variable	`API_Entities_Ci_Variable`
`404`	Group Variable Not Found	—

PUT/api/v4/groups/{id}/variables/{key}Update a group variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Request body

application/json — putApiV4GroupsIdVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update a group variable	`API_Entities_Ci_Variable`
`400`	400 Bad Request	—
`404`	Group Variable Not Found	—

DELETE/api/v4/groups/{id}/variables/{key}Delete a group variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a group variable	`API_Entities_Ci_Variable`
`404`	Group Variable Not Found	—

GET/api/v4/projects/{id}/variablesList all project variables

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all project variables	`API_Entities_Ci_Variable`

POST/api/v4/projects/{id}/variablesCreate a variable

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdVariables (required)

Responses

Status	Description	Schema
`201`	Create a variable	`API_Entities_Ci_Variable`
`400`	400 Bad Request	—

GET/api/v4/projects/{id}/variables/{key}Retrieve a single variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string
`filter[environment_scope]`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve a single variable	`API_Entities_Ci_Variable`
`404`	Variable Not Found	—

PUT/api/v4/projects/{id}/variables/{key}Update a variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string

Request body

application/json — putApiV4ProjectsIdVariablesKey (required)

Responses

Status	Description	Schema
`200`	Update a variable	`API_Entities_Ci_Variable`
`404`	Variable Not Found	—

DELETE/api/v4/projects/{id}/variables/{key}Delete a variable

Parameters

Name	In	Required	Type
`id`	path	yes	string
`key`	path	yes	string
`filter[environment_scope]`	query	no	string

Responses

Status	Description	Schema
`204`	Delete a variable	`API_Entities_Ci_Variable`
`404`	Variable Not Found	—

cluster_agents8

Operations related to the GitLab agent for Kubernetes

GET/api/v4/projects/{id}/cluster_agentsList all agents

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all agents	`API_Entities_Clusters_Agent`

POST/api/v4/projects/{id}/cluster_agentsCreate an agent

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdClusterAgents (required)

Responses

Status	Description	Schema
`201`	Create an agent	`API_Entities_Clusters_Agent`

GET/api/v4/projects/{id}/cluster_agents/{agent_id}Retrieve details on an agent

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve details on an agent	`API_Entities_Clusters_Agent`

DELETE/api/v4/projects/{id}/cluster_agents/{agent_id}Delete an agent

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

GET/api/v4/projects/{id}/cluster_agents/{agent_id}/tokensList all agent tokens

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all agent tokens	`API_Entities_Clusters_AgentTokenBasic`

POST/api/v4/projects/{id}/cluster_agents/{agent_id}/tokensCreate an agent token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdClusterAgentsAgentIdTokens (required)

Responses

Status	Description	Schema
`201`	Create an agent token	`API_Entities_Clusters_AgentTokenWithToken`

GET/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id}Retrieve an agent token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an agent token	`API_Entities_Clusters_AgentToken`

DELETE/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id}Revoke an agent token

Parameters

Name	In	Required	Type
`id`	path	yes	string
`agent_id`	path	yes	integer
`token_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Resource deleted	—

clusters16

Operations related to clusters

GET/api/v4/admin/clustersList all instance clusters

Responses

Status	Description	Schema
`200`	List all instance clusters	—
`403`	Forbidden	—

POST/api/v4/admin/clusters/addCreate an instance cluster

Request body

application/json — postApiV4AdminClustersAdd (required)

Responses

Status	Description	Schema
`201`	Create an instance cluster	`API_Entities_Cluster`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/admin/clusters/{cluster_id}Retrieve a single instance cluster

Parameters

Name	In	Required	Type
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a single instance cluster	`API_Entities_Cluster`
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/admin/clusters/{cluster_id}Update an instance cluster

Parameters

Name	In	Required	Type
`cluster_id`	path	yes	integer

Request body

application/json — putApiV4AdminClustersClusterId (required)

Responses

Status	Description	Schema
`200`	Update an instance cluster	`API_Entities_Cluster`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/admin/clusters/{cluster_id}Delete instance cluster

Parameters

Name	In	Required	Type
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete instance cluster	`API_Entities_Cluster`
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/discover-cert-based-clustersList all certificate-based clusters

Parameters

Name	In	Required	Type
`group_id`	query	yes	integer

Responses

Status	Description	Schema
`200`	List all certificate-based clusters	`API_Entities_DiscoveredClusters`
`403`	Forbidden	—

GET/api/v4/groups/{id}/clustersList all group clusters

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all group clusters	—
`403`	Forbidden	—

POST/api/v4/groups/{id}/clusters/userCreate a group cluster

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4GroupsIdClustersUser (required)

Responses

Status	Description	Schema
`201`	Create a group cluster	`API_Entities_ClusterGroup`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/groups/{id}/clusters/{cluster_id}Retrieve a group cluster

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a group cluster	`API_Entities_ClusterGroup`
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/groups/{id}/clusters/{cluster_id}Update a group cluster

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdClustersClusterId (required)

Responses

Status	Description	Schema
`200`	Update a group cluster	`API_Entities_ClusterGroup`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/groups/{id}/clusters/{cluster_id}Delete a group cluster

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a group cluster	`API_Entities_ClusterGroup`
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/clustersList all clusters in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all clusters in a project	—
`403`	Forbidden	—

POST/api/v4/projects/{id}/clusters/userAdd a cluster to a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdClustersUser (required)

Responses

Status	Description	Schema
`201`	Add a cluster to a project	`API_Entities_ClusterProject`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/clusters/{cluster_id}Retrieve a cluster from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a cluster from a project	`API_Entities_ClusterProject`
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/clusters/{cluster_id}Update a cluster in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdClustersClusterId (required)

Responses

Status	Description	Schema
`200`	Update a cluster in a project	`API_Entities_ClusterProject`
`400`	Validation error	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/clusters/{cluster_id}Delete cluster from a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`cluster_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete cluster from a project	`API_Entities_ClusterProject`
`403`	Forbidden	—
`404`	Not found	—

container_registry9

Operations related to container registry

POST/api/v4/container_registry_event/eventsReceives notifications from the container registry when an operation occurs

Responses

Status	Description	Schema
`200`	Success	—
`401`	Invalid Token	—

GET/api/v4/groups/{id}/registry/repositoriesList all registry repositories for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all registry repositories for a group	—
`401`	Unauthorized	—
`404`	Group Not Found	—

GET/api/v4/projects/{id}/registry/repositoriesList all registry repositories for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`tags`	query	no	boolean
`tags_count`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all registry repositories for a project	—
`401`	Unauthorized	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/registry/repositories/{repository_id}Delete registry repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`repository_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Success	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/registry/repositories/{repository_id}/tagsList all registry repository tags for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`repository_id`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all registry repository tags for a project	—
`401`	Unauthorized	—
`404`	Not Found	—
`405`	Method Not Allowed	—

DELETE/api/v4/projects/{id}/registry/repositories/{repository_id}/tagsDelete multiple registry repository tags

Parameters

Name	In	Required	Type
`id`	path	yes	string
`repository_id`	path	yes	integer
`name_regex_delete`	query	no	string
`name_regex`	query	no	string
`name_regex_keep`	query	no	string
`keep_n`	query	no	integer
`older_than`	query	no	string

Responses

Status	Description	Schema
`204`	Success	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

GET/api/v4/projects/{id}/registry/repositories/{repository_id}/tags/{tag_name}Retrieve details of a registry repository tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`repository_id`	path	yes	integer
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve details of a registry repository tag	`API_Entities_ContainerRegistry_TagDetails`
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

DELETE/api/v4/projects/{id}/registry/repositories/{repository_id}/tags/{tag_name}Delete a registry repository tag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`repository_id`	path	yes	integer
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`204`	Success	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/registry/repositories/{id}Retrieve details of a container registry repository

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tags`	query	no	boolean
`tags_count`	query	no	boolean
`size`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve details of a container registry repository	`API_Entities_ContainerRegistry_Repository`
`401`	Unauthorized	—
`404`	Repository Not Found	—

dependency_proxy1

Operations to manage dependency proxy for a groups

DELETE/api/v4/groups/{id}/dependency_proxy/cachePurge the dependency proxy for a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Purge the dependency proxy for a group	—
`401`	Unauthorized	—

environments8

Operations related to environments

GET/api/v4/projects/{id}/environmentsList all environments

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`name`	query	no	string
`search`	query	no	string
`states`	query	no	string

Responses

Status	Description	Schema
`200`	List all environments	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/environmentsCreate an environment

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdEnvironments (required)

Responses

Status	Description	Schema
`201`	Create an environment	`API_Entities_Environment`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/environments/review_appsSchedule multiple stopped review apps for deletion

Parameters

Name	In	Required	Type
`id`	path	yes	string
`before`	query	no	string
`limit`	query	no	integer
`dry_run`	query	no	boolean

Responses

Status	Description	Schema
`204`	Schedule multiple stopped review apps for deletion	`API_Entities_EnvironmentBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`409`	Conflict	—

POST/api/v4/projects/{id}/environments/stop_staleStop stale environments

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdEnvironmentsStopStale (required)

Responses

Status	Description	Schema
`201`	Stop stale environments	—
`400`	Bad request	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/environments/{environment_id}Retrieve an environment

Parameters

Name	In	Required	Type
`id`	path	yes	string
`environment_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve an environment	`API_Entities_Environment`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/environments/{environment_id}Update an existing environment

Parameters

Name	In	Required	Type
`id`	path	yes	string
`environment_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdEnvironmentsEnvironmentId (required)

Responses

Status	Description	Schema
`200`	Update an existing environment	`API_Entities_Environment`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/environments/{environment_id}Delete an environment

Parameters

Name	In	Required	Type
`id`	path	yes	string
`environment_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an environment	`API_Entities_Environment`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/environments/{environment_id}/stopStop an environment

Parameters

Name	In	Required	Type
`id`	path	yes	string
`environment_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdEnvironmentsEnvironmentIdStop (required)

Responses

Status	Description	Schema
`201`	Stop an environment	`API_Entities_Environment`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

feature_flags10

Operations related to feature flags

GET/api/v4/projects/{id}/feature_flagsList all feature flags for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`scope`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all feature flags for a project	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/feature_flagsCreate a feature flag

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdFeatureFlags (required)

Responses

Status	Description	Schema
`201`	Create a feature flag	`API_Entities_FeatureFlag`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/projects/{id}/feature_flags/{feature_flag_name}Retrieve a feature flag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`feature_flag_name`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a feature flag	`API_Entities_FeatureFlag`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/feature_flags/{feature_flag_name}Update a feature flag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`feature_flag_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdFeatureFlagsFeatureFlagName (required)

Responses

Status	Description	Schema
`200`	Update a feature flag	`API_Entities_FeatureFlag`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/feature_flags/{feature_flag_name}Delete a feature flag

Parameters

Name	In	Required	Type
`id`	path	yes	string
`feature_flag_name`	path	yes	string

Responses

Status	Description	Schema
`204`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/feature_flags_user_listsList all feature flag user lists for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all feature flag user lists for a project	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/feature_flags_user_listsCreate a feature flag user list

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdFeatureFlagsUserLists (required)

Responses

Status	Description	Schema
`201`	Create a feature flag user list	`API_Entities_FeatureFlag_UserList`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/feature_flags_user_lists/{iid}Retrieve a feature flag user list

Parameters

Name	In	Required	Type
`id`	path	yes	string
`iid`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve a feature flag user list	`API_Entities_FeatureFlag_UserList`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/feature_flags_user_lists/{iid}Update a feature flag user list

Parameters

Name	In	Required	Type
`id`	path	yes	string
`iid`	path	yes	string

Request body

application/json — putApiV4ProjectsIdFeatureFlagsUserListsIid (required)

Responses

Status	Description	Schema
`200`	Update a feature flag user list	`API_Entities_FeatureFlag_UserList`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/feature_flags_user_lists/{iid}Delete feature flag user list

Parameters

Name	In	Required	Type
`id`	path	yes	string
`iid`	path	yes	string

Responses

Status	Description	Schema
`204`	Resource deleted	—
`401`	Unauthorized	—
`404`	Not found	—
`409`	Conflict	—

features4

Operations related to managing Flipper-based feature flags

GET/api/v4/featuresList all feature flags

Responses

Status	Description	Schema
`200`	List all feature flags	—
`401`	Unauthorized	—
`403`	Forbidden	—

GET/api/v4/features/definitionsList all feature flag definitions

Responses

Status	Description	Schema
`200`	List all feature flag definitions	—
`401`	Unauthorized	—
`403`	Forbidden	—

POST/api/v4/features/{name}Create or update a feature flag

Parameters

Name	In	Required	Type
`name`	path	yes	string

Request body

application/json — postApiV4FeaturesName (required)

Responses

Status	Description	Schema
`201`	Create or update a feature flag	`API_Entities_Feature`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

DELETE/api/v4/features/{name}Delete a feature

Parameters

Name	In	Required	Type
`name`	path	yes	string

Responses

Status	Description	Schema
`204`	Resource deleted	—

freeze_periods5

Operations related to deploy freeze periods

GET/api/v4/projects/{id}/freeze_periodsList all freeze periods

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all freeze periods	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/freeze_periodsCreate a freeze period

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdFreezePeriods (required)

Responses

Status	Description	Schema
`201`	Create a freeze period	`API_Entities_FreezePeriod`
`400`	Bad request	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/freeze_periods/{freeze_period_id}Retrieve a freeze period

Parameters

Name	In	Required	Type
`id`	path	yes	string
`freeze_period_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a freeze period	`API_Entities_FreezePeriod`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/freeze_periods/{freeze_period_id}Update a freeze period

Parameters

Name	In	Required	Type
`id`	path	yes	string
`freeze_period_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdFreezePeriodsFreezePeriodId (required)

Responses

Status	Description	Schema
`200`	Update a freeze period	`API_Entities_FreezePeriod`
`400`	Bad request	—
`401`	Unauthorized	—

DELETE/api/v4/projects/{id}/freeze_periods/{freeze_period_id}Delete a freeze period

Parameters

Name	In	Required	Type
`id`	path	yes	string
`freeze_period_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a freeze period	`API_Entities_FreezePeriod`
`401`	Unauthorized	—

geo9

Operations related to Geo

POST/api/v4/geo/node_proxy/{id}/graphqlQuery the GraphQL endpoint of an existing Geo node

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Query the GraphQL endpoint of an existing Geo node	—
`404`	404 GeoNode Not Found	—
`500`	500 Internal Server Error	—

GET/api/v4/geo/proxyDetermine if a Geo site should proxy requests

Responses

Status	Description	Schema
`200`	Returns a Geo proxy response	—
`403`	Forbidden	—

POST/api/v4/geo/proxy_git_ssh/info_refs_receive_packInternal endpoint that returns git-received-pack output for git push

Request body

application/json — postApiV4GeoProxyGitSshInfoRefsReceivePack (required)

Responses

Status	Description	Schema
`200`	Responsible for making HTTP GET /repo.git/info/refs?service=git-receive-pack request from secondary gitlab-shell to primary	—
`401`	401 Unauthorized	—

POST/api/v4/geo/proxy_git_ssh/info_refs_upload_packInternal endpoint that returns info refs upload pack for clone or pull operations

Request body

application/json — postApiV4GeoProxyGitSshInfoRefsUploadPack (required)

Responses

Status	Description	Schema
`200`	Responsible for making HTTP GET /repo.git/info/refs?service=git-upload-pack request from secondary gitlab-shell to primary	—
`401`	401 Unauthorized	—

POST/api/v4/geo/proxy_git_ssh/receive_packInternal endpoint that posts git-receive-pack for git push

Request body

application/json — postApiV4GeoProxyGitSshReceivePack (required)

Responses

Status	Description	Schema
`200`	Responsible for making HTTP POST /repo.git/info/refs?service=git-receive-pack request from secondary gitlab-shell to primary	—
`401`	401 Unauthorized	—

POST/api/v4/geo/proxy_git_ssh/upload_packInternal endpoint that posts git-upload-pack for clone or pull operations

Request body

application/json — postApiV4GeoProxyGitSshUploadPack (required)

Responses

Status	Description	Schema
`200`	Responsible for making HTTP POST /repo.git/git-upload-pack request from secondary gitlab-shell to primary	—
`401`	401 Unauthorized	—

GET/api/v4/geo/repositories/{gl_repository}/pipeline_refsUsed by secondary runners to verify the secondary instance has the very latest version

Parameters

Name	In	Required	Type
`gl_repository`	path	yes	string

Responses

Status	Description	Schema
`200`	Returns the list of pipeline refs for the project	—
`401`	401 Unauthorized	—
`404`	404 Not found	—

GET/api/v4/geo/retrieve/{replicable_name}/{replicable_id}Internal endpoint that returns a replicable file

Parameters

Name	In	Required	Type
`replicable_name`	path	yes	string
`replicable_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Returns a replicable file from store (via CDN or sendfile)	—
`401`	401 Unauthorized	—
`404`	404 Not found	—

POST/api/v4/geo/statusInternal endpoint that posts the current node status

Request body

application/json — postApiV4GeoStatus (required)

Responses

Status	Description	Schema
`200`	Posts the current node status to the primary site	`API_Entities_GeoNodeStatus`
`400`	400 Bad Request	—
`401`	401 Unauthorized	—

integrations168

Operations related to integrations

GET/api/v4/groups/{id}/integrationsList all active integrations

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all active integrations	—
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/groups/{id}/integrations/apple-app-storeCreate or update the Apple App Store integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsAppleAppStore (required)

Responses

Status	Description	Schema
`200`	Create or update the Apple App Store integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/asanaCreate or update the Asana integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsAsana (required)

Responses

Status	Description	Schema
`200`	Create or update the Asana integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/assemblaCreate or update the Assembla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsAssembla (required)

Responses

Status	Description	Schema
`200`	Create or update the Assembla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/bambooCreate or update the Bamboo integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsBamboo (required)

Responses

Status	Description	Schema
`200`	Create or update the Bamboo integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/bugzillaCreate or update the Bugzilla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsBugzilla (required)

Responses

Status	Description	Schema
`200`	Create or update the Bugzilla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/buildkiteCreate or update the Buildkite integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsBuildkite (required)

Responses

Status	Description	Schema
`200`	Create or update the Buildkite integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/campfireCreate or update the Campfire integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsCampfire (required)

Responses

Status	Description	Schema
`200`	Create or update the Campfire integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/clickupCreate or update the Clickup integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsClickup (required)

Responses

Status	Description	Schema
`200`	Create or update the Clickup integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/confluenceCreate or update the Confluence integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsConfluence (required)

Responses

Status	Description	Schema
`200`	Create or update the Confluence integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/custom-issue-trackerCreate or update the Custom Issue Tracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsCustomIssueTracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Custom Issue Tracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/datadogCreate or update the Datadog integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsDatadog (required)

Responses

Status	Description	Schema
`200`	Create or update the Datadog integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/diffblue-coverCreate or update the Diffblue Cover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsDiffblueCover (required)

Responses

Status	Description	Schema
`200`	Create or update the Diffblue Cover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/discordCreate or update the Discord integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsDiscord (required)

Responses

Status	Description	Schema
`200`	Create or update the Discord integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/drone-ciCreate or update the Drone Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsDroneCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Drone Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/emails-on-pushCreate or update the Emails On Push integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsEmailsOnPush (required)

Responses

Status	Description	Schema
`200`	Create or update the Emails On Push integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/ewmCreate or update the Ewm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsEwm (required)

Responses

Status	Description	Schema
`200`	Create or update the Ewm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/external-wikiCreate or update the External Wiki integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsExternalWiki (required)

Responses

Status	Description	Schema
`200`	Create or update the External Wiki integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/git-guardianCreate or update the Git Guardian integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGitGuardian (required)

Responses

Status	Description	Schema
`200`	Create or update the Git Guardian integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/githubCreate or update the Github integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGithub (required)

Responses

Status	Description	Schema
`200`	Create or update the Github integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/gitlab-slack-applicationCreate or update the Gitlab Slack Application integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGitlabSlackApplication (required)

Responses

Status	Description	Schema
`200`	Create or update the Gitlab Slack Application integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/google-cloud-platform-artifact-registryCreate or update the Google Cloud Platform Artifact Registry integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGoogleCloudPlatformArtifactRegistry (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Artifact Registry integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/google-cloud-platform-workload-identity-federationCreate or update the Google Cloud Platform Workload Identity Federation integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Workload Identity Federation integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/google-playCreate or update the Google Play integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsGooglePlay (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Play integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/hangouts-chatCreate or update the Hangouts Chat integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsHangoutsChat (required)

Responses

Status	Description	Schema
`200`	Create or update the Hangouts Chat integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/harborCreate or update the Harbor integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsHarbor (required)

Responses

Status	Description	Schema
`200`	Create or update the Harbor integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/irkerCreate or update the Irker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsIrker (required)

Responses

Status	Description	Schema
`200`	Create or update the Irker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/jenkinsCreate or update the Jenkins integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsJenkins (required)

Responses

Status	Description	Schema
`200`	Create or update the Jenkins integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/jiraCreate or update the Jira integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsJira (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/jira-cloud-appCreate or update the Jira Cloud App integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsJiraCloudApp (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira Cloud App integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/linearCreate or update the Linear integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsLinear (required)

Responses

Status	Description	Schema
`200`	Create or update the Linear integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/matrixCreate or update the Matrix integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMatrix (required)

Responses

Status	Description	Schema
`200`	Create or update the Matrix integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/mattermostCreate or update the Mattermost integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMattermost (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/mattermost-slash-commandsCreate or update the Mattermost Slash Commands integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMattermostSlashCommands (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost Slash Commands integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/microsoft-teamsCreate or update the Microsoft Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMicrosoftTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Microsoft Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/mock-ciCreate or update the Mock Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMockCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/mock-monitoringCreate or update the Mock Monitoring integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsMockMonitoring (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Monitoring integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/packagistCreate or update the Packagist integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPackagist (required)

Responses

Status	Description	Schema
`200`	Create or update the Packagist integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/phorgeCreate or update the Phorge integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPhorge (required)

Responses

Status	Description	Schema
`200`	Create or update the Phorge integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/pipelines-emailCreate or update the Pipelines Email integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPipelinesEmail (required)

Responses

Status	Description	Schema
`200`	Create or update the Pipelines Email integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/pivotaltrackerCreate or update the Pivotaltracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPivotaltracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Pivotaltracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/pumbleCreate or update the Pumble integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPumble (required)

Responses

Status	Description	Schema
`200`	Create or update the Pumble integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/pushoverCreate or update the Pushover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsPushover (required)

Responses

Status	Description	Schema
`200`	Create or update the Pushover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/redmineCreate or update the Redmine integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsRedmine (required)

Responses

Status	Description	Schema
`200`	Create or update the Redmine integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/slackCreate or update the Slack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsSlack (required)

Responses

Status	Description	Schema
`200`	Create or update the Slack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/squash-tmCreate or update the Squash Tm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsSquashTm (required)

Responses

Status	Description	Schema
`200`	Create or update the Squash Tm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/teamcityCreate or update the Teamcity integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsTeamcity (required)

Responses

Status	Description	Schema
`200`	Create or update the Teamcity integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/telegramCreate or update the Telegram integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsTelegram (required)

Responses

Status	Description	Schema
`200`	Create or update the Telegram integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/unify-circuitCreate or update the Unify Circuit integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsUnifyCircuit (required)

Responses

Status	Description	Schema
`200`	Create or update the Unify Circuit integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/webex-teamsCreate or update the Webex Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsWebexTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Webex Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/youtrackCreate or update the Youtrack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsYoutrack (required)

Responses

Status	Description	Schema
`200`	Create or update the Youtrack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/groups/{id}/integrations/zentaoCreate or update the Zentao integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4GroupsIdIntegrationsZentao (required)

Responses

Status	Description	Schema
`200`	Create or update the Zentao integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/groups/{id}/integrations/{slug}Retrieve integration settings

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve integration settings	`API_Entities_Integration`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/groups/{id}/integrations/{slug}Disable an integration

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Disable an integration	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/integrations/slack/events

Request body

application/json — postApiV4IntegrationsSlackEvents (required)

Responses

Status	Description	Schema
`200`	Successfully processed event	—
`204`	Failed to process event	—
`401`	Unauthorized	—

POST/api/v4/integrations/slack/interactionsProcess Slack interaction events

Responses

Status	Description	Schema
`201`	Process Slack interaction events	—

POST/api/v4/integrations/slack/optionsGet Slack interactive component options

Responses

Status	Description	Schema
`201`	Get Slack interactive component options	—

GET/api/v4/projects/{id}/integrationsList all active integrations

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all active integrations	—
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/integrations/apple-app-storeCreate or update the Apple App Store integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsAppleAppStore (required)

Responses

Status	Description	Schema
`200`	Create or update the Apple App Store integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/asanaCreate or update the Asana integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsAsana (required)

Responses

Status	Description	Schema
`200`	Create or update the Asana integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/assemblaCreate or update the Assembla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsAssembla (required)

Responses

Status	Description	Schema
`200`	Create or update the Assembla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/bambooCreate or update the Bamboo integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsBamboo (required)

Responses

Status	Description	Schema
`200`	Create or update the Bamboo integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/bugzillaCreate or update the Bugzilla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsBugzilla (required)

Responses

Status	Description	Schema
`200`	Create or update the Bugzilla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/buildkiteCreate or update the Buildkite integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsBuildkite (required)

Responses

Status	Description	Schema
`200`	Create or update the Buildkite integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/campfireCreate or update the Campfire integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsCampfire (required)

Responses

Status	Description	Schema
`200`	Create or update the Campfire integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/clickupCreate or update the Clickup integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsClickup (required)

Responses

Status	Description	Schema
`200`	Create or update the Clickup integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/confluenceCreate or update the Confluence integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsConfluence (required)

Responses

Status	Description	Schema
`200`	Create or update the Confluence integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/custom-issue-trackerCreate or update the Custom Issue Tracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsCustomIssueTracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Custom Issue Tracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/datadogCreate or update the Datadog integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsDatadog (required)

Responses

Status	Description	Schema
`200`	Create or update the Datadog integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/diffblue-coverCreate or update the Diffblue Cover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsDiffblueCover (required)

Responses

Status	Description	Schema
`200`	Create or update the Diffblue Cover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/discordCreate or update the Discord integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsDiscord (required)

Responses

Status	Description	Schema
`200`	Create or update the Discord integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/drone-ciCreate or update the Drone Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsDroneCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Drone Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/emails-on-pushCreate or update the Emails On Push integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsEmailsOnPush (required)

Responses

Status	Description	Schema
`200`	Create or update the Emails On Push integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/ewmCreate or update the Ewm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsEwm (required)

Responses

Status	Description	Schema
`200`	Create or update the Ewm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/external-wikiCreate or update the External Wiki integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsExternalWiki (required)

Responses

Status	Description	Schema
`200`	Create or update the External Wiki integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/git-guardianCreate or update the Git Guardian integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGitGuardian (required)

Responses

Status	Description	Schema
`200`	Create or update the Git Guardian integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/githubCreate or update the Github integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGithub (required)

Responses

Status	Description	Schema
`200`	Create or update the Github integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/gitlab-slack-applicationCreate or update the Gitlab Slack Application integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGitlabSlackApplication (required)

Responses

Status	Description	Schema
`200`	Create or update the Gitlab Slack Application integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/google-cloud-platform-artifact-registryCreate or update the Google Cloud Platform Artifact Registry integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGoogleCloudPlatformArtifactRegistry (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Artifact Registry integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/google-cloud-platform-workload-identity-federationCreate or update the Google Cloud Platform Workload Identity Federation integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Workload Identity Federation integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/google-playCreate or update the Google Play integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsGooglePlay (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Play integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/hangouts-chatCreate or update the Hangouts Chat integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsHangoutsChat (required)

Responses

Status	Description	Schema
`200`	Create or update the Hangouts Chat integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/harborCreate or update the Harbor integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsHarbor (required)

Responses

Status	Description	Schema
`200`	Create or update the Harbor integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/irkerCreate or update the Irker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsIrker (required)

Responses

Status	Description	Schema
`200`	Create or update the Irker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/jenkinsCreate or update the Jenkins integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsJenkins (required)

Responses

Status	Description	Schema
`200`	Create or update the Jenkins integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/jiraCreate or update the Jira integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsJira (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/jira-cloud-appCreate or update the Jira Cloud App integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsJiraCloudApp (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira Cloud App integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/linearCreate or update the Linear integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsLinear (required)

Responses

Status	Description	Schema
`200`	Create or update the Linear integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/matrixCreate or update the Matrix integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMatrix (required)

Responses

Status	Description	Schema
`200`	Create or update the Matrix integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/mattermostCreate or update the Mattermost integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMattermost (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/mattermost-slash-commandsCreate or update the Mattermost Slash Commands integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMattermostSlashCommands (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost Slash Commands integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/projects/{id}/integrations/mattermost_slash_commands/triggerTrigger a slash command for mattermost-slash-commands

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdIntegrationsMattermostSlashCommandsTrigger (required)

Responses

Status	Description	Schema
`201`	Trigger a slash command for mattermost-slash-commands	—
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/integrations/microsoft-teamsCreate or update the Microsoft Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMicrosoftTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Microsoft Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/mock-ciCreate or update the Mock Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMockCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/mock-monitoringCreate or update the Mock Monitoring integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsMockMonitoring (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Monitoring integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/packagistCreate or update the Packagist integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPackagist (required)

Responses

Status	Description	Schema
`200`	Create or update the Packagist integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/phorgeCreate or update the Phorge integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPhorge (required)

Responses

Status	Description	Schema
`200`	Create or update the Phorge integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/pipelines-emailCreate or update the Pipelines Email integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPipelinesEmail (required)

Responses

Status	Description	Schema
`200`	Create or update the Pipelines Email integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/pivotaltrackerCreate or update the Pivotaltracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPivotaltracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Pivotaltracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/pumbleCreate or update the Pumble integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPumble (required)

Responses

Status	Description	Schema
`200`	Create or update the Pumble integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/pushoverCreate or update the Pushover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsPushover (required)

Responses

Status	Description	Schema
`200`	Create or update the Pushover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/redmineCreate or update the Redmine integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsRedmine (required)

Responses

Status	Description	Schema
`200`	Create or update the Redmine integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/slackCreate or update the Slack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsSlack (required)

Responses

Status	Description	Schema
`200`	Create or update the Slack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/squash-tmCreate or update the Squash Tm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsSquashTm (required)

Responses

Status	Description	Schema
`200`	Create or update the Squash Tm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/teamcityCreate or update the Teamcity integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsTeamcity (required)

Responses

Status	Description	Schema
`200`	Create or update the Teamcity integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/telegramCreate or update the Telegram integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsTelegram (required)

Responses

Status	Description	Schema
`200`	Create or update the Telegram integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/unify-circuitCreate or update the Unify Circuit integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsUnifyCircuit (required)

Responses

Status	Description	Schema
`200`	Create or update the Unify Circuit integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/webex-teamsCreate or update the Webex Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsWebexTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Webex Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/youtrackCreate or update the Youtrack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsYoutrack (required)

Responses

Status	Description	Schema
`200`	Create or update the Youtrack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/integrations/zentaoCreate or update the Zentao integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIntegrationsZentao (required)

Responses

Status	Description	Schema
`200`	Create or update the Zentao integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/integrations/{slug}Retrieve integration settings

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve integration settings	`API_Entities_Integration`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/integrations/{slug}Disable an integration

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Disable an integration	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/servicesList all active integrations

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all active integrations	—
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/services/apple-app-storeCreate or update the Apple App Store integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesAppleAppStore (required)

Responses

Status	Description	Schema
`200`	Create or update the Apple App Store integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/asanaCreate or update the Asana integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesAsana (required)

Responses

Status	Description	Schema
`200`	Create or update the Asana integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/assemblaCreate or update the Assembla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesAssembla (required)

Responses

Status	Description	Schema
`200`	Create or update the Assembla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/bambooCreate or update the Bamboo integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesBamboo (required)

Responses

Status	Description	Schema
`200`	Create or update the Bamboo integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/bugzillaCreate or update the Bugzilla integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesBugzilla (required)

Responses

Status	Description	Schema
`200`	Create or update the Bugzilla integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/buildkiteCreate or update the Buildkite integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesBuildkite (required)

Responses

Status	Description	Schema
`200`	Create or update the Buildkite integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/campfireCreate or update the Campfire integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesCampfire (required)

Responses

Status	Description	Schema
`200`	Create or update the Campfire integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/clickupCreate or update the Clickup integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesClickup (required)

Responses

Status	Description	Schema
`200`	Create or update the Clickup integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/confluenceCreate or update the Confluence integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesConfluence (required)

Responses

Status	Description	Schema
`200`	Create or update the Confluence integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/custom-issue-trackerCreate or update the Custom Issue Tracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesCustomIssueTracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Custom Issue Tracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/datadogCreate or update the Datadog integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesDatadog (required)

Responses

Status	Description	Schema
`200`	Create or update the Datadog integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/diffblue-coverCreate or update the Diffblue Cover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesDiffblueCover (required)

Responses

Status	Description	Schema
`200`	Create or update the Diffblue Cover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/discordCreate or update the Discord integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesDiscord (required)

Responses

Status	Description	Schema
`200`	Create or update the Discord integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/drone-ciCreate or update the Drone Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesDroneCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Drone Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/emails-on-pushCreate or update the Emails On Push integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesEmailsOnPush (required)

Responses

Status	Description	Schema
`200`	Create or update the Emails On Push integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/ewmCreate or update the Ewm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesEwm (required)

Responses

Status	Description	Schema
`200`	Create or update the Ewm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/external-wikiCreate or update the External Wiki integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesExternalWiki (required)

Responses

Status	Description	Schema
`200`	Create or update the External Wiki integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/git-guardianCreate or update the Git Guardian integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGitGuardian (required)

Responses

Status	Description	Schema
`200`	Create or update the Git Guardian integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/githubCreate or update the Github integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGithub (required)

Responses

Status	Description	Schema
`200`	Create or update the Github integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/gitlab-slack-applicationCreate or update the Gitlab Slack Application integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGitlabSlackApplication (required)

Responses

Status	Description	Schema
`200`	Create or update the Gitlab Slack Application integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/google-cloud-platform-artifact-registryCreate or update the Google Cloud Platform Artifact Registry integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGoogleCloudPlatformArtifactRegistry (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Artifact Registry integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/google-cloud-platform-workload-identity-federationCreate or update the Google Cloud Platform Workload Identity Federation integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGoogleCloudPlatformWorkloadIdentityFederation (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Cloud Platform Workload Identity Federation integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/google-playCreate or update the Google Play integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesGooglePlay (required)

Responses

Status	Description	Schema
`200`	Create or update the Google Play integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/hangouts-chatCreate or update the Hangouts Chat integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesHangoutsChat (required)

Responses

Status	Description	Schema
`200`	Create or update the Hangouts Chat integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/harborCreate or update the Harbor integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesHarbor (required)

Responses

Status	Description	Schema
`200`	Create or update the Harbor integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/irkerCreate or update the Irker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesIrker (required)

Responses

Status	Description	Schema
`200`	Create or update the Irker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/jenkinsCreate or update the Jenkins integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesJenkins (required)

Responses

Status	Description	Schema
`200`	Create or update the Jenkins integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/jiraCreate or update the Jira integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesJira (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/jira-cloud-appCreate or update the Jira Cloud App integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesJiraCloudApp (required)

Responses

Status	Description	Schema
`200`	Create or update the Jira Cloud App integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/linearCreate or update the Linear integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesLinear (required)

Responses

Status	Description	Schema
`200`	Create or update the Linear integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/matrixCreate or update the Matrix integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMatrix (required)

Responses

Status	Description	Schema
`200`	Create or update the Matrix integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/mattermostCreate or update the Mattermost integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMattermost (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/mattermost-slash-commandsCreate or update the Mattermost Slash Commands integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMattermostSlashCommands (required)

Responses

Status	Description	Schema
`200`	Create or update the Mattermost Slash Commands integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/projects/{id}/services/mattermost_slash_commands/triggerTrigger a slash command for mattermost-slash-commands

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdServicesMattermostSlashCommandsTrigger (required)

Responses

Status	Description	Schema
`201`	Trigger a slash command for mattermost-slash-commands	—
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/services/microsoft-teamsCreate or update the Microsoft Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMicrosoftTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Microsoft Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/mock-ciCreate or update the Mock Ci integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMockCi (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Ci integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/mock-monitoringCreate or update the Mock Monitoring integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesMockMonitoring (required)

Responses

Status	Description	Schema
`200`	Create or update the Mock Monitoring integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/packagistCreate or update the Packagist integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPackagist (required)

Responses

Status	Description	Schema
`200`	Create or update the Packagist integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/phorgeCreate or update the Phorge integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPhorge (required)

Responses

Status	Description	Schema
`200`	Create or update the Phorge integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/pipelines-emailCreate or update the Pipelines Email integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPipelinesEmail (required)

Responses

Status	Description	Schema
`200`	Create or update the Pipelines Email integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/pivotaltrackerCreate or update the Pivotaltracker integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPivotaltracker (required)

Responses

Status	Description	Schema
`200`	Create or update the Pivotaltracker integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/pumbleCreate or update the Pumble integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPumble (required)

Responses

Status	Description	Schema
`200`	Create or update the Pumble integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/pushoverCreate or update the Pushover integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesPushover (required)

Responses

Status	Description	Schema
`200`	Create or update the Pushover integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/redmineCreate or update the Redmine integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesRedmine (required)

Responses

Status	Description	Schema
`200`	Create or update the Redmine integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/slackCreate or update the Slack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesSlack (required)

Responses

Status	Description	Schema
`200`	Create or update the Slack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/squash-tmCreate or update the Squash Tm integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesSquashTm (required)

Responses

Status	Description	Schema
`200`	Create or update the Squash Tm integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/teamcityCreate or update the Teamcity integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesTeamcity (required)

Responses

Status	Description	Schema
`200`	Create or update the Teamcity integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/telegramCreate or update the Telegram integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesTelegram (required)

Responses

Status	Description	Schema
`200`	Create or update the Telegram integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/unify-circuitCreate or update the Unify Circuit integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesUnifyCircuit (required)

Responses

Status	Description	Schema
`200`	Create or update the Unify Circuit integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/webex-teamsCreate or update the Webex Teams integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesWebexTeams (required)

Responses

Status	Description	Schema
`200`	Create or update the Webex Teams integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/youtrackCreate or update the Youtrack integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesYoutrack (required)

Responses

Status	Description	Schema
`200`	Create or update the Youtrack integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

PUT/api/v4/projects/{id}/services/zentaoCreate or update the Zentao integration

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdServicesZentao (required)

Responses

Status	Description	Schema
`200`	Create or update the Zentao integration	`API_Entities_IntegrationBasic`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/services/{slug}Retrieve integration settings

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve integration settings	`API_Entities_Integration`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/services/{slug}Disable an integration

Parameters

Name	In	Required	Type
`slug`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Disable an integration	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/slack/triggerTrigger a global slack command

Request body

application/json — postApiV4SlackTrigger (required)

Responses

Status	Description	Schema
`201`	Trigger a global slack command	—
`401`	Unauthorized	—

jira_connect_subscriptions1

Operations related to JiraConnect subscriptions

POST/api/v4/integrations/jira_connect/subscriptionsSubscribe a namespace to a JiraConnectInstallation

Request body

application/json — postApiV4IntegrationsJiraConnectSubscriptions (required)

Responses

Status	Description	Schema
`201`	Subscribe a namespace to a JiraConnectInstallation	`API_Entities_BasicSuccess`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

merge_requests31

Operations related to merge requests

GET/api/v4/groups/{id}/merge_requestsList all group merge requests

Parameters

Name	In	Required	Type
`id`	path	yes	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`reviewer_username`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`my_reaction_emoji`	query	no	string
`reviewer_id`	query	no	integer
`state`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`with_labels_details`	query	no	boolean
`with_merge_status_recheck`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`view`	query	no	string
`scope`	query	no	string
`source_branch`	query	no	string
`source_project_id`	query	no	integer
`target_branch`	query	no	string
`search`	query	no	string
`in`	query	no	string
`wip`	query	no	string
`draft`	query	no	boolean
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[reviewer_username]`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[my_reaction_emoji]`	query	no	string
`not[reviewer_id]`	query	no	integer
`deployed_before`	query	no	string
`deployed_after`	query	no	string
`environment`	query	no	string
`merge_user_id`	query	no	integer
`merge_user_username`	query	no	string
`approver_ids`	query	no	string
`approved_by_ids`	query	no	string
`approved_by_usernames`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`non_archived`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all group merge requests	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

GET/api/v4/merge_requestsList all merge requests

Parameters

Name	In	Required	Type
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`reviewer_username`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`my_reaction_emoji`	query	no	string
`reviewer_id`	query	no	integer
`state`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`with_labels_details`	query	no	boolean
`with_merge_status_recheck`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`view`	query	no	string
`scope`	query	no	string
`source_branch`	query	no	string
`source_project_id`	query	no	integer
`target_branch`	query	no	string
`search`	query	no	string
`in`	query	no	string
`wip`	query	no	string
`draft`	query	no	boolean
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[reviewer_username]`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[my_reaction_emoji]`	query	no	string
`not[reviewer_id]`	query	no	integer
`deployed_before`	query	no	string
`deployed_after`	query	no	string
`environment`	query	no	string
`merge_user_id`	query	no	integer
`merge_user_username`	query	no	string
`approver_ids`	query	no	string
`approved_by_ids`	query	no	string
`approved_by_usernames`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`non_archived`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all merge requests	—
`401`	Unauthorized	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/merge_requestsList all project merge requests

Parameters

Name	In	Required	Type
`id`	path	yes	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`reviewer_username`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`my_reaction_emoji`	query	no	string
`reviewer_id`	query	no	integer
`state`	query	no	string
`order_by`	query	no	string
`sort`	query	no	string
`with_labels_details`	query	no	boolean
`with_merge_status_recheck`	query	no	boolean
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`view`	query	no	string
`scope`	query	no	string
`source_branch`	query	no	string
`source_project_id`	query	no	integer
`target_branch`	query	no	string
`search`	query	no	string
`in`	query	no	string
`wip`	query	no	string
`draft`	query	no	boolean
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[reviewer_username]`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[my_reaction_emoji]`	query	no	string
`not[reviewer_id]`	query	no	integer
`deployed_before`	query	no	string
`deployed_after`	query	no	string
`environment`	query	no	string
`merge_user_id`	query	no	integer
`merge_user_username`	query	no	string
`approver_ids`	query	no	string
`approved_by_ids`	query	no	string
`approved_by_usernames`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`iids`	query	no	array

Responses

Status	Description	Schema
`200`	List all project merge requests	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/projects/{id}/merge_requestsCreate a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdMergeRequests (required)

Responses

Status	Description	Schema
`201`	Create a merge request	`API_Entities_MergeRequest`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}Retrieve a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`render_html`	query	no	boolean
`include_diverged_commits_count`	query	no	boolean
`include_rebase_in_progress`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a merge request	`API_Entities_MergeRequest`
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}Update a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdMergeRequestsMergeRequestIid (required)

Responses

Status	Description	Schema
`200`	Update a merge request	`API_Entities_MergeRequest`
`400`	Bad request	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable entity	—

DELETE/api/v4/projects/{id}/merge_requests/{merge_request_iid}Delete a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a merge request	—
`401`	Unauthorized	—
`404`	Not found	—
`412`	Precondition failed	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/add_spent_timeAdd spent time for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidAddSpentTime (required)

Responses

Status	Description	Schema
`201`	Add spent time for a merge request	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/cancel_merge_when_pipeline_succeedsCancel merge when pipeline succeeds

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Cancel merge when pipeline succeeds	`API_Entities_MergeRequest`
`401`	Unauthorized	—
`404`	Not found	—
`405`	Method not allowed	—
`406`	Not acceptable	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/changesRetrieve merge request changes

Parameters

Name	In	Required	Type
`id`	path	yes	string
`unidiff`	query	no	boolean
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request changes	`API_Entities_MergeRequestChanges`
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/closes_issuesList all issues that close on merge

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all issues that close on merge	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/commitsRetrieve merge request commits

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request commits	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commitsList all context commits for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all context commits for a merge request	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commitsCreate context commits for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidContextCommits (required)

Responses

Status	Description	Schema
`201`	Create context commits for a merge request	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commitsDelete context commits from a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`commits`	query	yes	array
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete context commits from a merge request	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/diffsList all merge request diffs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer
`unidiff`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all merge request diffs	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}/mergeMerge a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdMergeRequestsMergeRequestIidMerge (required)

Responses

Status	Description	Schema
`200`	Merge a merge request	`API_Entities_MergeRequest`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`405`	Method not allowed	—
`409`	Conflict	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/merge_refMerge to default merge ref path

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Merge to default merge ref path	—
`400`	Bad request	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/participantsRetrieve merge request participants

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request participants	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelinesList all merge request pipelines

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all merge request pipelines	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelinesCreate a merge request pipeline

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidPipelines (required)

Responses

Status	Description	Schema
`201`	Create a merge request pipeline	`API_Entities_Ci_Pipeline`
`400`	Bad request	—
`404`	Not found	—
`405`	Method not allowed	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/raw_diffsRetrieve merge request raw diffs

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request raw diffs	—
`403`	Forbidden	—
`404`	Not found	—

PUT/api/v4/projects/{id}/merge_requests/{merge_request_iid}/rebaseRebase a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdMergeRequestsMergeRequestIidRebase (required)

Responses

Status	Description	Schema
`202`	Rebase a merge request	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/related_issuesList all issues related to the merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all issues related to the merge request	—
`403`	Forbidden	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_spent_timeReset spent time for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Reset spent time for a merge request	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_time_estimateReset the estimated time for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`201`	Reset the estimated time for a merge request	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/reviewersRetrieve merge request reviewers

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request reviewers	—
`404`	Not found	—

POST/api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_estimateSet the estimated time for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdMergeRequestsMergeRequestIidTimeEstimate (required)

Responses

Status	Description	Schema
`201`	Set the estimated time for a merge request	`API_Entities_IssuableTimeStats`
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_statsRetrieve time tracking stats for a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve time tracking stats for a merge request	`API_Entities_IssuableTimeStats`
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/versionsRetrieve merge request diff versions

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	Retrieve merge request diff versions	—

GET/api/v4/projects/{id}/merge_requests/{merge_request_iid}/versions/{version_id}Retrieve a merge request diff version

Parameters

Name	In	Required	Type
`id`	path	yes	string
`merge_request_iid`	path	yes	integer
`version_id`	path	yes	integer
`unidiff`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a merge request diff version	`API_Entities_MergeRequestDiffFull`

metadata2

Operations related to metadata of the GitLab instance

GET/api/v4/metadataRetrieve metadata information for this GitLab instance

Responses

Status	Description	Schema
`200`	Retrieve metadata information for this GitLab instance	`API_Entities_Metadata`
`401`	Unauthorized	—

GET/api/v4/versionRetrieves version information for the GitLab instance

Responses

Status	Description	Schema
`200`	Retrieves version information for the GitLab instance	`API_Entities_Metadata`
`401`	Unauthorized	—

ml_model_registry3

Operations related to Model registry

GET/api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/(*path/){file_name}Download an ml_model package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string
`path`	query	no	string
`status`	query	no	string
`model_version_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Download an ml_model package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/(*path/){file_name}Workhorse upload model package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string
`model_version_id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesMlModelsModelVersionIdFiles(*path)FileName (required)

Responses

Status	Description	Schema
`201`	Workhorse upload model package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/(*path/){file_name}/authorizeWorkhorse authorize model package file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`file_name`	path	yes	string
`model_version_id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdPackagesMlModelsModelVersionIdFiles(*path)FileNameAuthorize (required)

Responses

Status	Description	Schema
`200`	Workhorse authorize model package file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

plan_limits2

Operations related to plan limits

GET/api/v4/application/plan_limitsGet current plan limits

Parameters

Name	In	Required	Type
`plan_name`	query	no	string

Responses

Status	Description	Schema
`200`	Get current plan limits	`API_Entities_PlanLimit`
`401`	Unauthorized	—
`403`	Forbidden	—

PUT/api/v4/application/plan_limitsChange plan limits

Request body

application/json — putApiV4ApplicationPlanLimits (required)

Responses

Status	Description	Schema
`200`	Change plan limits	`API_Entities_PlanLimit`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—

project_import19

Operations related to importing projects

POST/api/v4/import/bitbucketImport repository from Bitbucket Cloud

Request body

application/json — postApiV4ImportBitbucket (required)

Responses

Status	Description	Schema
`201`	Import repository from Bitbucket Cloud	`ProjectImportEntity`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—
`503`	Service unavailable	—

POST/api/v4/import/bitbucket_serverImport repository from Bitbucket Server

Request body

application/json — postApiV4ImportBitbucketServer (required)

Responses

Status	Description	Schema
`201`	Import repository from Bitbucket Server	`ProjectEntity`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—
`503`	Service unavailable	—

POST/api/v4/import/githubImport a repository from GitHub

Request body

application/json — postApiV4ImportGithub (required)

Responses

Status	Description	Schema
`201`	Import a repository from GitHub	`ProjectEntity`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`422`	Unprocessable entity	—
`503`	Service unavailable	—

POST/api/v4/import/github/cancelCancel a GitHub project import

Request body

application/json — postApiV4ImportGithubCancel (required)

Responses

Status	Description	Schema
`200`	Cancel a GitHub project import	`ProjectImportEntity`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/importImport a project from a local archive

Responses

Status	Description	Schema
`201`	Import a project from a local archive	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/import-relationImport project resources

Responses

Status	Description	Schema
`201`	Import project resources	`API_Entities_RelationImportTracker`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/import-relation/authorizeWorkhorse authorize the project relation import upload

Responses

Status	Description	Schema
`201`	Workhorse authorize the project relation import upload	—

POST/api/v4/projects/import/authorizeWorkhorse authorize the project import upload

Responses

Status	Description	Schema
`201`	Workhorse authorize the project import upload	—

POST/api/v4/projects/remote-importImport a project from a remote archive

Responses

Status	Description	Schema
`201`	Import a project from a remote archive	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`429`	Too many requests	—
`503`	Service unavailable	—

POST/api/v4/projects/remote-import-s3Import a project from an AWS S3 bucket

Responses

Status	Description	Schema
`201`	Import a project from an AWS S3 bucket	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`429`	Too many requests	—
`503`	Service unavailable	—

GET/api/v4/projects/{id}/exportRetrieve the status of a project export

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the status of a project export	`API_Entities_ProjectExportStatus`
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/{id}/exportExport a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdExport (required)

Responses

Status	Description	Schema
`202`	Export a project	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`429`	Too many requests	—
`503`	Service unavailable	—

GET/api/v4/projects/{id}/export/downloadDownload a project export

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Download a project export	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/{id}/export_relationsSchedule a relations export for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdExportRelations (required)

Responses

Status	Description	Schema
`202`	Schedule a relations export for a project	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/projects/{id}/export_relations/downloadDownload a relations export for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	yes	string
`batched`	query	no	boolean
`batch_number`	query	no	integer

Responses

Status	Description	Schema
`200`	Download a relations export for a project	—
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`500`	Internal Server Error	—
`503`	Service unavailable	—

GET/api/v4/projects/{id}/export_relations/statusRetrieve the status of an relations export for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve the status of an relations export for a project	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

GET/api/v4/projects/{id}/importRetrieve the status of a project import

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the status of a project import	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

POST/api/v4/projects/{id}/import/gitImport a project from a Git URL

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdImportGit (required)

Responses

Status	Description	Schema
`201`	Import a project from a Git URL	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable Entity	—

GET/api/v4/projects/{id}/relation-importsRetrieve the status of a project resource import

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the status of a project resource import	`API_Entities_ProjectImportStatus`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`503`	Service unavailable	—

projects70

Operations related to projects

GET/api/v4/projectsList all projects

Parameters

Name	In	Required	Type
`order_by`	query	no	string
`sort`	query	no	string
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`search_namespaces`	query	no	boolean
`owned`	query	no	boolean
`starred`	query	no	boolean
`imported`	query	no	boolean
`membership`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`with_programming_language`	query	no	string
`min_access_level`	query	no	integer
`id_after`	query	no	integer
`id_before`	query	no	integer
`last_activity_after`	query	no	string
`last_activity_before`	query	no	string
`repository_storage`	query	no	string
`topic`	query	no	array
`topic_id`	query	no	integer
`updated_before`	query	no	string
`updated_after`	query	no	string
`include_pending_delete`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`wiki_checksum_failed`	query	no	boolean
`repository_checksum_failed`	query	no	boolean
`include_hidden`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`simple`	query	no	boolean
`statistics`	query	no	boolean
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all projects	—
`400`	Bad request	—

POST/api/v4/projectsCreate a project

Request body

application/json — postApiV4Projects (required)

Responses

Status	Description	Schema
`201`	Create a project	`API_Entities_Project`
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/user/{user_id}Create a project for a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	integer

Request body

application/json — postApiV4ProjectsUserUserId (required)

Responses

Status	Description	Schema
`201`	Create a project for a user	`API_Entities_Project`
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}Retrieve a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`statistics`	query	no	boolean
`with_custom_attributes`	query	no	boolean
`license`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a project	`API_Entities_ProjectWithAccess`

PUT/api/v4/projects/{id}Update a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsId (required)

Responses

Status	Description	Schema
`200`	Update a project	`API_Entities_Project`
`400`	Bad request	—
`403`	Unauthenticated	—

DELETE/api/v4/projects/{id}Delete a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`202`	Delete a project	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/{id}/archiveArchive a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Archive a project	`API_Entities_Project`
`403`	Unauthenticated	—

GET/api/v4/projects/{id}/audit_eventsList all project audit events

Parameters

Name	In	Required	Type
`created_after`	query	no	string
`created_before`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all project audit events	—

GET/api/v4/projects/{id}/audit_events/{audit_event_id}Retrieve a project audit event

Parameters

Name	In	Required	Type
`audit_event_id`	path	yes	integer
`id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project audit event	`API_Entities_AuditEvent`

POST/api/v4/projects/{id}/create_ci_configCreate merge request for missing ci config in project

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Create merge request for missing ci config in project	`API_Entities_MergeRequest`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Unprocessable entity	—

POST/api/v4/projects/{id}/forkCreate a fork of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdFork (required)

Responses

Status	Description	Schema
`201`	Create a fork of a project	`API_Entities_Project`
`403`	Unauthenticated	—
`404`	Not found	—
`409`	Conflict	—

DELETE/api/v4/projects/{id}/forkDelete a fork relationship

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a fork relationship	—
`304`	Not modified	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/{id}/fork/{forked_from_id}Create a fork relationship

Parameters

Name	In	Required	Type
`id`	path	yes	string
`forked_from_id`	path	yes	string

Responses

Status	Description	Schema
`201`	Create a fork relationship	`API_Entities_Project`
`401`	Unauthorized	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/forksList all forks of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`order_by`	query	no	string
`sort`	query	no	string
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`search_namespaces`	query	no	boolean
`owned`	query	no	boolean
`starred`	query	no	boolean
`imported`	query	no	boolean
`membership`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`with_programming_language`	query	no	string
`min_access_level`	query	no	integer
`id_after`	query	no	integer
`id_before`	query	no	integer
`last_activity_after`	query	no	string
`last_activity_before`	query	no	string
`repository_storage`	query	no	string
`topic`	query	no	array
`topic_id`	query	no	integer
`updated_before`	query	no	string
`updated_after`	query	no	string
`include_pending_delete`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`wiki_checksum_failed`	query	no	boolean
`repository_checksum_failed`	query	no	boolean
`include_hidden`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`simple`	query	no	boolean
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all forks of a project	—

GET/api/v4/projects/{id}/groupsList all ancestor groups

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`skip_groups`	query	no	array
`with_shared`	query	no	boolean
`shared_visible_only`	query	no	boolean
`shared_min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all ancestor groups	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/{id}/housekeepingStart the housekeeping task for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdHousekeeping (required)

Responses

Status	Description	Schema
`201`	Start the housekeeping task for a project	—
`401`	Unauthorized	—
`403`	Unauthenticated	—
`409`	Conflict	—

POST/api/v4/projects/{id}/import_project_members/{project_id}Import members

Parameters

Name	In	Required	Type
`id`	path	yes	string
`project_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Import members	—
`403`	Unauthenticated	—
`404`	Project Not Found	—
`422`	Import failed	—

GET/api/v4/projects/{id}/invited_groupsList all invited groups in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`relation`	query	no	array
`search`	query	no	string
`min_access_level`	query	no	integer
`page`	query	no	integer
`per_page`	query	no	integer
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all invited groups in a project	—

GET/api/v4/projects/{id}/issuesList all project issues

Parameters

Name	In	Required	Type
`id`	path	yes	string
`with_labels_details`	query	no	boolean
`state`	query	no	string
`closed_by_id`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`due_date`	query	no	string
`issue_type`	query	no	string
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`cursor`	query	no	string

Responses

Status	Description	Schema
`200`	List all project issues	`API_Entities_Issue`

POST/api/v4/projects/{id}/issuesCreate an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdIssues (required)

Responses

Status	Description	Schema
`201`	Create an issue	`API_Entities_Issue`

GET/api/v4/projects/{id}/issues/{issue_iid}Retrieve a project issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a project issue	`API_Entities_Issue`

PUT/api/v4/projects/{id}/issues/{issue_iid}Update an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIssuesIssueIid (required)

Responses

Status	Description	Schema
`200`	Update an issue	`API_Entities_Issue`

DELETE/api/v4/projects/{id}/issues/{issue_iid}Delete an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an issue	—

POST/api/v4/projects/{id}/issues/{issue_iid}/cloneClone an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidClone (required)

Responses

Status	Description	Schema
`201`	Clone an issue	`API_Entities_Issue`

GET/api/v4/projects/{id}/issues/{issue_iid}/closed_byList all merge requests that close an issue on merge

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Responses

Status	Description	Schema
`200`	List all merge requests that close an issue on merge	`API_Entities_MergeRequestBasic`

POST/api/v4/projects/{id}/issues/{issue_iid}/moveMove an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — postApiV4ProjectsIdIssuesIssueIidMove (required)

Responses

Status	Description	Schema
`201`	Move an issue	`API_Entities_Issue`

PUT/api/v4/projects/{id}/issues/{issue_iid}/reorderUpdate the order of an issue

Parameters

Name	In	Required	Type
`id`	path	yes	string
`issue_iid`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdIssuesIssueIidReorder (required)

Responses

Status	Description	Schema
`200`	Update the order of an issue	`API_Entities_Issue`

GET/api/v4/projects/{id}/issues_statisticsRetrieve issues statistics for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`labels`	query	no	array
`milestone`	query	no	string
`milestone_id`	query	no	string
`iids`	query	no	array
`search`	query	no	string
`in`	query	no	string
`author_id`	query	no	integer
`author_username`	query	no	string
`assignee_id`	query	no	integer
`assignee_username`	query	no	array
`created_after`	query	no	string
`created_before`	query	no	string
`updated_after`	query	no	string
`updated_before`	query	no	string
`not[labels]`	query	no	array
`not[milestone]`	query	no	string
`not[milestone_id]`	query	no	string
`not[iids]`	query	no	array
`not[author_id]`	query	no	integer
`not[author_username]`	query	no	string
`not[assignee_id]`	query	no	integer
`not[assignee_username]`	query	no	array
`not[weight]`	query	no	integer
`not[iteration_id]`	query	no	integer
`not[iteration_title]`	query	no	string
`scope`	query	no	string
`my_reaction_emoji`	query	no	string
`confidential`	query	no	boolean
`weight`	query	no	integer
`epic_id`	query	no	integer
`health_status`	query	no	string
`iteration_id`	query	no	integer
`iteration_title`	query	no	string

Responses

Status	Description	Schema
`200`	Retrieve issues statistics for a project	—

GET/api/v4/projects/{id}/languagesRetrieve programming language usage information

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve programming language usage information	—
`404`	Not found	—

GET/api/v4/projects/{id}/packages/protection/rulesList all package protection rules

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all package protection rules	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/packages/protection/rulesCreate a package protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdPackagesProtectionRules (required)

Responses

Status	Description	Schema
`201`	Create a package protection rule	`API_Entities_Projects_Packages_Protection_Rule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

PATCH/api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id}Update a package protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_protection_rule_id`	path	yes	integer

Request body

application/json — patchApiV4ProjectsIdPackagesProtectionRulesPackageProtectionRuleId (required)

Responses

Status	Description	Schema
`200`	Update a package protection rule	`API_Entities_Projects_Packages_Protection_Rule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

DELETE/api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id}Delete a package protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`package_protection_rule_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

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

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Check pages access of this project	—
`403`	Unauthenticated	—

GET/api/v4/projects/{id}/registry/protection/repository/rulesList all container repository protection rules

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all container repository protection rules	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/registry/protection/repository/rulesCreate a container repository protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRegistryProtectionRepositoryRules (required)

Responses

Status	Description	Schema
`201`	Create a container repository protection rule	`API_Entities_Projects_ContainerRegistry_Protection_Rule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

PATCH/api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id}Update a container repository protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`protection_rule_id`	path	yes	integer

Request body

application/json — patchApiV4ProjectsIdRegistryProtectionRepositoryRulesProtectionRuleId (required)

Responses

Status	Description	Schema
`200`	Update a container repository protection rule	`API_Entities_Projects_ContainerRegistry_Protection_Rule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

DELETE/api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id}Delete a container repository protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`protection_rule_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

GET/api/v4/projects/{id}/registry/protection/tag/rulesList all container registry protection tag rules

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all container registry protection tag rules	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/registry/protection/tag/rulesCreate a container registry protection tag rule

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdRegistryProtectionTagRules (required)

Responses

Status	Description	Schema
`201`	Create a container registry protection tag rule	`API_Entities_Projects_ContainerRegistry_Protection_TagRule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

PATCH/api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id}Update a container registry protection tag rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`protection_rule_id`	path	yes	integer

Request body

application/json — patchApiV4ProjectsIdRegistryProtectionTagRulesProtectionRuleId (required)

Responses

Status	Description	Schema
`200`	Update a container registry protection tag rule	`API_Entities_Projects_ContainerRegistry_Protection_TagRule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

DELETE/api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id}Delete a container registry protection tag rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`protection_rule_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a container protection tag rule	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/repository_sizeStart a task to recalculate repository size for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Start a task to recalculate repository size for a project	—
`401`	Unauthorized	—
`403`	Unauthenticated	—

POST/api/v4/projects/{id}/restoreRestore a project marked for deletion

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Restore a project marked for deletion	`API_Entities_Project`

POST/api/v4/projects/{id}/shareShare a project with a group

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdShare (required)

Responses

Status	Description	Schema
`201`	Share a project with a group	`API_Entities_ProjectGroupLink`
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/share/{group_id}Delete a shared project link in a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`group_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete a shared project link in a group	—
`400`	Bad request	—
`404`	Not found	—

GET/api/v4/projects/{id}/share_locationsList all groups available to invite to a project

Parameters

Name	In	Required	Type
`id`	path	yes	integer
`search`	query	no	string

Responses

Status	Description	Schema
`200`	List all groups available to invite to a project	`API_Entities_Group`

POST/api/v4/projects/{id}/starStar a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Star a project	`API_Entities_Project`
`304`	Not modified	—
`403`	Unauthenticated	—

GET/api/v4/projects/{id}/starrersList all users who starred a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all users who starred a project	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/statisticsRetrieve the statistics of the last 30 days

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the statistics of the last 30 days	`API_Entities_ProjectDailyStatistics`
`401`	401 Unauthorized	—
`404`	404 Project Not Found	—

GET/api/v4/projects/{id}/storageRetrieve the path to repository storage

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Retrieve the path to repository storage	`API_Entities_ProjectRepositoryStorage`
`403`	Unauthenticated	—

GET/api/v4/projects/{id}/terraform/state_protection_rulesList all Terraform state protection rules for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	List all Terraform state protection rules for a project	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

POST/api/v4/projects/{id}/terraform/state_protection_rulesCreate a Terraform state protection rule for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdTerraformStateProtectionRules (required)

Responses

Status	Description	Schema
`201`	Create a Terraform state protection rule for a project	`API_Entities_Terraform_StateProtectionRule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

PATCH/api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id}Update a Terraform state protection rule for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`terraform_state_protection_rule_id`	path	yes	integer

Request body

application/json — patchApiV4ProjectsIdTerraformStateProtectionRulesTerraformStateProtectionRuleId (required)

Responses

Status	Description	Schema
`200`	Update a Terraform state protection rule for a project	`API_Entities_Terraform_StateProtectionRule`
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—
`422`	Unprocessable Entity	—

DELETE/api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id}Delete a Terraform state protection rule

Parameters

Name	In	Required	Type
`id`	path	yes	string
`terraform_state_protection_rule_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	204 No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

PUT/api/v4/projects/{id}/transferTransfer a project to another namespace

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — putApiV4ProjectsIdTransfer (required)

Responses

Status	Description	Schema
`200`	Transfer a project to another namespace	`API_Entities_Project`
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/transfer_locationsList all transferable namespaces for a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all transferable namespaces for a project	—
`403`	Unauthenticated	—

POST/api/v4/projects/{id}/unarchiveUnarchive a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Unarchive a project	`API_Entities_Project`
`403`	Unauthenticated	—

POST/api/v4/projects/{id}/unstarUnstar a project

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`201`	Unstar a project	`API_Entities_Project`
`304`	Not modified	—
`403`	Unauthenticated	—

GET/api/v4/projects/{id}/uploadsList all uploads

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all uploads	—
`403`	Unauthenticated	—
`404`	Not found	—

POST/api/v4/projects/{id}/uploadsCreate an upload

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdUploads (required)

Responses

Status	Description	Schema
`201`	Create an upload	`API_Entities_ProjectUpload`
`404`	Not found	—

POST/api/v4/projects/{id}/uploads/authorizeWorkhorse authorize the file upload

Parameters

Name	In	Required	Type
`id`	path	yes	string

Responses

Status	Description	Schema
`200`	Workhorse authorize the file upload	—
`404`	Not found	—

GET/api/v4/projects/{id}/uploads/{secret}/{filename}Download an uploaded file by secret and filename

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secret`	path	yes	string
`filename`	path	yes	string

Responses

Status	Description	Schema
`200`	Download an uploaded file by secret and filename	—
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/uploads/{secret}/{filename}Delete an uploaded file by secret and filename

Parameters

Name	In	Required	Type
`id`	path	yes	string
`secret`	path	yes	string
`filename`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete an uploaded file by secret and filename	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/uploads/{upload_id}Download an uploaded file by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`upload_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Download an uploaded file by ID	—
`403`	Unauthenticated	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/uploads/{upload_id}Delete an uploaded file by ID

Parameters

Name	In	Required	Type
`id`	path	yes	string
`upload_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Delete an uploaded file by ID	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/projects/{id}/usersList all members of a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`search`	query	no	string
`skip_users`	query	no	array
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all members of a project	—
`403`	Unauthenticated	—
`404`	Not found	—

GET/api/v4/users/{user_id}/contributed_projectsList all projects contributions for a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string
`order_by`	query	no	string
`sort`	query	no	string
`page`	query	no	integer
`per_page`	query	no	integer
`simple`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all projects contributions for a user	—
`404`	404 User Not Found	—

GET/api/v4/users/{user_id}/projectsList all personal projects for a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string
`order_by`	query	no	string
`sort`	query	no	string
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`search_namespaces`	query	no	boolean
`owned`	query	no	boolean
`starred`	query	no	boolean
`imported`	query	no	boolean
`membership`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`with_programming_language`	query	no	string
`min_access_level`	query	no	integer
`id_after`	query	no	integer
`id_before`	query	no	integer
`last_activity_after`	query	no	string
`last_activity_before`	query	no	string
`repository_storage`	query	no	string
`topic`	query	no	array
`topic_id`	query	no	integer
`updated_before`	query	no	string
`updated_after`	query	no	string
`include_pending_delete`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`wiki_checksum_failed`	query	no	boolean
`repository_checksum_failed`	query	no	boolean
`include_hidden`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`simple`	query	no	boolean
`statistics`	query	no	boolean
`with_custom_attributes`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all personal projects for a user	—
`404`	404 User Not Found	—

GET/api/v4/users/{user_id}/starred_projectsList all projects starred by a user

Parameters

Name	In	Required	Type
`user_id`	path	yes	string
`order_by`	query	no	string
`sort`	query	no	string
`archived`	query	no	boolean
`visibility`	query	no	string
`search`	query	no	string
`search_namespaces`	query	no	boolean
`owned`	query	no	boolean
`starred`	query	no	boolean
`imported`	query	no	boolean
`membership`	query	no	boolean
`with_issues_enabled`	query	no	boolean
`with_merge_requests_enabled`	query	no	boolean
`with_programming_language`	query	no	string
`min_access_level`	query	no	integer
`id_after`	query	no	integer
`id_before`	query	no	integer
`last_activity_after`	query	no	string
`last_activity_before`	query	no	string
`repository_storage`	query	no	string
`topic`	query	no	array
`topic_id`	query	no	integer
`updated_before`	query	no	string
`updated_after`	query	no	string
`include_pending_delete`	query	no	boolean
`marked_for_deletion_on`	query	no	string
`active`	query	no	boolean
`wiki_checksum_failed`	query	no	boolean
`repository_checksum_failed`	query	no	boolean
`include_hidden`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer
`simple`	query	no	boolean
`statistics`	query	no	boolean

Responses

Status	Description	Schema
`200`	List all projects starred by a user	—
`404`	404 User Not Found	—

releases14

Operations related to releases

GET/api/v4/groups/{id}/releasesList all releases in a group

Parameters

Name	In	Required	Type
`id`	path	yes	string
`sort`	query	no	string
`simple`	query	no	boolean
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all releases in a group	—
`400`	Bad request	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/releasesList all releases in a project

Parameters

Name	In	Required	Type
`id`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer
`order_by`	query	no	string
`sort`	query	no	string
`include_html_description`	query	no	boolean
`updated_before`	query	no	string
`updated_after`	query	no	string

Responses

Status	Description	Schema
`200`	List all releases in a project	—

POST/api/v4/projects/{id}/releasesCreate a release

Parameters

Name	In	Required	Type
`id`	path	yes	string

Request body

application/json — postApiV4ProjectsIdReleases (required)

Responses

Status	Description	Schema
`201`	Create a release	`API_Entities_Release`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable entity	—

GET/api/v4/projects/{id}/releases/permalink/latest(/)(*suffix_path)Get the latest project release

Parameters

Name	In	Required	Type
`id`	path	yes	string
`suffix_path`	query	yes	string

Responses

Status	Description	Schema
`200`	Get the latest project release	—
`401`	Unauthorized	—
`404`	Not found	—

GET/api/v4/projects/{id}/releases/{tag_name}Retrieve a release by tag name

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`include_html_description`	query	no	boolean

Responses

Status	Description	Schema
`200`	Retrieve a release by tag name	`API_Entities_Release`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/releases/{tag_name}Update a release

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Request body

application/json — putApiV4ProjectsIdReleasesTagName (required)

Responses

Status	Description	Schema
`200`	Update a release	`API_Entities_Release`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

DELETE/api/v4/projects/{id}/releases/{tag_name}Delete a release

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Responses

Status	Description	Schema
`204`	Delete a release	`API_Entities_Release`
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

GET/api/v4/projects/{id}/releases/{tag_name}/assets/linksList all release links

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`page`	query	no	integer
`per_page`	query	no	integer

Responses

Status	Description	Schema
`200`	List all release links	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/releases/{tag_name}/assets/linksCreate a release link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string

Request body

application/json — postApiV4ProjectsIdReleasesTagNameAssetsLinks (required)

Responses

Status	Description	Schema
`201`	Create a release link	`API_Entities_Releases_Link`
`400`	Bad request	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id}Retrieve a release link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`link_id`	path	yes	integer

Responses

Status	Description	Schema
`200`	Retrieve a release link	`API_Entities_Releases_Link`
`401`	Unauthorized	—
`404`	Not found	—

PUT/api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id}Update a release link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`link_id`	path	yes	integer

Request body

application/json — putApiV4ProjectsIdReleasesTagNameAssetsLinksLinkId (required)

Responses

Status	Description	Schema
`200`	Update a release link	`API_Entities_Releases_Link`
`400`	Bad request	—
`401`	Unauthorized	—

DELETE/api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id}Delete a release link

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`link_id`	path	yes	integer

Responses

Status	Description	Schema
`204`	Bad request	—
`401`	Unauthorized	—

GET/api/v4/projects/{id}/releases/{tag_name}/downloads/*direct_asset_pathDownload a project release asset file

Parameters

Name	In	Required	Type
`id`	path	yes	string
`tag_name`	path	yes	string
`direct_asset_path`	query	yes	string

Responses

Status	Description	Schema
`200`	Download a project release asset file	—
`401`	Unauthorized	—
`404`	Not found	—

POST/api/v4/projects/{id}/releases/{tag_name}/evidenceGenerate release evidence

Parameters

Name	In	Required	Type
`tag_name`	path	yes	string
`id`	path	yes	integer

Responses

Status	Description	Schema
`201`	Generate release evidence	`API_Entities_Release`
`401`	Unauthorized	—
`404`	Not found	—

suggestions2

Operations related to suggestions

PUT/api/v4/suggestions/batch_applyApply multiple suggestions to a merge request

Request body

application/json — putApiV4SuggestionsBatchApply (required)

Responses

Status	Description	Schema
`200`	Apply multiple suggestions to a merge request	`API_Entities_Suggestion`

PUT/api/v4/suggestions/{id}/applyApply a suggestion to a merge request

Parameters

Name	In	Required	Type
`id`	path	yes	integer

Request body

application/json — putApiV4SuggestionsIdApply (required)

Responses

Status	Description	Schema
`200`	Apply a suggestion to a merge request	`API_Entities_Suggestion`

Try it

Operation

API key

Developer reference

Base URLhttps://gitlab.com

Rate limit

GitLab.com's own published limits (quoting docs.gitlab.com/user/gitlab_com/ verbatim): authenticated API traffic for a user is capped at 2,000 requests/minute, unauthenticated traffic from an IP address at 500 requests/minute, with lower endpoint-specific ceilings for a few routes (e.g. 10 requests/minute for the search API, 200/minute for issue creation).

Key endpoints

GET/api/v4/projects/{id}
GET/api/v4/projects/{id}/merge_requests
POST/api/v4/projects/{id}/merge_requests
GET/api/v4/projects/{id}/repository/commits
GET/api/v4/projects/{id}/issues

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing Gitlab also look at…

Kroki

QR code

Statically

Wandbox

APIs.guru

Beeceptor