{ "opencollection": "1.0.0", "info": { "name": "GitLab API", "version": "v4" }, "items": [ { "info": { "name": "access_requests", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of access requests for a group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/access_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Requests access for the authenticated user to a group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/access_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Approves an access request for the given user.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/access_requests/:user_id/approve", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the access requester" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Denies an access request for the given user.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/access_requests/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the access requester" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Gets a list of access requests for a project.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/access_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Requests access for the authenticated user to a project.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/access_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Approves an access request for the given user.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/access_requests/:user_id/approve", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the access requester" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Denies an access request for the given user.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/access_requests/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the access requester" } ] }, "docs": "This feature was introduced in GitLab 8.11." } ] }, { "info": { "name": "award_emoji", "type": "folder" }, "items": [ { "info": { "name": "List an awardable's emoji reactions for groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "epic_iid", "value": "", "type": "path", "description": "ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/epics/:epic_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "epic_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "issue_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" }, { "info": { "name": "List an awardable's emoji reactions for projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Add a new emoji reaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Add an emoji reaction on the specified awardable. This feature was introduced in 8.9" }, { "info": { "name": "Get a single emoji reaction", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of the emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9" }, { "info": { "name": "Delete an emoji reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/notes/:note_id/award_emoji/:award_id", "params": [ { "name": "award_id", "value": "", "type": "path", "description": "ID of an emoji reaction." }, { "name": "id", "value": "", "type": "path" }, { "name": "snippet_id", "value": "", "type": "path" }, { "name": "note_id", "value": "", "type": "path" } ] }, "docs": "Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9" } ] }, { "info": { "name": "badges", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of group badges viewable by the authenticated user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/badges", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "name", "value": "", "type": "query", "description": "Name for the badge" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Adds a badge to a group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/badges", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Preview a badge from a group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/badges/render", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "link_url", "value": "", "type": "query", "description": "URL of the badge link" }, { "name": "image_url", "value": "", "type": "query", "description": "URL of the badge image" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Gets a badge of a group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Updates a badge of a group.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Removes a badge from the group.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Gets a list of project badges viewable by the authenticated user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/badges", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "name", "value": "", "type": "query", "description": "Name for the badge" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Adds a badge to a project.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/badges", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Preview a badge from a project.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/badges/render", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "link_url", "value": "", "type": "query", "description": "URL of the badge link" }, { "name": "image_url", "value": "", "type": "query", "description": "URL of the badge image" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Gets a badge of a project.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Updates a badge of a project.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Removes a badge from the project.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/badges/:badge_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user." }, { "name": "badge_id", "value": "", "type": "path", "description": "The badge ID" } ] }, "docs": "This feature was introduced in GitLab 10.6." } ] }, { "info": { "name": "custom_attributes", "type": "folder" }, "items": [ { "info": { "name": "getApiV4GroupsIdCustomAttributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/custom_attributes", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get all custom attributes on a group" }, { "info": { "name": "getApiV4GroupsIdCustomAttributesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a custom attribute on a group" }, { "info": { "name": "putApiV4GroupsIdCustomAttributesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set a custom attribute on a group" }, { "info": { "name": "deleteApiV4GroupsIdCustomAttributesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a custom attribute on a group" }, { "info": { "name": "getApiV4ProjectsIdCustomAttributes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/custom_attributes", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get all custom attributes on a project" }, { "info": { "name": "getApiV4ProjectsIdCustomAttributesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a custom attribute on a project" }, { "info": { "name": "putApiV4ProjectsIdCustomAttributesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set a custom attribute on a project" }, { "info": { "name": "deleteApiV4ProjectsIdCustomAttributesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/custom_attributes/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of the custom attribute" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a custom attribute on a project" } ] }, { "info": { "name": "groups", "type": "folder" }, "items": [ { "info": { "name": "getApiV4Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups", "params": [ { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "skip_groups", "value": "", "type": "query", "description": "Array of group ids to exclude from list" }, { "name": "all_available", "value": "", "type": "query", "description": "When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member." }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by name, path, id or similarity if searching" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by asc (ascending) or desc (descending)" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Minimum access level of authenticated user" }, { "name": "top_level_only", "value": "", "type": "query", "description": "Only include top-level groups" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Return groups that are marked for deletion on this date" }, { "name": "active", "value": "", "type": "query", "description": "Limit by groups that are not archived and not marked for deletion" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Filter by repository storage used by the group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a groups list" }, { "info": { "name": "postApiV4Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups" }, "docs": "Create a group. Available only for users who can create groups." }, { "info": { "name": "getApiV4GroupsId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" }, { "name": "with_projects", "value": "", "type": "query", "description": "Omit project details" } ] }, "docs": "Get a single group, with containing projects." }, { "info": { "name": "putApiV4GroupsId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Update a group. Available only for users who can administrate groups." }, { "info": { "name": "deleteApiV4GroupsId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Remove a group." }, { "info": { "name": "postApiV4GroupsIdArchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/archive", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Archive a group" }, { "info": { "name": "postApiV4GroupsIdUnarchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/unarchive", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Unarchive a group" }, { "info": { "name": "postApiV4GroupsIdRestore", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/restore", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Restore a group." }, { "info": { "name": "getApiV4GroupsIdGroupsShared", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/groups/shared", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "skip_groups", "value": "", "type": "query", "description": "Array of group ids to exclude from list" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Minimum access level of authenticated user" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by name, path, id or similarity if searching" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by asc (ascending) or desc (descending)" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of shared groups this group was invited to" }, { "info": { "name": "getApiV4GroupsIdInvitedGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/invited_groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "relation", "value": "", "type": "query", "description": "Include group relations" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Minimum access level of authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of invited groups in this group" }, { "info": { "name": "getApiV4GroupsIdProjects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/projects", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "active", "value": "", "type": "query", "description": "Limit by projects that are not archived and not marked for deletion" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of authorized projects matching the search criteria" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field" }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "with_shared", "value": "", "type": "query", "description": "Include projects shared to this group" }, { "name": "include_subgroups", "value": "", "type": "query", "description": "Includes projects in subgroups of this group" }, { "name": "include_ancestor_groups", "value": "", "type": "query", "description": "Includes projects in ancestors of this group" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user on projects" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" }, { "name": "with_security_reports", "value": "", "type": "query", "description": "Return only projects having security report artifacts present" } ] }, "docs": "Get a list of projects in this group." }, { "info": { "name": "getApiV4GroupsIdProjectsShared", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/projects/shared", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of authorized projects matching the search criteria" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field" }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user on projects" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of shared projects in this group" }, { "info": { "name": "getApiV4GroupsIdSubgroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/subgroups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "skip_groups", "value": "", "type": "query", "description": "Array of group ids to exclude from list" }, { "name": "all_available", "value": "", "type": "query", "description": "When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member." }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by name, path, id or similarity if searching" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by asc (ascending) or desc (descending)" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Minimum access level of authenticated user" }, { "name": "top_level_only", "value": "", "type": "query", "description": "Only include top-level groups" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Return groups that are marked for deletion on this date" }, { "name": "active", "value": "", "type": "query", "description": "Limit by groups that are not archived and not marked for deletion" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Filter by repository storage used by the group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of subgroups in this group." }, { "info": { "name": "getApiV4GroupsIdDescendantGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/descendant_groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "skip_groups", "value": "", "type": "query", "description": "Array of group ids to exclude from list" }, { "name": "all_available", "value": "", "type": "query", "description": "When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member." }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by name, path, id or similarity if searching" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by asc (ascending) or desc (descending)" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Minimum access level of authenticated user" }, { "name": "top_level_only", "value": "", "type": "query", "description": "Only include top-level groups" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Return groups that are marked for deletion on this date" }, { "name": "active", "value": "", "type": "query", "description": "Limit by groups that are not archived and not marked for deletion" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Filter by repository storage used by the group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of descendant groups of this group." }, { "info": { "name": "postApiV4GroupsIdProjectsProjectId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/projects/:project_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "project_id", "value": "", "type": "path", "description": "The ID or path of the project" } ] }, "docs": "Transfer a project to the group namespace. Available only for admin." }, { "info": { "name": "getApiV4GroupsIdTransferLocations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/transfer_locations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "search", "value": "", "type": "query", "description": "Return list of namespaces matching the search criteria" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the groups to where the current group can be transferred to" }, { "info": { "name": "postApiV4GroupsIdTransfer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/transfer", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Transfer a group to a new parent group or promote a subgroup to a top-level group" }, { "info": { "name": "postApiV4GroupsIdTransferToOrganization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/transfer_to_organization", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Transfer a group to an organization" }, { "info": { "name": "postApiV4GroupsIdShare", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/share", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Share a group with a group" }, { "info": { "name": "deleteApiV4GroupsIdShareGroupId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/share/:group_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "group_id", "value": "", "type": "path", "description": "The ID of the shared group" } ] }, "docs": "Unshare a group with a group" }, { "info": { "name": "getApiV4GroupsIdAuditEventsAuditEventId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/audit_events/:audit_event_id", "params": [ { "name": "audit_event_id", "value": "", "type": "path", "description": "The ID of the audit event" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a specific audit event in this group." }, { "info": { "name": "getApiV4GroupsIdSamlUsers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/saml_users", "params": [ { "name": "username", "value": "", "type": "query", "description": "Return single user with a specific username." }, { "name": "search", "value": "", "type": "query", "description": "Search users by name, email, username." }, { "name": "active", "value": "", "type": "query", "description": "Return only active users." }, { "name": "blocked", "value": "", "type": "query", "description": "Return only blocked users." }, { "name": "created_after", "value": "", "type": "query", "description": "Return users created after the specified time." }, { "name": "created_before", "value": "", "type": "query", "description": "Return users created before the specified time." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of SAML users of the group" }, { "info": { "name": "getApiV4GroupsIdProvisionedUsers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/provisioned_users", "params": [ { "name": "username", "value": "", "type": "query", "description": "Return a single user with a specific username" }, { "name": "search", "value": "", "type": "query", "description": "Search users by name, email or username" }, { "name": "active", "value": "", "type": "query", "description": "Return only active users" }, { "name": "blocked", "value": "", "type": "query", "description": "Return only blocked users" }, { "name": "created_after", "value": "", "type": "query", "description": "Return users created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return users created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of users provisioned by the group" }, { "info": { "name": "Download the list of pending placeholder assignments for a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/placeholder_reassignments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Downloads a CSV file of pending placeholder assignments for a group.\n This feature was added in GitLab 17.10" }, { "info": { "name": "Upload placeholder reassignments CSV file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/placeholder_reassignments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Uploads a CSV file containing placeholder reassignments for a group" }, { "info": { "name": "Workhorse authorization for the reassignment CSV file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/placeholder_reassignments/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Authorizes Workhorse to handle CSV file uploads for placeholder reassignments.\n This feature was introduced in GitLab 17.10" }, { "info": { "name": "getApiV4GroupsIdIssues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/issues", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "with_labels_details", "value": "", "type": "query", "description": "Return titles of labels and other details" }, { "name": "state", "value": "", "type": "query", "description": "Return opened, closed, or all issues" }, { "name": "closed_by_id", "value": "", "type": "query", "description": "Return issues which were closed by the user with the given ID." }, { "name": "order_by", "value": "", "type": "query", "description": "Return issues ordered by `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, or `updated_at` fields." }, { "name": "sort", "value": "", "type": "query", "description": "Return issues sorted in `asc` or `desc` order." }, { "name": "due_date", "value": "", "type": "query", "description": "Return issues that have no due date (`0`), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, `0`" }, { "name": "issue_type", "value": "", "type": "query", "description": "The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket" }, { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "non_archived", "value": "", "type": "query", "description": "Return issues from non archived projects" } ] }, "docs": "Get a list of group issues" }, { "info": { "name": "getApiV4GroupsIdIssuesStatistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/issues_statistics", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" } ] }, "docs": "Get statistics for the list of group issues" }, { "info": { "name": "Workhorse authorize the file upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/uploads/authorize", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 19.0" }, { "info": { "name": "getApiV4GroupsIdUploads", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/uploads", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the list of uploads of a group" }, { "info": { "name": "Upload a file to a group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/uploads", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Uploads a file to the specified group. Returns a markdown-formatted link to the file." }, { "info": { "name": "getApiV4GroupsIdUploadsUploadId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/uploads/:upload_id", "params": [ { "name": "upload_id", "value": "", "type": "path", "description": "The ID of a group upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Download a single group upload by ID" }, { "info": { "name": "deleteApiV4GroupsIdUploadsUploadId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/uploads/:upload_id", "params": [ { "name": "upload_id", "value": "", "type": "path", "description": "The ID of a group upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a single group upload" }, { "info": { "name": "getApiV4GroupsIdUploadsSecretFilename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/uploads/:secret/:filename", "params": [ { "name": "secret", "value": "", "type": "path", "description": "The 32-character secret of a group upload" }, { "name": "filename", "value": "", "type": "path", "description": "The filename of a group upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Download a single group upload by secret and filename" }, { "info": { "name": "deleteApiV4GroupsIdUploadsSecretFilename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/uploads/:secret/:filename", "params": [ { "name": "secret", "value": "", "type": "path", "description": "The 32-character secret of a group upload" }, { "name": "filename", "value": "", "type": "path", "description": "The filename of a group upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a single group upload by secret and filename" }, { "info": { "name": "getApiV4GroupsIdBillableMembers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/billable_members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "search", "value": "", "type": "query", "description": "The exact name of the subscribed member" }, { "name": "sort", "value": "", "type": "query", "description": "The sorting option" } ] }, "docs": "Gets a list of billable users of top-level group." } ] }, { "info": { "name": "ldap", "type": "folder" }, "items": [ { "info": { "name": "postApiV4GroupsIdLdapSync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/ldap_sync", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Sync a group with LDAP." } ] }, { "info": { "name": "audit_events", "type": "folder" }, "items": [ { "info": { "name": "getApiV4GroupsIdAuditEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/audit_events", "params": [ { "name": "created_after", "value": "2016-01-19T09:05:50.355Z", "type": "query", "description": "Return audit events created after the specified time" }, { "name": "created_before", "value": "2016-01-19T09:05:50.355Z", "type": "query", "description": "Return audit events created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of audit events in this group." } ] }, { "info": { "name": "keys", "type": "folder" }, "items": [ { "info": { "name": "Get a list of Groups::SshCertificate for a Group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/ssh_certificates", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of ssh certificates created for a group." }, { "info": { "name": "Add a Groups::SshCertificate.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/ssh_certificates", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Create a ssh certificate for a group." }, { "info": { "name": "Removes an ssh certificate from a group.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/ssh_certificates/:ssh_certificates_id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "ssh_certificates_id", "value": "", "type": "path" } ] }, "docs": "Removes a Groups::SshCertificate" }, { "info": { "name": "Get single ssh key by id. Only available to admin users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/keys/:id", "params": [ { "name": "id", "value": "2", "type": "path", "description": "The ID of an SSH key" } ] }, "docs": "Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID\\\n of an SSH key" }, { "info": { "name": "Get user by fingerprint of SSH key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/keys", "params": [ { "name": "fingerprint", "value": "ba:81:59:68:d7:6c:cd:02:02:bf:6a:9b:55:4e:af:d1", "type": "query", "description": "The fingerprint of an SSH key" } ] }, "docs": "You can search for a user that owns a specific SSH key. Note only administrators can lookup SSH key\\\n with the fingerprint of an SSH key" } ] }, { "info": { "name": "runners", "type": "folder" }, "items": [ { "info": { "name": "List group's runners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/runners", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "type", "value": "", "type": "query", "description": "The type of runners to return" }, { "name": "paused", "value": "", "type": "query", "description": "Whether to include only runners that are accepting or ignoring new jobs" }, { "name": "status", "value": "", "type": "query", "description": "The status of runners to return" }, { "name": "tag_list", "value": "['macos', 'shell']", "type": "query", "description": "A list of runner tags" }, { "name": "version_prefix", "value": "'15.1.' or '16.'", "type": "query", "description": "The version prefix of runners to return" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List all runners available in the group as well as its ancestor groups, including any allowed shared runners." }, { "info": { "name": "Reset the runner registration token for a group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/runners/reset_registration_token", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Reset runner registration token" }, { "info": { "name": "List project's runners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/runners", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "scope", "value": "", "type": "query", "description": "Deprecated: Use `type` or `status` instead. The scope of runners to return" }, { "name": "type", "value": "", "type": "query", "description": "The type of runners to return" }, { "name": "paused", "value": "", "type": "query", "description": "Whether to include only runners that are accepting or ignoring new jobs" }, { "name": "status", "value": "", "type": "query", "description": "The status of runners to return" }, { "name": "tag_list", "value": "['macos', 'shell']", "type": "query", "description": "A list of runner tags" }, { "name": "version_prefix", "value": "'15.1.' or '16.'", "type": "query", "description": "The version prefix of runners to return" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List all runners available in the project, including from ancestor groups and any allowed shared runners." }, { "info": { "name": "Assign a runner to project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/runners", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Assign an available project runner to the project." }, { "info": { "name": "Unassign a project runner from the project", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/runners/:runner_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "runner_id", "value": "", "type": "path", "description": "The ID of a runner" } ] }, "docs": "It is not possible to unassign a runner from the owner project. If so, an error is returned. Use the call to delete a runner instead." }, { "info": { "name": "Reset the runner registration token for a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/runners/reset_registration_token", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" } ] }, "docs": "Reset runner registration token" }, { "info": { "name": "List available runners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners", "params": [ { "name": "scope", "value": "", "type": "query", "description": "Deprecated: Use `type` or `status` instead. The scope of runners to return" }, { "name": "type", "value": "", "type": "query", "description": "The type of runners to return" }, { "name": "paused", "value": "", "type": "query", "description": "Whether to include only runners that are accepting or ignoring new jobs" }, { "name": "status", "value": "", "type": "query", "description": "The status of runners to return" }, { "name": "tag_list", "value": "['macos', 'shell']", "type": "query", "description": "A list of runner tags" }, { "name": "version_prefix", "value": "'15.1.' or '16.'", "type": "query", "description": "The version prefix of runners to return" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get runners available for user" }, { "info": { "name": "List all runners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/all", "params": [ { "name": "scope", "value": "", "type": "query", "description": "Deprecated: Use `type` or `status` instead. The scope of runners to return" }, { "name": "type", "value": "", "type": "query", "description": "The type of runners to return" }, { "name": "paused", "value": "", "type": "query", "description": "Whether to include only runners that are accepting or ignoring new jobs" }, { "name": "status", "value": "", "type": "query", "description": "The status of runners to return" }, { "name": "tag_list", "value": "['macos', 'shell']", "type": "query", "description": "A list of runner tags" }, { "name": "version_prefix", "value": "'15.1.' or '16.'", "type": "query", "description": "The version prefix of runners to return" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all runners in the GitLab instance (shared and project). Access is restricted to users with either administrator access or auditor access." }, { "info": { "name": "Get runner's details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" }, { "name": "include_projects", "value": "", "type": "query", "description": "Include projects in the response. Set to false to improve performance for runners with many projects." } ] }, "docs": "At least the Maintainer role is required to get runner details at the project and group level. Instance-level runner details via this endpoint are available to all signed in users." }, { "info": { "name": "Update details of a runner", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/runners/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" } ] }, "docs": "Update runner's details" }, { "info": { "name": "Delete a runner", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/runners/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" } ] }, "docs": "Remove a runner" }, { "info": { "name": "getApiV4RunnersIdManagers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/:id/managers", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" } ] }, "docs": "Get a list of all runner's managers" }, { "info": { "name": "List runner's projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/:id/projects", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a paginated list of all projects associated with the specified runner. Access is restricted based on user permissions." }, { "info": { "name": "List runner's jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/:id/jobs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a runner" }, { "name": "system_id", "value": "", "type": "query", "description": "System ID associated with the runner manager" }, { "name": "status", "value": "", "type": "query", "description": "Status of the job" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by `id`" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by `asc` or `desc` order. Specify `order_by` as well, including for `id`" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for obtaining the next set of records" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List jobs that are being processed or were processed by the specified runner. The list of jobs is limited to projects where the user has at least the Reporter role." }, { "info": { "name": "Reset runner's authentication token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/runners/:id/reset_authentication_token", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the runner" } ] }, "docs": "Reset runner authentication token" }, { "info": { "name": "Reset instance's runner registration token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/runners/reset_registration_token" }, "docs": "Reset runner registration token" } ] }, { "info": { "name": "packages", "type": "folder" }, "items": [ { "info": { "name": "The Release file signature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/Release.gpg", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The unsigned Release file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/Release", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The signed Release file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/InRelease", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The installer (udeb) binary files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/Packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The installer (udeb) binary files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The source files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/source/Sources", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The source files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/source/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The binary files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/binary-:architecture/Packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The binary files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/dists/*distribution/:component/binary-:architecture/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "Download Debian package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/debian/pool/:distribution/:project_id/:letter/:package_name/:package_version/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "project_id", "value": "", "type": "path", "description": "The Project Id" }, { "name": "distribution", "value": "my-distro", "type": "path", "description": "The Debian Codename or Suite" }, { "name": "letter", "value": "a", "type": "path", "description": "The Debian Classification (first-letter or lib-first-letter)" }, { "name": "package_name", "value": "my-pkg", "type": "path", "description": "The Debian Source Package Name" }, { "name": "package_version", "value": "1.0.0", "type": "path", "description": "The Debian Source Package Version" }, { "name": "file_name", "value": "example_1.0.0~alpha2_amd64.deb", "type": "path", "description": "The Debian File Name" } ] }, "docs": "This feature was introduced in GitLab 14.2" }, { "info": { "name": "Get a list of Debian Distributions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "codename", "value": "sid", "type": "query", "description": "The Debian Codename" }, { "name": "suite", "value": "unstable", "type": "query", "description": "The Debian Suite" }, { "name": "origin", "value": "Grep", "type": "query", "description": "The Debian Origin" }, { "name": "label", "value": "grep.be", "type": "query", "description": "The Debian Label" }, { "name": "version", "value": "12", "type": "query", "description": "The Debian Version" }, { "name": "description", "value": "My description", "type": "query", "description": "The Debian Description" }, { "name": "valid_time_duration_seconds", "value": "604800", "type": "query", "description": "The duration before the Release file should be considered expired by the client" }, { "name": "components", "value": "main", "type": "query", "description": "The list of Components" }, { "name": "architectures", "value": "amd64", "type": "query", "description": "The list of Architectures" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Create a Debian Distribution", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Get a Debian Distribution", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Update a Debian Distribution", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Delete a Debian Distribution", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" }, { "name": "suite", "value": "unstable", "type": "query", "description": "The Debian Suite" }, { "name": "origin", "value": "Grep", "type": "query", "description": "The Debian Origin" }, { "name": "label", "value": "grep.be", "type": "query", "description": "The Debian Label" }, { "name": "version", "value": "12", "type": "query", "description": "The Debian Version" }, { "name": "description", "value": "My description", "type": "query", "description": "The Debian Description" }, { "name": "valid_time_duration_seconds", "value": "604800", "type": "query", "description": "The duration before the Release file should be considered expired by the client" }, { "name": "components", "value": "main", "type": "query", "description": "The list of Components" }, { "name": "architectures", "value": "amd64", "type": "query", "description": "The list of Architectures" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Get a Debian Distribution Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/debian_distributions/:codename/key.asc", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.4" }, { "info": { "name": "List packages within a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the group" }, { "name": "exclude_subgroups", "value": "", "type": "query", "description": "Determines if subgroups should be excluded" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "order_by", "value": "", "type": "query", "description": "Return packages ordered by `created_at`, `name`, `version` or `type` fields." }, { "name": "sort", "value": "", "type": "query", "description": "Return packages sorted in `asc` or `desc` order." }, { "name": "package_type", "value": "", "type": "query", "description": "Return packages of a certain type" }, { "name": "package_name", "value": "", "type": "query", "description": "Return packages with this name" }, { "name": "package_version", "value": "", "type": "query", "description": "Return packages with this version" }, { "name": "include_versionless", "value": "", "type": "query", "description": "Returns packages without a version" }, { "name": "status", "value": "", "type": "query", "description": "Return packages with specified status" } ] }, "docs": "Get a list of project packages at the group level. This feature was introduced in GitLab 12.5" }, { "info": { "name": "Download the maven package file at a group level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/maven/*path/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "path", "value": "foo/bar/mypkg/1.0-SNAPSHOT", "type": "query", "description": "Package path" }, { "name": "file_name", "value": "mypkg-1.0-SNAPSHOT.jar", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.7" }, { "info": { "name": "Get all tags for a given an NPM package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "package_name", "value": "", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Create or Update the given tag for the given NPM package and version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Deletes the given tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "package_name", "value": "", "type": "query", "description": "Package name" }, { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "NPM registry bulk advisory endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/-/npm/v1/security/advisories/bulk", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" } ] }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "NPM registry quick audit endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/-/npm/v1/security/audits/quick", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" } ] }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "NPM registry metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/npm/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "package_name", "value": "mypackage", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 11.8" }, { "info": { "name": "The NuGet V3 Feed Service Index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/index", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "The NuGet Symbol File Download Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/symbolfiles/*file_name/*signature/*same_file_name", "headers": [ { "name": "Symbolchecksum", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "file_name", "value": "mynugetpkg.pdb", "type": "query", "description": "The symbol file name" }, { "name": "signature", "value": "k813f89485474661234z7109cve5709eFFFFFFFF", "type": "query", "description": "The symbol file signature" }, { "name": "same_file_name", "value": "", "type": "query", "description": "The symbol file name. Must match the 'file_name' parameter" } ] }, "docs": "This feature was introduced in GitLab 16.7" }, { "info": { "name": "The NuGet V2 Feed Service Index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/v2", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." } ] }, "docs": "This feature was introduced in GitLab 16.2" }, { "info": { "name": "The NuGet V2 Feed Package $metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/v2/$metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." } ] }, "docs": "This feature was introduced in GitLab 16.3" }, { "info": { "name": "The NuGet Metadata Service - Package name level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/metadata/*package_name/index", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "package_name", "value": "MyNuGetPkg", "type": "query", "description": "The NuGet package name" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Metadata Service - Package name and version level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/metadata/*package_name/*package_version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "package_name", "value": "MyNuGetPkg", "type": "query", "description": "The NuGet package name" }, { "name": "package_version", "value": "1.0.0", "type": "query", "description": "The NuGet package version" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Search Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/nuget/query", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID or full group path." }, { "name": "q", "value": "MyNuGet", "type": "query", "description": "The search term" }, { "name": "skip", "value": "1", "type": "query", "description": "The number of results to skip" }, { "name": "take", "value": "1", "type": "query", "description": "The number of results to return" }, { "name": "prerelease", "value": "", "type": "query", "description": "Include prerelease versions" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The PyPi Simple Group Index Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/pypi/simple", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of the group." } ] }, "docs": "This feature was introduced in GitLab 15.1" }, { "info": { "name": "The PyPi Simple Group Package Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/pypi/simple/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of the group." }, { "name": "package_name", "value": "my.pypi.package", "type": "query", "description": "The PyPi package name" } ] }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "Get config.json", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/cargo/config.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This will be used by cargo for further requests" }, { "info": { "name": "Composer packages endpoint for registering packages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/composer", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a project" } ] }, "docs": "This feature was introduced in GitLab 13.1" }, { "info": { "name": "Composer package endpoint to download a package archive", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/composer/archives/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a project" }, { "name": "sha", "value": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab", "type": "query", "description": "Shasum of current json" }, { "name": "package_name", "value": "my-composer-package", "type": "query", "description": "The Composer package name" } ] }, "docs": "This feature was introduced in GitLab 13.1" }, { "info": { "name": "Authenticate user against conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/users/authenticate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.2" }, { "info": { "name": "Check for valid user credentials per conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/users/check_credentials", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Search for packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "q", "value": "Hello*", "type": "query", "description": "Search query" }, { "name": "ignorecase", "value": "False", "type": "query", "description": "Ignore case when searching (case-insensitive search)" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Get package references metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 18.0" }, { "info": { "name": "Ping the Conan API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/ping", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.2" }, { "info": { "name": "Package Snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Delete Package", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Digest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/digest", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Digest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/digest", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Download Urls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/download_urls", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Download Urls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/download_urls", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Upload Urls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/upload_urls", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Recipe Upload Urls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/upload_urls", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Download recipe files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Upload recipe package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Workhorse authorize the conan recipe file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Download package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Upload package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Workhorse authorize the conan package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Authenticate user against conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/users/authenticate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.2" }, { "info": { "name": "Check for valid user credentials per conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/users/check_credentials", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Search for packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "q", "value": "Hello*", "type": "query", "description": "Search query" }, { "name": "ignorecase", "value": "False", "type": "query", "description": "Ignore case when searching (case-insensitive search)" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Get package references metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 18.0" }, { "info": { "name": "Get the latest recipe revision", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/latest", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Get the list of revisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Delete recipe revision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" } ] }, "docs": "This feature was introduced in GitLab 18.1" }, { "info": { "name": "List recipe files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Download recipe files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.8" }, { "info": { "name": "Upload recipe package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.10" }, { "info": { "name": "Workhorse authorize the conan recipe file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/files/:file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.10" }, { "info": { "name": "Get package references metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" } ] }, "docs": "This feature was introduced in GitLab 18.1" }, { "info": { "name": "Get the latest package revision", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/latest", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Get the list of package revisions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/conan/v2/conans/:package_name/:package_version/:package_username/:package_channel/revisions/:recipe_revision/packages/:conan_package_reference/revisions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" } ] }, "docs": "This feature was introduced in GitLab 18.0" }, { "info": { "name": "Delete package revision", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" }, { "name": "package_revision", "value": "3bdd2d8c8e76c876ebd1ac0469a4e72c", "type": "path", "description": "Package revision" } ] }, "docs": "This feature was introduced in GitLab 18.1" }, { "info": { "name": "List package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" }, { "name": "package_revision", "value": "3bdd2d8c8e76c876ebd1ac0469a4e72c", "type": "path", "description": "Package revision" } ] }, "docs": "This feature was introduced in GitLab 18.0" }, { "info": { "name": "Download package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" }, { "name": "package_revision", "value": "3bdd2d8c8e76c876ebd1ac0469a4e72c", "type": "path", "description": "Package revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Upload package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" }, { "name": "package_revision", "value": "3bdd2d8c8e76c876ebd1ac0469a4e72c", "type": "path", "description": "Package revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "Workhorse authorize the conan package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "df28fd816be3a119de5ce4d374436b25", "type": "path", "description": "Recipe revision" }, { "name": "conan_package_reference", "value": "5ab84d6acfe1f23c4fae0ab88f26e3a396351ac9", "type": "path", "description": "Package reference" }, { "name": "package_revision", "value": "3bdd2d8c8e76c876ebd1ac0469a4e72c", "type": "path", "description": "Package revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 17.11" }, { "info": { "name": "The Release file signature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/Release.gpg", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The unsigned Release file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/Release", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The signed Release file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/InRelease", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The installer (udeb) binary files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/Packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The installer (udeb) binary files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/debian-installer/binary-:architecture/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The source files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/source/Sources", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The source files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/source/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "The binary files index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/binary-:architecture/Packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "The binary files index by hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/dists/*distribution/:component/binary-:architecture/by-hash/SHA256/:file_sha256", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "query", "description": "The Debian Codename or Suite" }, { "name": "component", "value": "main", "type": "path", "description": "The Debian Component" }, { "name": "architecture", "value": "binary-amd64", "type": "path", "description": "The Debian Architecture" }, { "name": "file_sha256", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 15.4" }, { "info": { "name": "Download Debian package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/pool/:distribution/:letter/:package_name/:package_version/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "distribution", "value": "my-distro", "type": "path", "description": "The Debian Codename or Suite" }, { "name": "letter", "value": "a", "type": "path", "description": "The Debian Classification (first-letter or lib-first-letter)" }, { "name": "package_name", "value": "my-pkg", "type": "path", "description": "The Debian Source Package Name" }, { "name": "package_version", "value": "1.0.0", "type": "path", "description": "The Debian Source Package Version" }, { "name": "file_name", "value": "example_1.0.0~alpha2_amd64.deb", "type": "path", "description": "The Debian File Name" } ] }, "docs": "This feature was introduced in GitLab 14.2" }, { "info": { "name": "Upload Debian package", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "example_1.0.0~alpha2_amd64.deb", "type": "path", "description": "The filename" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Authorize Debian package upload", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/debian/:file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "example_1.0.0~alpha2_amd64.deb", "type": "path", "description": "The filename" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "Workhorse authorize generic package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "path", "description": "Package name" }, { "name": "file_name", "value": "", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "Download package file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "", "type": "query", "description": "Package version" }, { "name": "path", "value": "", "type": "query", "description": "File directory path" }, { "name": "file_name", "value": "", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "Upload package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/generic/:package_name/*package_version/(*path/):file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "path", "description": "Package name" }, { "name": "file_name", "value": "", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 13.5" }, { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/go/*module_name/@v/list", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID or full path of a project" }, { "name": "module_name", "value": "", "type": "query", "description": "The name of the Go module" } ] }, "docs": "Get all tagged versions for a given Go module.See `go help goproxy`, GET $GOPROXY//@v/list. This feature was introduced in GitLab 13.1." }, { "info": { "name": "Version metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.info", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID or full path of a project" }, { "name": "module_name", "value": "", "type": "query", "description": "The name of the Go module" }, { "name": "module_version", "value": "", "type": "path", "description": "The version of the Go module" } ] }, "docs": "Get all tagged versions for a given Go module.See `go help goproxy`, GET $GOPROXY//@v/.info. This feature was introduced in GitLab 13.1" }, { "info": { "name": "Download module file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.mod", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID or full path of a project" }, { "name": "module_name", "value": "", "type": "query", "description": "The name of the Go module" }, { "name": "module_version", "value": "", "type": "path", "description": "The version of the Go module" } ] }, "docs": "Get the module file of a given module version.See `go help goproxy`, GET $GOPROXY//@v/.mod. This feature was introduced in GitLab 13.1." }, { "info": { "name": "Download module source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/go/*module_name/@v/:module_version.zip", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID or full path of a project" }, { "name": "module_name", "value": "", "type": "query", "description": "The name of the Go module" }, { "name": "module_version", "value": "", "type": "path", "description": "The version of the Go module" } ] }, "docs": "Get a zip of the source of the given module version.See `go help goproxy`, GET $GOPROXY//@v/.zip. This feature was introduced in GitLab 13.1." }, { "info": { "name": "Download a chart index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/helm/:channel/index.yaml", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "channel", "value": "stable", "type": "path", "description": "Helm channel" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Download a chart", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/helm/:channel/charts/:file_name.tgz", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "channel", "value": "stable", "type": "path", "description": "Helm channel" }, { "name": "file_name", "value": "mychart", "type": "path", "description": "Helm package file name" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Authorize a chart upload from workhorse", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/helm/api/:channel/charts/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "channel", "value": "stable", "type": "path", "description": "Helm channel" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Upload a chart", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/helm/api/:channel/charts", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "channel", "value": "stable", "type": "path", "description": "Helm channel" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Download the maven package file at a project level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/maven/*path/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "path", "value": "foo/bar/mypkg/1.0-SNAPSHOT", "type": "query", "description": "Package path" }, { "name": "file_name", "value": "mypkg-1.0-SNAPSHOT.jar", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.3" }, { "info": { "name": "Upload the maven package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/maven/*path/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "mypkg-1.0-SNAPSHOT.pom", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.3" }, { "info": { "name": "Workhorse authorize the maven package file upload", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/maven/*path/:file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "mypkg-1.0-SNAPSHOT.pom", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.3" }, { "info": { "name": "Get all tags for a given an NPM package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Create or Update the given tag for the given NPM package and version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Deletes the given tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "query", "description": "Package name" }, { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "NPM registry bulk advisory endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/-/npm/v1/security/advisories/bulk", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "NPM registry quick audit endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/-/npm/v1/security/audits/quick", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "Download the NPM tarball", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/*package_name/-/*file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "query", "description": "Package name" }, { "name": "file_name", "value": "", "type": "query", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.8" }, { "info": { "name": "Create or deprecate NPM package", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/:package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "", "type": "path", "description": "Package name" } ] }, "docs": "Create was introduced in GitLab 11.8 & deprecate support was added in 16.0" }, { "info": { "name": "NPM registry metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/npm/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "mypackage", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 11.8" }, { "info": { "name": "The NuGet V3 Feed Service Index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/index", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "The NuGet Symbol File Download Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/symbolfiles/*file_name/*signature/*same_file_name", "headers": [ { "name": "Symbolchecksum", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "mynugetpkg.pdb", "type": "query", "description": "The symbol file name" }, { "name": "signature", "value": "k813f89485474661234z7109cve5709eFFFFFFFF", "type": "query", "description": "The symbol file signature" }, { "name": "same_file_name", "value": "", "type": "query", "description": "The symbol file name. Must match the 'file_name' parameter" } ] }, "docs": "This feature was introduced in GitLab 16.7" }, { "info": { "name": "The NuGet V2 Feed Service Index", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/v2", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.2" }, { "info": { "name": "The NuGet V2 Feed Package Publish endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/v2", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.2" }, { "info": { "name": "The NuGet V2 Feed Package $metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/v2/$metadata", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.3" }, { "info": { "name": "The NuGet Metadata Service - Package name level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/metadata/*package_name/index", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "MyNuGetPkg", "type": "query", "description": "The NuGet package name" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Metadata Service - Package name and version level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/metadata/*package_name/*package_version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "MyNuGetPkg", "type": "query", "description": "The NuGet package name" }, { "name": "package_version", "value": "1.0.0", "type": "query", "description": "The NuGet package version" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Search Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/query", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "q", "value": "MyNuGet", "type": "query", "description": "The search term" }, { "name": "skip", "value": "1", "type": "query", "description": "The number of results to skip" }, { "name": "take", "value": "1", "type": "query", "description": "The number of results to return" }, { "name": "prerelease", "value": "", "type": "query", "description": "Include prerelease versions" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Content Service - index request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/download/*package_name/index", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "mynugetpkg.1.3.0.17.nupkg", "type": "query", "description": "The NuGet package name" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet Content Service - content request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/download/*package_name/*package_version/*package_filename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "mynugetpkg.1.3.0.17.nupkg", "type": "query", "description": "The NuGet package name" }, { "name": "package_version", "value": "1.3.0.17", "type": "query", "description": "The NuGet package version" }, { "name": "package_filename", "value": "mynugetpkg.1.3.0.17.nupkg", "type": "query", "description": "The NuGet package filename" } ] }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "The NuGet V3 Feed Package Publish endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "The NuGet Package Authorize endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 14.1" }, { "info": { "name": "The NuGet Symbol Package Publish endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/symbolpackage", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 14.1" }, { "info": { "name": "The NuGet Symbol Package Authorize endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/symbolpackage/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 14.1" }, { "info": { "name": "The NuGet Package Delete endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/*package_name/*package_version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "mynugetpkg", "type": "query", "description": "The NuGet package name" }, { "name": "package_version", "value": "1.0.1", "type": "query", "description": "The NuGet package version" } ] }, "docs": "This feature was introduced in GitLab 16.5" }, { "info": { "name": "The NuGet V2 Feed Package Authorize endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/nuget/v2/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.2" }, { "info": { "name": "The NuGet V2 Feed Find Packages by ID endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:project_id/packages/nuget/v2/FindPackagesById\\(\\)", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "id", "value": "mynugetpkg", "type": "query", "description": "The NuGet package name" } ] }, "docs": "This feature was introduced in GitLab 16.4" }, { "info": { "name": "The NuGet V2 Feed Enumerate Packages endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:project_id/packages/nuget/v2/Packages\\(\\)", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "$filter", "value": "mynugetpkg", "type": "query", "description": "The NuGet package name" } ] }, "docs": "This feature was introduced in GitLab 16.4" }, { "info": { "name": "The NuGet V2 Feed Single Package Metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:project_id/packages/nuget/v2/Packages\\(Id='*package_name',Version='*package_version'\\)", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "mynugetpkg", "type": "query", "description": "The NuGet package name" }, { "name": "package_version", "value": "1.3.0.17", "type": "query", "description": "The NuGet package version" } ] }, "docs": "This feature was introduced in GitLab 16.4" }, { "info": { "name": "List package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id/package_files", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project" }, { "name": "package_id", "value": "", "type": "path", "description": "ID of a package" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "order_by", "value": "", "type": "query", "description": "Return package files ordered by `id`, `created_at` or `file_name`" }, { "name": "sort", "value": "", "type": "query", "description": "Return package files sorted in `asc` or `desc` order." } ] }, "docs": "Get a list of package files of a single package" }, { "info": { "name": "Delete a package file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id/package_files/:package_file_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project" }, { "name": "package_id", "value": "", "type": "path", "description": "ID of a package" }, { "name": "package_file_id", "value": "", "type": "path", "description": "ID of a package file" } ] }, "docs": "This feature was introduced in GitLab 13.12" }, { "info": { "name": "Download a package file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id/package_files/:package_file_id/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project" }, { "name": "package_id", "value": "", "type": "path", "description": "ID of a package" }, { "name": "package_file_id", "value": "", "type": "path", "description": "ID of a package file" } ] }, "docs": "This feature was introduced in GitLab 18.4" }, { "info": { "name": "Get a list of Debian Distributions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "codename", "value": "sid", "type": "query", "description": "The Debian Codename" }, { "name": "suite", "value": "unstable", "type": "query", "description": "The Debian Suite" }, { "name": "origin", "value": "Grep", "type": "query", "description": "The Debian Origin" }, { "name": "label", "value": "grep.be", "type": "query", "description": "The Debian Label" }, { "name": "version", "value": "12", "type": "query", "description": "The Debian Version" }, { "name": "description", "value": "My description", "type": "query", "description": "The Debian Description" }, { "name": "valid_time_duration_seconds", "value": "604800", "type": "query", "description": "The duration before the Release file should be considered expired by the client" }, { "name": "components", "value": "main", "type": "query", "description": "The list of Components" }, { "name": "architectures", "value": "amd64", "type": "query", "description": "The list of Architectures" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Create a Debian Distribution", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Get a Debian Distribution", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Update a Debian Distribution", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Delete a Debian Distribution", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions/:codename", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" }, { "name": "suite", "value": "unstable", "type": "query", "description": "The Debian Suite" }, { "name": "origin", "value": "Grep", "type": "query", "description": "The Debian Origin" }, { "name": "label", "value": "grep.be", "type": "query", "description": "The Debian Label" }, { "name": "version", "value": "12", "type": "query", "description": "The Debian Version" }, { "name": "description", "value": "My description", "type": "query", "description": "The Debian Description" }, { "name": "valid_time_duration_seconds", "value": "604800", "type": "query", "description": "The duration before the Release file should be considered expired by the client" }, { "name": "components", "value": "main", "type": "query", "description": "The list of Components" }, { "name": "architectures", "value": "amd64", "type": "query", "description": "The list of Architectures" } ] }, "docs": "This feature was introduced in 14.0" }, { "info": { "name": "Get a Debian Distribution Key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/debian_distributions/:codename/key.asc", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "codename", "value": "sid", "type": "path", "description": "The Debian Codename" } ] }, "docs": "This feature was introduced in 14.4" }, { "info": { "name": "Get a list of project packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "order_by", "value": "", "type": "query", "description": "Return packages ordered by `created_at`, `name`, `version` or `type` fields." }, { "name": "sort", "value": "", "type": "query", "description": "Return packages sorted in `asc` or `desc` order." }, { "name": "package_type", "value": "", "type": "query", "description": "Return packages of a certain type" }, { "name": "package_name", "value": "", "type": "query", "description": "Return packages with this name" }, { "name": "package_version", "value": "", "type": "query", "description": "Return packages with this version" }, { "name": "include_versionless", "value": "", "type": "query", "description": "Returns packages without a version" }, { "name": "status", "value": "", "type": "query", "description": "Return packages with specified status" } ] }, "docs": "This feature was introduced in GitLab 11.8" }, { "info": { "name": "Get a single project package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_id", "value": "", "type": "path", "description": "The ID of a package" } ] }, "docs": "This feature was introduced in GitLab 11.9" }, { "info": { "name": "Delete a project package", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_id", "value": "", "type": "path", "description": "The ID of a package" } ] }, "docs": "This feature was introduced in GitLab 11.9" }, { "info": { "name": "Get the pipelines for a single project package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/:package_id/pipelines", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "package_id", "value": "", "type": "path", "description": "The ID of a package" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for obtaining the next set of records" } ] }, "docs": "This feature was introduced in GitLab 16.1" }, { "info": { "name": "The PyPi package download endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/pypi/files/:sha256/*file_identifier", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_identifier", "value": "my.pypi.package-0.0.1.tar.gz", "type": "query", "description": "The PyPi package file identifier" }, { "name": "sha256", "value": "5y57017232013c8ac80647f4ca153k3726f6cba62d055cd747844ed95b3c65ff", "type": "path", "description": "The PyPi package sha256 check sum" } ] }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "The PyPi Simple Project Index Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/pypi/simple", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.1" }, { "info": { "name": "The PyPi Simple Project Package Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/pypi/simple/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_name", "value": "my.pypi.package", "type": "query", "description": "The PyPi package name" } ] }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "The PyPi Package upload endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/pypi", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "Authorize the PyPi package upload from workhorse", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/pypi/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "Download repository metadata files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rpm/repodata/*file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "query", "description": "Repository metadata file name" } ] }, "docs": "This feature was introduced in GitLab 15.7" }, { "info": { "name": "Download RPM package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rpm/*package_file_id/*file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_file_id", "value": "", "type": "query", "description": "RPM package file id" }, { "name": "file_name", "value": "", "type": "query", "description": "RPM package file name" } ] }, "docs": "This feature was introduced in GitLab 15.7" }, { "info": { "name": "Upload a RPM package", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rpm", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.7" }, { "info": { "name": "Authorize package upload from workhorse", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rpm/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.7" }, { "info": { "name": "Download the spec index file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "Spec file name" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Download the gemspec file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/quick/Marshal.4.8/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "Gemspec file name" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Download the .gem package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/gems/:file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Authorize a gem upload from workhorse", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/api/v1/gems/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Upload a gem", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/api/v1/gems", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Fetch a list of dependencies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/rubygems/api/v1/dependencies", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "gems", "value": "", "type": "query", "description": "Comma delimited gem names" } ] }, "docs": "This feature was introduced in GitLab 13.9" }, { "info": { "name": "Composer packages endpoint at group level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/group/:id/-/packages/composer/packages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a group" } ] }, "docs": "This feature was introduced in GitLab 13.1" }, { "info": { "name": "Composer packages endpoint at group level for packages list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/group/:id/-/packages/composer/p/:sha", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a group" }, { "name": "sha", "value": "673594f85a55fe3c0eb45df7bd2fa9d95a1601ab", "type": "path", "description": "Shasum of current json" } ] }, "docs": "This feature was introduced in GitLab 13.1" }, { "info": { "name": "Composer v2 packages p2 endpoint at group level for package versions metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/group/:id/-/packages/composer/p2/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a group" }, { "name": "package_name", "value": "my-composer-package", "type": "query", "description": "The Composer package name" } ] }, "docs": "This feature was introduced in GitLab 13.1" }, { "info": { "name": "Composer packages endpoint at group level for package versions metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/group/:id/-/packages/composer/*package_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of a group" }, { "name": "package_name", "value": "my-composer-package", "type": "query", "description": "The Composer package name" } ] }, "docs": "This feature was introduced in GitLab 12.1" }, { "info": { "name": "Authenticate user against conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/users/authenticate" }, "docs": "This feature was introduced in GitLab 12.2" }, { "info": { "name": "Check for valid user credentials per conan CLI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/users/check_credentials" }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Search for packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/search", "params": [ { "name": "q", "value": "Hello*", "type": "query", "description": "Search query" }, { "name": "ignorecase", "value": "False", "type": "query", "description": "Ignore case when searching (case-insensitive search)" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Get package references metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/search", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 18.0" }, { "info": { "name": "Ping the Conan API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/ping" }, "docs": "This feature was introduced in GitLab 12.2" }, { "info": { "name": "Package Snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Snapshot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Delete Package", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Digest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/digest", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Digest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/digest", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Download Urls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/download_urls", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Recipe Download Urls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/download_urls", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Package Upload Urls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/packages/:conan_package_reference/upload_urls", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan package ID" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Recipe Upload Urls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/packages/conan/v1/conans/:package_name/:package_version/:package_username/:package_channel/upload_urls", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" } ] }, "docs": "This feature was introduced in GitLab 12.4" }, { "info": { "name": "Download recipe files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Upload recipe package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Workhorse authorize the conan recipe file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/export/:file_name/authorize", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "file_name", "value": "conanfile.py", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Download package files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.5" }, { "info": { "name": "Upload package files", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/packages/conan/v1/files/:package_name/:package_version/:package_username/:package_channel/:recipe_revision/package/:conan_package_reference/:package_revision/:file_name", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Workhorse authorize the conan package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/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", "params": [ { "name": "package_name", "value": "my-package", "type": "path", "description": "Package name" }, { "name": "package_version", "value": "1.0", "type": "path", "description": "Package version" }, { "name": "package_username", "value": "my-group+my-project", "type": "path", "description": "Package username" }, { "name": "package_channel", "value": "stable", "type": "path", "description": "Package channel" }, { "name": "recipe_revision", "value": "0", "type": "path", "description": "Conan Recipe Revision" }, { "name": "conan_package_reference", "value": "103f6067a947f366ef91fc1b7da351c588d1827f", "type": "path", "description": "Conan Package ID" }, { "name": "package_revision", "value": "0", "type": "path", "description": "Conan Package Revision" }, { "name": "file_name", "value": "conaninfo.txt", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 12.6" }, { "info": { "name": "Download the maven package file at instance level", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/maven/*path/:file_name", "params": [ { "name": "path", "value": "foo/bar/mypkg/1.0-SNAPSHOT", "type": "query", "description": "Package path" }, { "name": "file_name", "value": "mypkg-1.0-SNAPSHOT.jar", "type": "path", "description": "Package file name" } ] }, "docs": "This feature was introduced in GitLab 11.6" }, { "info": { "name": "Get all tags for a given an NPM package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/npm/-/package/*package_name/dist-tags", "params": [ { "name": "package_name", "value": "", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Create or Update the given tag for the given NPM package and version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "Deletes the given tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/packages/npm/-/package/*package_name/dist-tags/:tag", "params": [ { "name": "package_name", "value": "", "type": "query", "description": "Package name" }, { "name": "tag", "value": "", "type": "path", "description": "Package dist-tag" } ] }, "docs": "This feature was introduced in GitLab 12.7" }, { "info": { "name": "NPM registry bulk advisory endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/packages/npm/-/npm/v1/security/advisories/bulk" }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "NPM registry quick audit endpoint", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/packages/npm/-/npm/v1/security/audits/quick" }, "docs": "This feature was introduced in GitLab 15.6" }, { "info": { "name": "NPM registry metadata endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/npm/*package_name", "params": [ { "name": "package_name", "value": "mypackage", "type": "query", "description": "Package name" } ] }, "docs": "This feature was introduced in GitLab 11.8" } ] }, { "info": { "name": "dependency_proxy", "type": "folder" }, "items": [ { "info": { "name": "Purge the dependency proxy for a group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/dependency_proxy/cache", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" } ] }, "docs": "Schedules for deletion the cached manifests and blobs for a group.This endpoint requires the Owner role for the group." } ] }, { "info": { "name": "deploy_resources", "type": "folder" }, "items": [ { "info": { "name": "List group deploy tokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/deploy_tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "active", "value": "", "type": "query", "description": "Limit by active status" } ] }, "docs": "Get a list of a group's deploy tokens. This feature was introduced in GitLab 12.9." }, { "info": { "name": "Create a group deploy token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/deploy_tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" } ] }, "docs": "Creates a new deploy token for a group. This feature was introduced in GitLab 12.9." }, { "info": { "name": "Get a group deploy token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/deploy_tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the deploy token" } ] }, "docs": "Get a single group's deploy token by ID. This feature was introduced in GitLab 14.9. " }, { "info": { "name": "Delete a group deploy token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/deploy_tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the deploy token" } ] }, "docs": "Removes a deploy token from the group. This feature was introduced in GitLab 12.9." }, { "info": { "name": "List deploy keys for project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of a project's deploy keys." }, { "info": { "name": "Add deploy key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Creates a new deploy key for a project. If the deploy key already exists in another project, it's joined to the current project only if the original one is accessible by the same user." }, { "info": { "name": "Get a single deploy key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys/:key_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key_id", "value": "", "type": "path", "description": "The ID of the deploy key" } ] }, "docs": "Get a single key." }, { "info": { "name": "Update deploy key", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys/:key_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key_id", "value": "", "type": "path", "description": "The ID of the deploy key" } ] }, "docs": "Updates a deploy key for a project." }, { "info": { "name": "Delete deploy key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys/:key_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key_id", "value": "", "type": "path", "description": "The ID of the deploy key" } ] }, "docs": "Removes a deploy key from the project. If the deploy key is used only for this project, it's deleted from the system." }, { "info": { "name": "Enable a deploy key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_keys/:key_id/enable", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key_id", "value": "", "type": "path", "description": "The ID of the deploy key" } ] }, "docs": "Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful. This feature was added in GitLab 8.11." }, { "info": { "name": "List project deploy tokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "active", "value": "", "type": "query", "description": "Limit by active status" } ] }, "docs": "Get a list of a project's deploy tokens. This feature was introduced in GitLab 12.9." }, { "info": { "name": "Create a project deploy token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Creates a new deploy token for a project. This feature was introduced in GitLab 12.9." }, { "info": { "name": "Get a project deploy token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the deploy token" } ] }, "docs": "Get a single project's deploy token by ID. This feature was introduced in GitLab 14.9." }, { "info": { "name": "Delete a project deploy token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/deploy_tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the deploy token" } ] }, "docs": "This feature was introduced in GitLab 12.9." }, { "info": { "name": "List project deployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deployments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "order_by", "value": "", "type": "query", "description": "Return deployments ordered by either one of `id`, `iid`, `created_at`, `updated_at` or `ref` fields. Default is `id`" }, { "name": "sort", "value": "", "type": "query", "description": "Return deployments sorted in `asc` or `desc` order. Default is `asc`" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return deployments updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return deployments updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)" }, { "name": "finished_after", "value": "", "type": "query", "description": "Return deployments finished after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)" }, { "name": "finished_before", "value": "", "type": "query", "description": "Return deployments finished before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`)" }, { "name": "environment", "value": "", "type": "query", "description": "The name of the environment to filter deployments by" }, { "name": "status", "value": "", "type": "query", "description": "The status to filter deployments by. One of `created`, `running`, `success`, `failed`, `canceled`, or `blocked`" } ] }, "docs": "Get a list of deployments in a project. This feature was introduced in GitLab 8.11." }, { "info": { "name": "Create a deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/deployments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "This feature was introduced in GitLab 12.4." }, { "info": { "name": "Get a specific deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deployments/:deployment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The ID of the deployment" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Update a deployment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/deployments/:deployment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "deployment_id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 12.4." }, { "info": { "name": "Delete a specific deployment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/deployments/:deployment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The ID of the deployment" } ] }, "docs": "Delete a specific deployment that is not currently the last deployment for an environment or in a running state. This feature was introduced in GitLab 15.3." }, { "info": { "name": "List of merge requests associated with a deployment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/deployments/:deployment_id/merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The ID of the deployment" }, { "name": "author_id", "value": "", "type": "query", "description": "Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "author_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "assignee_id", "value": "", "type": "query", "description": "Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "assignee_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "reviewer_username", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "labels", "value": "", "type": "query", "description": "Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "milestone", "value": "", "type": "query", "description": "Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "reviewer_id", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "state", "value": "", "type": "query", "description": "Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged`." }, { "name": "order_by", "value": "", "type": "query", "description": "Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8." }, { "name": "sort", "value": "", "type": "query", "description": "Returns merge requests sorted in `asc` or `desc` order." }, { "name": "with_labels_details", "value": "", "type": "query", "description": "If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color`" }, { "name": "with_merge_status_recheck", "value": "", "type": "query", "description": "If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0." }, { "name": "created_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or after the given time. Expected in ISO 8601 format." }, { "name": "created_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or before the given time. Expected in ISO 8601 format." }, { "name": "updated_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or after the given time. Expected in ISO 8601 format." }, { "name": "updated_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or before the given time. Expected in ISO 8601 format." }, { "name": "view", "value": "", "type": "query", "description": "If simple, returns the `iid`, URL, title, description, and basic state of merge request" }, { "name": "scope", "value": "", "type": "query", "description": "Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all`" }, { "name": "source_branch", "value": "", "type": "query", "description": "Returns merge requests with the given source branch" }, { "name": "source_project_id", "value": "", "type": "query", "description": "Returns merge requests with the given source project id" }, { "name": "target_branch", "value": "", "type": "query", "description": "Returns merge requests with the given target branch" }, { "name": "search", "value": "", "type": "query", "description": "Search merge requests against their `title` and `description`." }, { "name": "in", "value": "title,description", "type": "query", "description": "Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma." }, { "name": "wip", "value": "", "type": "query", "description": "Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests." }, { "name": "draft", "value": "", "type": "query", "description": "Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests." }, { "name": "not[author_id]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "not[author_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "`` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[reviewer_username]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "not[labels]", "value": "", "type": "query", "description": "`` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "not[milestone]", "value": "", "type": "query", "description": "`` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "not[my_reaction_emoji]", "value": "", "type": "query", "description": "`` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "not[reviewer_id]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "deployed_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed before the given date/time. Expected in ISO 8601 format." }, { "name": "deployed_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed after the given date/time. Expected in ISO 8601 format" }, { "name": "environment", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed to the given environment" }, { "name": "approved", "value": "", "type": "query", "description": "Filters merge requests by their `approved` status. `yes` returns only approved merge requests. `no` returns only non-approved merge requests." }, { "name": "merge_user_id", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`." }, { "name": "merge_user_username", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`." } ] }, "docs": "Retrieves the list of merge requests shipped with a given deployment. This feature was introduced in GitLab 12.7." }, { "info": { "name": "Approve or reject a blocked deployment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/deployments/:deployment_id/approval", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "deployment_id", "value": "", "type": "path", "description": "The ID of the deployment" } ] }, "docs": "This feature was introduced in GitLab 14.8." }, { "info": { "name": "List all deploy keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/deploy_keys", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "public", "value": "", "type": "query", "description": "Only return deploy keys that are public" } ] }, "docs": "Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires administrator access and is not available on GitLab.com." }, { "info": { "name": "Create a deploy key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/deploy_keys" }, "docs": "Create a deploy key for the GitLab instance. This endpoint requires administrator access." }, { "info": { "name": "List all deploy tokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/deploy_tokens", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "active", "value": "", "type": "query", "description": "Limit by active status" } ] }, "docs": "Get a list of all deploy tokens across the GitLab instance. This endpoint requires administrator access. This feature was introduced in GitLab 12.9." } ] }, { "info": { "name": "avatars", "type": "folder" }, "items": [ { "info": { "name": "Download the group avatar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/avatar", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" } ] }, "docs": "This feature was introduced in GitLab 14.0" }, { "info": { "name": "Download a project avatar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/avatar", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.9" }, { "info": { "name": "getApiV4Avatar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/avatar", "params": [ { "name": "email", "value": "", "type": "query", "description": "Public email address of the user" }, { "name": "size", "value": "", "type": "query", "description": "Single pixel dimension for Gravatar images" } ] }, "docs": "Return avatar url for a user" } ] }, { "info": { "name": "clusters", "type": "folder" }, "items": [ { "info": { "name": "List group clusters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/clusters", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 12.1. Returns a list of group clusters." }, { "info": { "name": "Get a single group cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 12.1. Gets a single group cluster." }, { "info": { "name": "Edit group cluster", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 12.1. Updates an existing group cluster." }, { "info": { "name": "Delete group cluster", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster ID" } ] }, "docs": "This feature was introduced in GitLab 12.1. Deletes an existing group cluster. Does not remove existing resources within the connected Kubernetes cluster." }, { "info": { "name": "Add existing cluster to group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/clusters/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the group" } ] }, "docs": "This feature was introduced in GitLab 12.1. Adds an existing Kubernetes cluster to the group." }, { "info": { "name": "List project clusters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/clusters", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 11.7. Returns a list of project clusters." }, { "info": { "name": "Get a single project cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 11.7. Gets a single project cluster." }, { "info": { "name": "Edit project cluster", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 11.7. Updates an existing project cluster." }, { "info": { "name": "Delete project cluster", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/clusters/:cluster_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "cluster_id", "value": "", "type": "path", "description": "The Cluster ID" } ] }, "docs": "This feature was introduced in GitLab 11.7. Deletes an existing project cluster. Does not remove existing resources within the connected Kubernetes cluster." }, { "info": { "name": "Add existing cluster to project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/clusters/user", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 11.7. Adds an existing Kubernetes cluster to the project." }, { "info": { "name": "List instance clusters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/clusters" }, "docs": "This feature was introduced in GitLab 13.2. Returns a list of instance clusters." }, { "info": { "name": "Get a single instance cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/clusters/:cluster_id", "params": [ { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 13.2. Returns a single instance cluster." }, { "info": { "name": "Edit instance cluster", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/admin/clusters/:cluster_id", "params": [ { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 13.2. Updates an existing instance cluster." }, { "info": { "name": "Delete instance cluster", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/admin/clusters/:cluster_id", "params": [ { "name": "cluster_id", "value": "", "type": "path", "description": "The cluster ID" } ] }, "docs": "This feature was introduced in GitLab 13.2. Deletes an existing instance cluster. Does not remove existing resources within the connected Kubernetes cluster." }, { "info": { "name": "Add existing instance cluster", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/admin/clusters/add" }, "docs": "This feature was introduced in GitLab 13.2. Adds an existing Kubernetes instance cluster." }, { "info": { "name": "Discover all descendant certificate-based clusters in a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/discover-cert-based-clusters", "params": [ { "name": "group_id", "value": "", "type": "query", "description": "The group ID to find all certificate-based clusters in the hierarchy" } ] }, "docs": "This feature was introduced in GitLab 17.9. It will be removed in 18.0." } ] }, { "info": { "name": "container_registry", "type": "folder" }, "items": [ { "info": { "name": "List registry repositories within a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/registry/repositories", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group accessible by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of registry repositories in a group. This feature was introduced in GitLab 12.2." }, { "info": { "name": "List container repositories within a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "tags", "value": "", "type": "query", "description": "Determines if tags should be included" }, { "name": "tags_count", "value": "", "type": "query", "description": "Determines if the tags count should be included" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "Delete repository", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories/:repository_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "repository_id", "value": "", "type": "path", "description": "The ID of the repository" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "List tags of a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories/:repository_id/tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "repository_id", "value": "", "type": "path", "description": "The ID of the repository" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "Delete repository tags (in bulk)", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories/:repository_id/tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "repository_id", "value": "", "type": "path", "description": "The ID of the repository" }, { "name": "name_regex_delete", "value": "", "type": "query", "description": "The tag name regexp to delete, specify .* to delete all" }, { "name": "name_regex", "value": "", "type": "query", "description": "The tag name regexp to delete, specify .* to delete all" }, { "name": "name_regex_keep", "value": "", "type": "query", "description": "The tag name regexp to retain" }, { "name": "keep_n", "value": "", "type": "query", "description": "Keep n of latest tags with matching name" }, { "name": "older_than", "value": "", "type": "query", "description": "Delete older than: 1h, 1d, 1month" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "Get details about a repository tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories/:repository_id/tags/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "repository_id", "value": "", "type": "path", "description": "The ID of the repository" }, { "name": "tag_name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "Delete repository tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/registry/repositories/:repository_id/tags/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "repository_id", "value": "", "type": "path", "description": "The ID of the repository" }, { "name": "tag_name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "This feature was introduced in GitLab 11.8." }, { "info": { "name": "Receives notifications from the container registry when an operation occurs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/container_registry_event/events" }, "docs": "This feature was introduced in GitLab 12.10" }, { "info": { "name": "Get a container repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/registry/repositories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the repository" }, { "name": "tags", "value": "", "type": "query", "description": "Determines if tags should be included" }, { "name": "tags_count", "value": "", "type": "query", "description": "Determines if the tags count should be included" }, { "name": "size", "value": "", "type": "query", "description": "Determines if the size should be included" } ] }, "docs": "This feature was introduced in GitLab 13.6." } ] }, { "info": { "name": "group_import_and_export", "type": "folder" }, "items": [ { "info": { "name": "Download export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/export/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "This feature was introduced in GitLab 12.5." }, { "info": { "name": "Start export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/export", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "This feature was introduced in GitLab 12.5." }, { "info": { "name": "Start relations export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/export_relations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "This feature was introduced in GitLab 13.12" }, { "info": { "name": "Download relations export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/export_relations/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "relation", "value": "", "type": "query", "description": "Group relation name" }, { "name": "batched", "value": "", "type": "query", "description": "Whether to download in batches" }, { "name": "batch_number", "value": "", "type": "query", "description": "Batch number to download" } ] }, "docs": "This feature was introduced in GitLab 13.12" }, { "info": { "name": "Relations export status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/export_relations/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "relation", "value": "", "type": "query", "description": "Group relation name" } ] }, "docs": "This feature was introduced in GitLab 13.12" }, { "info": { "name": "Workhorse authorize the group import upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/import/authorize" }, "docs": "This feature was introduced in GitLab 12.8" }, { "info": { "name": "Create a new group import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/import" }, "docs": "This feature was introduced in GitLab 12.8" } ] }, { "info": { "name": "ci_variables", "type": "folder" }, "items": [ { "info": { "name": "getApiV4GroupsIdVariables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/variables", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group or URL-encoded path of the group owned by the authenticated\n user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of group-level variables" }, { "info": { "name": "postApiV4GroupsIdVariables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/variables", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group or URL-encoded path of the group owned by the authenticated\n user" } ] }, "docs": "Create a new variable in a group" }, { "info": { "name": "getApiV4GroupsIdVariablesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group or URL-encoded path of the group owned by the authenticated\n user" }, { "name": "key", "value": "", "type": "path", "description": "The key of the variable" } ] }, "docs": "Get the details of a group’s specific variable" }, { "info": { "name": "putApiV4GroupsIdVariablesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group or URL-encoded path of the group owned by the authenticated\n user" }, { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Update an existing variable from a group" }, { "info": { "name": "deleteApiV4GroupsIdVariablesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group or URL-encoded path of the group owned by the authenticated\n user" }, { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Delete an existing variable from a group" }, { "info": { "name": "getApiV4ProjectsIdVariables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/variables", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get project variables" }, { "info": { "name": "postApiV4ProjectsIdVariables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/variables", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user" } ] }, "docs": "Create a new variable in a project" }, { "info": { "name": "getApiV4ProjectsIdVariablesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of a variable" }, { "name": "filter[environment_scope]", "value": "", "type": "query", "description": "The environment scope of a variable" } ] }, "docs": "Get the details of a single variable from a project" }, { "info": { "name": "putApiV4ProjectsIdVariablesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Update an existing variable from a project" }, { "info": { "name": "deleteApiV4ProjectsIdVariablesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/variables/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of a variable" }, { "name": "filter[environment_scope]", "value": "", "type": "query", "description": "The environment scope of the variable" } ] }, "docs": "Delete an existing variable from a project" }, { "info": { "name": "getApiV4AdminCiVariables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/ci/variables", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List all instance-level variables" }, { "info": { "name": "postApiV4AdminCiVariables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/admin/ci/variables" }, "docs": "Create a new instance-level variable" }, { "info": { "name": "getApiV4AdminCiVariablesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/ci/variables/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Get the details of a specific instance-level variable" }, { "info": { "name": "putApiV4AdminCiVariablesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/admin/ci/variables/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Update an instance-level variable" }, { "info": { "name": "deleteApiV4AdminCiVariablesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/admin/ci/variables/:key", "params": [ { "name": "key", "value": "", "type": "path", "description": "The key of a variable" } ] }, "docs": "Delete an existing instance-level variable" } ] }, { "info": { "name": "integrations", "type": "folder" }, "items": [ { "info": { "name": "List all active integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/integrations", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of all active integrations." }, { "info": { "name": "Create/Edit Apple App Store integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/apple-app-store", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Apple App Store integration." }, { "info": { "name": "Create/Edit Asana integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/asana", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Asana integration." }, { "info": { "name": "Create/Edit Assembla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/assembla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Assembla integration." }, { "info": { "name": "Create/Edit Bamboo integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/bamboo", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bamboo integration." }, { "info": { "name": "Create/Edit Bugzilla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/bugzilla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bugzilla integration." }, { "info": { "name": "Create/Edit Buildkite integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/buildkite", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Buildkite integration." }, { "info": { "name": "Create/Edit Campfire integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/campfire", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Campfire integration." }, { "info": { "name": "Create/Edit Confluence integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/confluence", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Confluence integration." }, { "info": { "name": "Create/Edit Custom Issue Tracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/custom-issue-tracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Custom Issue Tracker integration." }, { "info": { "name": "Create/Edit Datadog integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/datadog", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Datadog integration." }, { "info": { "name": "Create/Edit Diffblue Cover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/diffblue-cover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Diffblue Cover integration." }, { "info": { "name": "Create/Edit Discord integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/discord", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Discord integration." }, { "info": { "name": "Create/Edit Drone Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/drone-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Drone Ci integration." }, { "info": { "name": "Create/Edit Emails On Push integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/emails-on-push", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Emails On Push integration." }, { "info": { "name": "Create/Edit External Wiki integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/external-wiki", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set External Wiki integration." }, { "info": { "name": "Create/Edit Gitlab Slack Application integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/gitlab-slack-application", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Gitlab Slack Application integration." }, { "info": { "name": "Create/Edit Google Play integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/google-play", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Play integration." }, { "info": { "name": "Create/Edit Hangouts Chat integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/hangouts-chat", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Hangouts Chat integration." }, { "info": { "name": "Create/Edit Harbor integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/harbor", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Harbor integration." }, { "info": { "name": "Create/Edit Irker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/irker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Irker integration." }, { "info": { "name": "Create/Edit Jenkins integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/jenkins", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jenkins integration." }, { "info": { "name": "Create/Edit Jira integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/jira", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira integration." }, { "info": { "name": "Create/Edit Jira Cloud App integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/jira-cloud-app", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira Cloud App integration." }, { "info": { "name": "Create/Edit Linear integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/linear", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Linear integration." }, { "info": { "name": "Create/Edit Matrix integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/matrix", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Matrix integration." }, { "info": { "name": "Create/Edit Mattermost Slash Commands integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/mattermost-slash-commands", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost Slash Commands integration." }, { "info": { "name": "Create/Edit Packagist integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/packagist", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Packagist integration." }, { "info": { "name": "Create/Edit Phorge integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/phorge", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Phorge integration." }, { "info": { "name": "Create/Edit Pipelines Email integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/pipelines-email", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pipelines Email integration." }, { "info": { "name": "Create/Edit Pivotaltracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/pivotaltracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pivotaltracker integration." }, { "info": { "name": "Create/Edit Pumble integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/pumble", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pumble integration." }, { "info": { "name": "Create/Edit Pushover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/pushover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pushover integration." }, { "info": { "name": "Create/Edit Redmine integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/redmine", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Redmine integration." }, { "info": { "name": "Create/Edit Ewm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/ewm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Ewm integration." }, { "info": { "name": "Create/Edit Youtrack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/youtrack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Youtrack integration." }, { "info": { "name": "Create/Edit Clickup integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/clickup", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Clickup integration." }, { "info": { "name": "Create/Edit Slack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/slack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Slack integration." }, { "info": { "name": "Create/Edit Microsoft Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/microsoft-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Microsoft Teams integration." }, { "info": { "name": "Create/Edit Mattermost integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/mattermost", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost integration." }, { "info": { "name": "Create/Edit Teamcity integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/teamcity", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Teamcity integration." }, { "info": { "name": "Create/Edit Telegram integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/telegram", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Telegram integration." }, { "info": { "name": "Create/Edit Unify Circuit integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/unify-circuit", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Unify Circuit integration." }, { "info": { "name": "Create/Edit Webex Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/webex-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Webex Teams integration." }, { "info": { "name": "Create/Edit Zentao integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/zentao", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Zentao integration." }, { "info": { "name": "Create/Edit Squash Tm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/squash-tm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Squash Tm integration." }, { "info": { "name": "Create/Edit Github integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/github", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Github integration." }, { "info": { "name": "Create/Edit Git Guardian integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/git-guardian", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Git Guardian integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Artifact Registry integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/google-cloud-platform-artifact-registry", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Artifact Registry integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Workload Identity Federation integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/google-cloud-platform-workload-identity-federation", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Workload Identity Federation integration." }, { "info": { "name": "Create/Edit Mock Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/mock-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Ci integration." }, { "info": { "name": "Create/Edit Mock Monitoring integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/mock-monitoring", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Monitoring integration." }, { "info": { "name": "Get an integration settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the integration settings." }, { "info": { "name": "Disable an integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/integrations/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disable the integration. Integration settings are preserved." }, { "info": { "name": "List all active integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/services", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of all active integrations." }, { "info": { "name": "Create/Edit Apple App Store integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/apple-app-store", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Apple App Store integration." }, { "info": { "name": "Create/Edit Asana integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/asana", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Asana integration." }, { "info": { "name": "Create/Edit Assembla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/assembla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Assembla integration." }, { "info": { "name": "Create/Edit Bamboo integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/bamboo", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bamboo integration." }, { "info": { "name": "Create/Edit Bugzilla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/bugzilla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bugzilla integration." }, { "info": { "name": "Create/Edit Buildkite integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/buildkite", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Buildkite integration." }, { "info": { "name": "Create/Edit Campfire integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/campfire", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Campfire integration." }, { "info": { "name": "Create/Edit Confluence integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/confluence", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Confluence integration." }, { "info": { "name": "Create/Edit Custom Issue Tracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/custom-issue-tracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Custom Issue Tracker integration." }, { "info": { "name": "Create/Edit Datadog integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/datadog", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Datadog integration." }, { "info": { "name": "Create/Edit Diffblue Cover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/diffblue-cover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Diffblue Cover integration." }, { "info": { "name": "Create/Edit Discord integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/discord", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Discord integration." }, { "info": { "name": "Create/Edit Drone Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/drone-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Drone Ci integration." }, { "info": { "name": "Create/Edit Emails On Push integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/emails-on-push", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Emails On Push integration." }, { "info": { "name": "Create/Edit External Wiki integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/external-wiki", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set External Wiki integration." }, { "info": { "name": "Create/Edit Gitlab Slack Application integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/gitlab-slack-application", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Gitlab Slack Application integration." }, { "info": { "name": "Create/Edit Google Play integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/google-play", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Play integration." }, { "info": { "name": "Create/Edit Hangouts Chat integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/hangouts-chat", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Hangouts Chat integration." }, { "info": { "name": "Create/Edit Harbor integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/harbor", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Harbor integration." }, { "info": { "name": "Create/Edit Irker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/irker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Irker integration." }, { "info": { "name": "Create/Edit Jenkins integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/jenkins", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jenkins integration." }, { "info": { "name": "Create/Edit Jira integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/jira", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira integration." }, { "info": { "name": "Create/Edit Jira Cloud App integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/jira-cloud-app", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira Cloud App integration." }, { "info": { "name": "Create/Edit Linear integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/linear", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Linear integration." }, { "info": { "name": "Create/Edit Matrix integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/matrix", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Matrix integration." }, { "info": { "name": "Create/Edit Mattermost Slash Commands integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/mattermost-slash-commands", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost Slash Commands integration." }, { "info": { "name": "Create/Edit Packagist integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/packagist", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Packagist integration." }, { "info": { "name": "Create/Edit Phorge integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/phorge", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Phorge integration." }, { "info": { "name": "Create/Edit Pipelines Email integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/pipelines-email", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pipelines Email integration." }, { "info": { "name": "Create/Edit Pivotaltracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/pivotaltracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pivotaltracker integration." }, { "info": { "name": "Create/Edit Pumble integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/pumble", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pumble integration." }, { "info": { "name": "Create/Edit Pushover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/pushover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pushover integration." }, { "info": { "name": "Create/Edit Redmine integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/redmine", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Redmine integration." }, { "info": { "name": "Create/Edit Ewm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/ewm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Ewm integration." }, { "info": { "name": "Create/Edit Youtrack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/youtrack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Youtrack integration." }, { "info": { "name": "Create/Edit Clickup integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/clickup", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Clickup integration." }, { "info": { "name": "Create/Edit Slack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/slack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Slack integration." }, { "info": { "name": "Create/Edit Microsoft Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/microsoft-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Microsoft Teams integration." }, { "info": { "name": "Create/Edit Mattermost integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/mattermost", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost integration." }, { "info": { "name": "Create/Edit Teamcity integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/teamcity", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Teamcity integration." }, { "info": { "name": "Create/Edit Telegram integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/telegram", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Telegram integration." }, { "info": { "name": "Create/Edit Unify Circuit integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/unify-circuit", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Unify Circuit integration." }, { "info": { "name": "Create/Edit Webex Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/webex-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Webex Teams integration." }, { "info": { "name": "Create/Edit Zentao integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/zentao", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Zentao integration." }, { "info": { "name": "Create/Edit Squash Tm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/squash-tm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Squash Tm integration." }, { "info": { "name": "Create/Edit Github integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/github", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Github integration." }, { "info": { "name": "Create/Edit Git Guardian integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/git-guardian", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Git Guardian integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Artifact Registry integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/google-cloud-platform-artifact-registry", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Artifact Registry integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Workload Identity Federation integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/google-cloud-platform-workload-identity-federation", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Workload Identity Federation integration." }, { "info": { "name": "Create/Edit Mock Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/mock-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Ci integration." }, { "info": { "name": "Create/Edit Mock Monitoring integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/services/mock-monitoring", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Monitoring integration." }, { "info": { "name": "Get an integration settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/services/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the integration settings." }, { "info": { "name": "Disable an integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/services/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disable the integration. Integration settings are preserved." }, { "info": { "name": "Trigger a slash command for mattermost-slash-commands", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/services/mattermost_slash_commands/trigger", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Added in GitLab 8.13" }, { "info": { "name": "List all active integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/integrations", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of all active integrations." }, { "info": { "name": "Create/Edit Apple App Store integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/apple-app-store", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Apple App Store integration." }, { "info": { "name": "Create/Edit Asana integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/asana", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Asana integration." }, { "info": { "name": "Create/Edit Assembla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/assembla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Assembla integration." }, { "info": { "name": "Create/Edit Bamboo integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/bamboo", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bamboo integration." }, { "info": { "name": "Create/Edit Bugzilla integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/bugzilla", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Bugzilla integration." }, { "info": { "name": "Create/Edit Buildkite integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/buildkite", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Buildkite integration." }, { "info": { "name": "Create/Edit Campfire integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/campfire", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Campfire integration." }, { "info": { "name": "Create/Edit Confluence integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/confluence", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Confluence integration." }, { "info": { "name": "Create/Edit Custom Issue Tracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/custom-issue-tracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Custom Issue Tracker integration." }, { "info": { "name": "Create/Edit Datadog integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/datadog", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Datadog integration." }, { "info": { "name": "Create/Edit Diffblue Cover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/diffblue-cover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Diffblue Cover integration." }, { "info": { "name": "Create/Edit Discord integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/discord", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Discord integration." }, { "info": { "name": "Create/Edit Drone Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/drone-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Drone Ci integration." }, { "info": { "name": "Create/Edit Emails On Push integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/emails-on-push", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Emails On Push integration." }, { "info": { "name": "Create/Edit External Wiki integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/external-wiki", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set External Wiki integration." }, { "info": { "name": "Create/Edit Gitlab Slack Application integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/gitlab-slack-application", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Gitlab Slack Application integration." }, { "info": { "name": "Create/Edit Google Play integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/google-play", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Play integration." }, { "info": { "name": "Create/Edit Hangouts Chat integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/hangouts-chat", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Hangouts Chat integration." }, { "info": { "name": "Create/Edit Harbor integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/harbor", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Harbor integration." }, { "info": { "name": "Create/Edit Irker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/irker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Irker integration." }, { "info": { "name": "Create/Edit Jenkins integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/jenkins", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jenkins integration." }, { "info": { "name": "Create/Edit Jira integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/jira", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira integration." }, { "info": { "name": "Create/Edit Jira Cloud App integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/jira-cloud-app", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Jira Cloud App integration." }, { "info": { "name": "Create/Edit Linear integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/linear", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Linear integration." }, { "info": { "name": "Create/Edit Matrix integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/matrix", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Matrix integration." }, { "info": { "name": "Create/Edit Mattermost Slash Commands integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/mattermost-slash-commands", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost Slash Commands integration." }, { "info": { "name": "Create/Edit Packagist integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/packagist", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Packagist integration." }, { "info": { "name": "Create/Edit Phorge integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/phorge", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Phorge integration." }, { "info": { "name": "Create/Edit Pipelines Email integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/pipelines-email", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pipelines Email integration." }, { "info": { "name": "Create/Edit Pivotaltracker integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/pivotaltracker", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pivotaltracker integration." }, { "info": { "name": "Create/Edit Pumble integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/pumble", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pumble integration." }, { "info": { "name": "Create/Edit Pushover integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/pushover", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Pushover integration." }, { "info": { "name": "Create/Edit Redmine integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/redmine", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Redmine integration." }, { "info": { "name": "Create/Edit Ewm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/ewm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Ewm integration." }, { "info": { "name": "Create/Edit Youtrack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/youtrack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Youtrack integration." }, { "info": { "name": "Create/Edit Clickup integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/clickup", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Clickup integration." }, { "info": { "name": "Create/Edit Slack integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/slack", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Slack integration." }, { "info": { "name": "Create/Edit Microsoft Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/microsoft-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Microsoft Teams integration." }, { "info": { "name": "Create/Edit Mattermost integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/mattermost", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mattermost integration." }, { "info": { "name": "Create/Edit Teamcity integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/teamcity", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Teamcity integration." }, { "info": { "name": "Create/Edit Telegram integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/telegram", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Telegram integration." }, { "info": { "name": "Create/Edit Unify Circuit integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/unify-circuit", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Unify Circuit integration." }, { "info": { "name": "Create/Edit Webex Teams integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/webex-teams", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Webex Teams integration." }, { "info": { "name": "Create/Edit Zentao integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/zentao", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Zentao integration." }, { "info": { "name": "Create/Edit Squash Tm integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/squash-tm", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Squash Tm integration." }, { "info": { "name": "Create/Edit Github integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/github", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Github integration." }, { "info": { "name": "Create/Edit Git Guardian integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/git-guardian", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Git Guardian integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Artifact Registry integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/google-cloud-platform-artifact-registry", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Artifact Registry integration." }, { "info": { "name": "Create/Edit Google Cloud Platform Workload Identity Federation integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/google-cloud-platform-workload-identity-federation", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Google Cloud Platform Workload Identity Federation integration." }, { "info": { "name": "Create/Edit Mock Ci integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/mock-ci", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Ci integration." }, { "info": { "name": "Create/Edit Mock Monitoring integration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/mock-monitoring", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Set Mock Monitoring integration." }, { "info": { "name": "Get an integration settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the integration settings." }, { "info": { "name": "Disable an integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The name of the integration" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disable the integration. Integration settings are preserved." }, { "info": { "name": "Trigger a slash command for mattermost-slash-commands", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/integrations/mattermost_slash_commands/trigger", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Added in GitLab 8.13" }, { "info": { "name": "postApiV4IntegrationsSlackEvents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/integrations/slack/events" }, "docs": "Receive Slack events" }, { "info": { "name": "Process Slack interaction events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/integrations/slack/interactions" }, "docs": "Processes interaction events from Slack" }, { "info": { "name": "Get Slack interactive component options", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/integrations/slack/options" }, "docs": "Retrieves options for Slack interactive components" }, { "info": { "name": "Trigger a global slack command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/slack/trigger" }, "docs": "Added in GitLab 9.4" } ] }, { "info": { "name": "invitations", "type": "folder" }, "items": [ { "info": { "name": "Get a list of group or project invitations viewable by the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/invitations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" } ] }, "docs": "This feature was introduced in GitLab 13.6" }, { "info": { "name": "Invite non-members by email address to a group or project.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/invitations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" } ] }, "docs": "This feature was introduced in GitLab 13.6" }, { "info": { "name": "putApiV4GroupsIdInvitationsEmail", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/invitations/:email", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "email", "value": "", "type": "path", "description": "The email address of the invitation" } ] }, "docs": "Updates a group or project invitation." }, { "info": { "name": "deleteApiV4GroupsIdInvitationsEmail", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/invitations/:email", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "email", "value": "", "type": "path", "description": "The email address of the invitation" } ] }, "docs": "Removes an invitation from a group or project." }, { "info": { "name": "Get a list of group or project invitations viewable by the authenticated user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/invitations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" } ] }, "docs": "This feature was introduced in GitLab 13.6" }, { "info": { "name": "Invite non-members by email address to a group or project.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/invitations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" } ] }, "docs": "This feature was introduced in GitLab 13.6" }, { "info": { "name": "putApiV4ProjectsIdInvitationsEmail", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/invitations/:email", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "email", "value": "", "type": "path", "description": "The email address of the invitation" } ] }, "docs": "Updates a group or project invitation." }, { "info": { "name": "deleteApiV4ProjectsIdInvitationsEmail", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/invitations/:email", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "email", "value": "", "type": "path", "description": "The email address of the invitation" } ] }, "docs": "Removes an invitation from a group or project." } ] }, { "info": { "name": "members", "type": "folder" }, "items": [ { "info": { "name": "getApiV4GroupsIdMembers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" }, { "name": "user_ids", "value": "", "type": "query", "description": "Array of user ids to look up for membership" }, { "name": "skip_users", "value": "", "type": "query", "description": "Array of user ids to be skipped for membership" }, { "name": "show_seat_info", "value": "", "type": "query", "description": "Show seat information for members" }, { "name": "with_saml_identity", "value": "", "type": "query", "description": "List only members with linked SAML identity" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of group or project members viewable by the authenticated user,\n excluding those with inherited membership from ancestor groups." }, { "info": { "name": "postApiV4GroupsIdMembers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" } ] }, "docs": "Adds a member to a group or project." }, { "info": { "name": "getApiV4GroupsIdMembersAll", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/members/all", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" }, { "name": "user_ids", "value": "", "type": "query", "description": "Array of user ids to look up for membership" }, { "name": "show_seat_info", "value": "", "type": "query", "description": "Show seat information for members" }, { "name": "state", "value": "", "type": "query", "description": "Filter results by member state" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of group or project members viewable by the authenticated user,\n including those with inherited membership from ancestor groups." }, { "info": { "name": "getApiV4GroupsIdMembersUserId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Gets a member of a group or project." }, { "info": { "name": "putApiV4GroupsIdMembersUserId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the new member" } ] }, "docs": "Updates a member of a group or project." }, { "info": { "name": "deleteApiV4GroupsIdMembersUserId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" }, { "name": "skip_subresources", "value": "", "type": "query", "description": "Flag indicating if the deletion of direct memberships of the removed member in subgroups and projects should be skipped" }, { "name": "unassign_issuables", "value": "", "type": "query", "description": "Flag indicating if the removed member should be unassigned from any issues or merge requests within given group or project" } ] }, "docs": "Removes a user from a group or project." }, { "info": { "name": "getApiV4GroupsIdMembersAllUserId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/members/all/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Gets a member of a group or project, including those who gained membership through ancestor group" }, { "info": { "name": "postApiV4GroupsIdMembersUserIdOverride", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id/override", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Overrides the access level of an LDAP group member." }, { "info": { "name": "deleteApiV4GroupsIdMembersUserIdOverride", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id/override", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Remove an LDAP group member access level override." }, { "info": { "name": "putApiV4GroupsIdMembersMemberIdApprove", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/members/:member_id/approve", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "member_id", "value": "", "type": "path", "description": "The ID of the member requiring approval" } ] }, "docs": "Approves a pending member" }, { "info": { "name": "postApiV4GroupsIdMembersApproveAll", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/members/approve_all", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" } ] }, "docs": "Approves all pending members" }, { "info": { "name": "getApiV4GroupsIdPendingMembers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/pending_members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Lists all pending members for a group including invited users" }, { "info": { "name": "putApiV4GroupsIdMembersUserIdState", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/members/:user_id/state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the user" } ] }, "docs": "Changes the state of the memberships of a user in the group" }, { "info": { "name": "getApiV4GroupsIdBillableMembersUserIdMemberships", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/billable_members/:user_id/memberships", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the direct memberships of a billable user of a top-level group." }, { "info": { "name": "getApiV4GroupsIdBillableMembersUserIdIndirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/billable_members/:user_id/indirect", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the indirect memberships of a billable user of a top-level group." }, { "info": { "name": "deleteApiV4GroupsIdBillableMembersUserId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/billable_members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a group" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Removes a billable member from a group or project." }, { "info": { "name": "getApiV4ProjectsIdMembers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" }, { "name": "user_ids", "value": "", "type": "query", "description": "Array of user ids to look up for membership" }, { "name": "skip_users", "value": "", "type": "query", "description": "Array of user ids to be skipped for membership" }, { "name": "show_seat_info", "value": "", "type": "query", "description": "Show seat information for members" }, { "name": "with_saml_identity", "value": "", "type": "query", "description": "List only members with linked SAML identity" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of group or project members viewable by the authenticated user,\n excluding those with inherited membership from ancestor groups." }, { "info": { "name": "postApiV4ProjectsIdMembers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" } ] }, "docs": "Adds a member to a group or project." }, { "info": { "name": "getApiV4ProjectsIdMembersAll", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/members/all", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "query", "value": "", "type": "query", "description": "A query string to search for members" }, { "name": "user_ids", "value": "", "type": "query", "description": "Array of user ids to look up for membership" }, { "name": "show_seat_info", "value": "", "type": "query", "description": "Show seat information for members" }, { "name": "state", "value": "", "type": "query", "description": "Filter results by member state" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of group or project members viewable by the authenticated user,\n including those with inherited membership from ancestor groups." }, { "info": { "name": "getApiV4ProjectsIdMembersUserId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Gets a member of a group or project." }, { "info": { "name": "putApiV4ProjectsIdMembersUserId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the new member" } ] }, "docs": "Updates a member of a group or project." }, { "info": { "name": "deleteApiV4ProjectsIdMembersUserId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/members/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" }, { "name": "skip_subresources", "value": "", "type": "query", "description": "Flag indicating if the deletion of direct memberships of the removed member in subgroups and projects should be skipped" }, { "name": "unassign_issuables", "value": "", "type": "query", "description": "Flag indicating if the removed member should be unassigned from any issues or merge requests within given group or project" } ] }, "docs": "Removes a user from a group or project." }, { "info": { "name": "getApiV4ProjectsIdMembersAllUserId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/members/all/:user_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" }, { "name": "user_id", "value": "", "type": "path", "description": "The user ID of the member" } ] }, "docs": "Gets a member of a group or project, including those who gained membership through ancestor group" } ] }, { "info": { "name": "merge_requests", "type": "folder" }, "items": [ { "info": { "name": "List group merge requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user." }, { "name": "author_id", "value": "", "type": "query", "description": "Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "author_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "assignee_id", "value": "", "type": "query", "description": "Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "assignee_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "reviewer_username", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "labels", "value": "", "type": "query", "description": "Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "milestone", "value": "", "type": "query", "description": "Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "reviewer_id", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "state", "value": "", "type": "query", "description": "Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged`." }, { "name": "order_by", "value": "", "type": "query", "description": "Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8." }, { "name": "sort", "value": "", "type": "query", "description": "Returns merge requests sorted in `asc` or `desc` order." }, { "name": "with_labels_details", "value": "", "type": "query", "description": "If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color`" }, { "name": "with_merge_status_recheck", "value": "", "type": "query", "description": "If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0." }, { "name": "created_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or after the given time. Expected in ISO 8601 format." }, { "name": "created_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or before the given time. Expected in ISO 8601 format." }, { "name": "updated_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or after the given time. Expected in ISO 8601 format." }, { "name": "updated_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or before the given time. Expected in ISO 8601 format." }, { "name": "view", "value": "", "type": "query", "description": "If simple, returns the `iid`, URL, title, description, and basic state of merge request" }, { "name": "scope", "value": "", "type": "query", "description": "Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all`" }, { "name": "source_branch", "value": "", "type": "query", "description": "Returns merge requests with the given source branch" }, { "name": "source_project_id", "value": "", "type": "query", "description": "Returns merge requests with the given source project id" }, { "name": "target_branch", "value": "", "type": "query", "description": "Returns merge requests with the given target branch" }, { "name": "search", "value": "", "type": "query", "description": "Search merge requests against their `title` and `description`." }, { "name": "in", "value": "title,description", "type": "query", "description": "Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma." }, { "name": "wip", "value": "", "type": "query", "description": "Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests." }, { "name": "draft", "value": "", "type": "query", "description": "Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests." }, { "name": "not[author_id]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "not[author_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "`` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[reviewer_username]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "not[labels]", "value": "", "type": "query", "description": "`` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "not[milestone]", "value": "", "type": "query", "description": "`` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "not[my_reaction_emoji]", "value": "", "type": "query", "description": "`` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "not[reviewer_id]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "deployed_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed before the given date/time. Expected in ISO 8601 format." }, { "name": "deployed_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed after the given date/time. Expected in ISO 8601 format" }, { "name": "environment", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed to the given environment" }, { "name": "approved", "value": "", "type": "query", "description": "Filters merge requests by their `approved` status. `yes` returns only approved merge requests. `no` returns only non-approved merge requests." }, { "name": "merge_user_id", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`." }, { "name": "merge_user_username", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`." }, { "name": "approver_ids", "value": "", "type": "query", "description": "Return merge requests which have specified the users with the given IDs as an individual approver" }, { "name": "approved_by_ids", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given IDs" }, { "name": "approved_by_usernames", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given\n usernames" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "non_archived", "value": "", "type": "query", "description": "Returns merge requests from non archived projects only." } ] }, "docs": "Get all merge requests for this group and its subgroups." }, { "info": { "name": "Set a time estimate for a merge_request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/time_estimate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge_request." } ] }, "docs": "Sets an estimated time of work for this merge_request." }, { "info": { "name": "Reset the time estimate for a project merge_request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/reset_time_estimate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge_request." } ] }, "docs": "Resets the estimated time for this merge_request to 0 seconds." }, { "info": { "name": "Add spent time for a merge_request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/add_spent_time", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge_request." } ] }, "docs": "Adds spent time for this merge_request." }, { "info": { "name": "Reset spent time for a merge_request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/reset_spent_time", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge_request" } ] }, "docs": "Resets the total spent time for this merge_request to 0 seconds." }, { "info": { "name": "Get time tracking stats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/time_stats", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge_request" } ] }, "docs": "Get time tracking stats" }, { "info": { "name": "List project merge requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "author_id", "value": "", "type": "query", "description": "Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "author_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "assignee_id", "value": "", "type": "query", "description": "Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "assignee_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "reviewer_username", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "labels", "value": "", "type": "query", "description": "Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "milestone", "value": "", "type": "query", "description": "Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "reviewer_id", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "state", "value": "", "type": "query", "description": "Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged`." }, { "name": "order_by", "value": "", "type": "query", "description": "Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8." }, { "name": "sort", "value": "", "type": "query", "description": "Returns merge requests sorted in `asc` or `desc` order." }, { "name": "with_labels_details", "value": "", "type": "query", "description": "If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color`" }, { "name": "with_merge_status_recheck", "value": "", "type": "query", "description": "If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0." }, { "name": "created_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or after the given time. Expected in ISO 8601 format." }, { "name": "created_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or before the given time. Expected in ISO 8601 format." }, { "name": "updated_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or after the given time. Expected in ISO 8601 format." }, { "name": "updated_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or before the given time. Expected in ISO 8601 format." }, { "name": "view", "value": "", "type": "query", "description": "If simple, returns the `iid`, URL, title, description, and basic state of merge request" }, { "name": "scope", "value": "", "type": "query", "description": "Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all`" }, { "name": "source_branch", "value": "", "type": "query", "description": "Returns merge requests with the given source branch" }, { "name": "source_project_id", "value": "", "type": "query", "description": "Returns merge requests with the given source project id" }, { "name": "target_branch", "value": "", "type": "query", "description": "Returns merge requests with the given target branch" }, { "name": "search", "value": "", "type": "query", "description": "Search merge requests against their `title` and `description`." }, { "name": "in", "value": "title,description", "type": "query", "description": "Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma." }, { "name": "wip", "value": "", "type": "query", "description": "Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests." }, { "name": "draft", "value": "", "type": "query", "description": "Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests." }, { "name": "not[author_id]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "not[author_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "`` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[reviewer_username]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "not[labels]", "value": "", "type": "query", "description": "`` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "not[milestone]", "value": "", "type": "query", "description": "`` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "not[my_reaction_emoji]", "value": "", "type": "query", "description": "`` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "not[reviewer_id]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "deployed_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed before the given date/time. Expected in ISO 8601 format." }, { "name": "deployed_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed after the given date/time. Expected in ISO 8601 format" }, { "name": "environment", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed to the given environment" }, { "name": "approved", "value": "", "type": "query", "description": "Filters merge requests by their `approved` status. `yes` returns only approved merge requests. `no` returns only non-approved merge requests." }, { "name": "merge_user_id", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`." }, { "name": "merge_user_username", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`." }, { "name": "approver_ids", "value": "", "type": "query", "description": "Return merge requests which have specified the users with the given IDs as an individual approver" }, { "name": "approved_by_ids", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given IDs" }, { "name": "approved_by_usernames", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given\n usernames" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "iids", "value": "", "type": "query", "description": "Returns the request having the given `iid`." } ] }, "docs": "Get all merge requests for this project." }, { "info": { "name": "Create merge request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." } ] }, "docs": "Create a new merge request." }, { "info": { "name": "Get single merge request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request." }, { "name": "render_html", "value": "", "type": "query", "description": "If `true`, response includes rendered HTML for title and description." }, { "name": "include_diverged_commits_count", "value": "", "type": "query", "description": "If `true`, response includes the commits behind the target branch." }, { "name": "include_rebase_in_progress", "value": "", "type": "query", "description": "If `true`, response includes whether a rebase operation is in progress." } ] }, "docs": "Shows information about a single merge request. Note: the `changes_count` value in the response is a string, not an integer. This is because when an merge request has too many changes to display and store, it is capped at 1,000. In that case, the API returns the string `\"1000+\"` for the changes count." }, { "info": { "name": "Update merge request", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Updates an existing merge request. You can change the target branch, title, or even close the merge request." }, { "info": { "name": "Delete a merge request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request." } ] }, "docs": "Only for administrators and project owners. Deletes the merge request in question. " }, { "info": { "name": "Get single merge request participants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/participants", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get a list of merge request participants." }, { "info": { "name": "Get single merge request reviewers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/reviewers", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get a list of merge request reviewers." }, { "info": { "name": "Get single merge request commits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of merge request commits." }, { "info": { "name": "List merge request context commits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/context_commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get a list of merge request context commits." }, { "info": { "name": "Create merge request context commits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/context_commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Create a list of merge request context commits." }, { "info": { "name": "Delete merge request context commits", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/context_commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "commits", "value": "", "type": "query", "description": "The context commits’ SHA." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Delete a list of merge request context commits." }, { "info": { "name": "Get single merge request changes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/changes", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "unidiff", "value": "", "type": "query", "description": "A diff in a Unified diff format" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Shows information about the merge request including its files and changes." }, { "info": { "name": "Get the merge request diffs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/diffs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "unidiff", "value": "", "type": "query", "description": "A diff in a Unified diff format" } ] }, "docs": "Get a list of merge request diffs." }, { "info": { "name": "Get the merge request raw diffs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/raw_diffs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get the raw diffs of a merge request that can used programmatically." }, { "info": { "name": "Get single merge request pipelines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/pipelines", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request." } ] }, "docs": "Get a list of merge request pipelines." }, { "info": { "name": "Create merge request pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/pipelines", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Create a new pipeline for a merge request. A pipeline created via this endpoint doesn’t run a regular branch/tag pipeline. It requires `.gitlab-ci.yml` to be configured with `only: [merge_requests]` to create jobs." }, { "info": { "name": "Merge a merge request", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/merge", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Accept and merge changes submitted with the merge request using this API." }, { "info": { "name": "Returns the up to date merge-ref HEAD commit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/merge_ref", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Returns the up to date merge-ref HEAD commit" }, { "info": { "name": "Cancel Merge When Pipeline Succeeds", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Cancel merge if \"Merge When Pipeline Succeeds\" is enabled" }, { "info": { "name": "Rebase a merge request", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/rebase", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Automatically rebase the `source_branch` of the merge request against its `target_branch`. This feature was added in GitLab 11.6" }, { "info": { "name": "List issues that close on merge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/closes_issues", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get all the issues that would be closed by merging the provided merge request." }, { "info": { "name": "List issues related to merge request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/related_issues", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Get all the related issues from title, description, commits, comments and discussions of the merge request." }, { "info": { "name": "Get a list of merge request diff versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "Get a single merge request diff version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/versions/:version_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The internal ID of the merge request" }, { "name": "version_id", "value": "", "type": "path", "description": "The ID of the merge request diff version" }, { "name": "unidiff", "value": "", "type": "query", "description": "A diff in a Unified diff format" } ] }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "List merge requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/merge_requests", "params": [ { "name": "author_id", "value": "", "type": "query", "description": "Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "author_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "assignee_id", "value": "", "type": "query", "description": "Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "assignee_username", "value": "", "type": "query", "description": "Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "reviewer_username", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "labels", "value": "", "type": "query", "description": "Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "milestone", "value": "", "type": "query", "description": "Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "reviewer_id", "value": "", "type": "query", "description": "Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "state", "value": "", "type": "query", "description": "Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged`." }, { "name": "order_by", "value": "", "type": "query", "description": "Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8." }, { "name": "sort", "value": "", "type": "query", "description": "Returns merge requests sorted in `asc` or `desc` order." }, { "name": "with_labels_details", "value": "", "type": "query", "description": "If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color`" }, { "name": "with_merge_status_recheck", "value": "", "type": "query", "description": "If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0." }, { "name": "created_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or after the given time. Expected in ISO 8601 format." }, { "name": "created_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests created on or before the given time. Expected in ISO 8601 format." }, { "name": "updated_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or after the given time. Expected in ISO 8601 format." }, { "name": "updated_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests updated on or before the given time. Expected in ISO 8601 format." }, { "name": "view", "value": "", "type": "query", "description": "If simple, returns the `iid`, URL, title, description, and basic state of merge request" }, { "name": "scope", "value": "", "type": "query", "description": "Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all`" }, { "name": "source_branch", "value": "", "type": "query", "description": "Returns merge requests with the given source branch" }, { "name": "source_project_id", "value": "", "type": "query", "description": "Returns merge requests with the given source project id" }, { "name": "target_branch", "value": "", "type": "query", "description": "Returns merge requests with the given target branch" }, { "name": "search", "value": "", "type": "query", "description": "Search merge requests against their `title` and `description`." }, { "name": "in", "value": "title,description", "type": "query", "description": "Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma." }, { "name": "wip", "value": "", "type": "query", "description": "Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests." }, { "name": "draft", "value": "", "type": "query", "description": "Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests." }, { "name": "not[author_id]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`." }, { "name": "not[author_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "`` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee." }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "`` Returns merge requests created by the given `username`. Mutually exclusive with `author_id`." }, { "name": "not[reviewer_username]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. Introduced in GitLab 13.8." }, { "name": "not[labels]", "value": "", "type": "query", "description": "`` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive." }, { "name": "not[milestone]", "value": "", "type": "query", "description": "`` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone." }, { "name": "not[my_reaction_emoji]", "value": "", "type": "query", "description": "`` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction." }, { "name": "not[reviewer_id]", "value": "", "type": "query", "description": "`` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`." }, { "name": "deployed_before", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed before the given date/time. Expected in ISO 8601 format." }, { "name": "deployed_after", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed after the given date/time. Expected in ISO 8601 format" }, { "name": "environment", "value": "2019-03-15T08:00:00Z", "type": "query", "description": "Returns merge requests deployed to the given environment" }, { "name": "approved", "value": "", "type": "query", "description": "Filters merge requests by their `approved` status. `yes` returns only approved merge requests. `no` returns only non-approved merge requests." }, { "name": "merge_user_id", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`." }, { "name": "merge_user_username", "value": "", "type": "query", "description": "Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`." }, { "name": "approver_ids", "value": "", "type": "query", "description": "Return merge requests which have specified the users with the given IDs as an individual approver" }, { "name": "approved_by_ids", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given IDs" }, { "name": "approved_by_usernames", "value": "", "type": "query", "description": "Return merge requests which have been approved by the specified users with the given\n usernames" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "non_archived", "value": "", "type": "query", "description": "Returns merge requests from non archived projects only." } ] }, "docs": "Get all merge requests the authenticated user has access to. By default it returns only merge requests created by the current user. To get all merge requests, use parameter `scope=all`." } ] }, { "info": { "name": "pypi_packages", "type": "folder" }, "items": [ { "info": { "name": "Download a package file from a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/-/packages/pypi/files/:sha256/*file_identifier", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of the group." }, { "name": "file_identifier", "value": "my.pypi.package-0.0.1.tar.gz", "type": "query", "description": "The PyPi package file identifier" }, { "name": "sha256", "value": "5y57017232013c8ac80647f4ca153k3726f6cba62d055cd747844ed95b3c65ff", "type": "path", "description": "The PyPi package sha256 check sum" } ] }, "docs": "This feature was introduced in GitLab 13.12" } ] }, { "info": { "name": "releases", "type": "folder" }, "items": [ { "info": { "name": "List group releases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/releases", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group owned by the authenticated user" }, { "name": "sort", "value": "", "type": "query", "description": "The direction of the order. Either `desc` (default) for descending order or `asc` for ascending order" }, { "name": "simple", "value": "", "type": "query", "description": "Return only limited fields for each release" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Returns a list of group releases." }, { "info": { "name": "List Releases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "order_by", "value": "", "type": "query", "description": "The field to use as order. Either `released_at` (default) or `created_at`" }, { "name": "sort", "value": "", "type": "query", "description": "The direction of the order. Either `desc` (default) for descending order or `asc` for ascending order" }, { "name": "include_html_description", "value": "", "type": "query", "description": "If `true`, a response includes HTML rendered markdown of the release description" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return releases updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return releases updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" } ] }, "docs": "Returns a paginated list of releases. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Create a release", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/releases", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Creates a release. Developer level access to the project is required to create a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Get a release by a tag name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The Git tag the release is associated with" }, { "name": "include_html_description", "value": "", "type": "query", "description": "If `true`, a response includes HTML rendered markdown of the release description" } ] }, "docs": "Gets a release for the given tag. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Update a release", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The Git tag the release is associated with" } ] }, "docs": "Updates a release. Developer level access to the project is required to update a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Delete a release", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The Git tag the release is associated with" } ] }, "docs": "Delete a release. Deleting a release doesn't delete the associated tag. Maintainer level access to the project is required to delete a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Download a project release asset file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/downloads/*direct_asset_path", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The Git tag the release is associated with" }, { "name": "direct_asset_path", "value": "", "type": "query", "description": "The path to the file to download, as specified when creating the release asset" } ] }, "docs": "This feature was introduced in GitLab 15.4." }, { "info": { "name": "Get the latest project release", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases/permalink/latest(/)(*suffix_path)", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "suffix_path", "value": "", "type": "query", "description": "The path to be suffixed to the latest release" } ] }, "docs": "This feature was introduced in GitLab 15.4." }, { "info": { "name": "Collect release evidence", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/evidence", "params": [ { "name": "tag_name", "value": "", "type": "path", "description": "The Git tag the release is associated with" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Creates an evidence for an existing Release. This feature was introduced in GitLab 12.10." }, { "info": { "name": "List links of a release", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/assets/links", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The tag associated with the release" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get assets as links from a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Create a release link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/assets/links", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The tag associated with the release" } ] }, "docs": "Create an asset as a link from a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Get a release link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/assets/links/:link_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The tag associated with the release" }, { "name": "link_id", "value": "", "type": "path", "description": "The ID of the link" } ] }, "docs": "Get an asset as a link from a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Update a release link", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/assets/links/:link_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The tag associated with the release" }, { "name": "link_id", "value": "", "type": "path", "description": "The ID of the link" } ] }, "docs": "Update an asset as a link from a release. This feature was introduced in GitLab 11.7." }, { "info": { "name": "Delete a release link", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/releases/:tag_name/assets/links/:link_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The tag associated with the release" }, { "name": "link_id", "value": "", "type": "path", "description": "The ID of the link" } ] }, "docs": "Deletes an asset as a link from a release. This feature was introduced in GitLab 11.7." } ] }, { "info": { "name": "access_tokens", "type": "folder" }, "items": [ { "info": { "name": "Rotate a resource access token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/access_tokens/self/rotate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The group ID" } ] }, "docs": "Rotates a resource access token by passing it to the API in a header" }, { "info": { "name": "Rotate a resource access token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/access_tokens/self/rotate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The project ID" } ] }, "docs": "Rotates a resource access token by passing it to the API in a header" }, { "info": { "name": "Get single personal access token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/personal_access_tokens/self" }, "docs": "Get the details of a personal access token by passing it to the API in a header" }, { "info": { "name": "Revoke a personal access token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/personal_access_tokens/self" }, "docs": "Revoke a personal access token by passing it to the API in a header" }, { "info": { "name": "Return personal access token associations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/personal_access_tokens/self/associations", "params": [ { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get groups and projects this personal access token can access by passing it to the API in a header" }, { "info": { "name": "Rotate a personal access token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/personal_access_tokens/self/rotate" }, "docs": "Rotates a personal access token by passing it to the API in a header" }, { "info": { "name": "List personal access tokens", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/personal_access_tokens", "params": [ { "name": "user_id", "value": "2", "type": "query", "description": "Filter PATs by User ID" }, { "name": "revoked", "value": "", "type": "query", "description": "Filter tokens where revoked state matches parameter" }, { "name": "state", "value": "active", "type": "query", "description": "Filter tokens which are either active or not" }, { "name": "created_before", "value": "2022-01-01", "type": "query", "description": "Filter tokens which were created before given datetime" }, { "name": "created_after", "value": "2021-01-01", "type": "query", "description": "Filter tokens which were created after given datetime" }, { "name": "last_used_before", "value": "2021-01-01", "type": "query", "description": "Filter tokens which were used before given datetime" }, { "name": "last_used_after", "value": "2022-01-01", "type": "query", "description": "Filter tokens which were used after given datetime" }, { "name": "expires_before", "value": "2022-01-01", "type": "query", "description": "Filter tokens which expire before given datetime" }, { "name": "expires_after", "value": "2021-01-01", "type": "query", "description": "Filter tokens which expire after given datetime" }, { "name": "search", "value": "token", "type": "query", "description": "Filters tokens by name" }, { "name": "sort", "value": "created_at_desc", "type": "query", "description": "Sort tokens" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all personal access tokens the authenticated user has access to." }, { "info": { "name": "Get single personal access token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/personal_access_tokens/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a personal access token by using the ID of the personal access token." }, { "info": { "name": "Revoke a personal access token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/personal_access_tokens/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Revoke a personal access token by using the ID of the personal access token." }, { "info": { "name": "Rotate personal access token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/personal_access_tokens/:id/rotate", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Rotates a personal access token." } ] }, { "info": { "name": "search", "type": "folder" }, "items": [ { "info": { "name": "Search on GitLab within a group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/(-/)search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the group" }, { "name": "search", "value": "", "type": "query", "description": "The expression it should be searched for" }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the search" }, { "name": "state", "value": "", "type": "query", "description": "Filter results by state" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter results by confidentiality" }, { "name": "type", "value": "", "type": "query", "description": "Filter work items by type. Only applies to work_items scope. Available types: issue, task, epic, incident, test_case, requirement, objective, key_result, ticket." }, { "name": "include_archived", "value": "", "type": "query", "description": "Includes archived projects in the search. Introduced in GitLab 18.9." }, { "name": "fields", "value": "", "type": "query", "description": "Array of fields you wish to search. Available with advanced search." }, { "name": "exclude_forks", "value": "", "type": "query", "description": "Excludes forked projects in the search. Available with exact code search. Introduced in GitLab 18.9." }, { "name": "num_context_lines", "value": "", "type": "query", "description": "Number of context lines around each match. Available with advanced and exact code search. Introduced in GitLab 18.11." }, { "name": "regex", "value": "", "type": "query", "description": "Performs a regex code search. Available with exact code search. Introduced in GitLab 18.9" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 10.5." }, { "info": { "name": "Search on GitLab within a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/(-/)search", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "", "type": "query", "description": "The expression it should be searched for" }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the search" }, { "name": "ref", "value": "", "type": "query", "description": "The name of a repository branch or tag. If not given, the default branch is used" }, { "name": "state", "value": "", "type": "query", "description": "Filter results by state" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter results by confidentiality" }, { "name": "type", "value": "", "type": "query", "description": "Filter work items by type. Only applies to work_items scope. Available types: issue, task, epic, incident, test_case, requirement, objective, key_result, ticket." }, { "name": "fields", "value": "", "type": "query", "description": "Array of fields you wish to search. Available with advanced search." }, { "name": "num_context_lines", "value": "", "type": "query", "description": "Number of context lines around each match. Available with advanced and exact code search. Introduced in GitLab 18.11." }, { "name": "regex", "value": "", "type": "query", "description": "Performs a regex code search. Available with exact code search. Introduced in GitLab 18.9" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 10.5." }, { "info": { "name": "Search on GitLab", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/search", "params": [ { "name": "search", "value": "", "type": "query", "description": "The expression it should be searched for" }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the search" }, { "name": "state", "value": "", "type": "query", "description": "Filter results by state" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter results by confidentiality" }, { "name": "type", "value": "", "type": "query", "description": "Filter work items by type. Only applies to work_items scope. Available types: issue, task, epic, incident, test_case, requirement, objective, key_result, ticket." }, { "name": "include_archived", "value": "", "type": "query", "description": "Includes archived projects in the search. Introduced in GitLab 18.9." }, { "name": "fields", "value": "", "type": "query", "description": "Array of fields you wish to search. Available with advanced search." }, { "name": "exclude_forks", "value": "", "type": "query", "description": "Excludes forked projects in the search. Available with exact code search. Introduced in GitLab 18.9." }, { "name": "num_context_lines", "value": "", "type": "query", "description": "Number of context lines around each match. Available with advanced and exact code search. Introduced in GitLab 18.11." }, { "name": "regex", "value": "", "type": "query", "description": "Performs a regex code search. Available with exact code search. Introduced in GitLab 18.9" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 10.5." } ] }, { "info": { "name": "wikis", "type": "folder" }, "items": [ { "info": { "name": "getApiV4GroupsIdWikis", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/wikis", "params": [ { "name": "with_content", "value": "", "type": "query", "description": "Include pages' content" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of wiki pages" }, { "info": { "name": "postApiV4GroupsIdWikis", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/wikis", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Create a wiki page" }, { "info": { "name": "getApiV4GroupsIdWikisSlug", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/groups/:id/wikis/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The slug of a wiki page" }, { "name": "version", "value": "", "type": "query", "description": "The version hash of a wiki page" }, { "name": "render_html", "value": "", "type": "query", "description": "Render content to HTML" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a wiki page" }, { "info": { "name": "putApiV4GroupsIdWikisSlug", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/groups/:id/wikis/:slug", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ] }, "docs": "Update a wiki page" }, { "info": { "name": "deleteApiV4GroupsIdWikisSlug", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/groups/:id/wikis/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The slug of a wiki page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a wiki page" }, { "info": { "name": "Upload an attachment to the wiki repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/groups/:id/wikis/attachments", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 11.3." }, { "info": { "name": "getApiV4ProjectsIdWikis", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/wikis", "params": [ { "name": "with_content", "value": "", "type": "query", "description": "Include pages' content" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of wiki pages" }, { "info": { "name": "postApiV4ProjectsIdWikis", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/wikis", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Create a wiki page" }, { "info": { "name": "getApiV4ProjectsIdWikisSlug", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/wikis/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The slug of a wiki page" }, { "name": "version", "value": "", "type": "query", "description": "The version hash of a wiki page" }, { "name": "render_html", "value": "", "type": "query", "description": "Render content to HTML" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a wiki page" }, { "info": { "name": "putApiV4ProjectsIdWikisSlug", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/wikis/:slug", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ] }, "docs": "Update a wiki page" }, { "info": { "name": "deleteApiV4ProjectsIdWikisSlug", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/wikis/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "The slug of a wiki page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a wiki page" }, { "info": { "name": "Upload an attachment to the wiki repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/wikis/attachments", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 11.3." } ] }, { "info": { "name": "alert_management", "type": "folder" }, "items": [ { "info": { "name": "postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/authorize", "params": [ { "name": "id", "value": "17", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "23", "type": "path", "description": "The IID of the Alert" } ] }, "docs": "Workhorse authorize metric image file upload" }, { "info": { "name": "getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images", "params": [ { "name": "id", "value": "17", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "23", "type": "path", "description": "The IID of the Alert" } ] }, "docs": "Metric Images for alert" }, { "info": { "name": "postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images", "params": [ { "name": "id", "value": "17", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "23", "type": "path", "description": "The IID of the Alert" } ] }, "docs": "Upload a metric image for an alert" }, { "info": { "name": "putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "17", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "23", "type": "path", "description": "The IID of the Alert" }, { "name": "metric_image_id", "value": "42", "type": "path", "description": "The ID of metric image" } ] }, "docs": "Update a metric image for an alert" }, { "info": { "name": "deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/alert_management_alerts/:alert_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "17", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "alert_iid", "value": "23", "type": "path", "description": "The IID of the Alert" }, { "name": "metric_image_id", "value": "42", "type": "path", "description": "The ID of metric image" } ] }, "docs": "Remove a metric image for an alert" } ] }, { "info": { "name": "branches", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryBranches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "search", "value": "", "type": "query", "description": "Return list of branches matching the search criteria" }, { "name": "regex", "value": "", "type": "query", "description": "Return list of branches matching the regex" }, { "name": "sort", "value": "", "type": "query", "description": "Return list of branches sorted by the given field" }, { "name": "page_token", "value": "", "type": "query", "description": "Name of branch to start the pagination from" } ] }, "docs": "Get a project repository branches" }, { "info": { "name": "postApiV4ProjectsIdRepositoryBranches", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create branch" }, { "info": { "name": "getApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path" } ] }, "docs": "Get a single repository branch" }, { "info": { "name": "deleteApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch" } ] }, "docs": "Delete a branch" }, { "info": { "name": "headApiV4ProjectsIdRepositoryBranchesBranch", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches/:branch", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch" } ] }, "docs": "Check if a branch exists" }, { "info": { "name": "putApiV4ProjectsIdRepositoryBranchesBranchProtect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches/:branch/protect", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch" } ] }, "docs": "Protect a single branch" }, { "info": { "name": "putApiV4ProjectsIdRepositoryBranchesBranchUnprotect", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/repository/branches/:branch/unprotect", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch" } ] }, "docs": "Unprotect a single branch" }, { "info": { "name": "deleteApiV4ProjectsIdRepositoryMergedBranches", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/repository/merged_branches", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Delete all merged branches" } ] }, { "info": { "name": "ci_catalog", "type": "folder" }, "items": [ { "info": { "name": "Publish a new component project release as version to the CI/CD catalog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/catalog/publish", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Publishes a release of a catalog resource as version to the CI/CD catalog." } ] }, { "info": { "name": "job_artifacts", "type": "folder" }, "items": [ { "info": { "name": "Download the artifacts archive from a job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/artifacts/:ref_name/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "ref_name", "value": "", "type": "path", "description": "Branch or tag name in repository. `HEAD` or `SHA` references are not supported." }, { "name": "job", "value": "", "type": "query", "description": "The name of the job." }, { "name": "job_token", "value": "", "type": "query", "description": "To be used with triggers for multi-project pipelines, available only on Premium and Ultimate tiers." }, { "name": "search_recent_successful_pipelines", "value": "", "type": "query", "description": "Search across recent successful pipelines instead of just the latest one." } ] }, "docs": "This feature was introduced in GitLab 8.10" }, { "info": { "name": "Download a specific file from artifacts archive from a ref", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/artifacts/:ref_name/raw/*artifact_path", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "ref_name", "value": "", "type": "path", "description": "Branch or tag name in repository. `HEAD` or `SHA` references are not supported." }, { "name": "job", "value": "", "type": "query", "description": "The name of the job." }, { "name": "artifact_path", "value": "", "type": "query", "description": "Path to a file inside the artifacts archive." }, { "name": "job_token", "value": "", "type": "query", "description": "To be used with triggers for multi-project pipelines, available only on Premium and Ultimate tiers." }, { "name": "search_recent_successful_pipelines", "value": "", "type": "query", "description": "Search across recent successful pipelines instead of just the latest one." } ] }, "docs": "This feature was introduced in GitLab 11.5" }, { "info": { "name": "Download the artifacts archive from a job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/artifacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "job_id", "value": "", "type": "path", "description": "The ID of a job" }, { "name": "job_token", "value": "", "type": "query", "description": "To be used with triggers for multi-project pipelines, available only on Premium and Ultimate tiers." } ] }, "docs": "This feature was introduced in GitLab 8.5" }, { "info": { "name": "Delete the artifacts files from a job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/artifacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "job_id", "value": "", "type": "path", "description": "The ID of a job" } ] }, "docs": "This feature was introduced in GitLab 11.9" }, { "info": { "name": "List all files in the artifacts archive", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/artifacts/tree", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "job_id", "value": "42", "type": "path", "description": "ID of a job" }, { "name": "path", "value": "coverage/reports", "type": "query", "description": "Path to browse in the artifacts archive. Defaults to root directory." }, { "name": "recursive", "value": "", "type": "query", "description": "If `true`, return all entries recursively." }, { "name": "job_token", "value": "", "type": "query", "description": "CI/CD job token for multi-project pipelines. Premium and Ultimate only." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Lists all files and directories in the artifacts archive without extracting them" }, { "info": { "name": "Download a specific file from artifacts archive", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/artifacts/*artifact_path", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "job_id", "value": "", "type": "path", "description": "The ID of a job" }, { "name": "artifact_path", "value": "", "type": "query", "description": "Path to a file inside the artifacts archive." }, { "name": "job_token", "value": "", "type": "query", "description": "To be used with triggers for multi-project pipelines, available only on Premium and Ultimate tiers." } ] }, "docs": "This feature was introduced in GitLab 10.0" }, { "info": { "name": "postApiV4ProjectsIdJobsJobIdArtifactsKeep", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/artifacts/keep", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "job_id", "value": "", "type": "path", "description": "The ID of a job" } ] }, "docs": "Keep the artifacts to prevent them from being deleted" }, { "info": { "name": "deleteApiV4ProjectsIdArtifacts", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/artifacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Expire the artifacts files from a project" } ] }, { "info": { "name": "ci_jobs", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdJobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "scope", "value": "pending,running", "type": "query", "description": "The scope of builds to show" }, { "name": "ref", "value": "feature-branch", "type": "query", "description": "The branch name (ref) to filter jobs by" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a projects jobs" }, { "info": { "name": "getApiV4ProjectsIdJobsJobId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a job" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a specific job of a project" }, { "info": { "name": "getApiV4ProjectsIdJobsJobIdTrace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/trace", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a job" }, { "name": "byte_offset", "value": "0", "type": "query", "description": "Byte offset to start reading from" }, { "name": "byte_limit", "value": "51200", "type": "query", "description": "Maximum number of bytes to return" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a trace of a specific job of a project" }, { "info": { "name": "postApiV4ProjectsIdJobsJobIdCancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/cancel", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a job" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Cancel a specific job of a project" }, { "info": { "name": "postApiV4ProjectsIdJobsJobIdRetry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/retry", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a job" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retry a specific job of a project" }, { "info": { "name": "postApiV4ProjectsIdJobsJobIdErase", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/erase", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a build" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Erase job (remove artifacts and the trace)" }, { "info": { "name": "Trigger an actionable job (manual, delayed, etc)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/jobs/:job_id/play", "params": [ { "name": "job_id", "value": "88", "type": "path", "description": "The ID of a Job" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was added in GitLab 8.11" }, { "info": { "name": "getApiV4Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/job" }, "docs": "Get current job using job token" } ] }, { "info": { "name": "ci_resource_groups", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdResourceGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/resource_groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all resource groups for a project" }, { "info": { "name": "getApiV4ProjectsIdResourceGroupsKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/resource_groups/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of the resource group" } ] }, "docs": "Get a specific resource group" }, { "info": { "name": "Edit an existing resource group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/resource_groups/:key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of the resource group" } ] }, "docs": "Updates an existing resource group's properties." }, { "info": { "name": "getApiV4ProjectsIdResourceGroupsKeyCurrentJob", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/resource_groups/:key/current_job", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of the resource group" } ] }, "docs": "Show current job for a specific resource group" }, { "info": { "name": "getApiV4ProjectsIdResourceGroupsKeyUpcomingJobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/resource_groups/:key/upcoming_jobs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key", "value": "", "type": "path", "description": "The key of the resource group" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List upcoming jobs for a specific resource group" } ] }, { "info": { "name": "secure_files", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdSecureFiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/secure_files", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the\n authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get list of secure files in a project" }, { "info": { "name": "postApiV4ProjectsIdSecureFiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/secure_files", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the\n authenticated user" } ] }, "docs": "Create a secure file" }, { "info": { "name": "getApiV4ProjectsIdSecureFilesSecureFileId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/secure_files/:secure_file_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the\n authenticated user" }, { "name": "secure_file_id", "value": "", "type": "path", "description": "The ID of a secure file" } ] }, "docs": "Get the details of a specific secure file in a project" }, { "info": { "name": "deleteApiV4ProjectsIdSecureFilesSecureFileId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/secure_files/:secure_file_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the\n authenticated user" }, { "name": "secure_file_id", "value": "", "type": "path" } ] }, "docs": "Remove a secure file" }, { "info": { "name": "getApiV4ProjectsIdSecureFilesSecureFileIdDownload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/secure_files/:secure_file_id/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the\n authenticated user" }, { "name": "secure_file_id", "value": "", "type": "path", "description": "The ID of a secure file" } ] }, "docs": "Download secure file" } ] }, { "info": { "name": "pipelines", "type": "folder" }, "items": [ { "info": { "name": "Get all Pipelines of the project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "scope", "value": "pending", "type": "query", "description": "The scope of pipelines" }, { "name": "status", "value": "pending", "type": "query", "description": "The status of pipelines" }, { "name": "ref", "value": "develop", "type": "query", "description": "The ref of pipelines" }, { "name": "sha", "value": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "type": "query", "description": "The sha of pipelines" }, { "name": "yaml_errors", "value": "", "type": "query", "description": "Returns pipelines with invalid configurations" }, { "name": "username", "value": "root", "type": "query", "description": "The username of the user who triggered pipelines" }, { "name": "updated_before", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "created_before", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "created_after", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "order_by", "value": "status", "type": "query", "description": "Order pipelines" }, { "name": "sort", "value": "asc", "type": "query", "description": "Sort pipelines" }, { "name": "source", "value": "push", "type": "query", "description": "The source of pipelines" }, { "name": "name", "value": "Build pipeline", "type": "query", "description": "Filter pipelines by name" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Create a new pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" } ] }, "docs": "This feature was introduced in GitLab 8.14" }, { "info": { "name": "Gets the latest pipeline for the project branch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/latest", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "ref", "value": "develop", "type": "query", "description": "Branch ref of pipeline. Uses project default branch if not specified." } ] }, "docs": "This feature was introduced in GitLab 12.3" }, { "info": { "name": "Gets a specific pipeline for the project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 8.11" }, { "info": { "name": "Deletes a pipeline", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 11.6" }, { "info": { "name": "getApiV4ProjectsIdPipelinesPipelineIdJobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/jobs", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" }, { "name": "include_retried", "value": "", "type": "query", "description": "Includes retried jobs" }, { "name": "scope", "value": "pending,running", "type": "query", "description": "The scope of builds to show" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get pipeline jobs" }, { "info": { "name": "getApiV4ProjectsIdPipelinesPipelineIdBridges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/bridges", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" }, { "name": "scope", "value": "pending,running", "type": "query", "description": "The scope of builds to show" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get pipeline bridge jobs" }, { "info": { "name": "Gets the variables for a given pipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/variables", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 11.11" }, { "info": { "name": "Gets the test report for a given pipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/test_report", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 13.0." }, { "info": { "name": "Gets the test report summary for a given pipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/test_report_summary", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 14.2" }, { "info": { "name": "Updates pipeline metadata", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/metadata", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 16.6" }, { "info": { "name": "Retry builds in the pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/retry", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 8.11." }, { "info": { "name": "Cancel all builds in the pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipelines/:pipeline_id/cancel", "params": [ { "name": "id", "value": "11", "type": "path", "description": "The project ID or URL-encoded path" }, { "name": "pipeline_id", "value": "18", "type": "path", "description": "The pipeline ID" } ] }, "docs": "This feature was introduced in GitLab 8.11." } ] }, { "info": { "name": "pipeline_schedules", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdPipelineSchedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "scope", "value": "active", "type": "query", "description": "The scope of pipeline schedules" } ] }, "docs": "Get all pipeline schedules" }, { "info": { "name": "postApiV4ProjectsIdPipelineSchedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a new pipeline schedule" }, { "info": { "name": "getApiV4ProjectsIdPipelineSchedulesPipelineScheduleId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "Get a single pipeline schedule" }, { "info": { "name": "putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "Edit a pipeline schedule" }, { "info": { "name": "deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "Delete a pipeline schedule" }, { "info": { "name": "getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPipelines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/pipelines", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule ID" }, { "name": "scope", "value": "pending", "type": "query", "description": "The scope of pipelines" }, { "name": "status", "value": "pending", "type": "query", "description": "The status of pipelines" }, { "name": "updated_before", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "created_before", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines created before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "created_after", "value": "2015-12-24T15:51:21.880Z", "type": "query", "description": "Return pipelines created after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "sort", "value": "desc", "type": "query", "description": "Sort pipelines" } ] }, "docs": "Get all pipelines triggered from a pipeline schedule" }, { "info": { "name": "postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdTakeOwnership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "Take ownership of a pipeline schedule" }, { "info": { "name": "Play a scheduled pipeline immediately", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/play", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "This feature was added in GitLab 12.8" }, { "info": { "name": "postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/variables", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" } ] }, "docs": "Create a new pipeline schedule variable" }, { "info": { "name": "getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" }, { "name": "key", "value": "NEW_VARIABLE", "type": "path", "description": "The key of the variable" } ] }, "docs": "Get a single pipeline schedule variable" }, { "info": { "name": "putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" }, { "name": "key", "value": "NEW_VARIABLE", "type": "path", "description": "The key of the variable" } ] }, "docs": "Edit a pipeline schedule variable" }, { "info": { "name": "deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "pipeline_schedule_id", "value": "13", "type": "path", "description": "The pipeline schedule id" }, { "name": "key", "value": "NEW_VARIABLE", "type": "path", "description": "The key of the variable" } ] }, "docs": "Delete a pipeline schedule variable" } ] }, { "info": { "name": "ci_triggers", "type": "folder" }, "items": [ { "info": { "name": "postApiV4ProjectsId(refRef)triggerPipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/(ref/:ref/)trigger/pipeline", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "ref", "value": "develop", "type": "path", "description": "The commit sha or name of a branch or tag" } ] }, "docs": "Trigger a GitLab project pipeline" }, { "info": { "name": "getApiV4ProjectsIdTriggers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/triggers", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get trigger tokens list" }, { "info": { "name": "postApiV4ProjectsIdTriggers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/triggers", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a trigger token" }, { "info": { "name": "getApiV4ProjectsIdTriggersTriggerId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/triggers/:trigger_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "trigger_id", "value": "10", "type": "path", "description": "The trigger token ID" } ] }, "docs": "Get specific trigger token of a project" }, { "info": { "name": "putApiV4ProjectsIdTriggersTriggerId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/triggers/:trigger_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "trigger_id", "value": "", "type": "path", "description": "The trigger token ID" } ] }, "docs": "Update a trigger token" }, { "info": { "name": "deleteApiV4ProjectsIdTriggersTriggerId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/triggers/:trigger_id", "params": [ { "name": "id", "value": "18", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "trigger_id", "value": "10", "type": "path", "description": "The trigger token ID" } ] }, "docs": "Delete a trigger token" } ] }, { "info": { "name": "cluster_agents", "type": "folder" }, "items": [ { "info": { "name": "List tokens for an agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id/tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 15.0. Returns a list of tokens for an agent." }, { "info": { "name": "Create an agent token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id/tokens", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" } ] }, "docs": "This feature was introduced in GitLab 15.0. Creates a new token for an agent." }, { "info": { "name": "Get a single agent token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id/tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the agent token" } ] }, "docs": "This feature was introduced in GitLab 15.0. Gets a single agent token." }, { "info": { "name": "Revoke an agent token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id/tokens/:token_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" }, { "name": "token_id", "value": "", "type": "path", "description": "The ID of the agent token" } ] }, "docs": "This feature was introduced in GitLab 15.0. Revokes an agent token." }, { "info": { "name": "List the agents for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 14.10. Returns the list of agents registered for the project." }, { "info": { "name": "Register an agent with a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 14.10. Registers an agent to the project." }, { "info": { "name": "Get details about an agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" } ] }, "docs": "This feature was introduced in GitLab 14.10. Gets a single agent details." }, { "info": { "name": "Delete a registered agent", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/cluster_agents/:agent_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "agent_id", "value": "", "type": "path", "description": "The ID of an agent" } ] }, "docs": "This feature was introduced in GitLab 14.10. Deletes an existing agent registration." } ] }, { "info": { "name": "commits", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryCommits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "ref_name", "value": "v1.1.0", "type": "query", "description": "The name of a repository branch or tag, if not given the default branch is used" }, { "name": "since", "value": "2021-09-20T11:50:22.001", "type": "query", "description": "Only commits after or on this date will be returned" }, { "name": "until", "value": "2021-09-20T11:50:22.001", "type": "query", "description": "Only commits before or on this date will be returned" }, { "name": "path", "value": "README.md", "type": "query", "description": "The file path" }, { "name": "follow", "value": "", "type": "query", "description": "Follow file renames when filtering by path" }, { "name": "author", "value": "John Smith", "type": "query", "description": "Search commits by commit author" }, { "name": "all", "value": "", "type": "query", "description": "Every commit will be returned" }, { "name": "with_stats", "value": "", "type": "query", "description": "Stats about each commit will be added to the response" }, { "name": "first_parent", "value": "", "type": "query", "description": "Only include the first parent of merges" }, { "name": "order", "value": "", "type": "query", "description": "List commits in order" }, { "name": "trailers", "value": "", "type": "query", "description": "Parse and include Git trailers for every commit" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a project repository commits" }, { "info": { "name": "Create a new commit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 8.13" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsSha", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag" }, { "name": "stats", "value": "", "type": "query", "description": "Include commit stats" } ] }, "docs": "Get a specific commit of a project" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaDiff", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/diff", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "unidiff", "value": "", "type": "query", "description": "A diff in a Unified diff format" } ] }, "docs": "Get the diff for a specific commit of a project" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaComments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag" } ] }, "docs": "Get a commit's comments" }, { "info": { "name": "postApiV4ProjectsIdRepositoryCommitsShaComments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag on which to post a comment" } ] }, "docs": "Post comment to commit" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaSequence", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/sequence", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit SHA" }, { "name": "first_parent", "value": "", "type": "query", "description": "Only include the first parent of merges" } ] }, "docs": "Get the sequence count of a commit SHA" }, { "info": { "name": "Cherry pick commit into a branch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/cherry_pick", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag to be cherry-picked" } ] }, "docs": "This feature was introduced in GitLab 8.15" }, { "info": { "name": "Revert a commit in a branch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/revert", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "Commit SHA to revert" } ] }, "docs": "This feature was introduced in GitLab 11.5" }, { "info": { "name": "Get all references a commit is pushed to", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/refs", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha" }, { "name": "type", "value": "", "type": "query", "description": "Scope" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 10.6" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaMergeRequests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag on which to find Merge Requests" }, { "name": "state", "value": "merged", "type": "query", "description": "Filter merge-requests by state" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get Merge Requests associated with a commit" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaSignature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/signature", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "", "type": "path", "description": "A commit sha, or the name of a branch or tag" } ] }, "docs": "Get a commit's signature" } ] }, { "info": { "name": "commit_statuses", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryCommitsShaStatuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/commits/:sha/statuses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project." }, { "name": "sha", "value": "18f3e63d05582537db6d183d9d557be09e1f90c8", "type": "path", "description": "Hash of the commit." }, { "name": "ref", "value": "develop", "type": "query", "description": "Name of the branch or tag. Default is the default branch." }, { "name": "stage", "value": "test", "type": "query", "description": "Filter statuses by build stage." }, { "name": "name", "value": "bundler:audit", "type": "query", "description": "Filter statuses by job name." }, { "name": "pipeline_id", "value": "1234", "type": "query", "description": "Filter statuses by pipeline ID." }, { "name": "all", "value": "", "type": "query", "description": "Include all statuses instead of latest only. Default is `false`." }, { "name": "order_by", "value": "", "type": "query", "description": "Values for sorting statuses. Valid values are `id` and `pipeline_id`. Default is `id`." }, { "name": "sort", "value": "", "type": "query", "description": "Sort statuses in ascending or descending order. Valid values are `asc` and `desc`. Default is `asc`." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a commit's statuses" }, { "info": { "name": "postApiV4ProjectsIdStatusesSha", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/statuses/:sha", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the project." }, { "name": "sha", "value": "18f3e63d05582537db6d183d9d557be09e1f90c8", "type": "path", "description": "The commit hash" } ] }, "docs": "Post status to a commit" } ] }, { "info": { "name": "draft_notes", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request" } ] }, "docs": "Get a list of merge request draft notes" }, { "info": { "name": "postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request." } ] }, "docs": "Create a new draft note" }, { "info": { "name": "getApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request" }, { "name": "draft_note_id", "value": "", "type": "path", "description": "The ID of a draft note" } ] }, "docs": "Get a single draft note" }, { "info": { "name": "putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project." }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request." }, { "name": "draft_note_id", "value": "", "type": "path", "description": "The ID of a draft note" } ] }, "docs": "Modify an existing draft note" }, { "info": { "name": "deleteApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request" }, { "name": "draft_note_id", "value": "", "type": "path", "description": "The ID of a draft note" } ] }, "docs": "Delete a draft note" }, { "info": { "name": "putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteIdPublish", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id/publish", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request" }, { "name": "draft_note_id", "value": "", "type": "path", "description": "The ID of a draft note" } ] }, "docs": "Publish a pending draft note" }, { "info": { "name": "postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesBulkPublish", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/draft_notes/bulk_publish", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The ID of a merge request" } ] }, "docs": "Bulk publish all pending draft notes" } ] }, { "info": { "name": "environments", "type": "folder" }, "items": [ { "info": { "name": "List environments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/environments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "name", "value": "", "type": "query", "description": "Return the environment with this name. Mutually exclusive with search" }, { "name": "search", "value": "", "type": "query", "description": "Return list of environments matching the search criteria. Mutually exclusive with name. Must be at least 3 characters." }, { "name": "states", "value": "", "type": "query", "description": "List all environments that match a specific state. Accepted values: `available`, `stopping`, or `stopped`. If no state value given, returns all environments" } ] }, "docs": "Get all environments for a given project. This feature was introduced in GitLab 8.11." }, { "info": { "name": "Create a new environment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/environments", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Creates a new environment with the given name and `external_url`. It returns `201` if the environment was successfully created, `400` for wrong parameters. This feature was introduced in GitLab 8.11." }, { "info": { "name": "getApiV4ProjectsIdEnvironmentsEnvironmentId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/environments/:environment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "environment_id", "value": "", "type": "path", "description": "The ID of the environment" } ] }, "docs": "Get a specific environment" }, { "info": { "name": "Update an existing environment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/environments/:environment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "environment_id", "value": "", "type": "path", "description": "The ID of the environment" } ] }, "docs": "Updates an existing environment name and/or `external_url`. It returns `200` if the environment was successfully updated. In case of an error, a status code `400` is returned. This feature was introduced in GitLab 8.11." }, { "info": { "name": "Delete an environment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/environments/:environment_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "environment_id", "value": "", "type": "path", "description": "The ID of the environment" } ] }, "docs": "It returns 204 if the environment was successfully deleted, and 404 if the environment does not exist. This feature was introduced in GitLab 8.11." }, { "info": { "name": "Delete multiple stopped review apps", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/environments/review_apps", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "before", "value": "", "type": "query", "description": "The date before which environments can be deleted. Defaults to 30 days ago. Expected in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of environments to delete. Defaults to 100" }, { "name": "dry_run", "value": "", "type": "query", "description": "Defaults to true for safety reasons. It performs a dry run where no actual deletion will be performed. Set to false to actually delete the environment" } ] }, "docs": "It schedules for deletion multiple environments that have already been stopped and are in the review app folder. The actual deletion is performed after 1 week from the time of execution. By default, it only deletes environments 30 days or older. You can change this default using the `before` parameter." }, { "info": { "name": "Stop an environment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/environments/:environment_id/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "environment_id", "value": "", "type": "path", "description": "The ID of the environment" } ] }, "docs": "It returns 200 if the environment was successfully stopped." }, { "info": { "name": "Stop stale environments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/environments/stop_stale", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "It returns `200` if stale environment check was scheduled successfully" } ] }, { "info": { "name": "error_tracking", "type": "folder" }, "items": [ { "info": { "name": "List project client keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/client_keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "List all client keys. This feature was introduced in GitLab 14.3." }, { "info": { "name": "Create a client key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/client_keys", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Creates a new client key for a project. The public key attribute is generated automatically.This feature was introduced in GitLab 14.3." }, { "info": { "name": "Delete a client key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/client_keys/:key_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "key_id", "value": "", "type": "path" } ] }, "docs": "Removes a client key from the project. This feature was introduced in GitLab 14.3." }, { "info": { "name": "Get Error Tracking settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/settings", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Get error tracking settings for the project. This feature was introduced in GitLab 12.7." }, { "info": { "name": "Update Error Tracking project settings. Available in GitLab 15.10 and later.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/settings", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Update Error Tracking settings for a project. Only for users with Maintainer role for the project." }, { "info": { "name": "Enable or disable the Error Tracking project settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/error_tracking/settings", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "The API allows you to enable or disable the Error Tracking settings for a project.Only for users with the Maintainer role for the project." } ] }, { "info": { "name": "feature_flags", "type": "folder" }, "items": [ { "info": { "name": "List feature flags for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "scope", "value": "", "type": "query", "description": "The scope of feature flags, one of: `enabled`, `disabled`" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets all feature flags of the requested project. This feature was introduced in GitLab 12.5." }, { "info": { "name": "Create a new feature flag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Creates a new feature flag. This feature was introduced in GitLab 12.5." }, { "info": { "name": "Get a single feature flag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags/:feature_flag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "feature_flag_name", "value": "", "type": "path", "description": "The name of the feature flag" } ] }, "docs": "Gets a single feature flag. This feature was introduced in GitLab 12.5." }, { "info": { "name": "Update a feature flag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags/:feature_flag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "feature_flag_name", "value": "", "type": "path", "description": "The name of the feature flag" } ] }, "docs": "Updates a feature flag. This feature was introduced in GitLab 13.2." }, { "info": { "name": "Delete a feature flag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags/:feature_flag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "feature_flag_name", "value": "", "type": "path", "description": "The name of the feature flag" } ] }, "docs": "Deletes a feature flag. This feature was introduced in GitLab 12.5." }, { "info": { "name": "List all feature flag user lists for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags_user_lists", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "", "type": "query", "description": "Return user lists matching the search criteria" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets all feature flag user lists for the requested project. This feature was introduced in GitLab 12.10." }, { "info": { "name": "Create a feature flag user list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags_user_lists", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Creates a feature flag user list. This feature was introduced in GitLab 12.10." }, { "info": { "name": "Get a feature flag user list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags_user_lists/:iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "iid", "value": "", "type": "path", "description": "The internal ID of the project's feature flag user list" } ] }, "docs": "Gets a feature flag user list. This feature was introduced in GitLab 12.10." }, { "info": { "name": "Update a feature flag user list", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags_user_lists/:iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "iid", "value": "", "type": "path", "description": "The internal ID of the project's feature flag user list" } ] }, "docs": "Updates a feature flag user list. This feature was introduced in GitLab 12.10." }, { "info": { "name": "Delete feature flag user list", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/feature_flags_user_lists/:iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "iid", "value": "", "type": "path", "description": "The internal ID of the project's feature flag user list" } ] }, "docs": "Deletes a feature flag user list. This feature was introduced in GitLab 12.10." } ] }, { "info": { "name": "files", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryFilesFilePathBlame", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path/blame", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of branch, tag or commit" }, { "name": "range[start]", "value": "", "type": "query", "description": "The first line of the range to blame" }, { "name": "range[end]", "value": "", "type": "query", "description": "The last line of the range to blame" } ] }, "docs": "Get blame file from the repository" }, { "info": { "name": "headApiV4ProjectsIdRepositoryFilesFilePathBlame", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path/blame", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of branch, tag or commit" } ] }, "docs": "Get blame file metadata from repository" }, { "info": { "name": "getApiV4ProjectsIdRepositoryFilesFilePathRaw", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path/raw", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of branch, tag or commit" }, { "name": "lfs", "value": "", "type": "query", "description": "Retrieve binary data for a file that is an lfs pointer" } ] }, "docs": "Get raw file contents from the repository" }, { "info": { "name": "getApiV4ProjectsIdRepositoryFilesFilePath", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of branch, tag or commit" } ] }, "docs": "Get a file from the repository" }, { "info": { "name": "postApiV4ProjectsIdRepositoryFilesFilePath", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." } ] }, "docs": "Create new file in repository" }, { "info": { "name": "putApiV4ProjectsIdRepositoryFilesFilePath", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." } ] }, "docs": "Update existing file in repository" }, { "info": { "name": "deleteApiV4ProjectsIdRepositoryFilesFilePath", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "branch", "value": "main", "type": "query", "description": "Name of the branch to commit into. To create a new branch, also provide `start_branch`." }, { "name": "commit_message", "value": "Initial commit", "type": "query", "description": "Commit message" }, { "name": "start_branch", "value": "main", "type": "query", "description": "Name of the branch to start the new commit from" }, { "name": "author_email", "value": "johndoe@example.com", "type": "query", "description": "The email of the author" }, { "name": "author_name", "value": "John Doe", "type": "query", "description": "The name of the author" }, { "name": "last_commit_id", "value": "2695effb5807a22ff3d138d593fd856244e155e7", "type": "query", "description": "Last known file commit id" } ] }, "docs": "Delete an existing file in repository" }, { "info": { "name": "headApiV4ProjectsIdRepositoryFilesFilePath", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/v4/projects/:id/repository/files/:file_path", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The project ID" }, { "name": "file_path", "value": "lib%2Fclass%2Erb", "type": "path", "description": "The URL-encoded path to the file." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of branch, tag or commit" } ] }, "docs": "Get file metadata from repository" } ] }, { "info": { "name": "freeze_periods", "type": "folder" }, "items": [ { "info": { "name": "List freeze periods", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/freeze_periods", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Paginated list of Freeze Periods, sorted by created_at in ascending order. This feature was introduced in GitLab 13.0." }, { "info": { "name": "Create a freeze period", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/freeze_periods", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Creates a freeze period. This feature was introduced in GitLab 13.0." }, { "info": { "name": "Get a freeze period", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/freeze_periods/:freeze_period_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "freeze_period_id", "value": "", "type": "path", "description": "The ID of the freeze period" } ] }, "docs": "Get a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0." }, { "info": { "name": "Update a freeze period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/freeze_periods/:freeze_period_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "freeze_period_id", "value": "", "type": "path" } ] }, "docs": "Updates a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0." }, { "info": { "name": "Delete a freeze period", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/freeze_periods/:freeze_period_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "freeze_period_id", "value": "", "type": "path", "description": "The ID of the freeze period" } ] }, "docs": "Deletes a freeze period for the given `freeze_period_id`. This feature was introduced in GitLab 13.0." } ] }, { "info": { "name": "issues", "type": "folder" }, "items": [ { "info": { "name": "List issue relations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/links", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project’s issue" } ] }, "docs": "Get a list of a given issue’s linked issues, sorted by the relationship creation datetime (ascending).Issues are filtered according to the user authorizations." }, { "info": { "name": "Create an issue link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/links", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project’s issue" } ] }, "docs": "Creates a two-way relation between two issues.The user must be allowed to update both issues to succeed." }, { "info": { "name": "Get an issue link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/links/:issue_link_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project’s issue" }, { "name": "issue_link_id", "value": "", "type": "path", "description": "ID of an issue relationship" } ] }, "docs": "Gets details about an issue link. This feature was introduced in GitLab 15.1." }, { "info": { "name": "Delete an issue link", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/links/:issue_link_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project’s issue" }, { "name": "issue_link_id", "value": "", "type": "path", "description": "The ID of an issue relationship" } ] }, "docs": "Deletes an issue link, thus removes the two-way relationship." }, { "info": { "name": "Set a time estimate for a issue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/time_estimate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of the issue." } ] }, "docs": "Sets an estimated time of work for this issue." }, { "info": { "name": "Reset the time estimate for a project issue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/reset_time_estimate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of the issue." } ] }, "docs": "Resets the estimated time for this issue to 0 seconds." }, { "info": { "name": "Add spent time for a issue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/add_spent_time", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of the issue." } ] }, "docs": "Adds spent time for this issue." }, { "info": { "name": "Reset spent time for a issue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/reset_spent_time", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of the issue" } ] }, "docs": "Resets the total spent time for this issue to 0 seconds." }, { "info": { "name": "Get time tracking stats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/time_stats", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of the issue" } ] }, "docs": "Get time tracking stats" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIidRelatedMergeRequests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/related_merge_requests", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "List merge requests that are related to the issue" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIidParticipants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/participants", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "List participants for an issue" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIidUserAgentDetail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/user_agent_detail", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Get the user agent details for an issue" }, { "info": { "name": "getApiV4Issues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/issues", "params": [ { "name": "with_labels_details", "value": "", "type": "query", "description": "Return titles of labels and other details" }, { "name": "state", "value": "", "type": "query", "description": "Return opened, closed, or all issues" }, { "name": "closed_by_id", "value": "", "type": "query", "description": "Return issues which were closed by the user with the given ID." }, { "name": "order_by", "value": "", "type": "query", "description": "Return issues ordered by `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, or `updated_at` fields." }, { "name": "sort", "value": "", "type": "query", "description": "Return issues sorted in `asc` or `desc` order." }, { "name": "due_date", "value": "", "type": "query", "description": "Return issues that have no due date (`0`), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, `0`" }, { "name": "issue_type", "value": "", "type": "query", "description": "The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket" }, { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "non_archived", "value": "", "type": "query", "description": "Return issues from non archived projects" } ] }, "docs": "Get currently authenticated user's issues" }, { "info": { "name": "getApiV4IssuesId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/issues/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Issue" } ] }, "docs": "Get specified issue (admin only)" }, { "info": { "name": "getApiV4IssuesStatistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/issues_statistics", "params": [ { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" } ] }, "docs": "Get currently authenticated user's issues statistics" } ] }, { "info": { "name": "projects", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdIssues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "with_labels_details", "value": "", "type": "query", "description": "Return titles of labels and other details" }, { "name": "state", "value": "", "type": "query", "description": "Return opened, closed, or all issues" }, { "name": "closed_by_id", "value": "", "type": "query", "description": "Return issues which were closed by the user with the given ID." }, { "name": "order_by", "value": "", "type": "query", "description": "Return issues ordered by `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, or `updated_at` fields." }, { "name": "sort", "value": "", "type": "query", "description": "Return issues sorted in `asc` or `desc` order." }, { "name": "due_date", "value": "", "type": "query", "description": "Return issues that have no due date (`0`), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, `0`" }, { "name": "issue_type", "value": "", "type": "query", "description": "The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket" }, { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for obtaining the next set of records" } ] }, "docs": "Get a list of project issues" }, { "info": { "name": "postApiV4ProjectsIdIssues", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a new project issue" }, { "info": { "name": "getApiV4ProjectsIdIssuesStatistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues_statistics", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "labels", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "milestone", "value": "", "type": "query", "description": "Milestone title" }, { "name": "milestone_id", "value": "", "type": "query", "description": "Return issues assigned to milestones with the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "iids", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "search", "value": "", "type": "query", "description": "Search issues for text present in the title, description, or any combination of these" }, { "name": "in", "value": "", "type": "query", "description": "`title`, `description`, or a string joining them with comma" }, { "name": "author_id", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given ID" }, { "name": "author_username", "value": "", "type": "query", "description": "Return issues which are authored by the user with the given username" }, { "name": "assignee_id", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given ID" }, { "name": "assignee_username", "value": "", "type": "query", "description": "Return issues which are assigned to the user with the given username" }, { "name": "created_after", "value": "", "type": "query", "description": "Return issues created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return issues created before the specified time" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return issues updated after the specified time" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return issues updated before the specified time" }, { "name": "not[labels]", "value": "", "type": "query", "description": "Comma-separated list of label names" }, { "name": "not[milestone]", "value": "", "type": "query", "description": "Milestone title" }, { "name": "not[milestone_id]", "value": "", "type": "query", "description": "Return issues assigned to milestones without the specified timebox value (\"Any\", \"None\", \"Upcoming\" or \"Started\")" }, { "name": "not[iids]", "value": "", "type": "query", "description": "The IID array of issues" }, { "name": "not[author_id]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given ID" }, { "name": "not[author_username]", "value": "", "type": "query", "description": "Return issues which are not authored by the user with the given username" }, { "name": "not[assignee_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given ID" }, { "name": "not[assignee_username]", "value": "", "type": "query", "description": "Return issues which are not assigned to the user with the given username" }, { "name": "not[weight]", "value": "", "type": "query", "description": "Return issues without the specified weight" }, { "name": "not[iteration_id]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given ID" }, { "name": "not[iteration_title]", "value": "", "type": "query", "description": "Return issues which are not assigned to the iteration with the given title" }, { "name": "scope", "value": "", "type": "query", "description": "Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`" }, { "name": "my_reaction_emoji", "value": "", "type": "query", "description": "Return issues reacted by the authenticated user by the given emoji" }, { "name": "confidential", "value": "", "type": "query", "description": "Filter confidential or public issues" }, { "name": "weight", "value": "", "type": "query", "description": "The weight of the issue" }, { "name": "epic_id", "value": "", "type": "query", "description": "The ID of an epic associated with the issues" }, { "name": "health_status", "value": "", "type": "query", "description": "The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any" }, { "name": "iteration_id", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given ID" }, { "name": "iteration_title", "value": "", "type": "query", "description": "Return issues which are assigned to the iteration with the given title" } ] }, "docs": "Get statistics for the list of project issues" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Get a single project issue" }, { "info": { "name": "putApiV4ProjectsIdIssuesIssueIid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Update an existing issue" }, { "info": { "name": "deleteApiV4ProjectsIdIssuesIssueIid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Delete a project issue" }, { "info": { "name": "putApiV4ProjectsIdIssuesIssueIidReorder", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/reorder", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Reorder an existing issue" }, { "info": { "name": "postApiV4ProjectsIdIssuesIssueIidMove", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/move", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Move an existing issue" }, { "info": { "name": "postApiV4ProjectsIdIssuesIssueIidClone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/clone", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "Clone an existing issue" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIidClosedBy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/closed_by", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path", "description": "The internal ID of a project issue" } ] }, "docs": "List merge requests closing issue" }, { "info": { "name": "Workhorse authorize the file upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/uploads/authorize", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 13.11" }, { "info": { "name": "getApiV4ProjectsIdUploads", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/uploads", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the list of uploads of a project" }, { "info": { "name": "postApiV4ProjectsIdUploads", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/uploads", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Upload a file" }, { "info": { "name": "getApiV4ProjectsIdUploadsUploadId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/uploads/:upload_id", "params": [ { "name": "upload_id", "value": "", "type": "path", "description": "The ID of a project upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Download a single project upload by ID" }, { "info": { "name": "deleteApiV4ProjectsIdUploadsUploadId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/uploads/:upload_id", "params": [ { "name": "upload_id", "value": "", "type": "path", "description": "The ID of a project upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a single project upload by ID" }, { "info": { "name": "getApiV4ProjectsIdUploadsSecretFilename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/uploads/:secret/:filename", "params": [ { "name": "secret", "value": "", "type": "path", "description": "The 32-character secret of a project upload" }, { "name": "filename", "value": "", "type": "path", "description": "The filename of a project upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Download a single project upload by secret and filename" }, { "info": { "name": "deleteApiV4ProjectsIdUploadsSecretFilename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/uploads/:secret/:filename", "params": [ { "name": "secret", "value": "", "type": "path", "description": "The 32-character secret of a project upload" }, { "name": "filename", "value": "", "type": "path", "description": "The filename of a project upload" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a single project upload by secret and filename" }, { "info": { "name": "Create merge request for missing ci config in project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/create_ci_config", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Creates a merge request to add missing CI configuration" }, { "info": { "name": "getApiV4ProjectsIdRegistryProtectionRepositoryRules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/repository/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Get list of container registry protection rules for a project" }, { "info": { "name": "postApiV4ProjectsIdRegistryProtectionRepositoryRules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/repository/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a container protection rule for a project" }, { "info": { "name": "patchApiV4ProjectsIdRegistryProtectionRepositoryRulesProtectionRuleId", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/repository/rules/:protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "protection_rule_id", "value": "", "type": "path", "description": "The ID of the container protection rule" } ] }, "docs": "Update a container protection rule for a project" }, { "info": { "name": "deleteApiV4ProjectsIdRegistryProtectionRepositoryRulesProtectionRuleId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/repository/rules/:protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "protection_rule_id", "value": "", "type": "path", "description": "The ID of the container protection rule" } ] }, "docs": "Delete container protection rule" }, { "info": { "name": "Gets a list of container protection tag rules for a project.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/tag/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." } ] }, "docs": "This feature was introduced in GitLab 18.7." }, { "info": { "name": "Create a container protection tag rule for a project. 5 rule limit per project.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/tag/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." } ] }, "docs": "This feature was introduced in GitLab 18.8." }, { "info": { "name": "Update a container protection tag rule for a project.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/tag/rules/:protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "protection_rule_id", "value": "", "type": "path", "description": "The ID of the container protection tag rule." } ] }, "docs": "This feature was introduced in GitLab 18.9." }, { "info": { "name": "Delete container protection tag rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/registry/protection/tag/rules/:protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project." }, { "name": "protection_rule_id", "value": "", "type": "path", "description": "The ID of the container protection tag rule." } ] }, "docs": "This feature was introduced in GitLab 18.9." }, { "info": { "name": "getApiV4ProjectsIdPackagesProtectionRules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/protection/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Get list of package protection rules for a project" }, { "info": { "name": "postApiV4ProjectsIdPackagesProtectionRules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/packages/protection/rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a package protection rule for a project" }, { "info": { "name": "patchApiV4ProjectsIdPackagesProtectionRulesPackageProtectionRuleId", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/packages/protection/rules/:package_protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_protection_rule_id", "value": "", "type": "path", "description": "The ID of the package protection rule" } ] }, "docs": "Update a package protection rule for a project" }, { "info": { "name": "deleteApiV4ProjectsIdPackagesProtectionRulesPackageProtectionRuleId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/packages/protection/rules/:package_protection_rule_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "package_protection_rule_id", "value": "", "type": "path", "description": "The ID of the package protection rule" } ] }, "docs": "Delete package protection rule" }, { "info": { "name": "getApiV4ProjectsIdStatistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/statistics", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Get the list of project fetch statistics for the last 30 days" }, { "info": { "name": "postApiV4ProjectsIdRestore", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/restore", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Restore a project" }, { "info": { "name": "getApiV4Projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects", "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to." }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of projects matching the search criteria" }, { "name": "search_namespaces", "value": "", "type": "query", "description": "Include ancestor namespaces when matching search criteria" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "imported", "value": "", "type": "query", "description": "Limit by imported by authenticated user" }, { "name": "membership", "value": "", "type": "query", "description": "Limit by projects that the current user is a member of" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "with_programming_language", "value": "", "type": "query", "description": "Limit to repositories which use the given programming language" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "id_after", "value": "", "type": "query", "description": "Limit results to projects with IDs greater than the specified ID" }, { "name": "id_before", "value": "", "type": "query", "description": "Limit results to projects with IDs less than the specified ID" }, { "name": "last_activity_after", "value": "", "type": "query", "description": "Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "last_activity_before", "value": "", "type": "query", "description": "Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Which storage shard the repository is on. Available only to admins" }, { "name": "topic", "value": "", "type": "query", "description": "Comma-separated list of topics. Limit results to projects having all topics" }, { "name": "topic_id", "value": "", "type": "query", "description": "Limit results to projects with the assigned topic given by the topic ID" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "include_pending_delete", "value": "", "type": "query", "description": "Include projects in pending delete state. Can only be set by admins" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Date when the project was marked for deletion" }, { "name": "active", "value": "", "type": "query", "description": "Limit by projects that are not archived and not marked for deletion" }, { "name": "wiki_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where wiki checksum is failed" }, { "name": "repository_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where repository checksum is failed" }, { "name": "include_hidden", "value": "", "type": "query", "description": "Include hidden projects. Can only be set by admins" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of visible projects for authenticated user" }, { "info": { "name": "postApiV4Projects", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects" }, "docs": "Create new project" }, { "info": { "name": "postApiV4ProjectsUserUserId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/user/:user_id", "params": [ { "name": "user_id", "value": "1", "type": "path", "description": "The ID of a user" } ] }, "docs": "Create new project for a specified user. Only available to admin users." }, { "info": { "name": "getApiV4ProjectsIdShareLocations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/share_locations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the project" }, { "name": "search", "value": "", "type": "query", "description": "Return list of groups matching the search criteria" } ] }, "docs": "Returns group that can be shared with the given project" }, { "info": { "name": "getApiV4ProjectsId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" }, { "name": "license", "value": "", "type": "query", "description": "Include project license data" } ] }, "docs": "Get a single project" }, { "info": { "name": "putApiV4ProjectsId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Update an existing project" }, { "info": { "name": "deleteApiV4ProjectsId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Delete a project" }, { "info": { "name": "postApiV4ProjectsIdFork", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/fork", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Fork new project for the current user or provided namespace." }, { "info": { "name": "deleteApiV4ProjectsIdFork", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/fork", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Remove a forked_from relationship" }, { "info": { "name": "getApiV4ProjectsIdForks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/forks", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to." }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of projects matching the search criteria" }, { "name": "search_namespaces", "value": "", "type": "query", "description": "Include ancestor namespaces when matching search criteria" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "imported", "value": "", "type": "query", "description": "Limit by imported by authenticated user" }, { "name": "membership", "value": "", "type": "query", "description": "Limit by projects that the current user is a member of" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "with_programming_language", "value": "", "type": "query", "description": "Limit to repositories which use the given programming language" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "id_after", "value": "", "type": "query", "description": "Limit results to projects with IDs greater than the specified ID" }, { "name": "id_before", "value": "", "type": "query", "description": "Limit results to projects with IDs less than the specified ID" }, { "name": "last_activity_after", "value": "", "type": "query", "description": "Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "last_activity_before", "value": "", "type": "query", "description": "Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Which storage shard the repository is on. Available only to admins" }, { "name": "topic", "value": "", "type": "query", "description": "Comma-separated list of topics. Limit results to projects having all topics" }, { "name": "topic_id", "value": "", "type": "query", "description": "Limit results to projects with the assigned topic given by the topic ID" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "include_pending_delete", "value": "", "type": "query", "description": "Include projects in pending delete state. Can only be set by admins" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Date when the project was marked for deletion" }, { "name": "active", "value": "", "type": "query", "description": "Limit by projects that are not archived and not marked for deletion" }, { "name": "wiki_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where wiki checksum is failed" }, { "name": "repository_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where repository checksum is failed" }, { "name": "include_hidden", "value": "", "type": "query", "description": "Include hidden projects. Can only be set by admins" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "List forks of this project" }, { "info": { "name": "getApiV4ProjectsIdPagesAccess", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pages_access", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Check pages access of this project" }, { "info": { "name": "postApiV4ProjectsIdArchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/archive", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Archive a project" }, { "info": { "name": "postApiV4ProjectsIdUnarchive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/unarchive", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Unarchive a project" }, { "info": { "name": "postApiV4ProjectsIdStar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/star", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Star a project" }, { "info": { "name": "postApiV4ProjectsIdUnstar", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/unstar", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Unstar a project" }, { "info": { "name": "getApiV4ProjectsIdStarrers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/starrers", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "user", "type": "query", "description": "Return list of users matching the search criteria" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the users who starred a project" }, { "info": { "name": "getApiV4ProjectsIdLanguages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/languages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Get languages in project repository" }, { "info": { "name": "postApiV4ProjectsIdForkForkedFromId", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/fork/:forked_from_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "forked_from_id", "value": "gitlab", "type": "path", "description": "The ID of the project it was forked from" } ] }, "docs": "Mark this project as forked from another" }, { "info": { "name": "postApiV4ProjectsIdShare", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/share", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Share the project with a group" }, { "info": { "name": "deleteApiV4ProjectsIdShareGroupId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/share/:group_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "group_id", "value": "", "type": "path", "description": "The ID of the group" } ] }, "docs": "Remove a group share" }, { "info": { "name": "Import members from another project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/import_project_members/:project_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "project_id", "value": "", "type": "path", "description": "The ID of the source project to import the members from." } ] }, "docs": "This feature was introduced in GitLab 14.2" }, { "info": { "name": "getApiV4ProjectsIdUsers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/users", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "user", "type": "query", "description": "Return list of users matching the search criteria" }, { "name": "skip_users", "value": "", "type": "query", "description": "Filter out users with the specified IDs" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the users list of a project" }, { "info": { "name": "getApiV4ProjectsIdGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "group", "type": "query", "description": "Return list of groups matching the search criteria" }, { "name": "skip_groups", "value": "", "type": "query", "description": "Array of group ids to exclude from list" }, { "name": "with_shared", "value": "", "type": "query", "description": "Include shared groups" }, { "name": "shared_visible_only", "value": "", "type": "query", "description": "Limit to shared groups user has access to" }, { "name": "shared_min_access_level", "value": "", "type": "query", "description": "Limit returned shared groups by minimum access level to the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get ancestor and shared groups for a project" }, { "info": { "name": "getApiV4ProjectsIdInvitedGroups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/invited_groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "relation", "value": "", "type": "query", "description": "Filter by group relation" }, { "name": "search", "value": "", "type": "query", "description": "Search for a specific group" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a list of invited groups in this project" }, { "info": { "name": "Start the housekeeping task for a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/housekeeping", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 9.0." }, { "info": { "name": "Start a task to recalculate repository size for a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository_size", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 15.0." }, { "info": { "name": "putApiV4ProjectsIdTransfer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/transfer", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Transfer a project to a new namespace" }, { "info": { "name": "getApiV4ProjectsIdTransferLocations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/transfer_locations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "search", "value": "search", "type": "query", "description": "Return list of namespaces matching the search criteria" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get the namespaces to where the project can be transferred" }, { "info": { "name": "getApiV4ProjectsIdStorage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/storage", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of a project" } ] }, "docs": "Show the storage information" }, { "info": { "name": "getApiV4ProjectsIdAuditEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/audit_events", "params": [ { "name": "created_after", "value": "2016-01-19T09:05:50.355Z", "type": "query", "description": "Return audit events created after the specified time" }, { "name": "created_before", "value": "2016-01-19T09:05:50.355Z", "type": "query", "description": "Return audit events created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a list of audit events in this project." }, { "info": { "name": "getApiV4ProjectsIdAuditEventsAuditEventId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/audit_events/:audit_event_id", "params": [ { "name": "audit_event_id", "value": "", "type": "path", "description": "The ID of the audit event" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a specific audit event in this project." }, { "info": { "name": "List all Terraform state protection rules for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state_protection_rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Lists all Terraform state protection rules for a project. This feature was introduced in GitLab 18.11." }, { "info": { "name": "getApiV4UsersUserIdProjects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/users/:user_id/projects", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID or username of the user" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to." }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of projects matching the search criteria" }, { "name": "search_namespaces", "value": "", "type": "query", "description": "Include ancestor namespaces when matching search criteria" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "imported", "value": "", "type": "query", "description": "Limit by imported by authenticated user" }, { "name": "membership", "value": "", "type": "query", "description": "Limit by projects that the current user is a member of" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "with_programming_language", "value": "", "type": "query", "description": "Limit to repositories which use the given programming language" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "id_after", "value": "", "type": "query", "description": "Limit results to projects with IDs greater than the specified ID" }, { "name": "id_before", "value": "", "type": "query", "description": "Limit results to projects with IDs less than the specified ID" }, { "name": "last_activity_after", "value": "", "type": "query", "description": "Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "last_activity_before", "value": "", "type": "query", "description": "Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Which storage shard the repository is on. Available only to admins" }, { "name": "topic", "value": "", "type": "query", "description": "Comma-separated list of topics. Limit results to projects having all topics" }, { "name": "topic_id", "value": "", "type": "query", "description": "Limit results to projects with the assigned topic given by the topic ID" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "include_pending_delete", "value": "", "type": "query", "description": "Include projects in pending delete state. Can only be set by admins" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Date when the project was marked for deletion" }, { "name": "active", "value": "", "type": "query", "description": "Limit by projects that are not archived and not marked for deletion" }, { "name": "wiki_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where wiki checksum is failed" }, { "name": "repository_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where repository checksum is failed" }, { "name": "include_hidden", "value": "", "type": "query", "description": "Include hidden projects. Can only be set by admins" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" }, { "name": "with_custom_attributes", "value": "", "type": "query", "description": "Include custom attributes in the response" } ] }, "docs": "Get a user projects" }, { "info": { "name": "getApiV4UsersUserIdContributedProjects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/users/:user_id/contributed_projects", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID or username of the user" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to." }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" } ] }, "docs": "Get projects that a user has contributed to" }, { "info": { "name": "getApiV4UsersUserIdStarredProjects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/users/:user_id/starred_projects", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "The ID or username of the user" }, { "name": "order_by", "value": "", "type": "query", "description": "Return projects ordered by field. storage_size, repository_size, wiki_size, packages_size are only available to admins. Similarity is available when searching and is limited to projects the user has access to." }, { "name": "sort", "value": "", "type": "query", "description": "Return projects sorted in ascending and descending order" }, { "name": "archived", "value": "", "type": "query", "description": "Limit by archived status" }, { "name": "visibility", "value": "", "type": "query", "description": "Limit by visibility" }, { "name": "search", "value": "", "type": "query", "description": "Return list of projects matching the search criteria" }, { "name": "search_namespaces", "value": "", "type": "query", "description": "Include ancestor namespaces when matching search criteria" }, { "name": "owned", "value": "", "type": "query", "description": "Limit by owned by authenticated user" }, { "name": "starred", "value": "", "type": "query", "description": "Limit by starred status" }, { "name": "imported", "value": "", "type": "query", "description": "Limit by imported by authenticated user" }, { "name": "membership", "value": "", "type": "query", "description": "Limit by projects that the current user is a member of" }, { "name": "with_issues_enabled", "value": "", "type": "query", "description": "Limit by enabled issues feature" }, { "name": "with_merge_requests_enabled", "value": "", "type": "query", "description": "Limit by enabled merge requests feature" }, { "name": "with_programming_language", "value": "", "type": "query", "description": "Limit to repositories which use the given programming language" }, { "name": "min_access_level", "value": "", "type": "query", "description": "Limit by minimum access level of authenticated user" }, { "name": "id_after", "value": "", "type": "query", "description": "Limit results to projects with IDs greater than the specified ID" }, { "name": "id_before", "value": "", "type": "query", "description": "Limit results to projects with IDs less than the specified ID" }, { "name": "last_activity_after", "value": "", "type": "query", "description": "Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "last_activity_before", "value": "", "type": "query", "description": "Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Which storage shard the repository is on. Available only to admins" }, { "name": "topic", "value": "", "type": "query", "description": "Comma-separated list of topics. Limit results to projects having all topics" }, { "name": "topic_id", "value": "", "type": "query", "description": "Limit results to projects with the assigned topic given by the topic ID" }, { "name": "updated_before", "value": "", "type": "query", "description": "Return projects updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "updated_after", "value": "", "type": "query", "description": "Return projects updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "include_pending_delete", "value": "", "type": "query", "description": "Include projects in pending delete state. Can only be set by admins" }, { "name": "marked_for_deletion_on", "value": "", "type": "query", "description": "Date when the project was marked for deletion" }, { "name": "active", "value": "", "type": "query", "description": "Limit by projects that are not archived and not marked for deletion" }, { "name": "wiki_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where wiki checksum is failed" }, { "name": "repository_checksum_failed", "value": "", "type": "query", "description": "Limit by projects where repository checksum is failed" }, { "name": "include_hidden", "value": "", "type": "query", "description": "Include hidden projects. Can only be set by admins" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "simple", "value": "", "type": "query", "description": "Return only the ID, URL, name, and path of each project" }, { "name": "statistics", "value": "", "type": "query", "description": "Include project statistics" } ] }, "docs": "Get projects starred by a user" } ] }, { "info": { "name": "metric_images", "type": "folder" }, "items": [ { "info": { "name": "postApiV4ProjectsIdIssuesIssueIidMetricImagesAuthorize", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/metric_images/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Upload a metric image for an incident" }, { "info": { "name": "getApiV4ProjectsIdIssuesIssueIidMetricImages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/metric_images", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Metric Images for issue" }, { "info": { "name": "postApiV4ProjectsIdIssuesIssueIidMetricImages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/metric_images", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Upload a metric image for an issue" }, { "info": { "name": "putApiV4ProjectsIdIssuesIssueIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "metric_image_id", "value": "", "type": "path", "description": "The ID of metric image" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Update a metric image for an issue" }, { "info": { "name": "deleteApiV4ProjectsIdIssuesIssueIidMetricImagesMetricImageId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:issue_iid/metric_images/:metric_image_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "metric_image_id", "value": "", "type": "path", "description": "The ID of metric image" }, { "name": "issue_iid", "value": "", "type": "path" } ] }, "docs": "Remove a metric image for an issue" } ] }, { "info": { "name": "ci_lint", "type": "folder" }, "items": [ { "info": { "name": "Validates a CI YAML configuration with a namespace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/ci/lint", "params": [ { "name": "sha", "value": "", "type": "query", "description": "Deprecated: Use content_ref instead" }, { "name": "content_ref", "value": "", "type": "query", "description": "The CI/CD configuration content is taken from this commit SHA, branch or tag. Defaults to the HEAD of the project's default branch" }, { "name": "dry_run", "value": "", "type": "query", "description": "Run pipeline creation simulation, or only do static check. This is false by default" }, { "name": "include_jobs", "value": "", "type": "query", "description": "If the list of jobs that would exist in a static check or pipeline\n simulation should be included in the response. This is false by default" }, { "name": "ref", "value": "", "type": "query", "description": "Deprecated: Use dry_run_ref instead" }, { "name": "dry_run_ref", "value": "", "type": "query", "description": "Branch or tag used as context when executing a dry run. Defaults to the default branch of the project. Only used when dry_run is true" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Checks if a project’s .gitlab-ci.yml configuration in a given commit (by default HEAD of the\n project’s default branch) is valid" }, { "info": { "name": "Validate a CI YAML configuration with a namespace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/ci/lint", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Checks if CI/CD YAML configuration is valid. This endpoint has namespace specific context" } ] }, { "info": { "name": "merge_request_approvals", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdMergeRequestsMergeRequestIidApprovals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/approvals", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "List approvals for merge request" }, { "info": { "name": "Change approval-related configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/approvals", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The IID of a merge request" } ] }, "docs": "Deprecated in 16.0. Use the merge request approvals API instead." }, { "info": { "name": "postApiV4ProjectsIdMergeRequestsMergeRequestIidApprove", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/approve", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Approve a merge request" }, { "info": { "name": "postApiV4ProjectsIdMergeRequestsMergeRequestIidUnapprove", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/unapprove", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Remove an approval from a merge request" }, { "info": { "name": "Remove all merge request approvals", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/reset_approvals", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "merge_request_iid", "value": "", "type": "path" } ] }, "docs": "Clear all approvals of merge request. This feature was added in GitLab 15.4" }, { "info": { "name": "getApiV4ProjectsIdMergeRequestsMergeRequestIidApprovalState", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:merge_request_iid/approval_state", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "merge_request_iid", "value": "", "type": "path", "description": "The IID of a merge request" } ] }, "docs": "Get approval state of merge request" } ] }, { "info": { "name": "ml_model_registry", "type": "folder" }, "items": [ { "info": { "name": "Workhorse authorize model package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "File name" }, { "name": "model_version_id", "value": "", "type": "path", "description": "Model version id" } ] }, "docs": "Introduced in GitLab 16.8" }, { "info": { "name": "Download an ml_model package file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "File name" }, { "name": "path", "value": "", "type": "query", "description": "File directory path" }, { "name": "status", "value": "", "type": "query", "description": "Package status" }, { "name": "model_version_id", "value": "", "type": "path", "description": "Model version id" } ] }, "docs": "This feature was introduced in GitLab 16.8" }, { "info": { "name": "Workhorse upload model package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_name", "value": "", "type": "path", "description": "File name" }, { "name": "model_version_id", "value": "", "type": "path", "description": "Model version id" } ] }, "docs": "Introduced in GitLab 16.8" } ] }, { "info": { "name": "gitlab_pages", "type": "folder" }, "items": [ { "info": { "name": "Get pages settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Get pages URL and other settings. This feature was introduced in Gitlab 16.8" }, { "info": { "name": "Update pages settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/pages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Update page settings for a project. User must have administrative access." }, { "info": { "name": "Unpublish pages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/pages", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Remove pages. The user must have administrator access. This feature was introduced in GitLab 12.6" }, { "info": { "name": "getApiV4ProjectsIdPagesDomains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all pages domains" }, { "info": { "name": "postApiV4ProjectsIdPagesDomains", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" } ] }, "docs": "Create a new pages domain" }, { "info": { "name": "getApiV4ProjectsIdPagesDomainsDomain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains/:domain", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "domain", "value": "", "type": "path", "description": "The domain" } ] }, "docs": "Get a single pages domain" }, { "info": { "name": "putApiV4ProjectsIdPagesDomainsDomain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains/:domain", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "domain", "value": "", "type": "path", "description": "The domain" } ] }, "docs": "Updates a pages domain" }, { "info": { "name": "deleteApiV4ProjectsIdPagesDomainsDomain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains/:domain", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "domain", "value": "", "type": "path", "description": "The domain" } ] }, "docs": "Delete a pages domain" }, { "info": { "name": "putApiV4ProjectsIdPagesDomainsDomainVerify", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/pages/domains/:domain/verify", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project owned by the authenticated user" }, { "name": "domain", "value": "", "type": "path", "description": "The domain to verify" } ] }, "docs": "Verify a pages domain" }, { "info": { "name": "getApiV4PagesDomains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/pages/domains", "params": [ { "name": "domain", "value": "", "type": "query", "description": "The domain of the GitLab Pages site to filter on." }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all pages domains" } ] }, { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/events", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "action", "value": "", "type": "query", "description": "Event action to filter on" }, { "name": "target_type", "value": "", "type": "query", "description": "Event target type to filter on" }, { "name": "before", "value": "", "type": "query", "description": "Include only events created before this date" }, { "name": "after", "value": "", "type": "query", "description": "Include only events created after this date" }, { "name": "sort", "value": "", "type": "query", "description": "Return events sorted in ascending and descending order" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List a project's visible events" }, { "info": { "name": "List currently authenticated user's events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/events", "params": [ { "name": "scope", "value": "all", "type": "query", "description": "Include all events across a user’s projects" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "action", "value": "", "type": "query", "description": "Event action to filter on" }, { "name": "target_type", "value": "", "type": "query", "description": "Event target type to filter on" }, { "name": "before", "value": "", "type": "query", "description": "Include only events created before this date" }, { "name": "after", "value": "", "type": "query", "description": "Include only events created after this date" }, { "name": "sort", "value": "", "type": "query", "description": "Return events sorted in ascending and descending order" } ] }, "docs": "This feature was introduced in GitLab 9.3." }, { "info": { "name": "Get the contribution events of a specified user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/users/:id/events", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or username of the user" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "action", "value": "", "type": "query", "description": "Event action to filter on" }, { "name": "target_type", "value": "", "type": "query", "description": "Event target type to filter on" }, { "name": "before", "value": "", "type": "query", "description": "Include only events created before this date" }, { "name": "after", "value": "", "type": "query", "description": "Include only events created after this date" }, { "name": "sort", "value": "", "type": "query", "description": "Return events sorted in ascending and descending order" } ] }, "docs": "This feature was introduced in GitLab 8.13." } ] }, { "info": { "name": "project_import", "type": "folder" }, "items": [ { "info": { "name": "Get export status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/export", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Start export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/export", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Download export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/export/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Start relations export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/export_relations", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 14.4" }, { "info": { "name": "Download relations export", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/export_relations/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "relation", "value": "", "type": "query", "description": "Project relation name" }, { "name": "batched", "value": "", "type": "query", "description": "Whether to download in batches" }, { "name": "batch_number", "value": "", "type": "query", "description": "Batch number to download" } ] }, "docs": "This feature was introduced in GitLab 14.4" }, { "info": { "name": "Relations export status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/export_relations/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "relation", "value": "", "type": "query", "description": "Project relation name" } ] }, "docs": "This feature was introduced in GitLab 14.4" }, { "info": { "name": "Workhorse authorize the project import upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/import/authorize" }, "docs": "This feature was introduced in GitLab 12.9" }, { "info": { "name": "Create a new project import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/import" }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Get a project import status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/import", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 10.6." }, { "info": { "name": "Import a project from a Git URL", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/import/git", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 18.10." }, { "info": { "name": "Create a new project import using a remote object storage path", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/remote-import" }, "docs": "This feature was introduced in GitLab 13.2." }, { "info": { "name": "Workhorse authorize the project relation import upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/import-relation/authorize" }, "docs": "This feature was introduced in GitLab 16.11" }, { "info": { "name": "Re-import a relation into a project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/import-relation" }, "docs": "This feature was introduced in GitLab 16.11." }, { "info": { "name": "Get the statuses of relation imports for specified project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/relation-imports", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 16.11." }, { "info": { "name": "Create a new project import using a file from AWS S3", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/remote-import-s3" }, "docs": "This feature was introduced in GitLab 14.9." }, { "info": { "name": "Import a BitBucket Cloud repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/import/bitbucket" }, "docs": "This feature was introduced in GitLab 17.0." }, { "info": { "name": "Import a BitBucket Server repository", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/import/bitbucket_server" }, "docs": "This feature was introduced in GitLab 13.2." }, { "info": { "name": "Import a GitHub project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/import/github" }, "docs": "This feature was introduced in GitLab 11.3.4." }, { "info": { "name": "Cancel GitHub project import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/import/github/cancel" }, "docs": "This feature was introduced in GitLab 15.5" } ] }, { "info": { "name": "hooks", "type": "folder" }, "items": [ { "info": { "name": "Set a url variable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/url_variables/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The key of the variable" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Sets a URL variable for a webhook" }, { "info": { "name": "Un-Set a url variable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/url_variables/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The key of the variable" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a URL variable from a webhook" }, { "info": { "name": "Set a custom header", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/custom_headers/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The name of the custom header" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Sets a custom header for a webhook" }, { "info": { "name": "Un-Set a custom header", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/custom_headers/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The name of the custom header" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a custom header from a webhook" }, { "info": { "name": "List project hooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/hooks", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of project hooks" }, { "info": { "name": "Add project hook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/hooks", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Adds a hook to a specified project" }, { "info": { "name": "Get project hook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "hook_id", "value": "", "type": "path", "description": "The ID of a project hook" } ] }, "docs": "Get a specific hook for a project" }, { "info": { "name": "Edit project hook", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the project hook" } ] }, "docs": "Edits a hook for a specified project." }, { "info": { "name": "Delete a project hook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the project hook" } ] }, "docs": "Removes a hook from a project. This is an idempotent method and can be called multiple times. Either the hook is available or not." }, { "info": { "name": "Get events for a given hook id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/events", "params": [ { "name": "status", "value": "", "type": "query", "description": "HTTP status code of the event" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "id", "value": "", "type": "path" }, { "name": "hook_id", "value": "", "type": "path" } ] }, "docs": "List web hook logs by hook id" }, { "info": { "name": "Triggers a hook test", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/test/:trigger", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "trigger", "value": "", "type": "path", "description": "The type of trigger hook" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Triggers a hook test" }, { "info": { "name": "Resend a webhook event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/hooks/:hook_id/events/:hook_log_id/resend", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "hook_id", "value": "", "type": "path" }, { "name": "hook_log_id", "value": "", "type": "path" } ] }, "docs": "Resend a webhook event" }, { "info": { "name": "Set a url variable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/hooks/:hook_id/url_variables/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The key of the variable" } ] }, "docs": "Sets a URL variable for a webhook" }, { "info": { "name": "Un-Set a url variable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/hooks/:hook_id/url_variables/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The key of the variable" } ] }, "docs": "Removes a URL variable from a webhook" }, { "info": { "name": "Set a custom header", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/hooks/:hook_id/custom_headers/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The name of the custom header" } ] }, "docs": "Sets a custom header for a webhook" }, { "info": { "name": "Un-Set a custom header", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/hooks/:hook_id/custom_headers/:key", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" }, { "name": "key", "value": "", "type": "path", "description": "The name of the custom header" } ] }, "docs": "Removes a custom header from a webhook" }, { "info": { "name": "List system hooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/hooks", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a list of all system hooks" }, { "info": { "name": "Add new system hook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/hooks" }, "docs": "Add a new system hook" }, { "info": { "name": "Get system hook", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the system hook" } ] }, "docs": "Get a system hook by its ID. Introduced in GitLab 14.9." }, { "info": { "name": "Test a hook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the hook" } ] }, "docs": "Tests a webhook by triggering a test event" }, { "info": { "name": "Edit system hook", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the system hook" } ] }, "docs": "Edits a system hook" }, { "info": { "name": "Delete system hook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The ID of the system hook" } ] }, "docs": "Deletes a system hook" } ] }, { "info": { "name": "projects_job_token_scope", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdJobTokenScope", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch CI_JOB_TOKEN access settings." }, { "info": { "name": "patchApiV4ProjectsIdJobTokenScope", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Patch CI_JOB_TOKEN access settings." }, { "info": { "name": "getApiV4ProjectsIdJobTokenScopeAllowlist", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/allowlist", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch project inbound allowlist for CI_JOB_TOKEN access settings." }, { "info": { "name": "postApiV4ProjectsIdJobTokenScopeAllowlist", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/allowlist", "params": [ { "name": "id", "value": "1", "type": "path", "description": "ID of user project" } ] }, "docs": "Add target project to allowlist." }, { "info": { "name": "getApiV4ProjectsIdJobTokenScopeGroupsAllowlist", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/groups_allowlist", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch project groups allowlist for CI_JOB_TOKEN access settings." }, { "info": { "name": "postApiV4ProjectsIdJobTokenScopeGroupsAllowlist", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/groups_allowlist", "params": [ { "name": "id", "value": "1", "type": "path", "description": "ID of user project" } ] }, "docs": "Add target group to allowlist." }, { "info": { "name": "deleteApiV4ProjectsIdJobTokenScopeGroupsAllowlistTargetGroupId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/groups_allowlist/:target_group_id", "params": [ { "name": "id", "value": "1", "type": "path", "description": "ID of user project" }, { "name": "target_group_id", "value": "2", "type": "path", "description": "ID of the group to be removed from the allowlist" } ] }, "docs": "Delete target group from allowlist." }, { "info": { "name": "deleteApiV4ProjectsIdJobTokenScopeAllowlistTargetProjectId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/job_token_scope/allowlist/:target_project_id", "params": [ { "name": "id", "value": "1", "type": "path", "description": "ID of user project" }, { "name": "target_project_id", "value": "2", "type": "path", "description": "ID of the project to be removed from the allowlist" } ] }, "docs": "Delete project from allowlist." } ] }, { "info": { "name": "project_snapshots", "type": "folder" }, "items": [ { "info": { "name": "Download a (possibly inconsistent) snapshot of a repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snapshot", "params": [ { "name": "wiki", "value": "", "type": "query", "description": "Set to true to receive the wiki repository" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "This feature was introduced in GitLab 10.7" } ] }, { "info": { "name": "snippets", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdSnippets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all project snippets" }, { "info": { "name": "postApiV4ProjectsIdSnippets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/snippets", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a new project snippet" }, { "info": { "name": "getApiV4ProjectsIdSnippetsSnippetId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "The ID of a project snippet" } ] }, "docs": "Get a single project snippet" }, { "info": { "name": "putApiV4ProjectsIdSnippetsSnippetId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "The ID of a project snippet" } ] }, "docs": "Update an existing project snippet" }, { "info": { "name": "deleteApiV4ProjectsIdSnippetsSnippetId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "The ID of a project snippet" } ] }, "docs": "Delete a project snippet" }, { "info": { "name": "getApiV4ProjectsIdSnippetsSnippetIdRaw", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/raw", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "The ID of a project snippet" } ] }, "docs": "Get a raw project snippet" }, { "info": { "name": "getApiV4ProjectsIdSnippetsSnippetIdFilesRefFilePathRaw", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/files/:ref/:file_path/raw", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "file_path", "value": "", "type": "path", "description": "The URL-encoded path to the file, like lib%2Fclass%2Erb" }, { "name": "ref", "value": "", "type": "path", "description": "The name of branch, tag or commit" }, { "name": "snippet_id", "value": "", "type": "path" } ] }, "docs": "Get raw project snippet file contents from the repository" }, { "info": { "name": "getApiV4ProjectsIdSnippetsSnippetIdUserAgentDetail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/snippets/:snippet_id/user_agent_detail", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "snippet_id", "value": "", "type": "path", "description": "The ID of a project snippet" } ] }, "docs": "Get the user agent details for a project snippet" }, { "info": { "name": "Get a snippets list for an authenticated user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets", "params": [ { "name": "created_after", "value": "", "type": "query", "description": "Return snippets created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return snippets created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "Create new snippet", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/snippets" }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "List all public personal snippets current_user has access to", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/public", "params": [ { "name": "created_after", "value": "", "type": "query", "description": "Return snippets created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return snippets created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "List all snippets current_user has access to", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/all", "params": [ { "name": "created_after", "value": "", "type": "query", "description": "Return snippets created after the specified time" }, { "name": "created_before", "value": "", "type": "query", "description": "Return snippets created before the specified time" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "repository_storage", "value": "", "type": "query", "description": "Filter by repository storage used by the snippet" } ] }, "docs": "This feature was introduced in GitLab 16.3." }, { "info": { "name": "Get a single snippet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a snippet" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "Update an existing snippet", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/snippets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a snippet" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "Remove snippet", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/snippets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a snippet" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "Get a raw snippet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/:id/raw", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a snippet" } ] }, "docs": "This feature was introduced in GitLab 8.15." }, { "info": { "name": "getApiV4SnippetsIdFilesRefFilePathRaw", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/:id/files/:ref/:file_path/raw", "params": [ { "name": "file_path", "value": "", "type": "path", "description": "The URL-encoded path to the file, like lib%2Fclass%2Erb" }, { "name": "ref", "value": "", "type": "path", "description": "The name of branch, tag or commit" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get raw snippet file contents from the repository" }, { "info": { "name": "getApiV4SnippetsIdUserAgentDetail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/snippets/:id/user_agent_detail", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of a snippet" } ] }, "docs": "Get the user agent details for a snippet" } ] }, { "info": { "name": "project_templates", "type": "folder" }, "items": [ { "info": { "name": "Get a list of templates available to this project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/templates/:type", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "type", "value": "", "type": "path", "description": "The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses|issues|merge_requests) of the template" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This endpoint was introduced in GitLab 11.4" }, { "info": { "name": "Download a template available to this project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/templates/:type/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "type", "value": "", "type": "path", "description": "The type (dockerfiles|gitignores|gitlab_ci_ymls|licenses|issues|merge_requests) of the template" }, { "name": "name", "value": "MIT", "type": "path", "description": "The key of the template, as obtained from the collection endpoint." }, { "name": "source_template_project_id", "value": "1", "type": "query", "description": "The project id where a given template is being stored. This is useful when multiple templates from different projects have the same name" }, { "name": "project", "value": "GitLab", "type": "query", "description": "The project name to use when expanding placeholders in the template. Only affects licenses" }, { "name": "fullname", "value": "GitLab B.V.", "type": "query", "description": "The full name of the copyright holder to use when expanding placeholders in the template. Only affects licenses" } ] }, "docs": "This endpoint was introduced in GitLab 11.4" } ] }, { "info": { "name": "protected_branches", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdProtectedBranches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/protected_branches", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "search", "value": "mai", "type": "query", "description": "Search for a protected branch by name" } ] }, "docs": "Get a project's protected branches" }, { "info": { "name": "postApiV4ProjectsIdProtectedBranches", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/protected_branches", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Protect a single branch" }, { "info": { "name": "getApiV4ProjectsIdProtectedBranchesName", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/protected_branches/:name", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "main", "type": "path", "description": "The name of the branch or wildcard" } ] }, "docs": "Get a single protected branch" }, { "info": { "name": "patchApiV4ProjectsIdProtectedBranchesName", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/projects/:id/protected_branches/:name", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "main", "type": "path", "description": "The name of the branch" } ] }, "docs": "Update a protected branch" }, { "info": { "name": "deleteApiV4ProjectsIdProtectedBranchesName", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/protected_branches/:name", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "main", "type": "path", "description": "The name of the protected branch" } ] }, "docs": "Unprotect a single branch" } ] }, { "info": { "name": "protected_tags", "type": "folder" }, "items": [ { "info": { "name": "Get a project's protected tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/protected_tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 11.3." }, { "info": { "name": "Protect a single tag or wildcard", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/protected_tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 11.3." }, { "info": { "name": "Get a single protected tag", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/protected_tags/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "release*", "type": "path", "description": "The name of the tag or wildcard" } ] }, "docs": "This feature was introduced in GitLab 11.3." }, { "info": { "name": "Unprotect a single tag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/protected_tags/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "release-1-0", "type": "path", "description": "The name of the protected tag" } ] }, "docs": "This feature was introduced in GitLab 11.3." } ] }, { "info": { "name": "remote_mirrors", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRemoteMirrors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "List the project's remote mirrors" }, { "info": { "name": "postApiV4ProjectsIdRemoteMirrors", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create remote mirror for a project" }, { "info": { "name": "getApiV4ProjectsIdRemoteMirrorsMirrorId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors/:mirror_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "mirror_id", "value": "", "type": "path", "description": "The ID of a remote mirror" } ] }, "docs": "Get a single remote mirror" }, { "info": { "name": "putApiV4ProjectsIdRemoteMirrorsMirrorId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors/:mirror_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "mirror_id", "value": "", "type": "path", "description": "The ID of a remote mirror" } ] }, "docs": "Update the attributes of a single remote mirror" }, { "info": { "name": "Delete a single remote mirror", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors/:mirror_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "mirror_id", "value": "", "type": "path", "description": "The ID of a remote mirror" } ] }, "docs": "This feature was introduced in GitLab 14.10" }, { "info": { "name": "postApiV4ProjectsIdRemoteMirrorsMirrorIdSync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors/:mirror_id/sync", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "mirror_id", "value": "", "type": "path", "description": "The ID of a remote mirror" } ] }, "docs": "Triggers a push mirror operation" }, { "info": { "name": "getApiV4ProjectsIdRemoteMirrorsMirrorIdPublicKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/remote_mirrors/:mirror_id/public_key", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "mirror_id", "value": "", "type": "path", "description": "The ID of a remote mirror" } ] }, "docs": "Get the public key of a single remote mirror" } ] }, { "info": { "name": "repositories", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryTree", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tree", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "ref", "value": "main", "type": "query", "description": "The name of a repository branch or tag, if not given the default branch is used" }, { "name": "path", "value": "files/html", "type": "query", "description": "The path of the tree" }, { "name": "recursive", "value": "", "type": "query", "description": "Used to get a recursive tree" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "pagination", "value": "", "type": "query", "description": "Specify the pagination method (\"none\" is only valid if \"recursive\" is true)" }, { "name": "page_token", "value": "a1e8f8d745cc87e3a9248358d9352bb7f9a0aeba", "type": "query", "description": "Record from which to start the keyset pagination" } ] }, "docs": "Get a project repository tree" }, { "info": { "name": "getApiV4ProjectsIdRepositoryBlobsShaRaw", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/blobs/:sha/raw", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "7d70e02340bac451f281cecf0a980907974bd8be", "type": "path", "description": "The commit hash" } ] }, "docs": "Get raw blob contents from the repository" }, { "info": { "name": "getApiV4ProjectsIdRepositoryBlobsSha", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/blobs/:sha", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "7d70e02340bac451f281cecf0a980907974bd8be", "type": "path", "description": "The commit hash" } ] }, "docs": "Get a blob from the repository" }, { "info": { "name": "getApiV4ProjectsIdRepositoryArchive", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/archive", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sha", "value": "7d70e02340bac451f281cecf0a980907974bd8be", "type": "query", "description": "The commit sha of the archive to be downloaded" }, { "name": "format", "value": "tar.gz", "type": "query", "description": "The archive format" }, { "name": "path", "value": "files/archives", "type": "query", "description": "Subfolder of the repository to be downloaded" }, { "name": "include_lfs_blobs", "value": "", "type": "query", "description": "Used to exclude LFS objects from archive" }, { "name": "exclude_paths", "value": "", "type": "query", "description": "Comma-separated list of paths to exclude from the archive" } ] }, "docs": "Get an archive of the repository" }, { "info": { "name": "getApiV4ProjectsIdRepositoryCompare", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/compare", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "from", "value": "main", "type": "query", "description": "The commit, branch name, or tag name to start comparison" }, { "name": "to", "value": "feature", "type": "query", "description": "The commit, branch name, or tag name to stop comparison" }, { "name": "from_project_id", "value": "1", "type": "query", "description": "The project to compare from" }, { "name": "straight", "value": "", "type": "query", "description": "Comparison method, `true` for direct comparison between `from` and `to` (`from`..`to`), `false` to compare using merge base (`from`...`to`)" }, { "name": "unidiff", "value": "", "type": "query", "description": "A diff in a Unified diff format" } ] }, "docs": "Compare two branches, tags, or commits" }, { "info": { "name": "getApiV4ProjectsIdRepositoryHealth", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/health", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "generate", "value": "", "type": "query", "description": "Triggers a new health report to be generated" } ] }, "docs": "Get repository health" }, { "info": { "name": "getApiV4ProjectsIdRepositoryContributors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/contributors", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "ref", "value": "main", "type": "query", "description": "The name of a repository branch or tag, if not given the default branch is used" }, { "name": "order_by", "value": "", "type": "query", "description": "Return contributors ordered by `name` or `email` or `commits`" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by asc (ascending) or desc (descending)" } ] }, "docs": "Get repository contributors" }, { "info": { "name": "getApiV4ProjectsIdRepositoryMergeBase", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/merge_base", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "refs", "value": "main", "type": "query", "description": "The refs to find the common ancestor of, multiple refs can be passed" } ] }, "docs": "Get the common ancestor between commits" }, { "info": { "name": "Generates a changelog section for a release and returns it", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/changelog", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "version", "value": "1.0.0", "type": "query", "description": "The version of the release, using the semantic versioning format" }, { "name": "from", "value": "ed899a2f4b50b4370feeea94676502b42383c746", "type": "query", "description": "The first commit in the range of commits to use for the changelog" }, { "name": "to", "value": "6104942438c14ec7bd21c6cd5bd995272b3faff6", "type": "query", "description": "The last commit in the range of commits to use for the changelog" }, { "name": "date", "value": "2021-09-20T11:50:22.001+00:00", "type": "query", "description": "The date and time of the release" }, { "name": "trailer", "value": "Changelog", "type": "query", "description": "The Git trailer to use for determining if commits are to be included in the changelog" }, { "name": "config_file", "value": ".gitlab/changelog_config.yml", "type": "query", "description": "The file path to the configuration file as stored in the project's Git repository. Defaults to '.gitlab/changelog_config.yml'" }, { "name": "config_file_ref", "value": "main", "type": "query", "description": "The git reference (for example, branch) where the changelog configuration file is defined. Defaults to the default repository branch." } ] }, "docs": "This feature was introduced in GitLab 14.6" }, { "info": { "name": "Generates a changelog section for a release and commits it in a changelog file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/changelog", "params": [ { "name": "id", "value": "1", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "This feature was introduced in GitLab 13.9" } ] }, { "info": { "name": "resource_events", "type": "folder" }, "items": [ { "info": { "name": "List project Issue milestone events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:eventable_id/resource_milestone_events", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "eventable_id", "value": "", "type": "path", "description": "The ID of the eventable" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of all milestone events for a single Issue" }, { "info": { "name": "Get single Issue milestone event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/issues/:eventable_id/resource_milestone_events/:event_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "event_id", "value": "", "type": "path", "description": "The ID of a resource milestone event" }, { "name": "eventable_id", "value": "", "type": "path", "description": "The ID of the eventable" } ] }, "docs": "Returns a single milestone event for a specific project Issue" }, { "info": { "name": "List project Merge request milestone events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:eventable_id/resource_milestone_events", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "eventable_id", "value": "", "type": "path", "description": "The ID of the eventable" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets a list of all milestone events for a single Merge request" }, { "info": { "name": "Get single Merge request milestone event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/merge_requests/:eventable_id/resource_milestone_events/:event_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "event_id", "value": "", "type": "path", "description": "The ID of a resource milestone event" }, { "name": "eventable_id", "value": "", "type": "path", "description": "The ID of the eventable" } ] }, "docs": "Returns a single milestone event for a specific project Merge request" } ] }, { "info": { "name": "submodules", "type": "folder" }, "items": [ { "info": { "name": "putApiV4ProjectsIdRepositorySubmodulesSubmodule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/repository/submodules/:submodule", "params": [ { "name": "id", "value": "gitlab-org/gitlab", "type": "path", "description": "The ID or URL-encoded path of a project" }, { "name": "submodule", "value": "gitlab-org/gitlab-shell", "type": "path", "description": "URL-encoded full path to submodule." } ] }, "docs": "Update existing submodule reference in repository" } ] }, { "info": { "name": "attestations", "type": "folder" }, "items": [ { "info": { "name": "Fetch the list of all attestations for a specific project and artifact hash", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/attestations/:subject_digest", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "subject_digest", "value": "", "type": "path", "description": "The SHA-256 hash of the artifact" } ] }, "docs": "This feature was introduced in GitLab 18.7" }, { "info": { "name": "Fetch a specific bundle by iid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/attestations/:attestation_iid/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "attestation_iid", "value": "", "type": "path", "description": "The iid of the attestation" } ] }, "docs": "This feature was introduced in GitLab 18.7" } ] }, { "info": { "name": "tags", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ProjectsIdRepositoryTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "sort", "value": "", "type": "query", "description": "Return tags sorted in updated by `asc` or `desc` order." }, { "name": "order_by", "value": "", "type": "query", "description": "Return tags ordered by `name`, `updated`, `version` fields." }, { "name": "search", "value": "", "type": "query", "description": "Return list of tags matching the search criteria" }, { "name": "page_token", "value": "", "type": "query", "description": "Name of tag to start the pagination from" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get a project repository tags" }, { "info": { "name": "postApiV4ProjectsIdRepositoryTags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tags", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" } ] }, "docs": "Create a new repository tag" }, { "info": { "name": "getApiV4ProjectsIdRepositoryTagsTagName", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tags/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "Get a single repository tag" }, { "info": { "name": "deleteApiV4ProjectsIdRepositoryTagsTagName", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tags/:tag_name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "Delete a repository tag" }, { "info": { "name": "getApiV4ProjectsIdRepositoryTagsTagNameSignature", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/repository/tags/:tag_name/signature", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "tag_name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "Get a tag's signature" } ] }, { "info": { "name": "terraform", "type": "folder" }, "items": [ { "info": { "name": "Download the latest version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/terraform/modules/:module_name/:module_system", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "module_name", "value": "infra-registry", "type": "path", "description": "Module name" }, { "name": "module_system", "value": "aws", "type": "path", "description": "Module system" }, { "name": "terraform-get", "value": "", "type": "query", "description": "Terraform get redirection flag" } ] }, "docs": "This feature was introduced in GitLab 16.7" }, { "info": { "name": "Download a specific version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/packages/terraform/modules/:module_name/:module_system/*module_version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "module_name", "value": "infra-registry", "type": "path", "description": "Module name" }, { "name": "module_system", "value": "aws", "type": "path", "description": "Module system" }, { "name": "module_version", "value": "", "type": "query", "description": "Module version" }, { "name": "terraform-get", "value": "", "type": "query", "description": "Terraform get redirection flag" } ] }, "docs": "This feature was introduced in GitLab 16.7" }, { "info": { "name": "Workhorse authorize Terraform Module package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/terraform/modules/:module_name/:module_system/*module_version/file/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "module_name", "value": "infra-registry", "type": "path", "description": "Module name" }, { "name": "module_system", "value": "aws", "type": "path", "description": "Module system" } ] }, "docs": "This feature was introduced in GitLab 13.11" }, { "info": { "name": "Upload Terraform Module package file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/projects/:id/packages/terraform/modules/:module_name/:module_system/*module_version/file", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or full path of a project" }, { "name": "module_name", "value": "infra-registry", "type": "path", "description": "Module name" }, { "name": "module_system", "value": "aws", "type": "path", "description": "Module system" } ] }, "docs": "This feature was introduced in GitLab 13.11" }, { "info": { "name": "Get a Terraform state by its name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" }, { "name": "ID", "value": "", "type": "query", "description": "Terraform state lock ID" } ] }, "docs": "Get a Terraform state by its name" }, { "info": { "name": "Add a new Terraform state or update an existing one", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" } ] }, "docs": "Add a new Terraform state or update an existing one" }, { "info": { "name": "Delete a Terraform state of a certain name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" } ] }, "docs": "Delete a Terraform state of a certain name" }, { "info": { "name": "Authorize Terraform state upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" } ] }, "docs": "This feature was introduced in GitLab 18.5" }, { "info": { "name": "Lock a Terraform state of a certain name", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name/lock", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" } ] }, "docs": "Lock a Terraform state of a certain name" }, { "info": { "name": "Unlock a Terraform state of a certain name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name/lock", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" }, { "name": "ID", "value": "", "type": "query", "description": "Terraform state lock ID" } ] }, "docs": "Unlock a Terraform state of a certain name" }, { "info": { "name": "Get a Terraform state version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name/versions/:serial", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path", "description": "The name of a Terraform state" }, { "name": "serial", "value": "", "type": "path", "description": "The version number of the state" } ] }, "docs": "Get a Terraform state version" }, { "info": { "name": "Delete a Terraform state version", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/projects/:id/terraform/state/:name/versions/:serial", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or URL-encoded path of the project" }, { "name": "name", "value": "", "type": "path" }, { "name": "serial", "value": "", "type": "path" } ] }, "docs": "Delete a Terraform state version" }, { "info": { "name": "List versions for a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/versions", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" } ] }, "docs": "List versions for a module" }, { "info": { "name": "Get download location for the latest version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/download", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" } ] }, "docs": "Download the latest version of a module" }, { "info": { "name": "Get details about the latest version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" } ] }, "docs": "Get details about the latest version of a module" }, { "info": { "name": "Get download location for specific version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/*module_version/download", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" }, { "name": "module_version", "value": "", "type": "query", "description": "Version of the module" } ] }, "docs": "Download specific version of a module" }, { "info": { "name": "Download specific version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/*module_version/file", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" }, { "name": "module_version", "value": "", "type": "query", "description": "Version of the module" } ] }, "docs": "Download specific version of a module" }, { "info": { "name": "Get details about specific version of a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/*module_version", "params": [ { "name": "module_namespace", "value": "", "type": "path", "description": "Group's ID or slug" }, { "name": "module_name", "value": "", "type": "path", "description": "Name of the module" }, { "name": "module_system", "value": "", "type": "path", "description": "System of the module" }, { "name": "module_version", "value": "", "type": "query", "description": "Version of the module" } ] }, "docs": "Get details about specific version of a module" } ] }, { "info": { "name": "batched_background_migrations", "type": "folder" }, "items": [ { "info": { "name": "getApiV4AdminBatchedBackgroundMigrationsId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/batched_background_migrations/:id", "params": [ { "name": "database", "value": "", "type": "query", "description": "The name of the database" }, { "name": "id", "value": "", "type": "path", "description": "The batched background migration id" } ] }, "docs": "Retrieve a batched background migration" }, { "info": { "name": "putApiV4AdminBatchedBackgroundMigrationsIdResume", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/admin/batched_background_migrations/:id/resume", "params": [ { "name": "id", "value": "", "type": "path", "description": "The batched background migration id" } ] }, "docs": "Resume a batched background migration" }, { "info": { "name": "putApiV4AdminBatchedBackgroundMigrationsIdPause", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/admin/batched_background_migrations/:id/pause", "params": [ { "name": "id", "value": "", "type": "path", "description": "The batched background migration id" } ] }, "docs": "Pause a batched background migration" }, { "info": { "name": "getApiV4AdminBatchedBackgroundMigrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/batched_background_migrations", "params": [ { "name": "database", "value": "", "type": "query", "description": "The name of the database, the default `main`" }, { "name": "job_class_name", "value": "", "type": "query", "description": "Filter migrations by job class name." } ] }, "docs": "Get the list of batched background migrations" } ] }, { "info": { "name": "database_dictionary", "type": "folder" }, "items": [ { "info": { "name": "getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/databases/:database_name/dictionary/tables/:table_name", "params": [ { "name": "database_name", "value": "", "type": "path", "description": "The database name" }, { "name": "table_name", "value": "", "type": "path", "description": "The table name" } ] }, "docs": "Retrieve dictionary details" }, { "info": { "name": "List dictionary tables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/databases/:database_name/dictionary/tables", "params": [ { "name": "database_name", "value": "", "type": "path", "description": "The database name" }, { "name": "table_size", "value": "", "type": "query", "description": "Filter by table size classification" } ] }, "docs": "Returns database dictionary tables filtered by database and optional table size" } ] }, { "info": { "name": "migrations", "type": "folder" }, "items": [ { "info": { "name": "getApiV4AdminMigrationsPending", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/admin/migrations/pending", "params": [ { "name": "database", "value": "", "type": "query", "description": "The name of the database" } ] }, "docs": "List pending database migrations" }, { "info": { "name": "postApiV4AdminMigrationsTimestampMark", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/admin/migrations/:timestamp/mark", "params": [ { "name": "timestamp", "value": "", "type": "path", "description": "The migration version timestamp" } ] }, "docs": "Mark the migration as successfully executed" } ] }, { "info": { "name": "broadcast_messages", "type": "folder" }, "items": [ { "info": { "name": "Get all broadcast messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/broadcast_messages", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "Create a broadcast message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/broadcast_messages" }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "Get a specific broadcast message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/broadcast_messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Broadcast message ID" } ] }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "Update a broadcast message", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/broadcast_messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Broadcast message ID" } ] }, "docs": "This feature was introduced in GitLab 8.12." }, { "info": { "name": "Delete a broadcast message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/broadcast_messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Broadcast message ID" } ] }, "docs": "This feature was introduced in GitLab 8.12." } ] }, { "info": { "name": "applications", "type": "folder" }, "items": [ { "info": { "name": "Get applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/applications" }, "docs": "List all registered applications" }, { "info": { "name": "Create a new application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/applications" }, "docs": "This feature was introduced in GitLab 10.5" }, { "info": { "name": "Delete an application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the application (not the application_id)" } ] }, "docs": "Delete a specific application" }, { "info": { "name": "Renew an application secret", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/applications/:id/renew-secret", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the application (not the application_id)" } ] }, "docs": "Renew the secret of a specific application" } ] }, { "info": { "name": "imports", "type": "folder" }, "items": [ { "info": { "name": "List all GitLab Migrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "sort", "value": "", "type": "query", "description": "Return GitLab Migrations sorted in created by `asc` or `desc` order." }, { "name": "status", "value": "", "type": "query", "description": "Return GitLab Migrations with specified status" } ] }, "docs": "This feature was introduced in GitLab 14.1." }, { "info": { "name": "Start a new GitLab Migration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/bulk_imports" }, "docs": "This feature was introduced in GitLab 14.2." }, { "info": { "name": "List all GitLab Migrations' entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports/entities", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "sort", "value": "", "type": "query", "description": "Return GitLab Migrations sorted in created by `asc` or `desc` order." }, { "name": "status", "value": "", "type": "query", "description": "Return all GitLab Migrations' entities with specified status" } ] }, "docs": "This feature was introduced in GitLab 14.1." }, { "info": { "name": "Get GitLab Migration details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports/:import_id", "params": [ { "name": "import_id", "value": "", "type": "path", "description": "The ID of user's GitLab Migration" } ] }, "docs": "This feature was introduced in GitLab 14.1." }, { "info": { "name": "List GitLab Migration entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports/:import_id/entities", "params": [ { "name": "import_id", "value": "", "type": "path", "description": "The ID of user's GitLab Migration" }, { "name": "status", "value": "", "type": "query", "description": "Return import entities with specified status" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 14.1." }, { "info": { "name": "Get GitLab Migration entity details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports/:import_id/entities/:entity_id", "params": [ { "name": "import_id", "value": "", "type": "path", "description": "The ID of user's GitLab Migration" }, { "name": "entity_id", "value": "", "type": "path", "description": "The ID of GitLab Migration entity" } ] }, "docs": "This feature was introduced in GitLab 14.1." }, { "info": { "name": "Get GitLab Migration entity failures", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/bulk_imports/:import_id/entities/:entity_id/failures", "params": [ { "name": "import_id", "value": "", "type": "path", "description": "The ID of user's GitLab Migration" }, { "name": "entity_id", "value": "", "type": "path", "description": "The ID of GitLab Migration entity" } ] }, "docs": "This feature was introduced in GitLab 16.6" }, { "info": { "name": "Cancel GitLab Migration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/bulk_imports/:import_id/cancel", "params": [ { "name": "import_id", "value": "", "type": "path", "description": "The ID of user's GitLab Migration" } ] }, "docs": "This feature was introduced in GitLab 17.1" }, { "info": { "name": "Import User Gists", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/import/github/gists" }, "docs": "This feature was introduced in GitLab 15.8" } ] }, { "info": { "name": "agents", "type": "folder" }, "items": [ { "info": { "name": "Get current agents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/job/allowed_agents" }, "docs": "Retrieves a list of agents for the given job token" } ] }, { "info": { "name": "ci_runners", "type": "folder" }, "items": [ { "info": { "name": "Register a new runner", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/runners" }, "docs": "Register a new runner for the instance" }, { "info": { "name": "Delete a runner by authentication token", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/runners", "params": [ { "name": "token", "value": "", "type": "query", "description": "The runner's authentication token" } ] }, "docs": "Delete a registered runner" }, { "info": { "name": "Internal endpoint that deletes a runner manager by authentication token and system ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/runners/managers", "params": [ { "name": "token", "value": "", "type": "query", "description": "The runner's authentication token" }, { "name": "system_id", "value": "", "type": "query", "description": "The runner's system identifier." } ] }, "docs": "Delete a registered runner manager" }, { "info": { "name": "Verify authentication for a registered runner", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/runners/verify" }, "docs": "Validate authentication credentials" }, { "info": { "name": "postApiV4RunnersResetAuthenticationToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/runners/reset_authentication_token" }, "docs": "Reset runner authentication token with current token" }, { "info": { "name": "Discover Job Router information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/runners/router/discovery" }, "docs": "This endpoint can be used by the runner to retrieve information about the Job Router." } ] }, { "info": { "name": "jobs", "type": "folder" }, "items": [ { "info": { "name": "postApiV4JobsRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/jobs/request" }, "docs": "Request a job" }, { "info": { "name": "putApiV4JobsId", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Job's ID" } ] }, "docs": "Update a job" }, { "info": { "name": "patchApiV4JobsIdTrace", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v4/jobs/:id/trace", "params": [ { "name": "id", "value": "", "type": "path", "description": "Job's ID" } ] }, "docs": "Append a patch to the job trace" }, { "info": { "name": "postApiV4JobsIdArtifactsAuthorize", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/jobs/:id/artifacts/authorize", "params": [ { "name": "id", "value": "", "type": "path", "description": "Job's ID" } ] }, "docs": "Authorize uploading job artifact" }, { "info": { "name": "getApiV4JobsIdArtifacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/jobs/:id/artifacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Job's ID" }, { "name": "token", "value": "", "type": "query", "description": "Job's authentication token" }, { "name": "direct_download", "value": "", "type": "query", "description": "Perform direct download from remote storage instead of proxying artifacts" } ] }, "docs": "Download the artifacts file for job" }, { "info": { "name": "postApiV4JobsIdArtifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/jobs/:id/artifacts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Job's ID" } ] }, "docs": "Upload a job artifact" } ] }, { "info": { "name": "chaos", "type": "folder" }, "items": [ { "info": { "name": "Chaos test endpoint for feature flag observability", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/chaos/test" }, "docs": "Picks a project by random ID and checks the `ebonet_chaos_tests` feature flag.\nWhen enabled, introduces a 20% chance of a 500 error and a 20% chance of\na 300ms delay. Returns 200 OK otherwise.\n" } ] }, { "info": { "name": "features", "type": "folder" }, "items": [ { "info": { "name": "List all features", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/features" }, "docs": "Get a list of all persisted features, with its gate values." }, { "info": { "name": "List all feature definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/features/definitions" }, "docs": "Get a list of all feature definitions." }, { "info": { "name": "Set or create a feature", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/features/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Set a feature's gate value. If a feature with the given name doesn't exist yet, it's created. The value can be a boolean, or an integer to indicate percentage of time." }, { "info": { "name": "Delete a feature", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/features/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Removes a feature gate. Response is equal when the gate exists, or doesn't." } ] }, { "info": { "name": "geo", "type": "folder" }, "items": [ { "info": { "name": "Determine if a Geo site should proxy requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/geo/proxy" }, "docs": "Returns a Geo proxy response" }, { "info": { "name": "Internal endpoint that returns a replicable file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/geo/retrieve/:replicable_name/:replicable_id", "params": [ { "name": "replicable_name", "value": "package_file", "type": "path", "description": "The replicable name of a replicator instance" }, { "name": "replicable_id", "value": "", "type": "path", "description": "The replicable ID of a replicable instance" } ] }, "docs": "Returns a replicable file from store (via CDN or sendfile)" }, { "info": { "name": "Used by secondary runners to verify the secondary instance has the very latest version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/geo/repositories/:gl_repository/pipeline_refs", "params": [ { "name": "gl_repository", "value": "", "type": "path", "description": "The repository to check" } ] }, "docs": "Returns the list of pipeline refs for the project" }, { "info": { "name": "Internal endpoint that posts the current node status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/status" }, "docs": "Posts the current node status to the primary site" }, { "info": { "name": "Internal endpoint that returns info refs upload pack for clone or pull operations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/proxy_git_ssh/info_refs_upload_pack" }, "docs": "Responsible for making HTTP GET /repo.git/info/refs?service=git-upload-pack\n request from secondary gitlab-shell to primary" }, { "info": { "name": "Internal endpoint that posts git-upload-pack for clone or pull operations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/proxy_git_ssh/upload_pack" }, "docs": "Responsible for making HTTP POST /repo.git/git-upload-pack\n request from secondary gitlab-shell to primary" }, { "info": { "name": "Internal endpoint that returns git-received-pack output for git push", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/proxy_git_ssh/info_refs_receive_pack" }, "docs": "Responsible for making HTTP GET /repo.git/info/refs?service=git-receive-pack\n request from secondary gitlab-shell to primary" }, { "info": { "name": "Internal endpoint that posts git-receive-pack for git push", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/proxy_git_ssh/receive_pack" }, "docs": "Responsible for making HTTP POST /repo.git/info/refs?service=git-receive-pack\n request from secondary gitlab-shell to primary" }, { "info": { "name": "Query the GraphQL endpoint of an existing Geo node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/geo/node_proxy/:id/graphql", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the Geo node" } ] }, "docs": "Query the GraphQL endpoint of an existing Geo node" } ] }, { "info": { "name": "glql", "type": "folder" }, "items": [ { "info": { "name": "Execute GLQL query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/glql" }, "docs": "Execute a GLQL (GitLab Query Language) query" } ] }, { "info": { "name": "jira_connect_subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Subscribe a namespace to a JiraConnectInstallation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/integrations/jira_connect/subscriptions" }, "docs": "Subscribes the namespace to the JiraConnectInstallation" } ] }, { "info": { "name": "markdown", "type": "folder" }, "items": [ { "info": { "name": "Render an arbitrary Markdown document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/markdown" }, "docs": "This feature was introduced in GitLab 11.0." } ] }, { "info": { "name": "namespaces", "type": "folder" }, "items": [ { "info": { "name": "Get namespace by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/namespaces/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID or URL-encoded path of the namespace" } ] }, "docs": "Get a namespace by ID" }, { "info": { "name": "Update a namespace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/namespaces/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deprecated in 17.8" }, { "info": { "name": "getApiV4NamespacesIdGitlabSubscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/namespaces/:id/gitlab_subscription", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns the subscription for the namespace" }, { "info": { "name": "Creates a storage limit exclusion for a Namespace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/namespaces/:id/storage/limit_exclusion", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Creates a Namespaces::Storage::LimitExclusion" }, { "info": { "name": "Removes a storage limit exclusion for a Namespace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/namespaces/:id/storage/limit_exclusion", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Removes a Namespaces::Storage::LimitExclusion" }, { "info": { "name": "Retrieve all limit exclusions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/namespaces/storage/limit_exclusions", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "Gets all records for namespaces that have been excluded" }, { "info": { "name": "List namespaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/namespaces", "params": [ { "name": "search", "value": "", "type": "query", "description": "Returns a list of namespaces the user is authorized to view based on the search criteria" }, { "name": "owned_only", "value": "", "type": "query", "description": "In GitLab 14.2 and later, returns a list of owned namespaces only" }, { "name": "top_level_only", "value": "", "type": "query", "description": "Only include top level namespaces" }, { "name": "full_path_search", "value": "", "type": "query", "description": "If `true`, the `search` parameter is matched against the full path of the namespaces" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "requested_hosted_plan", "value": "", "type": "query", "description": "Name of the hosted plan requested by the customer" } ] }, "docs": "Get a list of the namespaces of the authenticated user. If the user is an administrator, a list of all namespaces in the GitLab instance is shown." }, { "info": { "name": "Get existence of a namespace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/namespaces/:id/exists", "params": [ { "name": "id", "value": "", "type": "path", "description": "Namespace’s path" }, { "name": "parent_id", "value": "", "type": "query", "description": "The ID of the parent namespace. If no ID is specified, only top-level namespaces are considered." } ] }, "docs": "Get existence of a namespace by path. Suggests a new namespace path that does not already exist." } ] }, { "info": { "name": "offline_transfers", "type": "folder" }, "items": [ { "info": { "name": "List all offline transfer exports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/offline_exports", "params": [ { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" }, { "name": "sort", "value": "", "type": "query", "description": "Return offline transfer exports sorted in created by `asc` or `desc` order." }, { "name": "status", "value": "", "type": "query", "description": "Return offline transfer exports with specified status" } ] }, "docs": "Lists all offline transfer exports" }, { "info": { "name": "Start a new offline transfer export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/offline_exports" }, "docs": "Initiates a new offline transfer export" }, { "info": { "name": "Get offline transfer export details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/offline_exports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of user's offline transfer export" } ] }, "docs": "Retrieves details of an offline transfer export" }, { "info": { "name": "Start a new offline transfer import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/offline_imports" }, "docs": "Initiates a new offline transfer import from object storage" } ] }, { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "Create an organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/organizations" }, "docs": "This feature was introduced in GitLab 17.5. \\\n This feature is behind the `allow_organization_creation` feature flag. \\\n In GitLab 18.3, feature flag changed to `organization_switching`." } ] }, { "info": { "name": "suggestions", "type": "folder" }, "items": [ { "info": { "name": "putApiV4SuggestionsIdApply", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/suggestions/:id/apply", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the suggestion" } ] }, "docs": "Apply suggestion patch in the Merge Request it was created" }, { "info": { "name": "putApiV4SuggestionsBatchApply", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/suggestions/batch_apply" }, "docs": "Apply multiple suggestion patches in the Merge Request where they were created" } ] }, { "info": { "name": "unleash", "type": "folder" }, "items": [ { "info": { "name": "getApiV4FeatureFlagsUnleashProjectId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/feature_flags/unleash/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "instance_id", "value": "", "type": "query", "description": "The instance ID of Unleash Client" }, { "name": "app_name", "value": "", "type": "query", "description": "The application name of Unleash Client" } ] }, "docs": "Get Unleash features" }, { "info": { "name": "Get a list of features (v2 client support)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/feature_flags/unleash/:project_id/features", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "instance_id", "value": "", "type": "query", "description": "The instance ID of Unleash Client" }, { "name": "app_name", "value": "", "type": "query", "description": "The application name of Unleash Client" } ] }, "docs": "Deprecated in GitLab 15.6" }, { "info": { "name": "getApiV4FeatureFlagsUnleashProjectIdClientFeatures", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/feature_flags/unleash/:project_id/client/features", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of a project" }, { "name": "instance_id", "value": "", "type": "query", "description": "The instance ID of Unleash Client" }, { "name": "app_name", "value": "", "type": "query", "description": "The application name of Unleash Client" } ] }, "docs": "Get a list of features" }, { "info": { "name": "postApiV4FeatureFlagsUnleashProjectIdClientRegister", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/feature_flags/unleash/:project_id/client/register", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of a project" } ] }, "docs": "Register Unleash client" }, { "info": { "name": "postApiV4FeatureFlagsUnleashProjectIdClientMetrics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/feature_flags/unleash/:project_id/client/metrics", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of a project" } ] }, "docs": "Report Unleash client metrics" } ] }, { "info": { "name": "usage_data", "type": "folder" }, "items": [ { "info": { "name": "Track usage data event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/usage_data/increment_counter" }, "docs": "This feature was introduced in GitLab 13.4." }, { "info": { "name": "postApiV4UsageDataIncrementUniqueUsers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/usage_data/increment_unique_users" }, "docs": "Track usage data event for the current user" }, { "info": { "name": "Track multiple gitlab internal events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/usage_data/track_events" }, "docs": "This feature was introduced in GitLab 17.3." }, { "info": { "name": "Get the latest ServicePing payload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/usage_data/service_ping" }, "docs": "Introduces in Gitlab 16.9. Requires personal access token with read_service_ping scope." }, { "info": { "name": "Track gitlab internal events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/usage_data/track_event" }, "docs": "This feature was introduced in GitLab 16.2." }, { "info": { "name": "Get Non SQL usage ping metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/usage_data/non_sql_metrics" }, "docs": "This feature was introduced in GitLab 13.11." }, { "info": { "name": "Get raw SQL queries for usage data SQL metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/usage_data/queries" }, "docs": "This feature was introduced in GitLab 13.11." } ] }, { "info": { "name": "metrics", "type": "folder" }, "items": [ { "info": { "name": "Get a list of all metric definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/usage_data/metric_definitions", "params": [ { "name": "include_paths", "value": "true", "type": "query", "description": "Include file paths in the metric definitions" } ] }, "docs": "This feature was introduced in GitLab 13.11." } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "Return the user specific counts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/user_counts" }, "docs": "Assigned open issues, assigned MRs and pending todos count" }, { "info": { "name": "Create a runner owned by currently authenticated user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/user/runners" }, "docs": "Create a new runner" } ] }, { "info": { "name": "plan_limits", "type": "folder" }, "items": [ { "info": { "name": "Get current plan limits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/application/plan_limits", "params": [ { "name": "plan_name", "value": "", "type": "query", "description": "Name of the plan to get the limits from. Default: default." } ] }, "docs": "List the current limits of a plan on the GitLab instance." }, { "info": { "name": "Change plan limits", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/application/plan_limits" }, "docs": "Modify the limits of a plan on the GitLab instance." } ] }, { "info": { "name": "instance", "type": "folder" }, "items": [ { "info": { "name": "getApiV4ApplicationAppearance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/application/appearance" }, "docs": "Get the current appearance" }, { "info": { "name": "putApiV4ApplicationAppearance", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/application/appearance" }, "docs": "Modify appearance" }, { "info": { "name": "getApiV4ApplicationStatistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/application/statistics" }, "docs": "Get the current application statistics" } ] }, { "info": { "name": "metadata", "type": "folder" }, "items": [ { "info": { "name": "Retrieve metadata information for this GitLab instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/metadata" }, "docs": "This feature was introduced in GitLab 15.2." }, { "info": { "name": "Retrieves version information for the GitLab instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/version" }, "docs": "This feature was introduced in GitLab 8.13 and deprecated in 15.5. We recommend you instead use the Metadata API." } ] }, { "info": { "name": "project_topics", "type": "folder" }, "items": [ { "info": { "name": "Get topics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/topics", "params": [ { "name": "search", "value": "search", "type": "query", "description": "Return list of topics matching the search criteria" }, { "name": "without_projects", "value": "", "type": "query", "description": "Return list of topics without assigned projects" }, { "name": "organization_id", "value": "", "type": "query", "description": "The organization id for the topics" }, { "name": "page", "value": "1", "type": "query", "description": "Current page number" }, { "name": "per_page", "value": "20", "type": "query", "description": "Number of items per page" } ] }, "docs": "This feature was introduced in GitLab 14.5." }, { "info": { "name": "Create a topic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/topics" }, "docs": "This feature was introduced in GitLab 14.5." }, { "info": { "name": "Get topic", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/topics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of project topic" } ] }, "docs": "This feature was introduced in GitLab 14.5." }, { "info": { "name": "Update a topic", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v4/topics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of project topic" } ] }, "docs": "This feature was introduced in GitLab 14.5." }, { "info": { "name": "Delete a topic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v4/topics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of project topic" } ] }, "docs": "This feature was introduced in GitLab 14.9." }, { "info": { "name": "Merge topics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v4/topics/merge" }, "docs": "This feature was introduced in GitLab 15.4." } ] }, { "info": { "name": "web_commits", "type": "folder" }, "items": [ { "info": { "name": "Get the public key for web commits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v4/web_commits/public_key" }, "docs": "This feature was introduced in GitLab 17.4." } ] } ], "bundled": true }