GitLab integration: operations for AI agents
GitLab connects to Type.com as an integration. This page lists the 1862 operations documented for Claude and Codex in Type.com: 827 read, 417 write, 618 destructive.
About GitLab
GitLab REST API v4: 1862 current authoritative endpoint references with explicit transport, authentication and account limits.
Categories: Developer Tools & IT
How to connect GitLab to Type.com
- Connect
- Managed Pipedream OAuth; no direct provider preset.
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
1862 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
1862 operations listed.
GitLab subscriptions
- Write
Create a subscription for the namespace (deprecated)
Deprecated in GitLab 17.7
POST /api/v4/namespaces/{id}/gitlab_subscription - Destructive
Update the subscription for the namespace (deprecated)
Deprecated in GitLab 17.7
PUT /api/v4/namespaces/{id}/gitlab_subscription
Namespaces
- Read
Retrieve namespace subscription
Retrieves GitLab subscription details for a specified namespace.
GET /api/v4/namespaces/{id}/gitlab_subscription - Read
Retrieve namespace details
Retrieves a specified namespace.
GET /api/v4/namespaces/{id} - Read
Retrieve all limit exclusions
Gets all records for namespaces that have been excluded
GET /api/v4/namespaces/storage/limit_exclusions - Read
List all namespaces
Lists all namespaces available to the current user. If the user is an administrator, this endpoint returns all namespaces in the instance.
GET /api/v4/namespaces - Read
Verify namespace availability
Verifies that a namespace is available for use.
GET /api/v4/namespaces/{id}/exists - Write
Creates a storage limit exclusion for a Namespace
Creates a Namespaces::Storage::LimitExclusion
POST /api/v4/namespaces/{id}/storage/limit_exclusion - Destructive
Update a namespace
Deprecated in 17.8
PUT /api/v4/namespaces/{id} - Destructive
Removes a storage limit exclusion for a Namespace
Removes a Namespaces::Storage::LimitExclusion
DELETE /api/v4/namespaces/{id}/storage/limit_exclusion
CI minutes
- Write
Create a compute minutes purchase record for the namespace (deprecated)
Deprecated in GitLab 17.7
POST /api/v4/namespaces/{id}/minutes - Write
Transfer purchased compute minutes packs to another namespace (deprecated)
Deprecated in GitLab 17.7
PATCH /api/v4/namespaces/{id}/minutes/move/{target_id}
Add on purchases
- Read
Returns an add-on purchase for the namespace (deprecated)
Deprecated in GitLab 17.7
GET /api/v4/namespaces/{id}/subscription_add_on_purchase/{add_on_name} - Write
Create an add-on purchase for the namespace (deprecated)
Deprecated in GitLab 17.7
POST /api/v4/namespaces/{id}/subscription_add_on_purchase/{add_on_name} - Destructive
Update the add-on purchase for the namespace (deprecated)
Deprecated in GitLab 17.7
PUT /api/v4/namespaces/{id}/subscription_add_on_purchase/{add_on_name}
Namespace projects
- Read
Returns the projects of a namespace (including subgroups), with license data included
Used by CustomersDot to check OSS program compliance for a namespace, avoiding one API call per project to fetch license data.
GET /api/v4/internal/gitlab_subscriptions/namespaces/{id}/projects
Rollouts
- Write
Ingest a rollout workflow event
Reports flow-graph progress from the CD orchestrator (a Starlark workflow run by AutoFlow).
POST /api/v4/rollouts/{id}
Orbit
- Read
Get entity context
Resolves one Orbit token to a PostgreSQL summary and, optionally, its graph neighborhood. Requests that reach token resolution count against the orbit_query rate limit; with expand, they run at most one billable graph query. Requires a JSON request body.
POST /api/v4/orbit/context - Read
List deployed Orbit skills
Lists the Orbit skills deployed with the connected knowledge graph service.
GET /api/v4/orbit/skills - Read
Retrieve a deployed Orbit skill
Retrieves a complete deployed Orbit skill tree. HEAD requests retrieve only skill metadata.
GET /api/v4/orbit/skills/{name} - Read
Retrieve a deployed Orbit skill file
Retrieves a UTF-8 file from a deployed Orbit skill as raw text.
GET /api/v4/orbit/skills/{name}/{path} - Write
Execute a query
Executes a query against the Orbit gRPC service.
POST /api/v4/orbit/query - Write
Execute a named query
Executes a server-defined named query against the Orbit gRPC service. Requires a JSON request body: form encoding stringifies nested parameter values, which the per-query parameter schemas reject.
POST /api/v4/orbit/query/{name}
Software composition analysis
- Read
Download an SBOM scan result
Downloads an SBOM scan result file for a specified job.
GET /api/v4/jobs/{id}/sbom_scans/{sbom_digest} - Write
Authorize SBOM file upload
Authorizes uploading an SBOM file to be scanned for a specified job.
POST /api/v4/jobs/{id}/sbom_scans/authorize - Write
Upload an SBOM file
Uploads an SBOM file to be scanned for a specified job.
POST /api/v4/jobs/{id}/sbom_scans - Write
Reuse SBOM scan results
Reuses existing SBOM scan results if scans for the specified digest already exist.
POST /api/v4/jobs/{id}/sbom_scans/{sbom_digest}
Compliance policy settings
- Read
Retrieve security policy settings
Retrieves the current security policy settings for this GitLab instance.
GET /api/v4/admin/security/compliance_policy_settings - Write
Set status of an external control
Sets the status of a specified external control. Use this operation to inform GitLab that a control has passed or failed a check by an external service.
PATCH /api/v4/projects/{id}/compliance_external_controls/{control_id}/status - Destructive
Update security policy settings
Updates the security policy settings for this GitLab instance.
PUT /api/v4/admin/security/compliance_policy_settings
Security scans
- Write
Scan a file for vulnerabilities
Scans a specified file for security vulnerabilities using SAST.
POST /api/v4/projects/{id}/security_scans/sast/{sast_endpoint}
GitLab Duo
- Write
Evaluate code review
Evaluates code changes using GitLab Duo code review
POST /api/v4/duo_code_review/evaluations - Write
Generate a Chat response
Generates a response for a GitLab Duo Chat question.
POST /api/v4/chat/completions - Write
Get connection details for third party agents
Returns connection details including tokens for accessing third-party agents.
POST /api/v4/ai/third_party_agents/direct_access - Write
Generate Git commands from natural text
Generates Git commands from natural language input
POST /api/v4/ai/llm/git_command
Token exchange
- Write
Issue a short-lived JWT for a single modular-service audience
Issues a short-lived RS256 JWT scoped to one modular-service audience (such as the Artifact Registry). Claims include the requesting user id (sub), organization id, and deployment realm (saas / self-managed). Presented to the corresponding backend and verified against the instance JWKS.
POST /api/v4/token_exchange
Code Suggestions
- Read
Validate status of Code Suggestions
Validates the status Code Suggestions for a specified project. This checks if the project has `code_suggestions` enabled or if an ancestor group has the Code Suggestions add-on enabled.
POST /api/v4/code_suggestions/enabled - Write
Generate code completions
Generates code completions. Uses the AI abstraction layer to generate code completions. Requests to this endpoint are proxied to the AI Gateway.
POST /api/v4/code_suggestions/completions - Write
Retrieve direct connection details for the AI Gateway
Retrieves user-specific connection details which can be used by IDEs or clients to send `completion` requests to Code Suggestions directly through the AI Gateway.
POST /api/v4/code_suggestions/direct_access - Write
Retrieve connection details
Retrieves user-specific connection details which can be used by IDEs or clients for telemetry, including an instance-specific application ID, application access token, and clickhouse data plane URL.
POST /api/v4/code_suggestions/connection_details
Search
- Read
Search project code using natural language
Introduced in GitLab 18.11. Searches indexed project code using semantic (meaning-based) similarity rather than keyword matching. Use this when you do not know the exact symbol or file name, or to discover how a behavior is implemented across the codebase. Primary use cases: - When you do not know the exact symbol or file path - To see how a behavior or feature is implemented across the codebase - To discover related implementations (clients, jobs, workers) How to use: - Provide a concise, specific query with concrete keywords - Use directory_path to narrow scope (e.g. "app/services/") - Prefer precise intent over broad terms Results are grouped by file. Each file includes merged line ranges with content and a relevance score (0.0-1.0). The response includes an overall confidence level (high/medium/low/unknown) based on score distribution. Results are filtered by Duo context exclusion settings. Requires semantic code search to be enabled and indexed for the project namespace.
GET /api/v4/projects/{id}/(-/)search/semantic - Read
List all advanced search migrations
Lists all advanced search migrations for the GitLab instance.
GET /api/v4/admin/search/migrations - Read
Retrieve an advanced search migration
Retrieves a specified advanced search migration by migration version or name.
GET /api/v4/admin/search/migrations/{migration_id} - Read
Search an instance
Searches for a term across the entire GitLab instance. The response depends on the requested scope.
GET /api/v4/search - Read
Search on GitLab within a group
This feature was introduced in GitLab 10.5.
GET /api/v4/groups/{id}/(-/)search - Read
Search a project
Searches for content in a specified project.
GET /api/v4/projects/{id}/(-/)search
Projects
- Read
List external agent sessions for a project.
Returns a paginated list of external agent sessions for the project.
GET /api/v4/projects/{id}/ai_agent/sessions - Read
List all project security settings
Lists all security settings for the project. You must have the Security Manager, Developer, Maintainer, or Owner role for the project.
GET /api/v4/projects/{id}/security_settings - Read
List all Terraform state protection rules for a project
Lists all Terraform state protection rules for a project. This feature was introduced in GitLab 18.11.
GET /api/v4/projects/{id}/terraform/state_protection_rules - Read
List all personal projects for a user
Lists all personal projects for a specified user. Does not return group or subgroup projects. If the user profile is private, returns only an empty list.
GET /api/v4/users/{user_id}/projects - Read
List all projects contributions for a user
Lists all contributions to visible projects for a specified user. Returns only contributions in the past year.
GET /api/v4/users/{user_id}/contributed_projects - Read
List all projects starred by a user
Lists all visible projects starred by a specified user. Unauthenticated requests return only public projects.
GET /api/v4/users/{user_id}/starred_projects - Read
List all projects
Lists all projects. Unauthenticated requests return only public projects with a limited subset of attributes. You can filter responses by custom attributes. To use the `updated_after` or `updated_before` filters, you must also set `order_by` to `updated_at`.
GET /api/v4/projects - Read
Retrieve a project
Retrieves details on a specified project. This endpoint can be accessed without authentication if the project is publicly accessible.
GET /api/v4/projects/{id} - Read
List all forks of a project
Lists all forks of a project.
GET /api/v4/projects/{id}/forks - Read
Verify Pages access to a project
Verifies if the current user can access GitLab Pages in a specified project.
GET /api/v4/projects/{id}/pages_access - Read
List all users who starred a project
Lists all users who starred a specified project.
GET /api/v4/projects/{id}/starrers - Read
Retrieve programming language usage information
Retrieves information about all programming languages used in a specified project.
GET /api/v4/projects/{id}/languages - Read
List all members of a project
Lists all members with access to a specified project.
GET /api/v4/projects/{id}/users - Read
List all ancestor groups
Lists all ancestor groups for a specified project.
GET /api/v4/projects/{id}/groups - Read
List all invited groups in a project
Lists all invited groups in a project. Unauthenticated requests return only public invited groups. Limited to 60 requests a minute per user account for authenticated requires and per IP address for unauthenticated requests. Supports offset-based pagination (up to 50,000 projects) and keyset-based pagination (greater than 50,000 projects).
GET /api/v4/projects/{id}/invited_groups - Read
List all transferable namespaces for a project
Lists all namespaces where a specified project can be transferred.
GET /api/v4/projects/{id}/transfer_locations - Read
Retrieve the path to repository storage
Retrieves the path to repository storage for a specified project. If you are using Gitaly Cluster (Praefect), see Praefect-generated replica paths instead. Administrators only.
GET /api/v4/projects/{id}/storage - Read
List all project audit events
Lists all audit events for a specified project.
GET /api/v4/projects/{id}/audit_events - Read
Retrieve a project audit event
Retrieves an audit event for a specified project. Only available to users with at least the Developer role for the project.
GET /api/v4/projects/{id}/audit_events/{audit_event_id} - Read
Retrieve the statistics of the last 30 days
Retrieves the clone and pull statistics for the last 30 days from a specified project.
GET /api/v4/projects/{id}/statistics - Read
List all package protection rules
Lists all package protection rules for a specified project.
GET /api/v4/projects/{id}/packages/protection/rules - Read
List all container registry protection tag rules
Lists all container registry protection tag rules for a project. This feature was introduced in GitLab 18.7.
GET /api/v4/projects/{id}/registry/protection/tag/rules - Read
List all container repository protection rules
Lists all container repository protection rules for a specified project.
GET /api/v4/projects/{id}/registry/protection/repository/rules - Read
List all uploads
Lists all uploads of a project sorted by `created_at` in descending order. You must have the Maintainer or Owner role for the project.
GET /api/v4/projects/{id}/uploads - Read
Download an uploaded file by ID
Downloads an uploaded file with a specified ID. You must have the Maintainer or Owner role for the project.
GET /api/v4/projects/{id}/uploads/{upload_id} - Read
Download an uploaded file by secret and filename
Downloads an uploaded file with a specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for the project.
GET /api/v4/projects/{id}/uploads/{secret}/{filename} - Read
List all project issues
Lists all issues for a specified project. If the project is private, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/projects/{id}/issues - Read
Retrieve issues statistics for a project
Retrieves statistics for issues in a specified project.
GET /api/v4/projects/{id}/issues_statistics - Read
Retrieve a project issue
Retrieves a specified issue for a project. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/projects/{id}/issues/{issue_iid} - Read
List all merge requests that close an issue on merge
Lists all merge requests that close a specified issue when merged. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/projects/{id}/issues/{issue_iid}/closed_by - Write
Create an external agent session.
Creates a new external agent session for the current user and project. Returns an existing record if an idempotency_key is provided and a matching session already exists.
POST /api/v4/projects/{id}/ai_agent/sessions - Write
Complete or fail an external agent session.
Marks a session as completed or failed. The authenticated user must be the creator of the session.
PATCH /api/v4/projects/{id}/ai_agent/sessions/{session_id} - Write
Register an external agent identity.
Registers a new agent identity for the current user, project, agent type, and machine fingerprint combination. Returns an existing record if one already exists. Returns 403 if the identity has been revoked.
POST /api/v4/projects/{id}/ai_agent/identities - Write
Ingest external agent audit events.
Accepts a batch of up to 500 audit events for an external agent session. Events are validated, deduplicated by cloud_event_id, and enqueued for storage.
POST /api/v4/projects/{id}/ai_agent/audit_events - Write
Create a Terraform state protection rule for a project
This feature was introduced in GitLab 19.1.
POST /api/v4/projects/{id}/terraform/state_protection_rules - Write
Update a Terraform state protection rule for a project
This feature was introduced in GitLab 19.0.
PATCH /api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id} - Write
Restore a project marked for deletion
Restores a specified project that was marked for deletion.
POST /api/v4/projects/{id}/restore - Write
Create a project
Creates a project owned by the authenticated user. If your HTTP repository is not publicly accessible, add authentication information to the URL `https://username:password@gitlab.company.com/group/project.git`, where `password` is a public access key with the `api` scope.
POST /api/v4/projects - Write
Create a project for a user
Creates a project for a user. Administrators only.
POST /api/v4/projects/user/{user_id} - Write
Create a fork of a project
Creates a fork of a project.
POST /api/v4/projects/{id}/fork - Write
Unarchive a project
Unarchives a specified project. You must be an administrator or have the Owner role on the project.
POST /api/v4/projects/{id}/unarchive - Write
Star a project
Stars a specified project.
POST /api/v4/projects/{id}/star - Write
Unstar a project
Unstars a specified project.
POST /api/v4/projects/{id}/unstar - Write
Create a fork relationship
Creates a fork relationship between a project and an upstream project.
POST /api/v4/projects/{id}/fork/{forked_from_id} - Write
Import members
Imports members from another project. If the role of the importing member for the target project is a Maintainer, then members with the Owner role for the source project are imported with the Maintainer role. If the importing member is an Owner, then members with the Owner role for the source project are imported with the Owner role.
POST /api/v4/projects/{id}/import_project_members/{project_id} - Write
Start the housekeeping task for a project
Starts the housekeeping task for a project.
POST /api/v4/projects/{id}/housekeeping - Write
Start a task to recalculate repository size for a project
This feature was introduced in GitLab 15.0.
POST /api/v4/projects/{id}/repository_size - Write
Create a package protection rule
Creates a package protection rule for a specified project.
POST /api/v4/projects/{id}/packages/protection/rules - Write
Update a package protection rule
Updates a package protection rule for a specified project.
PATCH /api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id} - Write
Create a container registry protection tag rule
Creates a container registry protection tag rule for a project to control who can push or delete container tags. This feature was introduced in GitLab 18.8.
POST /api/v4/projects/{id}/registry/protection/tag/rules - Write
Update a container registry protection tag rule
Updates a container registry protection tag rule for a project. This feature was introduced in GitLab 18.9.
PATCH /api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id} - Write
Create a container repository protection rule
Creates a container repository protection rule for a specified project to control who can push or delete container images.
POST /api/v4/projects/{id}/registry/protection/repository/rules - Write
Update a container repository protection rule
Updates a container repository protection rule for a specified project.
PATCH /api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id} - Write
Create a CI configuration merge request
Creates a merge request to add CI configuration to a specified project.
POST /api/v4/projects/{id}/create_ci_config - Write
Workhorse authorize the file upload
This feature was introduced in GitLab 13.11
POST /api/v4/projects/{id}/uploads/authorize - Write
Create an upload
Creates an upload.
POST /api/v4/projects/{id}/uploads - Write
Create an issue
Creates an issue for a specified project.
POST /api/v4/projects/{id}/issues - Write
Move an issue
Moves a specified issue to a different project. If the target project is the source project or the user has insufficient permissions, an error message with status code `400` is returned. If a label or milestone with the same name also exists in the target project, it is then assigned to the issue being moved.
POST /api/v4/projects/{id}/issues/{issue_iid}/move - Write
Clone an issue
Clones a specified issue to a project. Copies as much data as possible as long as the target project contains equivalent criteria, such as labels or milestones. If you have insufficient permissions, an error message with status code `400` is returned.
POST /api/v4/projects/{id}/issues/{issue_iid}/clone - Destructive
Update project security settings
Updates project security settings for a specified project. You must have the Maintainer or Owner role for the project.
PUT /api/v4/projects/{id}/security_settings - Destructive
Delete a Terraform state protection rule
This feature was introduced in GitLab 19.0.
DELETE /api/v4/projects/{id}/terraform/state_protection_rules/{terraform_state_protection_rule_id} - Destructive
Update a project
Updates an existing project. If your HTTP repository is not publicly accessible, add authentication information to the URL `https://username:password@gitlab.company.com/group/project.git`, where `password` is a public access key with the `api` scope. At least one project attribute must be updated.
PUT /api/v4/projects/{id} - Destructive
Delete a project
Deletes a specified project.
DELETE /api/v4/projects/{id} - Destructive
Delete a fork relationship
Deletes a fork relationship between projects.
DELETE /api/v4/projects/{id}/fork - Destructive
Archive a project
Archives a specified project. You must be an administrator or be assigned the Owner role on the project.
POST /api/v4/projects/{id}/archive - Destructive
Transfer a project to another namespace
Transfers a project to another namespace.
PUT /api/v4/projects/{id}/transfer - Destructive
Delete a package protection rule
Deletes a package protection rule from a specified project.
DELETE /api/v4/projects/{id}/packages/protection/rules/{package_protection_rule_id} - Destructive
Delete a container registry protection tag rule
Deletes a container registry protection tag rule from a project. This feature was introduced in GitLab 18.9.
DELETE /api/v4/projects/{id}/registry/protection/tag/rules/{protection_rule_id} - Destructive
Delete a container repository protection rule
Deletes a specified container repository protection rule.
DELETE /api/v4/projects/{id}/registry/protection/repository/rules/{protection_rule_id} - Destructive
Delete an uploaded file by ID
Deletes an uploaded file with a specified ID. You must have the Maintainer or Owner role for the project.
DELETE /api/v4/projects/{id}/uploads/{upload_id} - Destructive
Delete an uploaded file by secret and filename
Deletes an uploaded file with a specified secret and filename. You must have the Maintainer or Owner role for the project.
DELETE /api/v4/projects/{id}/uploads/{secret}/{filename} - Destructive
Update an issue
Updates a specified issue for a project. This request is also used to close or reopen an issue using the `state_event` parameter. At least one of the following parameters is required for the request to be successful: `assignee_id`, `assignee_ids`, `confidential`, `created_at`, `description`, `discussion_locked`, `due_date`, `issue_type`, `labels`, `milestone_id`, `state_event`, `title`.
PUT /api/v4/projects/{id}/issues/{issue_iid} - Destructive
Delete an issue
Deletes a specified issue.
DELETE /api/v4/projects/{id}/issues/{issue_iid} - Destructive
Update the order of an issue
Updates the order of a specified issue in a project. You can see the results when sorting issues manually.
PUT /api/v4/projects/{id}/issues/{issue_iid}/reorder
GitLab Duo workflows
- Read
Fetch the Duo Code Review custom instructions for a merge request
Fetch all Duo Code Review custom instructions for a merge request.
GET /api/v4/ai/duo_workflows/code_review/custom_instructions - Read
Get workflow details
Retrieves detailed information about a specific workflow by its ID.
GET /api/v4/ai/duo_workflows/workflows/{id} - Read
List all workflow checkpoints
Lists all checkpoints associated with a specific workflow.
GET /api/v4/ai/duo_workflows/workflows/{id}/checkpoints - Read
Get a workflow checkpoint reconstructed from incremental blobs
Retrieves a full workflow checkpoint reconstructed from incremental data blobs.
GET /api/v4/ai/duo_workflows/workflows/{id}/checkpoints/by_thread_ts - Read
Get details on a workflow checkpoint
Retrieves detailed information about a specific workflow checkpoint.
GET /api/v4/ai/duo_workflows/workflows/{id}/checkpoints/{checkpoint_id} - Read
List all workflow events
Retrieves a list of all events associated with a specific workflow.
GET /api/v4/ai/duo_workflows/workflows/{id}/events - Read
List Duo Agent Platform tools
Returns a list of all available Duo Agent Platform tools.
GET /api/v4/ai/duo_workflows/list_tools - Read
Get Duo Workflows WebSocket connection details
Retrieves WebSocket connection information to establish a session with Duo Workflows.
GET /api/v4/ai/duo_workflows/ws - Read
Get workflow trace as JSONL
Returns the full trace of a workflow session as JSON Lines (JSONL). Each line is a JSON object representing one checkpoint event in chronological order.
GET /api/v4/ai/duo_workflows/workflows/{workflow_id}/trace.jsonl - Read
List all agent privileges
Lists all available agent privileges with their IDs, names, descriptions, and whether each is enabled by default. This endpoint has no supported attributes.
GET /api/v4/ai/duo_workflows/workflows/agent_privileges - Write
Ingest AI audit events from Duo Workflow Service
Ingest AI audit events from Duo Workflow Service. See the pinned request/response schema and parameters for the authoritative contract.
POST /api/v4/ai/duo_workflows/workflows/{id}/audit_events - Write
Submit risk assessment results for a merge request
Submits the categorical claims and summary produced by the risk assessment tool.
POST /api/v4/ai/duo_workflows/tools/risk_assessment/results - Write
Submit risk assessment results for a merge request (deprecated)
Submits the categorical claims and summary produced by the risk assessment tool.
POST /api/v4/ai/duo_workflows/tools/risk_classification/results - Write
Add code review comments to a merge request
Adds review comments generated by Duo Workflows to a merge request.
POST /api/v4/ai/duo_workflows/code_review/add_comments - Write
Create workflow persistence (agent-initiated, limited privileges)
Accessible via ai_workflows scope token. Does not accept agent_privileges or pre_approved_agent_privileges.
POST /api/v4/ai/duo_workflows/agent_workflows - Write
Update the workflow status
Updates the execution status of a specified workflow.
PATCH /api/v4/ai/duo_workflows/workflows/{id} - Write
Create workflow checkpoint
Creates a new checkpoint state for an active workflow execution.
POST /api/v4/ai/duo_workflows/workflows/{id}/checkpoints - Write
Create multiple workflow checkpoint writes
Writes multiple checkpoint entries for a workflow in a single request.
POST /api/v4/ai/duo_workflows/workflows/{id}/checkpoint_writes_batch - Write
Create workflow event
Creates a new event for a specified workflow execution.
POST /api/v4/ai/duo_workflows/workflows/{id}/events - Write
Connection details for accessing Duo Agent Platform Service directly
Returns connection details for direct access to the Duo Agent Platform Service.
POST /api/v4/ai/duo_workflows/direct_access - Write
Create a flow
Creates and starts a flow.
POST /api/v4/ai/duo_workflows/workflows - Write
Request Duo Workflows server-side execution connection details
Workhorse pre-authorization endpoint. Returns the connection details Workhorse needs to run the flow itself over gRPC and stream the actions it receives back to the caller, for callers that cannot execute actions of their own. Requests must arrive through Workhorse.
POST /api/v4/ai/duo_workflows/workflows/{workflow_id}/execute - Write
Resume a paused workflow
Resumes execution of a previously paused workflow.
POST /api/v4/ai/duo_workflows/workflows/{workflow_id}/resume - Write
Restart a failed or stopped workflow as a new session
Creates and starts a new session with the flow, goal, noteable, source, privileges and trigger of the given workflow. The original workflow is not modified.
POST /api/v4/ai/duo_workflows/workflows/{workflow_id}/restart - Write
Set the AI-recommended reviewers for a merge request
Replaces the AI-recommended reviewers persisted for a specified merge request. Available only when the recommend reviewers flow is enabled for the project.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/suggested_reviewers - Destructive
Revoke ai_workflows token
Revokes an active Duo Workflows authentication token.
POST /api/v4/ai/duo_workflows/revoke_token - Destructive
Update workflow event
Updates an existing event for a specified workflow.
PUT /api/v4/ai/duo_workflows/workflows/{id}/events/{event_id}
Enterprise users
- Read
List all enterprise users
Lists all enterprise users for a specified top-level group. Use the `page` and `per_page` pagination parameters to filter the results.
GET /api/v4/groups/{id}/enterprise_users - Read
Retrieve an enterprise user
Retrieves a specified enterprise user.
GET /api/v4/groups/{id}/enterprise_users/{user_id} - Write
Update an enterprise user
Updates a specified enterprise user.
PATCH /api/v4/groups/{id}/enterprise_users/{user_id} - Destructive
Delete an enterprise user
Deletes a specified enterprise user.
DELETE /api/v4/groups/{id}/enterprise_users/{user_id} - Destructive
Disable two-factor authentication for an enterprise user
Disables two-factor authentication (2FA) for a specified enterprise user.
PATCH /api/v4/groups/{id}/enterprise_users/{user_id}/disable_two_factor
Dependency management
- Read
Retrieve a single dependency list export
Retrieves a dependency list export.
GET /api/v4/dependency_list_exports/{export_id} - Read
Download dependency list export
Downloads a dependency list export.
GET /api/v4/dependency_list_exports/{export_id}/download - Read
Get vulnerabilities
Returns vulnerabilities related to an occurrence.
GET /api/v4/occurrences/vulnerabilities - Read
List all project dependencies
Lists all dependencies for a specified project. This operation partially mirrors the dependency list feature, which is available only for languages and package managers supported by Gemnasium. Responses are paginated and return 20 results by default.
GET /api/v4/projects/{id}/dependencies - Write
Create a dependency list export
Creates a CycloneDX JSON export for all the project dependencies detected in a pipeline. If an authenticated user does not have the read_dependency permission, this request returns a `403 Forbidden` status code.
POST /api/v4/projects/{id}/dependency_list_exports - Write
Create a dependency list export
Creates a CycloneDX JSON export for all the project dependencies detected in a pipeline. If an authenticated user does not have the read_dependency permission, this request returns a `403 Forbidden` status code.
POST /api/v4/groups/{id}/dependency_list_exports - Write
Create a dependency list export
Creates a CycloneDX JSON export for all the project dependencies detected in a pipeline. If an authenticated user does not have the read_dependency permission, this request returns a `403 Forbidden` status code.
POST /api/v4/pipelines/{id}/dependency_list_exports
Protected branches
- Read
List all protected branches
Lists all protected branches from a group. If a wildcard is set, it is returned instead of the exact name of the branches that match that wildcard.
GET /api/v4/groups/{id}/protected_branches - Read
Retrieve a protected branch
Retrieves a specified protected branch. Retrieve multiple branches by using a wildcard in the `name`.
GET /api/v4/groups/{id}/protected_branches/{name} - Read
List all protected branches
Lists all protected branches for a specified project.
GET /api/v4/projects/{id}/protected_branches - Read
Retrieve a protected branch or wildcard protected branch
Retrieves a specified protected branch or wildcard protected branch.
GET /api/v4/projects/{id}/protected_branches/{name} - Write
Protect a repository branch
Protects a specified repository branch. Protect multiple branches by using a wildcard in the `name`.
POST /api/v4/groups/{id}/protected_branches - Write
Update a protected branch
Updates a protected branch for a specified group.
PATCH /api/v4/groups/{id}/protected_branches/{name} - Write
Protect repository branches
Protects a specified repository branch or several project repository branches using a wildcard protected branch.
POST /api/v4/projects/{id}/protected_branches - Write
Update a protected branch
Updates a protected branch for a specified project.
PATCH /api/v4/projects/{id}/protected_branches/{name} - Destructive
Unprotect repository branches
Unprotects a specified protected branch Unprotect multiple branches by using a wildcard in the `name`.
DELETE /api/v4/groups/{id}/protected_branches/{name} - Destructive
Unprotect repository branches
Unprotects a specified protected branch or wildcard protected branch.
DELETE /api/v4/projects/{id}/protected_branches/{name}
Storage moves
- Read
List all group repository storage moves
Lists all group repository storage moves for an instance.
GET /api/v4/group_repository_storage_moves - Read
Retrieve a group repository storage move
Retrieves a specified group repository storage move. This feature was introduced in GitLab 13.9.
GET /api/v4/group_repository_storage_moves/{repository_storage_move_id} - Read
List all repository storage moves for a group
Lists all repository storage moves for a specified group.
GET /api/v4/groups/{id}/repository_storage_moves - Read
Retrieve a repository storage move for a group
Retrieves a specified repository storage move for a group. This feature was introduced in GitLab 13.9.
GET /api/v4/groups/{id}/repository_storage_moves/{repository_storage_move_id} - Read
List all snippet repository storage moves
Lists all snippet repository storage moves. By default, `GET` requests return 20 results at a time because the API results are paginated.
GET /api/v4/snippet_repository_storage_moves - Read
Retrieve a snippet repository storage move
Retrieves a specified snippet repository storage move.
GET /api/v4/snippet_repository_storage_moves/{repository_storage_move_id} - Read
List all repository storage moves for a snippet
Lists all repository storage moves for a specified snippet. By default, `GET` requests return 20 results at a time because the API results are paginated.
GET /api/v4/snippets/{id}/repository_storage_moves - Read
Retrieve a repository storage move for a snippet
Retrieves a repository storage move for a specified snippet.
GET /api/v4/snippets/{id}/repository_storage_moves/{repository_storage_move_id} - Read
List all project repository storage moves
Lists all project repository storage moves.
GET /api/v4/project_repository_storage_moves - Read
Retrieve a project repository storage move
Retrieves a specified project repository storage move.
GET /api/v4/project_repository_storage_moves/{repository_storage_move_id} - Read
List all repository storage moves for a project
Lists all repository storage moves for a project.
GET /api/v4/projects/{id}/repository_storage_moves - Read
Retrieve a repository storage move for a project
Retrieves a specified repository storage move for a project.
GET /api/v4/projects/{id}/repository_storage_moves/{repository_storage_move_id} - Write
Create group repository storage moves for a storage shard
Creates repository storage moves for all groups on a specified storage shard.
POST /api/v4/group_repository_storage_moves - Write
Create a group repository storage move
Creates a group repository storage move for a specified group. This operation moves only group wiki repositories and does not move repositories for projects in a group.
POST /api/v4/groups/{id}/repository_storage_moves - Write
Schedule repository storage moves for all snippets on a storage shard
Schedules repository storage moves for each snippet repository stored on the source storage shard. This endpoint migrates all snippets at once.
POST /api/v4/snippet_repository_storage_moves - Write
Schedule a repository storage move for a snippet
Schedules a repository storage move for a specified snippet.
POST /api/v4/snippets/{id}/repository_storage_moves - Write
Create repository storage moves for all projects on a storage shard
Creates repository storage moves for each project repository stored on the source storage shard. This endpoint migrates all projects at once.
POST /api/v4/project_repository_storage_moves - Write
Create a repository storage move for a project
Creates a repository storage move for a specified project.
POST /api/v4/projects/{id}/repository_storage_moves
Iterations
- Read
List all project iterations
Lists all iterations for a specified project. Iterations created by **Enable automatic scheduling** in iteration cadences return `null` for the `title` and `description` fields. This feature was introduced in GitLab 13.5.
GET /api/v4/projects/{id}/iterations - Read
List all group iterations
Lists all iterations for a specified group. Iterations created by **Enable automatic scheduling** in iteration cadences return `null` for the `title` and `description` fields. This feature was introduced in GitLab 13.5.
GET /api/v4/groups/{id}/iterations
SAML group links
- Read
Lists SAML group links
Get SAML group links for a group
GET /api/v4/groups/{id}/saml_group_links - Read
Get SAML group link
Get a SAML group link for the group
GET /api/v4/groups/{id}/saml_group_links/{saml_group_name} - Write
Add SAML group link
Add a SAML group link for a group
POST /api/v4/groups/{id}/saml_group_links - Destructive
Delete SAML group link
Deletes a SAML group link for the group
DELETE /api/v4/groups/{id}/saml_group_links/{saml_group_name}
Resource events
- Read
List all issue iteration events
Lists all iteration events for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_iteration_events - Read
Retrieve an issue iteration event
Retrieves an iteration event for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_iteration_events/{event_id} - Read
List all project issue weight events
Lists all weight events for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_weight_events - Read
Retrieve single issue weight event
Retrieves a single weight event for a specified project issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_weight_events/{event_id} - Read
List all project issue state events
Lists all state events for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_state_events - Read
Retrieve an issue state event
Retrieves a state event for a specified project issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_state_events/{event_id} - Read
List all project merge request state events
Lists all state events for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_state_events - Read
Retrieve a merge request state event
Retrieves a state event for a specified project merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_state_events/{event_id} - Read
List all group epic state events
Lists all state events for a specified epic.
GET /api/v4/groups/{id}/epics/{eventable_id}/resource_state_events - Read
Retrieve an epic state event
Retrieves a state event for a specified group epic.
GET /api/v4/groups/{id}/epics/{eventable_id}/resource_state_events/{event_id} - Read
List all project issue label events
Lists all label events for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_label_events - Read
Retrieve an issue label event
Retrieves a label event for a specified project issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_label_events/{event_id} - Read
List all project merge request label events
Lists all label events for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_label_events - Read
Retrieve a merge request label event
Retrieves a label event for a specified project merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_label_events/{event_id} - Read
List all group epic label events
Lists all label events for a specified epic.
GET /api/v4/groups/{id}/epics/{eventable_id}/resource_label_events - Read
Retrieve an epic label event
Retrieves a label event for a specified group epic.
GET /api/v4/groups/{id}/epics/{eventable_id}/resource_label_events/{event_id} - Read
List all project issue milestone events
Lists all milestone events for a specified issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_events - Read
Retrieve an issue milestone event
Retrieves a specified milestone event for a project issue.
GET /api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_events/{event_id} - Read
List all project merge request milestone events
Lists all milestone events for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_events - Read
Retrieve a merge request milestone event
Retrieves a specified milestone event for a project merge request.
GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_events/{event_id}
Protected environments
- Read
List all protected environments for a project
Lists all protected environments for a specified project.
GET /api/v4/projects/{id}/protected_environments - Read
Retrieve a protected environment for a project
Retrieves a specified protected environment for a project.
GET /api/v4/projects/{id}/protected_environments/{name} - Read
List all protected environments for a group
Lists all protected environments for a specified group.
GET /api/v4/groups/{id}/protected_environments - Read
Retrieve a protected environment for a group
Retrieves a specified protected environment for a group.
GET /api/v4/groups/{id}/protected_environments/{name} - Write
Protect an environment for a project
Protects a specified environment for a project.
POST /api/v4/projects/{id}/protected_environments - Write
Protect an environment for a group
Protects a specified environment for a group.
POST /api/v4/groups/{id}/protected_environments - Destructive
Update a protected environment for a project
Updates a specified protected environment for a project.
PUT /api/v4/projects/{id}/protected_environments/{name} - Destructive
Unprotect a protected environment for a project
Unprotects a specified protected environment for a project.
DELETE /api/v4/projects/{id}/protected_environments/{name} - Destructive
Update a protected environment for a group
Updates a specified protected environment for a group.
PUT /api/v4/groups/{id}/protected_environments/{name} - Destructive
Unprotect a group environment
Unprotects a specified protected environment for a group.
DELETE /api/v4/groups/{id}/protected_environments/{name}
Analytics
- Read
List deployment frequencies for the project
Retrieves deployment frequency analytics data for a specific project.
GET /api/v4/projects/{id}/analytics/deployment_frequency - Read
Retrieve count of recently created issues for a group
Retrieves the count of recently created issues for a specified group.
GET /api/v4/analytics/group_activity/issues_count - Read
Retrieve count of recently created merge requests for a group
Retrieves the count of recently created merge requests for a specified group.
GET /api/v4/analytics/group_activity/merge_requests_count - Read
Retrieve count of members recently added to a group
Retrieves the count of members recently added to a specified group.
GET /api/v4/analytics/group_activity/new_members_count
Code review analytics
- Read
List code review information about project
Retrieves code review analytics data for a specific project.
GET /api/v4/analytics/code_review
Project alias
- Read
List all project aliases
Lists all project aliases for the instance.
GET /api/v4/project_aliases - Read
Retrieve a project alias
Retrieves details of a specified project alias.
GET /api/v4/project_aliases/{name} - Write
Create a project alias
Creates a project alias.
POST /api/v4/project_aliases - Destructive
Delete a project alias
Deletes a specified project alias. Administrators only.
DELETE /api/v4/project_aliases/{name}
Merge request approvals
- Read
List all approval rules for a merge request
Lists all approval rules and any associated details for a specified merge request. Use the `page` and `per_page` pagination parameters to restrict the list of approval rules.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_rules - Read
Retrieve an approval rule for a specific merge request
Retrieves information about an approval rule for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_rules/{approval_rule_id} - Read
Retrieve MR approval settings for a project
Retrieves the merge request approval settings for a specified project.
GET /api/v4/projects/{id}/merge_request_approval_setting - Read
Retrieve MR approval settings for a group
Retrieves the merge request approval settings for a specified group.
GET /api/v4/groups/{id}/merge_request_approval_setting - Read
Retrieve approval state for a merge request
Retrieves the approval state for a specified merge request. In the response, `approved_by` contains information about all approvers of the merge request, regardless of whether those approvals satisfy any approval rule.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approvals - Read
Retrieve approval details for a merge request
Retrieves approval details for a specified merge request. If a user has modified the approval rules for the merge request, the response includes `approval_rules_overwritten`.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_state - Write
Create an approval rule for a merge request
Creates an approval rule for a specified merge request. If `approval_project_rule_id` is set with the ID of an existing approval rule from the project, this endpoint copies the values for `name`, `users`, and `groups` from the project rule.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_rules - Write
Change approval-related configuration (deprecated)
Deprecated in 16.0. Use the merge request approvals API instead.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approvals - Write
Approve merge request
Approves a specified merge request. The currently authenticated user must be an eligible approver. The `sha` parameter ensures you are approving the current version of the merge request. If defined, the value must match the merge request’s HEAD commit SHA. A mismatch returns a `409 Conflict` response.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approve - Destructive
Update an approval rule for a merge request
Updates a specified approval rule for a merge request. This endpoint removes any approvers and groups not included in the `group_ids`, `user_ids`, or `usernames` attributes. The `report_approver` or `code_owner` rules are system-generated, and you cannot edit them.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_rules/{approval_rule_id} - Destructive
Delete an approval rule for a merge request
Deletes a specified approval rule for a merge request. The `report_approver` or `code_owner` rules are system-generated, and you cannot edit them.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/approval_rules/{approval_rule_id} - Destructive
Update MR approval settings for a project
Updates the merge request approval settings for a specified project.
PUT /api/v4/projects/{id}/merge_request_approval_setting - Destructive
Update MR approval settings for a group
Updates the merge request approval settings for a specified group.
PUT /api/v4/groups/{id}/merge_request_approval_setting - Destructive
Unapprove a merge request
Unapproves a merge request. Removes the approval for the currently authenticated user from a specified merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/unapprove - Destructive
Reset approvals for a merge request
Resets all approvals for a specified merge request. Available only to bot users with a valid project or group token. Human users receive a `401 Unauthorized` response.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_approvals
Vulnerabilities
- Read
Retrieve a vulnerability export
Retrieves a specified vulnerability export.
GET /api/v4/security/vulnerability_exports/{id} - Read
Download a vulnerability export
Downloads a specified vulnerability export.
GET /api/v4/security/vulnerability_exports/{id}/download - Read
Retrieve a vulnerability archive export
Retrieves the attributes for a specified vulnerability archive export. You can use this endpoint to poll the export status until it is `finished`. Clients should use the `Poll-Interval` response header to determine how long to wait before sending the next poll. The `Poll-Interval` represents the time in milliseconds.
GET /api/v4/security/vulnerability_archive_exports/{id} - Read
Download a vulnerability archive export
Downloads a vulnerability archive export.
GET /api/v4/security/vulnerability_archive_exports/{id}/download - Read
Get related issues for a vulnerability
Lists related issues for a vulnerability.
GET /api/v4/vulnerabilities/{id}/issue_links - Read
List all project vulnerability findings
Lists all vulnerability findings for a specified project. Responses are paginated and return 20 results by default.
GET /api/v4/projects/{id}/vulnerability_findings - Read
Retrieve a vulnerability
Retrieves a specified vulnerability.
GET /api/v4/vulnerabilities/{id} - Read
List all project vulnerabilities
Lists all vulnerabilities for a specified project.
GET /api/v4/projects/{id}/vulnerabilities - Write
Create a project-level vulnerability export
Creates a vulnerability export for a project. Returns status code `403` if the authenticated user does not have permission to create a vulnerability.
POST /api/v4/security/projects/{id}/vulnerability_exports - Write
Create a group-level vulnerability export
Creates a vulnerability export for a group. Returns status code `403` if the authenticated user does not have permission to create a vulnerability.
POST /api/v4/security/groups/{id}/vulnerability_exports - Write
Create an instance-level vulnerability export
Creates a vulnerability export for the projects of the user selected in the Security Dashboard. The created vulnerability export is automatically deleted at the time specified in the `expires_at` field.
POST /api/v4/security/vulnerability_exports - Write
Create an export for archived vulnerabilities
Creates an export for archived vulnerabilities in a specified project. If an authenticated user does not have permission to read vulnerabilities, returns a `403 Forbidden` status code.
POST /api/v4/security/projects/{id}/vulnerability_archive_exports - Write
Relate an issue to a vulnerability
Relates an issue to a vulnerability.
POST /api/v4/vulnerabilities/{id}/issue_links - Write
Update AI False Positive Detection results
Updates the confidence score and explanation for AI-based False Positive Detection flows.
POST /api/v4/vulnerabilities/{vulnerability_id}/flags/ai_detection - Write
Resolve a vulnerability
Resolves a specified vulnerability. Returns status code `304` if the vulnerability is already resolved. Returns status code `403` if the authenticated user does not have permission to change the vulnerability status.
POST /api/v4/vulnerabilities/{id}/resolve - Write
Dismiss a vulnerability
Dismisses a specified vulnerability. Returns status code `304` if the vulnerability is already dismissed. Returns status code `403` if the authenticated user does not have permission to change the vulnerability status.
POST /api/v4/vulnerabilities/{id}/dismiss - Write
Confirm a vulnerability
Confirms a specified vulnerability, marking it as genuine and requiring action. Returns status code `304` if the vulnerability is already confirmed. Returns status code `403` if the authenticated user does not have permission to change the vulnerability status.
POST /api/v4/vulnerabilities/{id}/confirm - Write
Create a new vulnerability
Creates a new vulnerability from a confirmed finding.
POST /api/v4/projects/{id}/vulnerabilities - Destructive
Delete a link between an issue and a vulnerability
Deletes a link between an issue and a vulnerability.
DELETE /api/v4/vulnerabilities/{id}/issue_links/{issue_link_id} - Destructive
Revert a vulnerability to detected state
Reverts a specified vulnerability to detected state. Returns status code `304` if the vulnerability is already in detected state. Returns status code `403` if the authenticated user does not have permission to change vulnerability status.
POST /api/v4/vulnerabilities/{id}/revert
Project Google Cloud integration
- Read
Retrieve setup script for Google Cloud integration
Retrieves the setup script for Google Cloud integration.
GET /api/v4/projects/{id}/google_cloud/setup/integrations.sh - Read
Retrieve configuration script for Google Cloud runner provisioning
Retrieves the configuration script for Google Cloud runner provisioning.
GET /api/v4/projects/{id}/google_cloud/setup/runner_deployment_project.sh
Project approvals
- Read
Retrieve approval configuration for a project
Retrieves the approval configuration for a project.
GET /api/v4/projects/{id}/approvals - Write
Create or update approval configuration for a project
Creates or updates the approval configuration for a project. The currently authenticated user must be an eligible approver.
POST /api/v4/projects/{id}/approvals
Licenses
- Read
List all software license policies
Lists all software license policies for a specified project.
GET /api/v4/projects/{id}/managed_licenses - Read
Retrieve a software license policy
Retrieves a specified software license policy from a project.
GET /api/v4/projects/{id}/managed_licenses/{managed_license_id} - Read
Retrieve license information
Retrieves information about the current license.
GET /api/v4/license - Read
Download license usage data
Downloads usage data for the currently active license.
GET /api/v4/license/usage_export - Read
Retrieve a license
Retrieves information about a specified license.
GET /api/v4/license/{id} - Read
List all licenses
Lists all information about all licenses.
GET /api/v4/licenses - Write
Create a software license policy
Creates a software license policy for a specified project.
POST /api/v4/projects/{id}/managed_licenses - Write
Update a software license policy
Updates a specified software license policy for a project.
PATCH /api/v4/projects/{id}/managed_licenses/{managed_license_id} - Write
Create a license
Creates a license.
POST /api/v4/license - Destructive
Delete a software license policy
Deletes a specified software license policy from a project.
DELETE /api/v4/projects/{id}/managed_licenses/{managed_license_id} - Destructive
Delete a license
Deletes a specified license.
DELETE /api/v4/license/{id} - Destructive
Trigger recalculation of billable users
Triggers recalculation of billable users for a specified license.
PUT /api/v4/license/{id}/refresh_billable_users
Group credentials inventory
- Read
List all personal access tokens for a group
Lists all personal access tokens associated with enterprise users in a top-level group. This feature was introduced in GitLab 17.8.
GET /api/v4/groups/{id}/manage/personal_access_tokens - Read
List all group and project access tokens for a group
Lists all group and project access tokens associated with a top-level-group. This feature was introduced in GitLab 17.10.
GET /api/v4/groups/{id}/manage/resource_access_tokens - Read
List all SSH keys for a group
Lists all SSH public keys associated with enterprise users in a top-level-group. This feature was introduced in GitLab 17.9.
GET /api/v4/groups/{id}/manage/ssh_keys - Destructive
Revoke a personal access token for an enterprise user
Revokes a specified personal access token for an enterprise user.
DELETE /api/v4/groups/{id}/manage/personal_access_tokens/{pat_id} - Destructive
Rotate a personal access token for an enterprise user
Rotates a specified personal access token for an enterprise user associated with the top-level group. This revokes the previous token and creates a token that expires after one week.
POST /api/v4/groups/{id}/manage/personal_access_tokens/{pat_id}/rotate - Destructive
Revoke a group or project access token for a group
Revokes a specified group or project access token associated with a top-level group.
DELETE /api/v4/groups/{id}/manage/resource_access_tokens/{prat_id} - Destructive
Rotate a group or project access token for a group
Rotates a specified group or project access token associated with a top-level group. This revokes the previous token and creates a new token.
POST /api/v4/groups/{id}/manage/resource_access_tokens/{prat_id}/rotate - Destructive
Delete an SSH key for an enterprise user
Deletes a specified SSH public key for an enterprise user associated with the top-level group.
DELETE /api/v4/groups/{id}/manage/ssh_keys/{key_id}
Merge requests
- Read
List all dependencies for a merge request
List all merge request dependencies for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/blocks - Read
Retrieve a merge request dependency
Retrieves a specified merge request dependency.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/blocks/{block_id} - Read
Retrieve blocked merge requests
Retrieves merge requests blocked by a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/blockees - Read
Retrieve merge request diff versions
Retrieves merge request diff versions.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/versions - Read
Retrieve a merge request diff version
Retrieves a merge request diff version.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/versions/{version_id} - Read
List all merge requests
Lists all merge requests accessible to the authenticated user. By default, returns only merge requests created by the current user. Use `scope=all` to get all merge requests.
GET /api/v4/merge_requests - Read
List all group merge requests
Lists all merge requests for a specified group and any subgroups.
GET /api/v4/groups/{id}/merge_requests - Read
Retrieve time tracking stats for a merge request
Retrieves time tracking stats for a specified merge request, including time estimate and time spent in seconds and human-readable format (for example, `1h 30m`).
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_stats - Read
List all project merge requests
Lists all project merge requests.
GET /api/v4/projects/{id}/merge_requests - Read
Retrieve a merge request
Retrieves a merge request for a specified project.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid} - Read
Retrieve merge request participants
Retrieves participants for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/participants - Read
Retrieve merge request reviewers
Retrieves reviewers for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reviewers - Read
Retrieve merge request commits
Retrieves commits for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/commits - Read
List all context commits for a merge request
Lists all context commits for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits - Read
Retrieve merge request changes
Retrieves changes for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/changes - Read
List all merge request diffs
Lists all merge request diffs.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/diffs - Read
Retrieve merge request raw diffs
Retrieves the raw diffs of the files changed in a merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/raw_diffs - Read
List all merge request pipelines
Lists all merge request pipelines.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelines - Read
Merge to default merge ref path
Merges the changes between the merge request source and target branches into the `refs/merge-requests/:iid/merge` ref, of the target project repository, if possible. This ref has the state the target branch would have if a regular merge action was taken.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/merge_ref - Read
List all issues that close on merge
Lists all issues that close on merge.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/closes_issues - Read
List all issues related to the merge request
Lists all issues related to the merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/related_issues - Write
Create a merge request dependency
Creates a merge request dependency between two merge requests. The merge request is blocked until the dependency merges.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/blocks - Write
Set the estimated time for a merge request
Sets an estimated time of work for a specified merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_estimate - Write
Add spent time for a merge request
Adds spent time for a specified merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/add_spent_time - Write
Create a merge request
Creates a merge request for a project.
POST /api/v4/projects/{id}/merge_requests - Write
Create context commits for a merge request
Creates context commits for a specified merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits - Write
Create a merge request pipeline
Creates a merge request pipeline. Pipelines created with this operation must configure `.gitlab-ci.yml` with `only: [merge_requests]` to create jobs.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelines - Destructive
Remove a merge request dependency
Removes a merge request dependency.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/blocks/{block_id} - Destructive
Reset the estimated time for a merge request
Resets the estimated time for a specified merge request to `0` seconds.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_time_estimate - Destructive
Reset spent time for a merge request
Resets the total spent time for a specified merge request to `0` seconds.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_spent_time - Destructive
Delete a merge request
Deletes a specified merge request for a project. Administrators and project Owners only.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid} - Destructive
Update a merge request
Updates a merge request for a specified project.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid} - Destructive
Delete context commits from a merge request
Deletes specified context commits from a merge request.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits - Destructive
Merge a merge request
Merges a merge request. Accepts and merges changes submitted with the merge request.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/merge - Destructive
Cancel merge when pipeline succeeds (deprecated)
Cancels an automatic merge for a merge request that has been set to merge when the pipeline succeeds. This endpoint does not return the merge request. Deprecated in GitLab 19.5. Use POST /projects/:id/merge_requests/:merge_request_iid/cancel_auto_merge instead.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/cancel_merge_when_pipeline_succeeds - Destructive
Cancel auto merge
Cancels an automatic merge for a merge request that has been set to merge automatically. Use this endpoint instead of `cancel_merge_when_pipeline_succeeds`, which returns a status hash rather than the merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/cancel_auto_merge - Destructive
Rebase a merge request
Rebases a merge request. Automatically rebases the `source_branch` of the merge request against its `target_branch`.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/rebase
Hooks
- Read
List all group hooks
Lists all group hooks.
GET /api/v4/groups/{id}/hooks - Read
Retrieve a group hook
Retrieves a specified group hook.
GET /api/v4/groups/{id}/hooks/{hook_id} - Read
List all events
Lists all events for a specified webhook.
GET /api/v4/groups/{id}/hooks/{hook_id}/events - Read
List all system hooks
Lists all system hooks for the instance.
GET /api/v4/hooks - Read
Retrieve a system hook
Retrieves a specified system hook.
GET /api/v4/hooks/{hook_id} - Read
List all webhooks for a project
Lists all webhooks for a specified project.
GET /api/v4/projects/{id}/hooks - Read
Retrieve a project webhook
Retrieves a specified webhook for a project.
GET /api/v4/projects/{id}/hooks/{hook_id} - Read
List all events
Lists all events for a specified webhook.
GET /api/v4/projects/{id}/hooks/{hook_id}/events - Write
Create a group hook
Creates a hook for a specified group. This endpoint has a rate limit of 10 requests per minute for each authenticated user for a given group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/groups/{id}/hooks - Write
Trigger a test webhook
Triggers a test webhook. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project or group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/groups/{id}/hooks/{hook_id}/test/{trigger} - Write
Resend a webhook event
Resends a webhook event. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project or group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/groups/{id}/hooks/{hook_id}/events/{hook_log_id}/resend - Write
Create a system hook
Creates a system hook. This endpoint has a rate limit of five requests per minute for each authenticated user. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/hooks - Write
Create a test run
Creates a test run for a webhook. Executes the webhook with mock data.
POST /api/v4/hooks/{hook_id} - Write
Add a webhook to a project
Adds a webhook to a specified project. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/projects/{id}/hooks - Write
Trigger a test webhook
Triggers a test webhook. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project or group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/projects/{id}/hooks/{hook_id}/test/{trigger} - Write
Resend a webhook event
Resends a webhook event. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project or group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.
POST /api/v4/projects/{id}/hooks/{hook_id}/events/{hook_log_id}/resend - Destructive
Update a group hook
Updates a hook for a specified group.
PUT /api/v4/groups/{id}/hooks/{hook_id} - Destructive
Delete a group hook
Deletes a hook from a group. This is an idempotent method and can be called multiple times. Either the hook is available or not.
DELETE /api/v4/groups/{id}/hooks/{hook_id} - Destructive
Update a URL variable
Updates a URL variable for a specified webhook.
PUT /api/v4/groups/{id}/hooks/{hook_id}/url_variables/{key} - Destructive
Delete a URL variable
Deletes a URL variable from a specified webhook.
DELETE /api/v4/groups/{id}/hooks/{hook_id}/url_variables/{key} - Destructive
Update a custom header
Updates a custom header for a specified webhook.
PUT /api/v4/groups/{id}/hooks/{hook_id}/custom_headers/{key} - Destructive
Delete a custom header
Deletes a custom header from a specified webhook.
DELETE /api/v4/groups/{id}/hooks/{hook_id}/custom_headers/{key} - Destructive
Update a URL variable
Updates a URL variable for a specified webhook.
PUT /api/v4/hooks/{hook_id}/url_variables/{key} - Destructive
Delete a URL variable
Deletes a URL variable from a specified webhook.
DELETE /api/v4/hooks/{hook_id}/url_variables/{key} - Destructive
Update a custom header
Updates a custom header for a specified webhook.
PUT /api/v4/hooks/{hook_id}/custom_headers/{key} - Destructive
Delete a custom header
Deletes a custom header from a specified webhook.
DELETE /api/v4/hooks/{hook_id}/custom_headers/{key} - Destructive
Update a system hook
Updates a specified system hook.
PUT /api/v4/hooks/{hook_id} - Destructive
Delete a system hook
Deletes a specified system hook. Administrators only.
DELETE /api/v4/hooks/{hook_id} - Destructive
Update a URL variable
Updates a URL variable for a specified webhook.
PUT /api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key} - Destructive
Delete a URL variable
Deletes a URL variable from a specified webhook.
DELETE /api/v4/projects/{id}/hooks/{hook_id}/url_variables/{key} - Destructive
Update a custom header
Updates a custom header for a specified webhook.
PUT /api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key} - Destructive
Delete a custom header
Deletes a custom header from a specified webhook.
DELETE /api/v4/projects/{id}/hooks/{hook_id}/custom_headers/{key} - Destructive
Update a project webhook
Updates a specified webhook for a project.
PUT /api/v4/projects/{id}/hooks/{hook_id} - Destructive
Delete a project webhook
Deletes a specified webhook for a project.
DELETE /api/v4/projects/{id}/hooks/{hook_id}
Provider identities
- Read
Retrieve SAML identities for a group
Retrieves SAML identities for a group.
GET /api/v4/groups/{id}/saml/identities - Read
Retrieve a SAML identity
Retrieves a specified SAML identity.
GET /api/v4/groups/{id}/saml/{uid} - Read
Retrieve SCIM identities for a group
Retrieves SCIM identities for a group.
GET /api/v4/groups/{id}/scim/identities - Read
Retrieve a SCIM identity
Retrieves a specified SCIM identity.
GET /api/v4/groups/{id}/scim/{uid} - Write
Update `extern_uid` field for a SAML identity
Updates the `extern_uid` field for a specified SAML identity.
PATCH /api/v4/groups/{id}/saml/{uid} - Write
Update `extern_uid` field for a SCIM identity
Updates the `extern_uid` field for a specified SCIM identity.
PATCH /api/v4/groups/{id}/scim/{uid} - Destructive
Delete a SAML identity
Deletes a specified SAML identity.
DELETE /api/v4/groups/{id}/saml/{uid} - Destructive
Delete a SCIM identity
Deletes a specified SCIM identity.
DELETE /api/v4/groups/{id}/scim/{uid}
Member roles
- Read
List all group member roles
Lists all member roles in a specified group.
GET /api/v4/groups/{id}/member_roles - Read
List all instance member roles
Lists all member roles for this GitLab instance.
GET /api/v4/member_roles - Read
Get Admin Roles for this GitLab instance
Retrieves all custom admin roles configured for the instance.
GET /api/v4/admin_member_roles - Write
Add a member role to a group
Adds a member role to a group. You can only add member roles at the root level of the group.
POST /api/v4/groups/{id}/member_roles - Write
Create an instance member role
Creates an instance member role.
POST /api/v4/member_roles - Write
Create Admin Role on the GitLab instance
Creates a new custom admin role with specified permissions.
POST /api/v4/admin_member_roles - Destructive
Remove member role of a group
Removes a specified member role from a group.
DELETE /api/v4/groups/{id}/member_roles/{member_role_id} - Destructive
Delete an instance member role
Deletes an instance member role.
DELETE /api/v4/member_roles/{member_role_id} - Destructive
Delete Admin Role
Deletes a specific custom admin role by its ID.
DELETE /api/v4/admin_member_roles/{member_role_id}
Merge trains
- Read
List all merge trains for a project
Lists all merge trains for a specified project.
GET /api/v4/projects/{id}/merge_trains - Read
List all merge requests in a merge train
Lists all merge requests in a merge train for a target branch.
GET /api/v4/projects/{id}/merge_trains/{target_branch} - Read
Retrieve merge train status
Retrieves the merge train status of a specified merge request.
GET /api/v4/projects/{id}/merge_trains/merge_requests/{merge_request_iid} - Write
Add a merge request to a merge train
Adds a specified merge request to a merge train.
POST /api/v4/projects/{id}/merge_trains/merge_requests/{merge_request_iid}
Push rules
- Read
Retrieve the push rules of a group
Retrieves the push rules of a specified group.
GET /api/v4/groups/{id}/push_rule - Read
Retrieve the push rules of a project
Retrieves the push rules of a specified project.
GET /api/v4/projects/{id}/push_rule - Write
Add push rules to a group
Adds push rules to a specified group. Use only if you have not defined any push rules so far.
POST /api/v4/groups/{id}/push_rule - Write
Add push rules to a project
Adds push rules to a specified project.
POST /api/v4/projects/{id}/push_rule - Destructive
Update push rules of a group
Updates the push rules for a specified group.
PUT /api/v4/groups/{id}/push_rule - Destructive
Delete the push rules of a group
Deletes all the push rules of a specified group.
DELETE /api/v4/groups/{id}/push_rule - Destructive
Update push rules of a project
Updates the push rules for a specified project.
PUT /api/v4/projects/{id}/push_rule - Destructive
Delete the push rules of a project
Deletes all the push rules of a specified project.
DELETE /api/v4/projects/{id}/push_rule
Workspaces
- Read
Gets agentw info
Retrieves agent info for agentw for the given workspace token
GET /api/v4/internal/agents/agentw/agent_info - Read
authorize_user_access
Returns whether the user is authorized to access the workspace.
GET /api/v4/internal/agents/agentw/authorize_user_access
OAuth applications
- Read
server_config
Returns configuration for Workspaces HTTP Server.
GET /api/v4/internal/agents/agentw/server_config
Project mirrors
- Read
Retrieve project pull mirror details
Retrieves pull mirror details for a specified project.
GET /api/v4/projects/{id}/mirror/pull - Write
Start the pull mirroring process for a project
Starts the pull mirroring process for a specified project.
POST /api/v4/projects/{id}/mirror/pull - Destructive
Update project pull mirroring settings
Updates pull mirroring settings for a specified project. This feature was introduced in GitLab 17.5.
PUT /api/v4/projects/{id}/mirror/pull
LDAP
- Read
List all LDAP group links
Lists all LDAP group links.
GET /api/v4/groups/{id}/ldap_group_links - Read
List all LDAP groups
Lists all LDAP groups on the GitLab instance. Limited to 20 results.
GET /api/v4/ldap/groups - Read
List all LDAP groups by provider
Lists all LDAP groups for the specified provider. Limited to 20 results.
GET /api/v4/ldap/{provider}/groups - Write
Add an LDAP group link with CN or filter
Adds an LDAP group link using a CN or filter.
POST /api/v4/groups/{id}/ldap_group_links - Write
Sync a group with LDAP
Syncs a specified group with its linked LDAP group. You must be an administrator or have the Owner role for the group.
POST /api/v4/groups/{id}/ldap_sync - Destructive
Delete an LDAP group link with CN or filter
Deletes an LDAP group link using a CN or filter.
DELETE /api/v4/groups/{id}/ldap_group_links - Destructive
Delete LDAP group link
Deletes an LDAP group link. Deprecated. Scheduled for removal in a future release.
DELETE /api/v4/groups/{id}/ldap_group_links/{cn} - Destructive
Delete LDAP group link
Deletes an LDAP group link for a specific LDAP provider.Deprecated. Scheduled for removal in a future release.
DELETE /api/v4/groups/{id}/ldap_group_links/{provider}/{cn}
Geo
- Read
List all Geo sites
Lists all Geo sites for the instance.
GET /api/v4/geo_sites - Read
List all Geo site statuses
Lists all Geo site statuses.
GET /api/v4/geo_sites/status - Read
Retrieve a Geo site
Retrieves a specified Geo site.
GET /api/v4/geo_sites/{id} - Read
Retrieve a Geo site status
Retrieves the status for a specified Geo site.
GET /api/v4/geo_sites/{id}/status - Read
List all Geo nodes
Lists all Geo nodes for the instance.
GET /api/v4/geo_nodes - Read
List all Geo node statuses
Lists all Geo node statuses.
GET /api/v4/geo_nodes/status - Read
Retrieve a single Geo node
Retrieves a single Geo Node.
GET /api/v4/geo_nodes/{id} - Read
Retrieve metrics for a Geo node
Retrieves metrics for a specified Geo node.
GET /api/v4/geo_nodes/{id}/status - Read
Returns a Geo proxy response
Determines if the current Geo site should proxy requests.
GET /api/v4/geo/proxy - Read
Retrieve a replicable file
Retrieves a replicable file for a Geo secondary site. Serves the file through a CDN or sendfile.
GET /api/v4/geo/retrieve/{replicable_name}/{replicable_id} - Read
List all pipeline refs for a project
Lists all pipeline refs for a project. Secondary runners use them to check the site is up to date.
GET /api/v4/geo/repositories/{gl_repository}/pipeline_refs - Write
Create a Geo site
Creates a Geo site.
POST /api/v4/geo_sites - Write
Repair a Geo site
Repairs the OAuth authentication of a Geo site if there is an OAuth synchronization problem between the primary or secondary Geo sites.
POST /api/v4/geo_sites/{id}/repair - Write
Create a Geo node
Creates a Geo node.
POST /api/v4/geo_nodes - Write
Repair authentication of the Geo node
Repairs the OAuth authentication of a primary Geo node.
POST /api/v4/geo_nodes/{id}/repair - Write
Create a status for a secondary site
Creates a status for a secondary Geo site on the primary site, including replication metrics.
POST /api/v4/geo/status - Write
Create a report of persistent verification failures
Creates a report on the primary site of resources that persistently fail verification on a secondary site.
POST /api/v4/geo/failures - Write
Proxy a git-upload-pack info/refs request to the primary site
Proxies a git-upload-pack info/refs request from a secondary site to the primary site.
POST /api/v4/geo/proxy_git_ssh/info_refs_upload_pack - Write
Proxy a git-upload-pack request to the primary site
Proxies a git-upload-pack request from a secondary site to the primary site.
POST /api/v4/geo/proxy_git_ssh/upload_pack - Write
Proxy a git-receive-pack info/refs request to the primary site
Proxies a git-receive-pack info/refs request from a secondary site to the primary site.
POST /api/v4/geo/proxy_git_ssh/info_refs_receive_pack - Write
Proxy a git-receive-pack request to the primary site
Proxies a git-receive-pack request from a secondary site to the primary site.
POST /api/v4/geo/proxy_git_ssh/receive_pack - Write
Query the GraphQL endpoint of an existing Geo site
Queries the GraphQL endpoint of an existing Geo site.
POST /api/v4/geo/node_proxy/{id}/graphql - Destructive
Update a Geo site
Updates a specified Geo site.
PUT /api/v4/geo_sites/{id} - Destructive
Delete a Geo site
Deletes a specified Geo site.
DELETE /api/v4/geo_sites/{id} - Destructive
Update a Geo node
Updates a specified Geo node.
PUT /api/v4/geo_nodes/{id} - Destructive
Delete a Geo node
Deletes a specified Geo node.
DELETE /api/v4/geo_nodes/{id}
Experiments
- Read
List all experiments
Lists all experiments on the GitLab instance. Each experiment has an `enabled` status that indicates whether the experiment is enabled globally, or only in specific contexts.
GET /api/v4/experiments - Read
Get current variant assignment for an experiment context
Returns the currently cached variant assignment for the given experiment and context. Defaults to current user if no context is provided.
GET /api/v4/experiments/{experiment_name}/assignments - Write
Force a variant assignment for an experiment context
Forces a specific variant assignment for the given experiment and context. The assignment is stored in Redis cache and will persist until overwritten. Defaults to current user if no context is provided.
POST /api/v4/experiments/{experiment_name}/assignments - Destructive
Delete cached assignments for an experiment
Removes all cached variant assignments for the experiment with the given cache key. Useful for cleaning up completed experiments whose code has been removed from the codebase.
DELETE /api/v4/experiments/{name}/cache - Destructive
Clear a variant assignment for an experiment context
Removes the cached variant assignment for the given experiment and context, returning the actor to normal rollout assignment. Defaults to current user if no context is provided.
DELETE /api/v4/experiments/{experiment_name}/assignments
Advanced search rollout
- Destructive
Rollout namespaces to be indexed up to n%
This feature was introduced in GitLab 12.7. **DEPRECATED**: This endpoint is deprecated and for GitLab.com use only. This will only ever increase the number of indexed namespaces. Providing a value lower than the current rolled out percentage will have no effect. This percentage is never persisted but is used to calculate the number of new namespaces to rollout. If the same percentage is applied again at a later time, due to possible new namespaces being created during the period, some of them will also be indexed. Therefore you may expect that setting this to 10%, then waiting a month and setting to 10% again will trigger new namespaces to be added (i.e. 10% of the number of newly created namespaces in the last month within the given plan).
PUT /api/v4/elasticsearch_indexed_namespaces/rollout - Destructive
Rollback namespaces to be indexed down to n%
This feature was introduced in GitLab 12.7. **DEPRECATED**: This endpoint is deprecated and for GitLab.com use only. This will only ever decrease the number of indexed namespaces. Providing a value higher than the current rolled out percentage will have no effect. This percentage is never persisted but is used to calculate the number of namespaces to rollback.
PUT /api/v4/elasticsearch_indexed_namespaces/rollback
Epics
- Read
List all related epic links for a group
Lists all related epic links for a specified group and its subgroups. The user needs to have access to both the `source_epic` and `target_epic` to view the related epic link.
GET /api/v4/groups/{id}/related_epic_links - Read
List all linked epics for an epic
Lists all linked epics for a specified epic.
GET /api/v4/groups/{id}/epics/{epic_iid}/related_epics - Read
List all epic boards in a group
Lists all epic boards for a specified group. This feature was introduced in GitLab 15.9.
GET /api/v4/groups/{id}/epic_boards - Read
Retrieve a group epic board
Retrieves a specified group epic board. This feature was introduced in GitLab 15.9.
GET /api/v4/groups/{id}/epic_boards/{board_id} - Read
List all group epic board lists
Lists all group epic board lists for a specified board. Does not include `open` and `closed` lists. This feature was introduced in GitLab 15.9.
GET /api/v4/groups/{id}/epic_boards/{board_id}/lists - Read
Retrieve a group epic board list
Retrieves a specified group epic board list. This feature was introduced in GitLab 15.9.
GET /api/v4/groups/{id}/epic_boards/{board_id}/lists/{list_id} - Read
List all group epics
Lists all epics for a specified group and its subgroups. Responses are paginated and return 20 results by default.
GET /api/v4/groups/{id}/epics - Read
List all group epics
Lists all epics for a specified group and its subgroups. Responses are paginated and return 20 results by default.
GET /api/v4/groups/{id}/-/epics - Read
Get details of an epic
Gets a single epic
GET /api/v4/groups/{id}/epics/{epic_iid} - Read
Get details of an epic
Gets a single epic
GET /api/v4/groups/{id}/-/epics/{epic_iid} - Read
Get related epics
Lists all child epics of an epic.
GET /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics - Read
List all issues for an epic
Lists all issues assigned to a specified epic that are available to the authenticated user. Responses are paginated and return 20 results by default.
GET /api/v4/groups/{id}/epics/{epic_iid}/issues - Read
List all issues for an epic
Lists all issues assigned to a specified epic that are available to the authenticated user. Responses are paginated and return 20 results by default.
GET /api/v4/groups/{id}/-/epics/{epic_iid}/issues - Write
Create a related epic link
Creates a two-way relation between two epics. The user must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for both groups.
POST /api/v4/groups/{id}/epics/{epic_iid}/related_epics - Write
Create a new epic
Creates a new epic
POST /api/v4/groups/{id}/(-/)epics - Write
Create and relate epic to a parent
Creates a new epic and associates it with the provided parent epic.
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics - Write
Relate epics
Creates an association between two epics, designating one as the parent epic and the other as the child epic.
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} - Write
Add an issue to an epic
Adds a specified issue to an epic. If the issue already belongs to another epic, it is removed from the original epic.
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id} - Write
Create a to-do item for an epic
Creates a to-do item for the current user on a specified epic. If a to-do item already exists for the user on that epic, status code 304 is returned.
POST /api/v4/groups/{id}/epics/{epic_iid}/todo - Destructive
Delete a related epic link
Deletes a two-way relation between two specified epics. The user must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for both groups.
DELETE /api/v4/groups/{id}/epics/{epic_iid}/related_epics/{related_epic_link_id} - Destructive
Update an epic
Updates an epic
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid} - Destructive
Destroy an epic
Deletes an epic
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid} - Destructive
Remove epics relation
Unassigns a child epic from a parent epic.
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} - Destructive
Reorder child epics
Reorders a child epic.
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} - Destructive
Update a related epic link
Updates the relation of a specified issue to an epic.
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id} - Destructive
Remove an issue from the epic
Removes an issue from the epic. Does not delete the issue.
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id}
Dependency proxy
- Read
Proxy the download of a NPM package tarball
This feature was introduced in 16.11
GET /api/v4/projects/{id}/dependency_proxy/packages/npm/{package_name}/-/{file_name} - Read
Proxy the download of a maven package file at a project level
This feature was introduced in GitLab 16.2
GET /api/v4/projects/{id}/dependency_proxy/packages/maven/{path}/{file_name} - Destructive
Purge the dependency proxy for a group
Purges the dependency proxy for a specified group and schedules the cached manifests and blobs for deletion. This endpoint requires the Owner role for the group.
DELETE /api/v4/groups/{id}/dependency_proxy/cache
DORA metrics
- Read
Retrieve project-level DORA metrics
Retrieves DORA metrics for a specified project.
GET /api/v4/projects/{id}/dora/metrics - Read
Retrieve group-level DORA metrics
Retrieves DORA metrics for a specified group.
GET /api/v4/groups/{id}/dora/metrics
Approval rules
- Read
Get all project approval rules
Private API subject to change
GET /api/v4/projects/{id}/approval_settings - Read
List all approval rules for a group
Lists all approval rules and any associated details for a specified group. Restricted to group administrators. Use the `page` and `per_page` pagination parameters to restrict the list of approval rules.
GET /api/v4/groups/{id}/approval_rules - Read
List all approval rules for a project
Lists all approval rules and any associated details for a specified project. To restrict the list of approval rules, use the `page` and `per_page` pagination parameters.
GET /api/v4/projects/{id}/approval_rules - Read
Retrieve an approval rule for a project
Retrieves information about a specified approval rule for a project.
GET /api/v4/projects/{id}/approval_rules/{approval_rule_id} - Write
Create new approval rule
Private API subject to change
POST /api/v4/projects/{id}/approval_settings/rules - Write
Create an approval rule for a group
Creates an approval rule for a group. Restricted to group administrators. Do not use the `rule_type` field when building approval rules from the API. The field supports these rule types: - `any_approver`: A pre-configured default rule with `approvals_required` set to `0`.
POST /api/v4/groups/{id}/approval_rules - Write
Create an approval rule for a project
Creates an approval rule for a specified project.
POST /api/v4/projects/{id}/approval_rules - Destructive
Update approval rule
Private API subject to change
PUT /api/v4/projects/{id}/approval_settings/rules/{approval_rule_id} - Destructive
Delete an approval rule
Private API subject to change
DELETE /api/v4/projects/{id}/approval_settings/rules/{approval_rule_id} - Destructive
Update group approval rule
Updates an approval rule for a group.
PUT /api/v4/groups/{id}/approval_rules/{approval_rule_id} - Destructive
Update an approval rule for a project
Updates a specified approval rule for a project. This endpoint removes any approvers and groups not defined in the `group_ids`, `user_ids`, or `usernames` attributes. Hidden groups (private groups the user does not have permission to view) that are not in the `users` or `groups` parameters are preserved by default. To remove them, set `remove_hidden_groups` to `true`. This ensures hidden groups are not removed unintentionally when a user updates an approval rule.
PUT /api/v4/projects/{id}/approval_rules/{approval_rule_id} - Destructive
Delete an approval rule for a project
Deletes an approval rule for a specified project.
DELETE /api/v4/projects/{id}/approval_rules/{approval_rule_id}
External status checks
- Read
Retrieve project external status check services
Retrieves information on external status check services for a project.
GET /api/v4/projects/{id}/external_status_checks - Read
List all status checks for a merge request
Lists all external status check services for a specified merge request and their status.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_checks - Write
Create external status check service
Creates an external status check service for a specified project.
POST /api/v4/projects/{id}/external_status_checks - Write
Update status of an external status check
Updates the status of an external status check for a specified merge request, informing GitLab that a merge request has passed a check by an external service. To set the status of an external check, the personal access token used must belong to a user with the Developer, Maintainer, or Owner role on the target project of the merge request. Any user with permission to approve the merge request can use this operation.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_check_responses - Write
Retry failed status check for a merge request
Retries a specified failed external status check for a merge request. Even though the merge request has not changed, this endpoint resends the current state of merge request to the defined external service.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/status_checks/{external_status_check_id}/retry - Destructive
Update external status check service
Updates an existing external status check for a project.
PUT /api/v4/projects/{id}/external_status_checks/{check_id} - Destructive
Delete external status check service
Deletes a specified external status check service for a project.
DELETE /api/v4/projects/{id}/external_status_checks/{check_id}
Groups
- Read
List all billable group members
Lists all billable members of a specified top-level group. Includes members in any subgroups or projects. You must have the Owner role for the group.
GET /api/v4/groups/{id}/billable_members - Read
List all uploads for a group
Lists all uploads for a specified group sorted by `created_at` in descending order. You must have the Maintainer or Owner role for the group.
GET /api/v4/groups/{id}/uploads - Read
Download an uploaded file by ID
Downloads an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.
GET /api/v4/groups/{id}/uploads/{upload_id} - Read
Download an uploaded file by secret and filename
Downloads an uploaded file with a specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for the group.
GET /api/v4/groups/{id}/uploads/{secret}/{filename} - Read
List all issues for a group
Lists all issues for a specified group. If the group is private, you must provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/groups/{id}/issues - Read
Retrieve issues statistics for a group
Retrieves statistics for issues in a specified group.
GET /api/v4/groups/{id}/issues_statistics - Read
Retrieve pending reassignments
Retrieves a CSV file with a list of pending reassignments. This feature was introduced in GitLab 17.10.
GET /api/v4/groups/{id}/placeholder_reassignments - Read
List all groups
Lists all visible groups for the authenticated user. Unauthenticated requests return only public groups.
GET /api/v4/groups - Read
Retrieve a group
Retrieves a specified group by ID or path.
GET /api/v4/groups/{id} - Read
List all invited groups
Lists all groups invited to a specified group.
GET /api/v4/groups/{id}/invited_groups - Read
List all projects in a group
Lists all projects in a specified group accessible to the authenticated user. Unauthenticated requests return only public projects with a limited subset of attributes.
GET /api/v4/groups/{id}/projects - Read
List all subgroups
Lists all subgroups for a specified group.
GET /api/v4/groups/{id}/subgroups - Read
List all descendant groups
Lists all descendant groups for a specified group.
GET /api/v4/groups/{id}/descendant_groups - Read
List all transfer locations for a group
Lists all groups that a specified source group can be transferred to.
GET /api/v4/groups/{id}/transfer_locations - Read
Retrieve a group audit event
Retrieves an audit event for a specified group. Only available to group Owners and administrators.
GET /api/v4/groups/{id}/audit_events/{audit_event_id} - Read
List all SAML users
Lists all SAML users for a specified top-level group. Use the `page` and `per_page` pagination parameters to filter the results.
GET /api/v4/groups/{id}/saml_users - Read
List all provisioned users
Lists all provisioned users for a specified group.
GET /api/v4/groups/{id}/provisioned_users - Write
Workhorse authorize the file upload
This feature was introduced in GitLab 19.0
POST /api/v4/groups/{id}/uploads/authorize - Write
Upload a file to a group
Uploads a file to the specified group. Returns a markdown-formatted link to the file.
POST /api/v4/groups/{id}/uploads - Write
Reassign placeholders
Reassigns placeholder users with an uploaded CSV file.
POST /api/v4/groups/{id}/placeholder_reassignments - Write
Workhorse authorization for the reassignment CSV file
Authorizes Workhorse to handle CSV file uploads for placeholder reassignments. This feature was introduced in GitLab 17.10
POST /api/v4/groups/{id}/placeholder_reassignments/authorize - Write
Create a group
Creates a project group. Available only for users who can create groups.
POST /api/v4/groups - Write
Unarchive a group
Unarchives a specified group. You must be an administrator or have the Owner role for the group.
POST /api/v4/groups/{id}/unarchive - Write
Restore a group
Restores a specified group that was previously scheduled for deletion. Can not restore groups outside of the retention period (30 days by default).
POST /api/v4/groups/{id}/restore - Write
Transfer a project to a group
Transfers a specified project to another group. Administrators only.
POST /api/v4/groups/{id}/projects/{project_id} - Write
Transfer a group
Transfers a group to another parent group or transforms a subgroup into a top-level group. You must be an administrator or have the Owner role for the group.
POST /api/v4/groups/{id}/transfer - Write
Transfer a group to an organization
Transfers a group to another organization asynchronously. Requires the Owner role.
POST /api/v4/groups/{id}/transfer_to_organization - Destructive
Update group security settings
Updates group security settings for a specified group. You must have the Security Manager, Maintainer, or Owner role for the group.
PUT /api/v4/groups/{id}/security_settings - Destructive
Delete an uploaded file by ID
Deletes an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.
DELETE /api/v4/groups/{id}/uploads/{upload_id} - Destructive
Delete an uploaded file by secret and filename
Deletes an uploaded file with a specified secret and filename. You must have the Maintainer or Owner role for the group.
DELETE /api/v4/groups/{id}/uploads/{secret}/{filename} - Destructive
Update group attributes
Updates the attributes for a specified group. You must be an administrator or have the Owner role for the group.
PUT /api/v4/groups/{id} - Destructive
Schedule a group for deletion
Schedules a group for deletion. Groups are deleted at the end of the retention period (30 days by default). Use the `permanently_remove` param to override the retention period.
DELETE /api/v4/groups/{id} - Destructive
Archive a group
Archives a specified group. You must be an administrator or have the Owner role for the group.
POST /api/v4/groups/{id}/archive
Cluster agents
- Read
List all agent URL configurations
Lists all agent URL configurations for a specified agent. You must have the Developer, Maintainer, or Owner role to use this endpoint. This feature was introduced in GitLab 17.4.
GET /api/v4/projects/{id}/cluster_agents/{agent_id}/url_configurations - Read
Retrieve an agent URL configuration
Retrieves an agent URL configuration. You must have the Developer, Maintainer, or Owner role to use this endpoint. This feature was introduced in GitLab 17.4.
GET /api/v4/projects/{id}/cluster_agents/{agent_id}/url_configurations/{url_configuration_id} - Read
List all agents
Lists all agents registered for the project. You must have the Developer, Maintainer, or Owner role to use this endpoint.
GET /api/v4/projects/{id}/cluster_agents - Read
Retrieve details on an agent
Retrieves details on a specified agent. You must have the Developer, Maintainer, or Owner role to use this endpoint.
GET /api/v4/projects/{id}/cluster_agents/{agent_id} - Read
List all agent tokens
Lists all active tokens for an agent. You must have the Developer, Maintainer, or Owner role to use this endpoint.
GET /api/v4/projects/{id}/cluster_agents/{agent_id}/tokens - Read
Retrieve an agent token
Retrieves a specified agent token. You must have the Developer, Maintainer, or Owner role to use this endpoint. Returns a `404` if the agent token has been revoked.
GET /api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id} - Write
Create an agent URL configuration
Creates an agent URL configuration. You must have the Maintainer or Owner role to use this endpoint. An agent can have only one URL configuration at the time. This feature was introduced in GitLab 17.4.
POST /api/v4/projects/{id}/cluster_agents/{agent_id}/url_configurations - Write
Create an agent
Creates an agent for the project. You must have the Maintainer or Owner role to use this endpoint.
POST /api/v4/projects/{id}/cluster_agents - Write
Create an agent token
Creates a token for an agent. You must have the Maintainer or Owner role to use this endpoint. An agent can have only two active tokens at one time.
POST /api/v4/projects/{id}/cluster_agents/{agent_id}/tokens - Destructive
Delete an agent URL configuration
Deletes an agent URL configuration. You must have the Maintainer or Owner role to use this endpoint. This feature was introduced in GitLab 17.4.
DELETE /api/v4/projects/{id}/cluster_agents/{agent_id}/url_configurations/{url_configuration_id} - Destructive
Delete an agent
Deletes an existing agent registration. You must have the Maintainer or Owner role to use this endpoint.
DELETE /api/v4/projects/{id}/cluster_agents/{agent_id} - Destructive
Revoke an agent token
Revokes an agent token. You must have the Maintainer or Owner role to use this endpoint.
DELETE /api/v4/projects/{id}/cluster_agents/{agent_id}/tokens/{token_id}
Runners
- Read
List all runner controller tokens
Lists all runner controller tokens.
GET /api/v4/runner_controllers/{runner_controller_id}/tokens - Read
List all runner controllers
Lists all runner controllers.
GET /api/v4/runner_controllers - Read
List all available runners
Lists all runners available to the user. For group runners, you must have the Owner role in the owner namespace.
GET /api/v4/runners - Read
List all runners
Lists all runners in the GitLab instance (project and shared). You must have either administrator access or auditor access.
GET /api/v4/runners/all - Read
Retrieve details on a runner
Retrieves details of a runner. Instance runner details are available to all authenticated users through this endpoint. For groups and projects, you must have the Maintainer or Owner role for the associated project or group.
GET /api/v4/runners/{id} - Read
List all managers for a runner
List all managers for a specified runner.
GET /api/v4/runners/{id}/managers - Read
Get projects associated with a runner
Get a paginated list of all projects associated with the specified runner. Access is restricted based on user permissions.
GET /api/v4/runners/{id}/projects - Read
List all jobs processed by a runner
Lists all jobs that are being processed or were processed by a specified runner. The list of jobs is limited to projects where the user has the Reporter, Developer, Maintainer, or Owner role.
GET /api/v4/runners/{id}/jobs - Read
List all runners for a project
List all runners available in the project, including from ancestor groups and any allowed shared runners.
GET /api/v4/projects/{id}/runners - Read
List all runners in a group
Lists all runners available in a specified group and any ancestor groups, including any allowed instance runners.
GET /api/v4/groups/{id}/runners - Write
Assign a runner to a project
Assigns an available project runner to a project.
POST /api/v4/projects/{id}/runners - Destructive
Update a runner
Updates a specified runner.
PUT /api/v4/runners/{id} - Destructive
Delete a runner
Deletes a specified runner.
DELETE /api/v4/runners/{id} - Destructive
Reset an authentication token for a runner
Resets the authentication token for a specified runner.
POST /api/v4/runners/{id}/reset_authentication_token - Destructive
Unassign a runner from a project
Unassigns a specified project runner from a project. You cannot unassign a runner from the owner project. Use the delete a runner operation instead.
DELETE /api/v4/projects/{id}/runners/{runner_id} - Destructive
Reset the runner registration token for the instance
Resets the runner registration token for the GitLab instance.
POST /api/v4/runners/reset_registration_token - Destructive
Reset the runner registration token for a project
Resets the runner registration token for a specified project.
POST /api/v4/projects/{id}/runners/reset_registration_token - Destructive
Reset the runner registration token for a group
Resets the runner registration token for a specified group.
POST /api/v4/groups/{id}/runners/reset_registration_token
Runner controller tokens
- Read
Retrieve a single runner controller token
Retrieves details of a specified runner controller token by its ID.
GET /api/v4/runner_controllers/{runner_controller_id}/tokens/{id} - Write
Create a runner controller token
Creates a runner controller token.
POST /api/v4/runner_controllers/{runner_controller_id}/tokens - Destructive
Revoke a runner controller token
Revokes an existing runner controller token.
DELETE /api/v4/runner_controllers/{runner_controller_id}/tokens/{id} - Destructive
Rotate a runner controller token
Rotates an existing runner controller token.
POST /api/v4/runner_controllers/{runner_controller_id}/tokens/{id}/rotate
Runner controllers
- Read
List all scopes for a runner controller
Lists all scopes for a runner controller.
GET /api/v4/runner_controllers/{id}/scopes - Read
Retrieve a single runner controller
Retrieves details of a specified runner controller.
GET /api/v4/runner_controllers/{id} - Write
Add instance scope
Adds an instance scope to a runner controller. When added, the runner controller evaluates jobs for all runners in the GitLab instance. A runner controller can have only one instance scope. If an instance scope already exists, this operation returns an error.
POST /api/v4/runner_controllers/{id}/scopes/instance - Write
Add runner scope
Adds a runner scope to a runner controller. When added, the runner controller evaluates jobs only for a specified runner. A runner controller with an instance scope cannot have runner scopes. Remove the instance scope before adding runner scopes.
POST /api/v4/runner_controllers/{id}/scopes/runners/{runner_id} - Write
Register a runner controller
Registers a runner controller.
POST /api/v4/runner_controllers - Destructive
Remove instance scope
Removes an instance scope from a runner controller.
DELETE /api/v4/runner_controllers/{id}/scopes/instance - Destructive
Remove runner scope
Removes a runner scope from a runner controller.
DELETE /api/v4/runner_controllers/{id}/scopes/runners/{runner_id} - Destructive
Update a runner controller
Updates the details of an existing runner controller by its ID.
PUT /api/v4/runner_controllers/{id} - Destructive
Delete a runner controller
Deletes a specified runner controller. Administrators only.
DELETE /api/v4/runner_controllers/{id}
Audit events
- Read
List all instance audit events
Lists all available instance audit events, limited to a maximum of 30 days for each query.
GET /api/v4/audit_events - Read
Retrieve an instance audit event
Retrieves a specified instance audit event.
GET /api/v4/audit_events/{id} - Read
List all group audit events
Lists all audit events for a specified group.
GET /api/v4/groups/{id}/audit_events
Data management
- Read
Retrieve information about a model record
Retrieves information about a specified model record. Only available to administrators.
GET /api/v4/admin/data_management/{model_name}/{record_identifier} - Read
Retrieve model information
Retrieves information about a data model in an instance. Only available to administrators.
GET /api/v4/admin/data_management/{model_name} - Destructive
Recalculate the checksum of a model record
Recalculates the checksum of a specified model record. The checksum value is a representation of the queried model hashed with the md5 or sha256 algorithm. Only available to administrators on primary Geo sites.
PUT /api/v4/admin/data_management/{model_name}/{record_identifier}/checksum - Destructive
Recalculate checksums for model records
Recalculates checksums for selected records of a specified model, filtered by `checksum_state` and `identifiers` parameters if provided. The request enqueues a background job to perform the recalculation. Only available to administrators on primary Geo sites.
PUT /api/v4/admin/data_management/{model_name}/checksum
Knowledge graph
- Read
Get all enabled namespaces for Knowledge Graph
This endpoint retrieves all namespaces that have Knowledge Graph enabled
GET /api/v4/admin/knowledge_graph/namespaces - Destructive
Enable a namespace for Knowledge Graph
This endpoint enables Knowledge Graph for a specific namespace
PUT /api/v4/admin/knowledge_graph/namespaces/{id} - Destructive
Disable a namespace for Knowledge Graph
This endpoint disables Knowledge Graph for a specific namespace
DELETE /api/v4/admin/knowledge_graph/namespaces/{id}
Code search
- Read
Get all the Zoekt nodes
Returns a list of all Zoekt search nodes available in the instance.
GET /api/v4/admin/zoekt/shards - Read
Get all the indexed namespaces for this node
Retrieves all root namespaces indexed by the specified Zoekt search node.
GET /api/v4/admin/zoekt/shards/{node_id}/indexed_namespaces - Write
Update the number of replicas override for an enabled namespace
Updates the replication factor override for a namespace enabled in the Zoekt search engine.
PATCH /api/v4/admin/zoekt/namespaces/{id} - Destructive
Triggers indexing for the specified project
Triggers background indexing of the specified project using the Zoekt search engine.
PUT /api/v4/admin/zoekt/projects/{project_id}/index - Destructive
Add a namespace to a node for Zoekt indexing
Enables and assigns a namespace to a specific Zoekt node for code search indexing.
PUT /api/v4/admin/zoekt/shards/{node_id}/indexed_namespaces/{namespace_id} - Destructive
Remove a namespace from a node for Zoekt indexing
Removes a namespace from a Zoekt node, deleting its indexed data and disabling search.
DELETE /api/v4/admin/zoekt/shards/{node_id}/indexed_namespaces/{namespace_id}
Active context
- Read
Get all ActiveContext connections
Returns every ActiveContext connection configured for this instance.
GET /api/v4/admin/active_context/connections - Write
Replay items from the dead queue into another queue
Enqueues a background task that replays dead queue items into the specified target queue.
POST /api/v4/admin/active_context/dead_queue/replay - Destructive
Activate an ActiveContext connection
Activates the specified connection and deactivates the previously active connection, if any.
PUT /api/v4/admin/active_context/connections/activate - Destructive
Deactivate an ActiveContext connection
Deactivates the specified connection. This asynchronously drops indexed data for the connection and deletes the connection record.
PUT /api/v4/admin/active_context/connections/deactivate - Destructive
Update collection options
Updates the queue shard count and/or queue shard limit for the specified collection.
PUT /api/v4/admin/active_context/collections/{id} - Destructive
Clear the ActiveContext dead queue
Removes all items from the dead queue and returns the number of items cleared.
DELETE /api/v4/admin/active_context/dead_queue - Destructive
Update enabled namespace state
Transitions the indexing state of an enabled namespace to pending or ready.
PUT /api/v4/admin/active_context/code/enabled_namespaces
Boards
- Read
List all group issue boards in a group
Lists all group issue boards for a specified group.
GET /api/v4/groups/{id}/boards - Read
Retrieve a group issue board
Retrieves a specified group issue board.
GET /api/v4/groups/{id}/boards/{board_id} - Read
List all group issue board lists
Lists all group issue board lists for a specified board. Does not include `open` and `closed` lists.
GET /api/v4/groups/{id}/boards/{board_id}/lists - Read
Retrieve a group issue board list
Retrieves a specified group issue board list.
GET /api/v4/groups/{id}/boards/{board_id}/lists/{list_id} - Read
List all project issue boards
Lists all issue boards in a specified project.
GET /api/v4/projects/{id}/boards - Read
Retrieve an issue board
Retrieves a specified issue board in a project.
GET /api/v4/projects/{id}/boards/{board_id} - Read
List all board lists in an issue board
Lists all lists in a specified issue board. Does not include `open` and `closed` lists.
GET /api/v4/projects/{id}/boards/{board_id}/lists - Read
Retrieve a board list
Retrieves a specified list from an issue board.
GET /api/v4/projects/{id}/boards/{board_id}/lists/{list_id} - Write
Create a group issue board
Creates a group issue board for a specified group.
POST /api/v4/groups/{id}/boards - Write
Create a group issue board list
Creates a group issue board list for a specified board.
POST /api/v4/groups/{id}/boards/{board_id}/lists - Write
Create an issue board
Creates an issue board in a specified project.
POST /api/v4/projects/{id}/boards - Write
Create an issue board list
Creates an issue board list.
POST /api/v4/projects/{id}/boards/{board_id}/lists - Destructive
Delete a group issue board
Deletes a specified group issue board.
DELETE /api/v4/groups/{id}/boards/{board_id} - Destructive
Update a group issue board
Updates a specified group issue board.
PUT /api/v4/groups/{id}/boards/{board_id} - Destructive
Update a group issue board list
Updates a specified group issue board list. This call is used to change list position.
PUT /api/v4/groups/{id}/boards/{board_id}/lists/{list_id} - Destructive
Delete a group issue board list
Deletes a specified group issue board list. Only for administrators and users with the Owner role for the group.
DELETE /api/v4/groups/{id}/boards/{board_id}/lists/{list_id} - Destructive
Update an issue board
Updates a specified issue board in a project.
PUT /api/v4/projects/{id}/boards/{board_id} - Destructive
Delete an issue board
Deletes a specified issue board in a project.
DELETE /api/v4/projects/{id}/boards/{board_id} - Destructive
Update position of a board list
Updates the position of a specified list from an issue board.
PUT /api/v4/projects/{id}/boards/{board_id}/lists/{list_id} - Destructive
Delete a list from an issue board
Deletes a specified list from an issue board.
DELETE /api/v4/projects/{id}/boards/{board_id}/lists/{list_id}
Organizations
- Read
Report an organization's current lifecycle state
Returns the organization's current maintenance lifecycle state.
GET /api/v4/internal/org_mover/maintenance_state - Read
Report cutover readiness for an organization
Reports whether an organization is drained and safe to enter maintenance, and what is blocking it when not.
GET /api/v4/internal/org_mover/maintenance_readiness - Write
Exit maintenance on an organization (maintenance -> active)
Returns an organization from maintenance to active.
POST /api/v4/internal/org_mover/exit_maintenance - Write
Create an organization
Creates an organization. This feature was introduced in GitLab 17.5. This feature is behind the `allow_organization_creation` feature flag. In GitLab 18.3, the feature flag changed to `organization_switching`. In GitLab 19.4, the feature flag changed to `org_stage_experimental`.
POST /api/v4/organizations - Write
Restore a soft-deleted organization
Restores a soft-deleted organization. This feature was introduced in GitLab 19.6.
POST /api/v4/organizations/{id}/restore - Destructive
Start maintenance on an organization (active -> maintenance_initialization)
Begins the maintenance transition for an organization.
POST /api/v4/internal/org_mover/start_maintenance - Destructive
Confirm maintenance on an organization (maintenance_initialization -> maintenance)
Completes the maintenance transition once the organization is drained.
POST /api/v4/internal/org_mover/confirm_maintenance - Destructive
Cancel maintenance on an organization (maintenance_initialization -> active)
Aborts maintenance initialization before the organization reaches the maintenance state, returning it to active.
POST /api/v4/internal/org_mover/cancel_maintenance - Destructive
Soft-delete an organization
This feature was introduced in GitLab 19.2.
DELETE /api/v4/organizations/{id}
MLOps
- Read
MLflow artifact API
MLflow artifacts mapping to GitLab artifacts
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow-artifacts/artifacts - Read
Get MLflow artifact file
Retrieves an MLflow artifact file
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow-artifacts/artifacts/{model_version}/{file_path} - Read
Fetch a Registered Model by Name
https://www.mlflow.org/docs/2.19.0/rest-api.html#get-registeredmodel
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/get - Read
Search Registered Models within a project
https://mlflow.org/docs/2.19.0/rest-api.html#search-registeredmodels
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/search - Read
Gets a Model Version by alias
https://mlflow.org/docs/2.19.0/rest-api.html#get-model-version-by-alias
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/alias - Read
Gets an MLFlow Run, which maps to GitLab Candidates
https://www.mlflow.org/docs/1.28.0/rest-api.html#get-run
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/get - Read
Searches runs/candidates within a project
https://www.mlflow.org/docs/2.19.0/rest-api.html#search-runsexperiment_ids supports only a single experiment ID.Introduced in GitLab 16.4
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/search - Read
Fetch the download URI for the model version.
Returns version in MLflow format "mlflow-artifacts:<version>" https://mlflow.org/docs/2.19.0/rest-api.html#get-download-uri-for-modelversion-artifacts
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/get-download-uri - Read
Fetch model version by name and version
https://mlflow.org/docs/2.19.0/rest-api.html#get-modelversion
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/get - Read
Gets metric history for a run
https://www.mlflow.org/docs/2.19.0/rest-api.html#get-metric-history
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/metrics/get-history - Read
Fetch experiment by experiment_id
https://www.mlflow.org/docs/2.19.0/rest-api.html#get-experiment
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/get - Read
Fetch experiment by experiment_name
https://www.mlflow.org/docs/2.19.0/rest-api.html#get-experiment-by-name
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/get-by-name - Read
List experiments
https://www.mlflow.org/docs/2.19.0/rest-api.html#search-experiments
GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/list - Read
Search experiments
https://www.mlflow.org/docs/2.19.0/rest-api.html#search-experiments
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/search - Write
Creates a Registered Model.
MLFlow Registered Models map to GitLab Models. https://mlflow.org/docs/2.19.0/rest-api.html#create-registeredmodel
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/create - Write
Update a Registered Model by Name
https://mlflow.org/docs/2.19.0/rest-api.html#update-registeredmodel
PATCH /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/update - Write
Fetch the latest Model Version for the given Registered Model Name
https://mlflow.org/docs/2.19.0/rest-api.html#get-latest-modelversions
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/get-latest-versions - Write
Creates a Run.
MLFlow Runs map to GitLab Candidates. https://www.mlflow.org/docs/2.19.0/rest-api.html#create-run
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/create - Write
Updates a Run.
MLFlow Runs map to GitLab Candidates. https://www.mlflow.org/docs/2.19.0/rest-api.html#update-run
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/update - Write
Logs a metric to a run.
https://www.mlflow.org/docs/1.28.0/rest-api.html#log-metric
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-metric - Write
Logs a parameter to a run.
https://www.mlflow.org/docs/2.19.0/rest-api.html#log-param
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-parameter - Write
Sets a tag for a run.
https://www.mlflow.org/docs/2.19.0/rest-api.html#set-tag
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/set-tag - Write
Logs multiple parameters and metrics.
https://www.mlflow.org/docs/2.19.0/rest-api.html#log-param
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-batch - Write
Creates a Model Version.
MLFlow Model Versions map to GitLab Model Versions. https://mlflow.org/docs/2.19.0/rest-api.html#create-modelversion
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/create - Write
Updates a Model Version.
https://mlflow.org/docs/2.19.0/rest-api.html#update-modelversion
PATCH /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/update - Write
Create experiment
https://www.mlflow.org/docs/2.19.0/rest-api.html#create-experiment
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/create - Write
Sets a tag for an experiment.
https://www.mlflow.org/docs/2.19.0/rest-api.html#set-experiment-tag
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/set-experiment-tag - Destructive
Delete a Registered Model by Name
https://mlflow.org/docs/2.19.0/rest-api.html#delete-registeredmodel
DELETE /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/delete - Destructive
Delete a run.
https://mlflow.org/docs/2.19.0/rest-api.html#delete-run
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/delete - Destructive
Delete an experiment.
https://mlflow.org/docs/2.19.0/rest-api.html#delete-experiment
POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/delete
VSCode
- Read
Retrieve the settings manifest for Settings Sync
Retrieves the manifest of the settings stored for VS Code Settings Sync.
GET /api/v4/vscode/settings_sync/v1/manifest - Read
Retrieve the settings manifest for Settings Sync
Retrieves the manifest of the settings stored for VS Code Settings Sync.
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/manifest - Read
Retrieve a specific setting resource
Retrieves a single VS Code setting resource. Returns 204 when the resource does not exist.
GET /api/v4/vscode/settings_sync/v1/resource/{resource_name}/{id} - Read
Retrieve a specific setting resource
Retrieves a single VS Code setting resource. Returns 204 when the resource does not exist.
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}/{id} - Read
List all references to a VS Code setting resource
Lists all references to the stored versions of a VS Code setting resource.
GET /api/v4/vscode/settings_sync/v1/resource/{resource_name} - Read
List all references to a VS Code setting resource
Lists all references to the stored versions of a VS Code setting resource.
GET /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name} - Write
Create or update a specific setting
Creates a VS Code setting resource, or updates it if it already exists.
POST /api/v4/vscode/settings_sync/v1/resource/{resource_name} - Write
Create or update a specific setting
Creates a VS Code setting resource, or updates it if it already exists.
POST /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name} - Destructive
Delete all VS Code setting resources for a user
Deletes all VS Code setting resources of the current user.
DELETE /api/v4/vscode/settings_sync/v1/collection - Destructive
Delete all VS Code setting resources for a user
Deletes all VS Code setting resources of the current user.
DELETE /api/v4/vscode/settings_sync/{settings_context_hash}/v1/collection
Custom attributes
- Read
List all custom attributes for a user
Lists all custom attributes for a specified user.
GET /api/v4/users/{id}/custom_attributes - Read
Retrieve a custom attribute for a user
Retrieves a specified custom attribute for a user.
GET /api/v4/users/{id}/custom_attributes/{key} - Read
List all custom attributes for a project
Lists all custom attributes for a specified project.
GET /api/v4/projects/{id}/custom_attributes - Read
Retrieve a custom attribute for a project
Retrieves a specified custom attribute for a project.
GET /api/v4/projects/{id}/custom_attributes/{key} - Read
List all custom attributes for a group
Lists all custom attributes for a specified group.
GET /api/v4/groups/{id}/custom_attributes - Read
Retrieve a custom attribute for a group
Retrieves a specified custom attribute for a group.
GET /api/v4/groups/{id}/custom_attributes/{key} - Destructive
Creates or updates a custom attribute for a user
Creates or updates a custom attribute for a specified user. If the attribute already exists, it is updated, otherwise a new attribute is created.
PUT /api/v4/users/{id}/custom_attributes/{key} - Destructive
Delete a custom attribute for a user
Deletes a specified custom attribute for a user.
DELETE /api/v4/users/{id}/custom_attributes/{key} - Destructive
Creates or updates a custom attribute for a project
Creates or updates a custom attribute for a specified project. If the attribute already exists, it is updated, otherwise a new attribute is created.
PUT /api/v4/projects/{id}/custom_attributes/{key} - Destructive
Delete a custom attribute for a project
Deletes a specified custom attribute for a project.
DELETE /api/v4/projects/{id}/custom_attributes/{key} - Destructive
Creates or updates a custom attribute for a group
Creates or updates a custom attribute for a specified group. If the attribute already exists, it is updated, otherwise a new attribute is created.
PUT /api/v4/groups/{id}/custom_attributes/{key} - Destructive
Delete a custom attribute for a group
Deletes a specified custom attribute for a group.
DELETE /api/v4/groups/{id}/custom_attributes/{key}
Users
- Read
Retrieve a Support PIN for a user
Retrieves a Support PIN for a specified user. GitLab Support may ask for this PIN to validate your identity. Administrators only.
GET /api/v4/users/{id}/support_pin - Read
List all users
Lists all users on the instance. This endpoint supports keyset pagination. In GitLab 17.0 and later, keyset pagination is used by default.
GET /api/v4/users - Read
Retrieve a user as a regular user
Retrieves a specified user as a regular user.
GET /api/v4/users/{id} - Read
Retrieve the status of a user
Retrieves the status of a user. You can access this endpoint without authentication.
GET /api/v4/users/{user_id}/status - Read
List all accounts followed by a user
Lists all user accounts being followed by a specified user.
GET /api/v4/users/{id}/following - Read
List all accounts that follow a user
Lists all user accounts that follow a specified user.
GET /api/v4/users/{id}/followers - Read
List all email addresses for a user
Lists all email addresses for a specified user account. Administrators only.
GET /api/v4/users/{id}/emails - Read
List all project and group memberships for a user
Lists all project and group memberships for a specified user. Administrators only.
GET /api/v4/users/{user_id}/memberships - Read
Retrieve association counts for a user
Retrieves the number of groups, projects, issues, and merge requests associated with a specified user.
GET /api/v4/users/{id}/associations_count - Read
Retrieve current user details
Retrieves details about your user account.
GET /api/v4/user - Read
List all email addresses for a user
Lists all email addresses for the currently authenticated user.
GET /api/v4/user/emails - Read
Retrieve Support PIN
Retrieves a Support PIN for the currently authenticated user. GitLab Support may ask for this PIN to validate your identity.
GET /api/v4/user/support_pin - Read
Retrieve your user preferences
Retrieves your user preferences.
GET /api/v4/user/preferences - Read
Retrieve details on an email address
Retrieves details on a specified email address for the currently authenticated user.
GET /api/v4/user/emails/{email_id} - Read
List all activity for a user
Lists all activity for a specified user.
GET /api/v4/user/activities - Read
Retrieve your user status
Retrieves your user status.
GET /api/v4/user/status - Read
Return the user specific counts
Assigned open issues, assigned MRs and pending todos count
GET /api/v4/user_counts - Write
Create a user
Creates a user. Administrators only.
POST /api/v4/users - Write
Follow a user
Follows a specified user account.
POST /api/v4/users/{id}/follow - Write
Unfollow a user
Unfollows a specified user account.
POST /api/v4/users/{id}/unfollow - Write
Add an email address for a user
Adds an email address for a specified user account. Administrators only.
POST /api/v4/users/{id}/emails - Write
Reactivate a user
Reactivates a specified user account that was previously deactivated. Administrators only.
POST /api/v4/users/{id}/activate - Write
Approve access to a user
Approves access to a specified user account that is pending approval. Administrators only.
POST /api/v4/users/{id}/approve - Write
Reject access to a user
Rejects access to a specified user account that is pending approval. Administrators only.
POST /api/v4/users/{id}/reject - Write
Unblock access to a user
Unblocks a specified user account that was previously blocked. Administrators only.
POST /api/v4/users/{id}/unblock - Write
Unban a user
Unbans a specified user account that was previously banned. Administrators only.
POST /api/v4/users/{id}/unban - Write
Add an email address
Adds an email address for the currently authenticated user.
POST /api/v4/user/emails - Write
Create a Support PIN
Creates a Support PIN. The PIN expires seven days after creation. GitLab Support may ask for this PIN to validate your identity.
POST /api/v4/user/support_pin - Write
Update a user status
Sets the status of the currently authenticated user. Any parameters that are not passed are ignored. This operation is similar but distinct from the Set a user status operation.
PATCH /api/v4/user/status - Write
Create a runner owned by currently authenticated user
Create a new runner
POST /api/v4/user/runners - Destructive
Revoke a Support PIN for a user
Revokes a Support PIN for a specified user. This immediately expires and removes the PIN. Administrators only.
POST /api/v4/users/{id}/support_pin/revoke - Destructive
Update a user
Updates the details of a specified user.
PUT /api/v4/users/{id} - Destructive
Delete a user
Deletes a user. Administrators only.
DELETE /api/v4/users/{id} - Destructive
Disable two-factor authentication for a user
Disables two-factor authentication for a specified user account. Administrators only.
PATCH /api/v4/users/{id}/disable_two_factor - Destructive
Delete authentication identity from a user
Deletes a user authentication identity using the provider name associated with that identity. Administrators only.
DELETE /api/v4/users/{id}/identities/{provider} - Destructive
Delete an email address for a user
Deletes a specified email address for a user account. You cannot delete a primary email address. Administrators only.
DELETE /api/v4/users/{id}/emails/{email_id} - Destructive
Deactivate a user
Deactivates a specified user account. Administrators only.
POST /api/v4/users/{id}/deactivate - Destructive
Block access to a user
Blocks a specified user account. Administrators only.
POST /api/v4/users/{id}/block - Destructive
Ban a user
Bans a specified user account. Administrators only.
POST /api/v4/users/{id}/ban - Destructive
Update a user's credit_card_validation (deprecated)
Deprecated in 17.7
PUT /api/v4/user/{user_id}/credit_card_validation - Destructive
Update your user preferences
Updates your user preferences.
PUT /api/v4/user/preferences - Destructive
Delete an email address
Deletes the specified email address. You cannot delete a primary email address. Any future emails sent to the deleted email address are sent to the primary email address instead.
DELETE /api/v4/user/emails/{email_id} - Destructive
Set a user status
Sets the status of the currently authenticated user. Any parameters that are not passed are nullified. This operation is similar but distinct from the Update a user status operation.
PUT /api/v4/user/status
Deploy resources
- Read
List all project deploy keys for a user
Lists all project deploy keys accessible to a specified user.
GET /api/v4/users/{user_id}/project_deploy_keys - Read
List all project deployments
Lists all deployments in a project.
GET /api/v4/projects/{id}/deployments - Read
Retrieve a deployment
Retrieves a specified deployment.
GET /api/v4/projects/{id}/deployments/{deployment_id} - Read
List all merge requests associated with a deployment
Lists all merge requests shipped with a specified deployment.
GET /api/v4/projects/{id}/deployments/{deployment_id}/merge_requests - Read
List all deploy tokens
Lists all deploy tokens for the instance.
GET /api/v4/deploy_tokens - Read
List all project deploy tokens
Lists all project deploy tokens.
GET /api/v4/projects/{id}/deploy_tokens - Read
Retrieve a project deploy token
Retrieves a project deploy token.
GET /api/v4/projects/{id}/deploy_tokens/{token_id} - Read
List all group deploy tokens
Lists all group deploy tokens.
GET /api/v4/groups/{id}/deploy_tokens - Read
Retrieve a group deploy token
Get a single group's deploy token by ID. This feature was introduced in GitLab 14.9.
GET /api/v4/groups/{id}/deploy_tokens/{token_id} - Read
List all deploy keys
Lists all deploy keys for the instance.
GET /api/v4/deploy_keys - Read
List all deploy keys for project
Lists all deploy keys for a specified project.
GET /api/v4/projects/{id}/deploy_keys - Read
Retrieve a deploy key
Retrieves a specified deploy key.
GET /api/v4/projects/{id}/deploy_keys/{key_id} - Write
Create a deployment
Creates a deployment.
POST /api/v4/projects/{id}/deployments - Write
Approve or reject a deployment
Approves or rejects a deployment.
POST /api/v4/projects/{id}/deployments/{deployment_id}/approval - Write
Create a project deploy token
Creates a project deploy token.
POST /api/v4/projects/{id}/deploy_tokens - Write
Create a group deploy token
Creates a group deploy token.
POST /api/v4/groups/{id}/deploy_tokens - Write
Create a deploy key
Creates a deploy key for the GitLab instance. Requires administrator access.
POST /api/v4/deploy_keys - Write
Add a deploy key for a project
Adds a deploy key for a specified project. If the deploy key already exists in another project, it is joined to the current project only if the original one is accessible by the same user.
POST /api/v4/projects/{id}/deploy_keys - Write
Enable a deploy key
Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.
POST /api/v4/projects/{id}/deploy_keys/{key_id}/enable - Destructive
Update a deployment
Updates a specified deployment.
PUT /api/v4/projects/{id}/deployments/{deployment_id} - Destructive
Delete a deployment
Deletes a specified deployment that is not currently the last deployment for an environment or in a `running` state.
DELETE /api/v4/projects/{id}/deployments/{deployment_id} - Destructive
Delete a project deploy token
Deletes a project deploy token.
DELETE /api/v4/projects/{id}/deploy_tokens/{token_id} - Destructive
Delete a group deploy token
Deletes a group deploy token.
DELETE /api/v4/groups/{id}/deploy_tokens/{token_id} - Destructive
Update a deploy key
Updates a deploy key for a project.
PUT /api/v4/projects/{id}/deploy_keys/{key_id} - Destructive
Delete a deploy key
Deletes a deploy key from the project. If the deploy key is used only for this project, it is deleted from the system.
DELETE /api/v4/projects/{id}/deploy_keys/{key_id}
Keys
- Read
List all SSH keys for a user
Lists all SSH keys for a specified user account.
GET /api/v4/users/{user_id}/keys - Read
Retrieve an SSH key for a user
Retrieves an SSH key for a specified user account. This endpoint does not require authentication.
GET /api/v4/users/{id}/keys/{key_id} - Read
List all GPG keys for a user
Lists all GPG keys for a specified user account. This endpoint does not require authentication.
GET /api/v4/users/{id}/gpg_keys - Read
Retrieve a GPG key for a user
Retrieves a GPG key for a specified user account. This endpoint does not require authentication.
GET /api/v4/users/{id}/gpg_keys/{key_id} - Read
List all SSH keys
Lists all SSH keys for the currently authenticated user.
GET /api/v4/user/keys - Read
Retrieve an SSH key
Retrieves a specified SSH key for the currently authenticated user.
GET /api/v4/user/keys/{key_id} - Read
List all GPG keys
Lists all GPG keys for the currently authenticated user.
GET /api/v4/user/gpg_keys - Read
Retrieve a GPG key
Retrieves a GPG key for the currently authenticated user.
GET /api/v4/user/gpg_keys/{key_id} - Read
Retrieve user by SSH key ID
Retrieves user by SSH key ID. Administrators only.
GET /api/v4/keys/{id} - Read
Retrieve user by SSH key fingerprint
Retrieves user by SSH key fingerprint. Administrators only.
GET /api/v4/keys - Read
List all group SSH certificates
Lists all SSH certificates for a specified group.
GET /api/v4/groups/{id}/ssh_certificates - Write
Add an SSH key for a user
Adds an SSH key for a specified user account. Administrators only.
POST /api/v4/users/{user_id}/keys - Write
Add a GPG key for a user
Adds a GPG key for a specified user account. Administrators only.
POST /api/v4/users/{id}/gpg_keys - Write
Add an SSH key
Adds an SSH key for the currently authenticated user.
POST /api/v4/user/keys - Write
Add a GPG key
Adds a GPG key for the currently authenticated user.
POST /api/v4/user/gpg_keys - Write
Add a group SSH certificate
Adds a group SSH certificate for a specified group.
POST /api/v4/groups/{id}/ssh_certificates - Destructive
Delete an SSH key for a user
Deletes an SSH key from a specified user account. Administrators only.
DELETE /api/v4/users/{id}/keys/{key_id} - Destructive
Delete a GPG key for a user
Deletes a GPG key from a specified user account. Administrators only.
DELETE /api/v4/users/{id}/gpg_keys/{key_id} - Destructive
Revoke a GPG key for a user.
Deletes a GPG key from a specified user account. Administrators only.
POST /api/v4/users/{id}/gpg_keys/{key_id}/revoke - Destructive
Delete an SSH key
Deletes a specified SSH key from the currently authenticated user.
DELETE /api/v4/user/keys/{key_id} - Destructive
Delete a GPG key
Deletes a GPG key from your user account.
DELETE /api/v4/user/gpg_keys/{key_id} - Destructive
Revoke a GPG key
This feature was added in GitLab 10.0
POST /api/v4/user/gpg_keys/{key_id}/revoke - Destructive
Delete a group SSH certificate
Deletes a specified group SSH certificate.
DELETE /api/v4/groups/{id}/ssh_certificates/{ssh_certificates_id}
Access tokens
- Read
List all impersonation tokens for a user
Lists all impersonation tokens for a specified user. Administrators only.
GET /api/v4/users/{user_id}/impersonation_tokens - Read
Retrieve an impersonation token for a user
Retrieves an impersonation token for a specified user. Administrators only.
GET /api/v4/users/{user_id}/impersonation_tokens/{impersonation_token_id} - Read
List all personal access tokens for a project service account
Lists all personal access tokens for a specified project service account
GET /api/v4/projects/{id}/service_accounts/{user_id}/personal_access_tokens - Read
List all personal access tokens for a group service account
Lists all personal access tokens for a specified group service account
GET /api/v4/groups/{id}/service_accounts/{user_id}/personal_access_tokens - Read
List all project access tokens
Lists all project access tokens for a specified project.
GET /api/v4/projects/{id}/access_tokens - Read
Retrieve details on a project access token
Retrieves details on a specified project access token.
GET /api/v4/projects/{id}/access_tokens/{token_id} - Read
List all group access tokens
Lists all group access tokens for a specified group.
GET /api/v4/groups/{id}/access_tokens - Read
Retrieve details on a group access token
Retrieves details on a specified group access token.
GET /api/v4/groups/{id}/access_tokens/{token_id} - Read
Retrieve a personal access token
Retrieves a specified personal access token by passing it to the API in a header.
GET /api/v4/personal_access_tokens/self - Read
List all token associations
Lists all groups and projects accessible by the personal access token used to authenticate the request. Generally, this includes any groups or projects that the user is a member of.
GET /api/v4/personal_access_tokens/self/associations - Read
List all personal access tokens
Lists all personal access tokens accessible by the authenticated user. For administrators, returns all personal access tokens in the instance. For non-administrators, returns all of their personal access tokens.
GET /api/v4/personal_access_tokens - Read
Retrieve a personal access token
Retrieves details for a specified personal access token. Administrators can retrieve details on any token. Non-administrators can only retrieve details on their own tokens.
GET /api/v4/personal_access_tokens/{id} - Write
Create an impersonation token
Creates an impersonation token. These tokens are used to act on behalf of a user and can perform API calls as well as Git read and write actions. These tokens are not visible to the associated user on their profile settings page. Token values are included with the response, but cannot be retrieved later. Administrators only.
POST /api/v4/users/{user_id}/impersonation_tokens - Write
Create a personal access token for a user
Creates a personal access token for a user. To create a fine-grained personal access token, use `granular_scopes` instead of `scopes`. Token values are included with the response, but cannot be retrieved later. Administrators only.
POST /api/v4/users/{user_id}/personal_access_tokens - Write
Create a personal access token
Creates a personal access token for the currently authenticated user. For security purposes, the token is limited to the `k8s_proxy` and `self_rotate` scope. Token values are included with the response, but cannot be retrieved later. This feature was introduced in GitLab 16.5.
POST /api/v4/user/personal_access_tokens - Write
Create a personal access token for a project service account
Creates a personal access token for a specified project service account. Available only for project Owners, Maintainers, and administrators.
POST /api/v4/projects/{id}/service_accounts/{user_id}/personal_access_tokens - Write
Create a personal access token for a group service account
Creates a personal access token for a specified group service account. Available only for group Owners and administrators. This feature was introduced in GitLab 16.1.
POST /api/v4/groups/{id}/service_accounts/{user_id}/personal_access_tokens - Write
Create a project access token
Creates a project access token for a specified project. You cannot create a token with an access level greater than your account. For example, a user with the Maintainer role cannot create a project access token with the Owner role. You must use a personal access token with this endpoint. You cannot authenticate with a project access token.
POST /api/v4/projects/{id}/access_tokens - Write
Create a group access token
Creates a group access token for a specified group. You cannot create a token with an access level greater than your account. For example, a user with the Maintainer role cannot create a group access token with the Owner role. You must use a personal access token with this endpoint. You cannot authenticate with a group access token.
POST /api/v4/groups/{id}/access_tokens - Destructive
Revoke an impersonation token
Revokes an impersonation token for a specified user. Administrators only.
DELETE /api/v4/users/{user_id}/impersonation_tokens/{impersonation_token_id} - Destructive
Revoke a personal access token for a project service account
Revokes a specified personal access token for a project service account.
DELETE /api/v4/projects/{id}/service_accounts/{user_id}/personal_access_tokens/{token_id} - Destructive
Rotate a personal access token for a project service account
Rotates a specified personal access token for a project service account. This revokes the existing token and creates a token with the same name, description, and scopes.
POST /api/v4/projects/{id}/service_accounts/{user_id}/personal_access_tokens/{token_id}/rotate - Destructive
Revoke a personal access token for a group service account
Revokes a specified personal access token for a group service account.
DELETE /api/v4/groups/{id}/service_accounts/{user_id}/personal_access_tokens/{token_id} - Destructive
Rotate a personal access token for a group service account
Rotates a specified personal access token for a group service account. This revokes the existing token and creates a token with the same name, description, and scopes.
POST /api/v4/groups/{id}/service_accounts/{user_id}/personal_access_tokens/{token_id}/rotate - Destructive
Rotate a project access token
Rotates a project access token by passing it to the API in a header.
POST /api/v4/projects/{id}/access_tokens/self/rotate - Destructive
Rotate a group access token
Rotates a group access token by passing it to the API in a header.
POST /api/v4/groups/{id}/access_tokens/self/rotate - Destructive
Revoke a project access token
Revokes a specified project access token.
DELETE /api/v4/projects/{id}/access_tokens/{token_id} - Destructive
Rotate a project access token
Rotates a project access token. This immediately revokes the previous token and creates a token. Generally, this endpoint rotates a specific project access token by authenticating with a personal access token. You can also use a project access token to rotate itself. If you attempt to use this endpoint to rotate a token that was previously revoked, any active tokens from the same token family are revoked. This feature was introduced in GitLab 16.0.
POST /api/v4/projects/{id}/access_tokens/{token_id}/rotate - Destructive
Revoke a group access token
Revokes a specified group access token.
DELETE /api/v4/groups/{id}/access_tokens/{token_id} - Destructive
Rotate a group access token
Rotates a group access token. This immediately revokes the previous token and creates a token. Generally, this endpoint rotates a specific group access token by authenticating with a personal access token. You can also use a group access token to rotate itself. If you attempt to use this endpoint to rotate a token that was previously revoked, any active tokens from the same token family are revoked. This feature was introduced in GitLab 16.0.
POST /api/v4/groups/{id}/access_tokens/{token_id}/rotate - Destructive
Rotate a personal access token
Rotates a personal access token by passing it to the API in a header
POST /api/v4/personal_access_tokens/self/rotate - Destructive
Revoke a personal access token
Revokes a personal access token by passing it to the API in a header.
DELETE /api/v4/personal_access_tokens/self - Destructive
Revoke a personal access token
Revokes a specified personal access token. Administrators can revoke tokens for any user. Non-administrators can only revoke their own tokens.
DELETE /api/v4/personal_access_tokens/{id} - Destructive
Rotate a personal access token
Rotates a specified personal access token. This revokes the previous token and creates a token that expires after one week. Administrators can revoke tokens for any user. Non-administrators can only revoke their own tokens.
POST /api/v4/personal_access_tokens/{id}/rotate
Avatars
- Read
Download a project avatar
Downloads a project avatar. You can access this endpoint without authentication if the project is publicly accessible. This feature was introduced in GitLab 16.9.
GET /api/v4/projects/{id}/avatar - Read
Download a group avatar
Downloads a group avatar image.
GET /api/v4/groups/{id}/avatar - Read
Return avatar url for a user
Returns the Gravatar URL for the user with the given public email address.
GET /api/v4/avatar - Destructive
Upload an avatar
Uploads an avatar for the currently authenticated user. This feature was introduced in GitLab 17.0.
PUT /api/v4/user/avatar
Applications
- Read
List all applications
Lists all applications owned by the authenticated user.
GET /api/v4/user/applications - Read
Retrieve an application
Retrieves details of a specific application owned by the authenticated user.
GET /api/v4/user/applications/{id} - Read
Get applications
List all registered applications
GET /api/v4/applications - Write
Create an application
Creates a new OAuth application for the authenticated user. This feature was introduced in GitLab 19.0
POST /api/v4/user/applications - Write
Create a new application
This feature was introduced in GitLab 10.5. The granular_scopes parameter requires the granular_oauth_tokens feature flag.
POST /api/v4/applications - Write
Renew an application secret
Renew the secret of a specific application
POST /api/v4/applications/{id}/renew-secret - Destructive
Delete an application
Deletes a specified application owned by the authenticated user.
DELETE /api/v4/user/applications/{id} - Destructive
Update an application
Updates an existing application owned by the authenticated user.
PUT /api/v4/user/applications/{id} - Destructive
Delete an application
Delete a specific application
DELETE /api/v4/applications/{id}
To-dos
- Read
List all to-do items
Lists all to-do items. When no filter is applied, it returns all pending to-do items for the current user. Different filters allow the user to refine the request.
GET /api/v4/todos - Write
Create a to-do item for an issuable
Creates a to-do item for the current user on a specified issuable. If a to-do item already exists for the user on that issuable, returns a `304` status code.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/todo - Write
Create a to-do item for an issuable
Creates a to-do item for the current user on a specified issuable. If a to-do item already exists for the user on that issuable, returns a `304` status code.
POST /api/v4/projects/{id}/issues/{issue_iid}/todo - Write
Mark a to-do item as done
Marks a to-do item for the current user as done.
POST /api/v4/todos/{id}/mark_as_done - Write
Mark all to-do items as done
Marks all pending to-do items for the current user as done. It returns the HTTP status code `204` with an empty response.
POST /api/v4/todos/mark_as_done
Templates
- Read
List all license templates
Lists all available license templates.
GET /api/v4/templates/licenses - Read
Retrieve a license template
Retrieves a specified license template. You can pass parameters to replace the license placeholder.
GET /api/v4/templates/licenses/{name} - Read
List all .gitignore templates
Lists all .gitignore templates.
GET /api/v4/templates/gitignores - Read
Retrieve a .gitignore template
Retrieves a specified .gitignore template.
GET /api/v4/templates/gitignores/{name} - Read
List all GitLab CI/CD YAML templates
Lists all GitLab CI/CD YAML templates.
GET /api/v4/templates/gitlab_ci_ymls - Read
Retrieve a GitLab CI/CD YAML template
Retrieves a specified GitLab CI/CD YAML template.
GET /api/v4/templates/gitlab_ci_ymls/{name} - Read
List all Dockerfile templates
Lists all Dockerfile templates.
GET /api/v4/templates/dockerfiles - Read
Retrieve a Dockerfile template
Retrieves a specified Dockerfile template.
GET /api/v4/templates/dockerfiles/{name}
Resource subscriptions
- Write
Subscribe to a merge request
Subscribes the currently authenticated user to a specified merge request. They will receive notifications on changes to this item.
POST /api/v4/projects/{id}/merge_requests/{subscribable_id}/subscribe - Write
Subscribe to an issue
Subscribes the currently authenticated user to a specified issue. They will receive notifications on changes to this item.
POST /api/v4/projects/{id}/issues/{subscribable_id}/subscribe - Write
Subscribe to a project label
Subscribes the currently authenticated user to a specified project label. They will receive notifications on changes to this item.
POST /api/v4/projects/{id}/labels/{subscribable_id}/subscribe - Write
Subscribe to a group label
Subscribes the currently authenticated user to a specified group label. They will receive notifications on changes to this item.
POST /api/v4/groups/{id}/labels/{subscribable_id}/subscribe - Destructive
Unsubscribe to a merge request
Unsubscribes the currently authenticated user from a specified merge request. They will no longer receive notifications on changes to this item.
POST /api/v4/projects/{id}/merge_requests/{subscribable_id}/unsubscribe - Destructive
Unsubscribe to an issue
Unsubscribes the currently authenticated user from a specified issue. They will no longer receive notifications on changes to this item.
POST /api/v4/projects/{id}/issues/{subscribable_id}/unsubscribe - Destructive
Unsubscribe to a project label
Unsubscribes the currently authenticated user from a specified project label. They will no longer receive notifications on changes to this item.
POST /api/v4/projects/{id}/labels/{subscribable_id}/unsubscribe - Destructive
Unsubscribe to a group label
Unsubscribes the currently authenticated user from a specified group label. They will no longer receive notifications on changes to this item.
POST /api/v4/groups/{id}/labels/{subscribable_id}/unsubscribe
Sidekiq
- Read
List all job queue metrics
Lists all details about all Sidekiq job queues, including backlog size and latency.
GET /api/v4/sidekiq/queue_metrics - Read
List all Sidekiq processes
Lists all details about all registered Sidekiq worker processes, including hostname, process ID, queues, and concurrency settings.
GET /api/v4/sidekiq/process_metrics - Read
Retrieve job completion metrics
Retrieves statistics on the completion status of all Sidekiq jobs.
GET /api/v4/sidekiq/job_stats - Read
List all Sidekiq metrics
Lists all Sidekiq metrics. Includes queue, process, and job completion metrics.
GET /api/v4/sidekiq/compound_metrics - Destructive
Delete jobs from a Sidekiq queue
Deletes jobs from a Sidekiq queue that match the specified metadata. At least one of 32 related parameters must be provided.
DELETE /api/v4/admin/sidekiq/queues/{queue_name}
Instance
- Read
Retrieve application settings
Retrieves the current application settings for this GitLab instance.
GET /api/v4/application/settings - Read
Retrieve application statistics
Retrieves the current application statistics for this GitLab instance.
GET /api/v4/application/statistics - Read
Get the current appearance
Retrieves the instance's branding and appearance configuration including logos, colors, and custom headers.
GET /api/v4/application/appearance - Destructive
Update application settings
Updates the current application settings for this GitLab instance. At least one setting must be updated.
PUT /api/v4/application/settings - Destructive
Modify appearance
Updates instance appearance settings like branding, logos, headers, and footer messages.
PUT /api/v4/application/appearance
Service accounts
- Read
List all instance service accounts
Lists all instance service accounts. Use the `page` and `per_page` pagination parameters to filter the results.
GET /api/v4/service_accounts - Read
List all project service accounts
Lists all service accounts in a specified project. Use the `page` and `per_page` pagination parameters to filter the results.
GET /api/v4/projects/{id}/service_accounts - Read
Get a single project service account
Gets a specified service account in a specified project.
GET /api/v4/projects/{id}/service_accounts/{user_id} - Read
List all group service accounts
Lists all service accounts in a specified group. Use the `page` and `per_page` pagination parameters to filter the results.
GET /api/v4/groups/{id}/service_accounts - Read
Get a single group service account
Gets a specified service account in a specified group.
GET /api/v4/groups/{id}/service_accounts/{user_id} - Write
Create an instance service account
Creates an instance service account.
POST /api/v4/service_accounts - Write
Update an instance service account
Updates a specified instance service account.
PATCH /api/v4/service_accounts/{user_id} - Write
Create a project service account
Creates a service account in a specified project.
POST /api/v4/projects/{id}/service_accounts - Write
Update a project service account
Update a specified project service account.
PATCH /api/v4/projects/{id}/service_accounts/{user_id} - Write
Create a group service account
Creates a service account in a specified group.
POST /api/v4/groups/{id}/service_accounts - Write
Update a group service account
Update a specified group service account.
PATCH /api/v4/groups/{id}/service_accounts/{user_id} - Destructive
Delete a project service account
Deletes a specified project service account. Available only for project Owners, Maintainers, and administrators.
DELETE /api/v4/projects/{id}/service_accounts/{user_id} - Destructive
Delete a group service account
Deletes a specified group service account. Available only for group Owners and administrators.
DELETE /api/v4/groups/{id}/service_accounts/{user_id}
Milestones
- Read
List all project milestones
Lists all milestones for a specified project.
GET /api/v4/projects/{id}/milestones - Read
Retrieve a project milestone
Retrieves a specified project milestone.
GET /api/v4/projects/{id}/milestones/{milestone_id} - Read
List all issues for a project milestone
Lists all issues assigned to a specified project milestone.
GET /api/v4/projects/{id}/milestones/{milestone_id}/issues - Read
List all merge requests for a project milestone
Lists all merge requests assigned to a specified project milestone.
GET /api/v4/projects/{id}/milestones/{milestone_id}/merge_requests - Read
List all burndown chart events for a milestone
Lists all burndown chart events for a specified milestone.
GET /api/v4/projects/{id}/milestones/{milestone_id}/burndown_events - Read
List all group milestones
Lists all group milestones for a specified group.
GET /api/v4/groups/{id}/milestones - Read
Retrieve a group milestone
Retrieves a specified group milestone.
GET /api/v4/groups/{id}/milestones/{milestone_id} - Read
List all issues assigned to a single milestone
Lists all issues assigned to a specified group milestone.
GET /api/v4/groups/{id}/milestones/{milestone_id}/issues - Read
List all merge requests assigned to a single milestone
Lists all merge requests assigned to a specified group milestone.
GET /api/v4/groups/{id}/milestones/{milestone_id}/merge_requests - Read
List all burndown chart events for a milestone
Lists all burndown chart events for a specified milestone.
GET /api/v4/groups/{id}/milestones/{milestone_id}/burndown_events - Write
Create a project milestone
Creates a project milestone.
POST /api/v4/projects/{id}/milestones - Write
Promote a project milestone to a group milestone
Promotes a specified project milestone to a group milestone. Only for users with the Planner, Reporter, Developer, Maintainer, or Owner role for the group.
POST /api/v4/projects/{id}/milestones/{milestone_id}/promote - Write
Create a group milestone
Creates a milestone for the specified group.
POST /api/v4/groups/{id}/milestones - Destructive
Update a project milestone
Updates a specified project milestone.
PUT /api/v4/projects/{id}/milestones/{milestone_id} - Destructive
Delete a project milestone
Deletes a specified project milestone. Only for users with the Planner, Reporter, Developer, Maintainer, or Owner role for the project.
DELETE /api/v4/projects/{id}/milestones/{milestone_id} - Destructive
Update a group milestone
Updates the specified group milestone.
PUT /api/v4/groups/{id}/milestones/{milestone_id} - Destructive
Delete a group milestone
Deletes the specified group milestone.
DELETE /api/v4/groups/{id}/milestones/{milestone_id}
Notification settings
- Read
Retrieve global notification settings
Retrieves the global notification level and email address.
GET /api/v4/notification_settings - Read
Retrieve notification settings for a group
Retrieves the notification level for a specified group.
GET /api/v4/groups/{id}/notification_settings - Read
Retrieve notification settings for a project
Retrieves the notification level for a specified project.
GET /api/v4/projects/{id}/notification_settings - Destructive
Update global notification settings
Updates notification settings and email address.
PUT /api/v4/notification_settings - Destructive
Update notification settings for a group
Updates the notification settings for a specified group.
PUT /api/v4/groups/{id}/notification_settings - Destructive
Update notification settings for a project
Updates the notification settings for a specified project.
PUT /api/v4/projects/{id}/notification_settings
Notes
- Read
List all issue notes
Lists all notes for a specified issue.
GET /api/v4/projects/{id}/issues/{noteable_id}/notes - Read
Retrieve an issue note
Retrieves a specified note for an issue.
GET /api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id} - Read
List all merge request notes
Lists all notes for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/notes - Read
Retrieve a merge request note
Retrieves a specified note for a merge request.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id} - Read
List all snippet notes
Lists all notes for a specified snippet.
GET /api/v4/projects/{id}/snippets/{noteable_id}/notes - Read
Retrieve a snippet note
Retrieves a specified note for a snippet.
GET /api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id} - Read
List all wiki page meta notes
Lists all notes for a specified wiki page meta.
GET /api/v4/projects/{id}/wiki_pages/{noteable_id}/notes - Read
Retrieve a wiki page meta note
Retrieves a specified note for a wiki page meta.
GET /api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id} - Read
List all epic notes
Lists all notes for a specified epic.
GET /api/v4/groups/{id}/epics/{noteable_id}/notes - Read
Retrieve an epic note
Retrieves a specified note for an epic.
GET /api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id} - Read
List all vulnerability notes
Lists all notes for a specified vulnerability.
GET /api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes - Read
Retrieve a vulnerability note
Retrieves a specified note for a vulnerability.
GET /api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id} - Read
List all wiki page meta notes
Lists all notes for a specified wiki page meta.
GET /api/v4/groups/{id}/wiki_pages/{noteable_id}/notes - Read
Retrieve a wiki page meta note
Retrieves a specified note for a wiki page meta.
GET /api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id} - Write
Create an issue note
Creates a note for an issue.
POST /api/v4/projects/{id}/issues/{noteable_id}/notes - Write
Create a merge request note
Creates a note for a merge request.
POST /api/v4/projects/{id}/merge_requests/{noteable_id}/notes - Write
Create a snippet note
Creates a note for a snippet.
POST /api/v4/projects/{id}/snippets/{noteable_id}/notes - Write
Create a wiki page meta note
Creates a note for a wiki page meta.
POST /api/v4/projects/{id}/wiki_pages/{noteable_id}/notes - Write
Create an epic note
Creates a note for an epic.
POST /api/v4/groups/{id}/epics/{noteable_id}/notes - Write
Create a vulnerability note
Creates a note for a vulnerability.
POST /api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes - Write
Create a wiki page meta note
Creates a note for a wiki page meta.
POST /api/v4/groups/{id}/wiki_pages/{noteable_id}/notes - Destructive
Update an issue note
Updates an existing note for an issue.
PUT /api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id} - Destructive
Delete an issue note
Deletes a specified note from an issue.
DELETE /api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id} - Destructive
Update a merge request note
Updates an existing note for a merge request.
PUT /api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id} - Destructive
Delete a merge request note
Deletes a specified note from a merge request.
DELETE /api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id} - Destructive
Update a snippet note
Updates an existing note for a snippet.
PUT /api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id} - Destructive
Delete a snippet note
Deletes a specified note from a snippet.
DELETE /api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id} - Destructive
Update a wiki page meta note
Updates an existing note for a wiki page meta.
PUT /api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id} - Destructive
Delete a wiki page meta note
Deletes a specified note from a wiki page meta.
DELETE /api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id} - Destructive
Update an epic note
Updates an existing note for an epic.
PUT /api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id} - Destructive
Delete an epic note
Deletes a specified note from an epic.
DELETE /api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id} - Destructive
Update a vulnerability note
Updates an existing note for a vulnerability.
PUT /api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id} - Destructive
Delete a vulnerability note
Deletes a specified note from a vulnerability.
DELETE /api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id} - Destructive
Update a wiki page meta note
Updates an existing note for a wiki page meta.
PUT /api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id} - Destructive
Delete a wiki page meta note
Deletes a specified note from a wiki page meta.
DELETE /api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id}
MCP
- Read
Get MCP response listener
Listens for Model Context Protocol responses
GET /api/v4/mcp - Write
Create MCP request handler
Handles Model Context Protocol requests
POST /api/v4/mcp
Labels
- Read
List all project labels
Lists all labels for a specified project. By default, this request returns 20 results at a time because the API results are paginated.
GET /api/v4/projects/{id}/labels - Read
Retrieve a project label
Retrieves a specified label for a project.
GET /api/v4/projects/{id}/labels/{name} - Read
List all group labels
Lists all group labels for a specified group.
GET /api/v4/groups/{id}/labels - Read
Retrieve a group label
Retrieves a specified group label.
GET /api/v4/groups/{id}/labels/{name} - Write
Create a project label
Creates a label for a specified project.
POST /api/v4/projects/{id}/labels - Write
Create a group label
Creates a group label.
POST /api/v4/groups/{id}/labels - Destructive
Update an existing label. At least one optional parameter is required. (deprecated)
Deprecated in GitLab 12.4. Use PUT /projects/:id/labels/:name instead.
PUT /api/v4/projects/{id}/labels - Destructive
Delete an existing label (deprecated)
Deprecated in GitLab 12.4. Use DELETE /projects/:id/labels/:name instead.
DELETE /api/v4/projects/{id}/labels - Destructive
Update a project label
Updates a specified label for a project with a different name or color. At least one parameter is required to update the label.
PUT /api/v4/projects/{id}/labels/{name} - Destructive
Delete a project label
Deletes a specified label from a project.
DELETE /api/v4/projects/{id}/labels/{name} - Destructive
Promote a label to a group label (deprecated)
Added in GitLab 12.3 and deprecated in GitLab 12.4. Use PUT /projects/:id/labels/:name/promote instead.
PUT /api/v4/projects/{id}/labels/promote - Destructive
Promote a project label to a group label
Promotes a specified project label to a group label. The label keeps its ID.
PUT /api/v4/projects/{id}/labels/{name}/promote - Destructive
Update a group label
Updates an existing group label. At least one parameter is required to update the group label.
PUT /api/v4/groups/{id}/labels - Destructive
Delete a group label
Deletes a specified group label.
DELETE /api/v4/groups/{id}/labels - Destructive
Update a group label
Updates a specified group label. At least one parameter is required to update the group label.
PUT /api/v4/groups/{id}/labels/{name} - Destructive
Delete a group label
Deletes a specified group label.
DELETE /api/v4/groups/{id}/labels/{name}
Discussions
- Read
List all discussions for an issue
Lists all discussions for a specified issue.
GET /api/v4/projects/{id}/issues/{noteable_id}/discussions - Read
Retrieve a discussion for an issue
Retrieves a specified discussion for an issue.
GET /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id} - Read
List comments in an issue discussion
Lists the comments in a specified issue discussion.
GET /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id}/notes - Read
Retrieve a comment from an issue discussion
Retrieves a specified comment from a issue discussion.
GET /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Read
List all discussions for a snippet
Lists all discussions for a specified snippet.
GET /api/v4/projects/{id}/snippets/{noteable_id}/discussions - Read
Retrieve a discussion for a snippet
Retrieves a specified discussion for a snippet.
GET /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id} - Read
List comments in a snippet discussion
Lists the comments in a specified snippet discussion.
GET /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id}/notes - Read
Retrieve a comment from a snippet discussion
Retrieves a specified comment from a snippet discussion.
GET /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Read
List all discussions for a merge request
Lists all discussions for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions - Read
Retrieve a discussion for a merge request
Retrieves a specified discussion for a merge request.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id} - Read
List comments in a merge request discussion
Lists the comments in a specified merge request discussion.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id}/notes - Read
Retrieve a comment from a merge request discussion
Retrieves a specified comment from a merge request discussion.
GET /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Read
List all discussions for a commit
Lists all discussions for a specified commit.
GET /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions - Read
Retrieve a discussion for a commit
Retrieves a specified discussion for a commit.
GET /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id} - Read
List comments in a commit discussion
Lists the comments in a specified commit discussion.
GET /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id}/notes - Read
Retrieve a comment from a commit discussion
Retrieves a specified comment from a commit discussion.
GET /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Read
List all discussions for an epic
Lists all discussions for a specified epic.
GET /api/v4/groups/{id}/epics/{noteable_id}/discussions - Read
Retrieve a discussion for an epic
Retrieves a specified discussion for an epic.
GET /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id} - Read
List comments in an epic discussion
Lists the comments in a specified epic discussion.
GET /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id}/notes - Read
Retrieve a comment from an epic discussion
Retrieves a specified comment from a epic discussion.
GET /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Write
Create an issue discussion
Creates a discussion for a specified issue. Replies can be added to it later.
POST /api/v4/projects/{id}/issues/{noteable_id}/discussions - Write
Add a comment to an issue discussion
Adds a comment to a specified issue discussion.
POST /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id}/notes - Write
Create a snippet discussion
Creates a discussion for a specified snippet. Replies can be added to it later.
POST /api/v4/projects/{id}/snippets/{noteable_id}/discussions - Write
Add a comment to a snippet discussion
Adds a comment to a specified snippet discussion.
POST /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id}/notes - Write
Create a merge request discussion
Creates a discussion for a specified merge request. Replies can be added to it later.
POST /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions - Write
Add a comment to a merge request discussion
Adds a comment to a specified merge request discussion.
POST /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id}/notes - Write
Create a commit discussion
Creates a discussion for a specified commit. Replies can be added to it later.
POST /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions - Write
Add a comment to a commit discussion
Adds a comment to a specified commit discussion.
POST /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id}/notes - Write
Create an epic discussion
Creates a discussion for a specified epic. Replies can be added to it later.
POST /api/v4/groups/{id}/epics/{noteable_id}/discussions - Write
Add a comment to an epic discussion
Adds a comment to a specified epic discussion.
POST /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id}/notes - Destructive
Resolve or unresolve an issue discussion
Resolves or unresolves a specified issue discussion.
PUT /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id} - Destructive
Update a comment in an issue discussion
Updates or changes the status of a specified comment in a issue discussion.
PUT /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Delete a comment from an issue discussion
Deletes a specified comment from a issue discussion.
DELETE /api/v4/projects/{id}/issues/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Update a comment in a snippet discussion
Updates or changes the status of a specified comment in a snippet discussion.
PUT /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Delete a comment from a snippet discussion
Deletes a specified comment from a snippet discussion.
DELETE /api/v4/projects/{id}/snippets/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Resolve or unresolve a merge request discussion
Resolves or unresolves a specified merge request discussion.
PUT /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id} - Destructive
Update a comment in a merge request discussion
Updates or changes the status of a specified comment in a merge request discussion.
PUT /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Delete a comment from a merge request discussion
Deletes a specified comment from a merge request discussion.
DELETE /api/v4/projects/{id}/merge_requests/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Update a comment in a commit discussion
Updates or changes the status of a specified comment in a commit discussion.
PUT /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Delete a comment from a commit discussion
Deletes a specified comment from a commit discussion.
DELETE /api/v4/projects/{id}/repository/commits/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Resolve or unresolve an epic discussion
Resolves or unresolves a specified epic discussion.
PUT /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id} - Destructive
Update a comment in an epic discussion
Updates or changes the status of a specified comment in a epic discussion.
PUT /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id}/notes/{note_id} - Destructive
Delete a comment from an epic discussion
Deletes a specified comment from a epic discussion.
DELETE /api/v4/groups/{id}/epics/{noteable_id}/discussions/{discussion_id}/notes/{note_id}
Wikis
- Read
List all wiki pages for a group
Lists all wiki pages for a specified group.
GET /api/v4/groups/{id}/wikis - Read
Retrieve a wiki page for a group
Retrieves a specified wiki page for a group.
GET /api/v4/groups/{id}/wikis/{slug} - Read
List all wiki pages for a project
Lists all wiki pages for a specified project.
GET /api/v4/projects/{id}/wikis - Read
Retrieve a wiki page for a project
Retrieves a specified wiki page for a project.
GET /api/v4/projects/{id}/wikis/{slug} - Write
Create a wiki page for a group
Creates a wiki page for a specified group. Requests can define the title, slug, and content.
POST /api/v4/groups/{id}/wikis - Write
Upload an attachment to a group wiki
Uploads a file to the `uploads` directory in a specified group wiki.
POST /api/v4/groups/{id}/wikis/attachments - Write
Create a wiki page for a project
Creates a wiki page for a specified project. Requests can define the title, slug, and content.
POST /api/v4/projects/{id}/wikis - Write
Upload an attachment to a project wiki
Uploads a file to the `uploads` directory in a specified project wiki.
POST /api/v4/projects/{id}/wikis/attachments - Destructive
Update a wiki page for a group
Updates a specified wiki page for a group.
PUT /api/v4/groups/{id}/wikis/{slug} - Destructive
Delete a wiki page for a group
Deletes a specified wiki page from a group.
DELETE /api/v4/groups/{id}/wikis/{slug} - Destructive
Update a wiki page for a project
Updates a specified wiki page for a project.
PUT /api/v4/projects/{id}/wikis/{slug} - Destructive
Delete a wiki page for a project
Deletes a specified wiki page from a project.
DELETE /api/v4/projects/{id}/wikis/{slug}
Web commits
- Read
Retrieve the public signing key
Retrieves the GitLab public key for signing web commits. This feature was introduced in GitLab 17.4.
GET /api/v4/web_commits/public_key
Usage data
- Read
List all Service Ping SQL queries
Lists all raw SQL queries used to compute Service Ping. Administrators only.
GET /api/v4/usage_data/queries - Read
List all non-SQL metrics
Lists all non-SQL metrics data used in the Service ping. Administrators only.
GET /api/v4/usage_data/non_sql_metrics - Read
Retrieve Service Ping payload
Retrieves the Service Ping payload from the application cache as JSON. If no cached payload is available, returns an empty response. Requires a personal access token with the `read_service_ping` scope. Introduced in GitLab 16.9.
GET /api/v4/usage_data/service_ping - Write
Track usage data event
This feature was introduced in GitLab 13.4.
POST /api/v4/usage_data/increment_counter - Write
Track usage data event for the current user
Tracks a unique-user event for the current user in Service Ping.
POST /api/v4/usage_data/increment_unique_users - Write
Track multiple internal GitLab events
Tracks one or more GitLab internal events in a single request. Each event increments Service Ping counters in Redis and is optionally sent to Snowplow. This feature was introduced in GitLab 17.3.
POST /api/v4/usage_data/track_events - Write
Track an internal GitLab event
Tracks a GitLab internal event. This action increments Service Ping counters in Redis and is optionally sent to Snowplow. Introduced in GitLab 16.2.
POST /api/v4/usage_data/track_event
Metrics
- Read
Download metric definitions
Downloads all metric definitions as a single YAML file.
GET /api/v4/usage_data/metric_definitions
Unleash
- Read
Get Unleash features
This endpoint is a no-op and always returns a 200 OK response.
GET /api/v4/feature_flags/unleash/{project_id} - Read
Get a list of features (v2 client support) (deprecated)
Deprecated in GitLab 15.6
GET /api/v4/feature_flags/unleash/{project_id}/features - Read
Get a list of features
Returns feature flags in the Unleash client features format used by GitLab feature flag clients.
GET /api/v4/feature_flags/unleash/{project_id}/client/features - Write
Register Unleash client
This endpoint is a no-op and always returns a 200 OK response.
POST /api/v4/feature_flags/unleash/{project_id}/client/register - Write
Report Unleash client metrics
This endpoint is a no-op and always returns a 200 OK response.
POST /api/v4/feature_flags/unleash/{project_id}/client/metrics
Project topics
- Read
List all topics
Lists all project topics sorted by the number of associated projects.
GET /api/v4/topics - Read
Retrieve a topic
Retrieves a specified project topic.
GET /api/v4/topics/{id} - Write
Create a project topic
Creates a project topic. Administrators only.
POST /api/v4/topics - Destructive
Update a project topic
Updates a specified project topic. Administrators only.
PUT /api/v4/topics/{id} - Destructive
Delete a project topic
Deletes a specified project topic. Administrators only.
DELETE /api/v4/topics/{id} - Destructive
Merge topics
Merges a source topic into a target topic. This action deletes the source topic and moves all assigned projects to the target topic. Administrators only.
POST /api/v4/topics/merge
Terraform
- Read
Retrieve a Terraform state version
Retrieves a specified Terraform state version.
GET /api/v4/projects/{id}/terraform/state/{name}/versions/{serial} - Read
Retrieve a Terraform state
Retrieves a Terraform state by name for a specified project.
GET /api/v4/projects/{id}/terraform/state/{name} - Read
Download the latest version of a module
Downloads the latest version of a specified module. This feature was introduced in GitLab 16.7.
GET /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system} - Read
Download a specific version of a module
This feature was introduced in GitLab 16.7
GET /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version} - Read
List all available versions for a module
Lists all available versions for a specified module.
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/versions - Read
Retrieve download URL for latest module version
Retrieves download URL for latest module version.
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/download - Read
Retrieve latest version for a module
Retrieves latest version for a specified module.
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system} - Read
Get download location for specific version of a module
Download specific version of a module
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/download - Read
Download specific version of a module
Download specific version of a module
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/file - Read
Get details about specific version of a module
Get details about specific version of a module
GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version} - Write
Authorize Terraform state upload
Authorizes uploading a Terraform state for a specified project. This feature was introduced in GitLab 18.5.
POST /api/v4/projects/{id}/terraform/state/{name}/authorize - Destructive
Delete a Terraform state version
Deletes a specified Terraform state version.
DELETE /api/v4/projects/{id}/terraform/state/{name}/versions/{serial} - Destructive
Create or update a Terraform state
Creates or updates a Terraform state for a specified project.
POST /api/v4/projects/{id}/terraform/state/{name} - Destructive
Delete a Terraform state
Deletes a Terraform state for a specified project.
DELETE /api/v4/projects/{id}/terraform/state/{name} - Destructive
Lock a Terraform state
Locks a Terraform state for a specified project.
POST /api/v4/projects/{id}/terraform/state/{name}/lock - Destructive
Unlock a Terraform state
Unlocks a Terraform state for a specified project.
DELETE /api/v4/projects/{id}/terraform/state/{name}/lock - Destructive
Workhorse authorize Terraform Module package file
This feature was introduced in GitLab 13.11
PUT /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file/authorize - Destructive
Upload Terraform Module package file
This feature was introduced in GitLab 13.11
PUT /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file
Tags
- Read
List all project repository tags
Lists all repository tags from a project, sorted by update date and time in descending order.
GET /api/v4/projects/{id}/repository/tags - Read
Retrieve a single repository tag
Retrieves a repository tag with a specified name. This endpoint can be accessed without authentication if the repository is publicly accessible.
GET /api/v4/projects/{id}/repository/tags/{tag_name} - Read
Retrieve X.509 signature of a tag
Retrieves the X.509 signature from a signed tag. Unsigned tags return a `404 Not Found` response.
GET /api/v4/projects/{id}/repository/tags/{tag_name}/signature - Write
Create a tag
Creates a tag in the repository that points to a specified reference.
POST /api/v4/projects/{id}/repository/tags - Destructive
Delete a tag
Deletes a specified repository tag.
DELETE /api/v4/projects/{id}/repository/tags/{tag_name}
Attestations
- Read
List all attestations for a project
Lists all attestations for a specified project and artifact hash. This feature was introduced in GitLab 18.7.
GET /api/v4/projects/{id}/attestations/{subject_digest} - Read
Retrieve an attestation bundle
This feature was introduced in GitLab 18.7
GET /api/v4/projects/{id}/attestations/{attestation_iid}/download
Suggestions
- Destructive
Apply a suggestion to a merge request
Applies a suggested patch in a merge request. You must have the Developer, Maintainer, or Owner role.
PUT /api/v4/suggestions/{id}/apply - Destructive
Apply multiple suggestions to a merge request
Applies multiple suggested patches in a merge request. You must have the Developer, Maintainer, or Owner role.
PUT /api/v4/suggestions/batch_apply
Submodules
- Destructive
Update a submodule reference
Updates a reference for a specified submodule.
PUT /api/v4/projects/{id}/repository/submodules/{submodule}
Snippets
- Read
List all snippets for current user
Lists all snippets for the currently authenticated user.
GET /api/v4/snippets - Read
List all public snippets
Lists all public snippets accessible to the currently authenticated user.
GET /api/v4/snippets/public - Read
List all snippets
Lists all snippets available to the currently authenticated user. Users with Administrator or Auditor access levels can see all snippets (both personal and project). This feature was introduced in GitLab 16.3.
GET /api/v4/snippets/all - Read
Retrieve a snippet
Retrieves a specified snippet.
GET /api/v4/snippets/{id} - Read
Retrieve a raw snippet
Retrieves the raw contents of a specified snippet as plain text
GET /api/v4/snippets/{id}/raw - Read
Retrieve snippet file content
Retrieves the raw file content from a snippet as plain text.
GET /api/v4/snippets/{id}/files/{ref}/{file_path}/raw - Read
Retrieve user agent details for a snippet
Retrieves user agent details for a specified snippet.
GET /api/v4/snippets/{id}/user_agent_detail - Read
List all snippets for a project
Lists all snippets for a specified project.
GET /api/v4/projects/{id}/snippets - Read
Retrieve a project snippet
Retrieves a specified project snippet.
GET /api/v4/projects/{id}/snippets/{snippet_id} - Read
Retrieve a raw project snippet
Retrieves the raw contents of a specified project snippet as plain text
GET /api/v4/projects/{id}/snippets/{snippet_id}/raw - Read
Retrieve snippet repository file content
Retrieves the raw file content from a snippet repository as plain text.
GET /api/v4/projects/{id}/snippets/{snippet_id}/files/{ref}/{file_path}/raw - Read
Retrieve user agent details for a project snippet
Retrieves user agent details for a specified snippet. Available only for administrators.
GET /api/v4/projects/{id}/snippets/{snippet_id}/user_agent_detail - Write
Create a snippet
Creates a snippet.
POST /api/v4/snippets - Write
Create a project snippet
Creates a project snippet. The user must have permission to create snippets.
POST /api/v4/projects/{id}/snippets - Destructive
Update snippet
Updates a specified snippet.
PUT /api/v4/snippets/{id} - Destructive
Delete snippet
Deletes a specified snippet.
DELETE /api/v4/snippets/{id} - Destructive
Update a project snippet
Updates a specified project snippet. The user must have permission to modify snippets. Updates to snippets with multiple files must use the `files` attribute.
PUT /api/v4/projects/{id}/snippets/{snippet_id} - Destructive
Delete a project snippet
Deletes a specified project snippet.
DELETE /api/v4/projects/{id}/snippets/{snippet_id}
Packages: RubyGem
- Read
Download the spec index file
Downloads a RubyGems spec index file (specs.4.8.gz, latest_specs.4.8.gz, or prerelease_specs.4.8.gz) for a project.
GET /api/v4/projects/{id}/packages/rubygems/{file_name} - Read
Download a gemspec file
Downloads a gemspec file in Marshal format for a specified gem version.
GET /api/v4/projects/{id}/packages/rubygems/quick/Marshal.4.8/{file_name} - Read
Download a gem file
Downloads a specified gem file for a project.
GET /api/v4/projects/{id}/packages/rubygems/gems/{file_name} - Read
Retrieve dependencies
Retrieves a list of dependencies for specified gems. The response is a marshalled array of hashes for all versions of the requested gems. Because the response is marshalled, you can store it in a file.
GET /api/v4/projects/{id}/packages/rubygems/api/v1/dependencies - Write
Authorize a gem upload from workhorse
This feature was introduced in GitLab 13.9
POST /api/v4/projects/{id}/packages/rubygems/api/v1/gems/authorize - Write
Upload a gem
Uploads a gem for a specified project.
POST /api/v4/projects/{id}/packages/rubygems/api/v1/gems
Packages: RPM
- Read
Download repository metadata files
This feature was introduced in GitLab 15.7
GET /api/v4/projects/{id}/packages/rpm/repodata/{file_name} - Read
Download RPM package files
This feature was introduced in GitLab 15.7
GET /api/v4/projects/{id}/packages/rpm/{package_file_id}/{file_name} - Write
Upload a RPM package
This feature was introduced in GitLab 15.7
POST /api/v4/projects/{id}/packages/rpm - Write
Authorize package upload from workhorse
This feature was introduced in GitLab 15.7
POST /api/v4/projects/{id}/packages/rpm/authorize
Repositories
- Read
List all repository trees in a project
Lists all repository files and directories in a specified project. This endpoint can be accessed without authentication if the repository is publicly accessible. This command provides essentially the same features as the `git ls-tree` command. Use `with_last_commit` to include the last commit that changed each entry. `with_last_commit` cannot be combined with `recursive`.
GET /api/v4/projects/{id}/repository/tree - Read
Retrieve raw blob content
Retrieves the raw file contents for a blob, by blob SHA. This endpoint can be accessed without authentication if the repository is publicly accessible.
GET /api/v4/projects/{id}/repository/blobs/{sha}/raw - Read
Retrieve a blob from a repository
Retrieves information, such as size and content, about blobs in a repository. Blob content is Base64 encoded. This endpoint can be accessed without authentication, if the repository is publicly accessible.
GET /api/v4/projects/{id}/repository/blobs/{sha} - Read
Retrieve file archive from a repository
Retrieves the file archive of a specified repository. This endpoint can be accessed without authentication if the repository is publicly accessible. For GitLab.com users, this endpoint has a rate limit threshold of 5 requests per minute.
GET /api/v4/projects/{id}/repository/archive - Read
Compare branches, tags, or commits
Compares branches, tags, or commits. Retrieves the differences between two branches, tags, or commits in a specified project.
GET /api/v4/projects/{id}/repository/compare - Read
Retrieve repository health statistics
Retrieves statistics related to the health of a project repository. This endpoint is rate-limited to 5 requests/hour per project when `generate` is `true`. Available only to users with push access to the repository.
GET /api/v4/projects/{id}/repository/health - Read
Retrieve contributors metrics
Retrieves a list of contributors to a specified repository.
GET /api/v4/projects/{id}/repository/contributors - Read
Retrieve a merge base
Retrieves the merge base for two specified commits.
GET /api/v4/projects/{id}/repository/merge_base - Read
Get contents of multiple files in a single request
Each blob is truncated to the first 1 MB; the `truncated` field indicates when this happens.
POST /api/v4/projects/{id}/repository/blobs/batch - Read
List files changed between two commits
Returns the path, change status, and file modes for every path that differs between two refs.
GET /api/v4/projects/{id}/repository/changed_paths - Read
Retrieve diverging commit counts between two refs
Retrieves the number of commits by which the `to` ref is ahead of and behind the `from` ref.
GET /api/v4/projects/{id}/repository/diverging_commits - Read
Get diff statistics between two commits
Returns the number of added and deleted lines for every file that differs between two refs.
GET /api/v4/projects/{id}/repository/diff_stats - Read
Generate changelog data
Generates changelog data based on commits in a repository, without committing them to a changelog file. Works exactly like `POST /projects/:id/repository/changelog`, except the changelog data is not committed to any changelog file.
GET /api/v4/projects/{id}/repository/changelog - Write
Add changelog data to file
Adds changelog data to file.
POST /api/v4/projects/{id}/repository/changelog
Remote mirrors
- Read
List all remote mirrors for a project
Lists all remote mirrors for a specified project.
GET /api/v4/projects/{id}/remote_mirrors - Read
Retrieve a remote mirror for a project
Retrieves a specified remote mirror for a project.
GET /api/v4/projects/{id}/remote_mirrors/{mirror_id} - Read
Retrieve a public key for a remote mirror
Retrieves the public key of a specified remote mirror that uses SSH authentication.
GET /api/v4/projects/{id}/remote_mirrors/{mirror_id}/public_key - Write
Create a push mirror
Creates a push mirror.
POST /api/v4/projects/{id}/remote_mirrors - Write
Force push mirror update
Forces an update to a push mirror.
POST /api/v4/projects/{id}/remote_mirrors/{mirror_id}/sync - Destructive
Update a remote mirror in a project
Updates the configuration or operational status of a specified remote mirror.
PUT /api/v4/projects/{id}/remote_mirrors/{mirror_id} - Destructive
Delete a remote mirror from a project
Deletes a specified remote mirror from a project.
DELETE /api/v4/projects/{id}/remote_mirrors/{mirror_id}
Releases
- Read
List all release links
Lists all assets as links from a release.
GET /api/v4/projects/{id}/releases/{tag_name}/assets/links - Read
Retrieve a release link
Retrieves a specified asset as a link from a release.
GET /api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id} - Read
List all releases in a group
Lists all releases for projects in a specified group.
GET /api/v4/groups/{id}/releases - Read
List all releases in a project
Lists all releases for a specified project. Sorted by `released_at`.
GET /api/v4/projects/{id}/releases - Read
Retrieve a release by tag name
Retrieves a release with a specified tag name.
GET /api/v4/projects/{id}/releases/{tag_name} - Read
Download a project release asset file
This feature was introduced in GitLab 15.4.
GET /api/v4/projects/{id}/releases/{tag_name}/downloads/{direct_asset_path} - Read
Get the latest project release
This feature was introduced in GitLab 15.4.
GET /api/v4/projects/{id}/releases/permalink/latest - Read
Get the latest project release
This feature was introduced in GitLab 15.4.
GET /api/v4/projects/{id}/releases/permalink/latest/{suffix_path} - Write
Create a release link
Creates an asset link for a specified release.
POST /api/v4/projects/{id}/releases/{tag_name}/assets/links - Write
Create a release
Creates a release. Developer level access to the project is required to create a release.
POST /api/v4/projects/{id}/releases - Write
Generate release evidence
Generates an evidence for an existing release.
POST /api/v4/projects/{id}/releases/{tag_name}/evidence - Destructive
Update a release link
Updates a specified asset link for a release.
PUT /api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id} - Destructive
Delete a release link
Deletes a specified asset link from a release.
DELETE /api/v4/projects/{id}/releases/{tag_name}/assets/links/{link_id} - Destructive
Update a release
Updates a release. Developer level access to the project is required to update a release.
PUT /api/v4/projects/{id}/releases/{tag_name} - Destructive
Delete a release
Delete a release. Deleting a release doesn't delete the associated tag. Requires at least the Developer role for the project. This feature was introduced in GitLab 11.7.
DELETE /api/v4/projects/{id}/releases/{tag_name}
Packages: PyPi
- Read
Download a package file from a group
This feature was introduced in GitLab 13.12
GET /api/v4/groups/{id}/-/packages/pypi/files/{sha256}/{file_identifier} - Read
List all packages for a group
Lists all packages for a specified group in an HTML file.
GET /api/v4/groups/{id}/-/packages/pypi/simple - Read
The PyPi Simple Group Package Endpoint
This feature was introduced in GitLab 12.10
GET /api/v4/groups/{id}/-/packages/pypi/simple/{package_name} - Read
The PyPi package download endpoint
This feature was introduced in GitLab 12.10
GET /api/v4/projects/{id}/packages/pypi/files/{sha256}/{file_identifier} - Read
List all packages for a project
Lists all packages for a specified project in an HTML file.
GET /api/v4/projects/{id}/packages/pypi/simple - Read
The PyPi Simple Project Package Endpoint
This feature was introduced in GitLab 12.10
GET /api/v4/projects/{id}/packages/pypi/simple/{package_name} - Write
Upload a package
Uploads a PyPI package for a specified project.
POST /api/v4/projects/{id}/packages/pypi - Write
Authorize the PyPi package upload from workhorse
This feature was introduced in GitLab 12.10
POST /api/v4/projects/{id}/packages/pypi/authorize
Protected tags
- Read
List all protected tags
Lists all protected tags for a specified project.
GET /api/v4/projects/{id}/protected_tags - Read
Retrieve a protected tag or wildcard protected tag
Retrieves a specified protected tag or wildcard protected tag.
GET /api/v4/projects/{id}/protected_tags/{name} - Write
Protect a repository tag
Protects a specified repository tag using a wildcard protected tag.
POST /api/v4/projects/{id}/protected_tags - Destructive
Unprotect repository tags
Unprotects a specified protected tag or wildcard protected tag.
DELETE /api/v4/projects/{id}/protected_tags/{name}
Project templates
- Read
List all templates of a particular type
Lists all templates of a specified type for a project.
GET /api/v4/projects/{id}/templates/{type} - Read
Retrieve a template of a particular type
Retrieves a template of a specified type for a project.
GET /api/v4/projects/{id}/templates/{type}/{name}
Project snapshots
- Read
Download snapshot of a Git repository
Downloads snapshot of a Git repository.
GET /api/v4/projects/{id}/snapshot
Packages
- Read
List all packages for a project
Lists all packages for a specified project. All package types are included in results. Unauthenticated requests return only packages of public projects. By default, packages with `default`, `deprecated`, and `error` status are returned. Use the `status` parameter to view other packages.
GET /api/v4/projects/{id}/packages - Read
Retrieve a project package
Retrieves a specified project package. Only packages with status `default` or `deprecated` are returned.
GET /api/v4/projects/{id}/packages/{package_id} - Read
List all package pipelines
Lists all pipelines for a specified package. The results are sorted by `id` in descending order. The results are paginated and return up to 20 records per page. This feature was introduced in GitLab 16.1.
GET /api/v4/projects/{id}/packages/{package_id}/pipelines - Read
List all package files
Lists all package files for a specified package.
GET /api/v4/projects/{id}/packages/{package_id}/package_files - Read
Download a package file
This feature was introduced in GitLab 18.4
GET /api/v4/projects/{id}/packages/{package_id}/package_files/{package_file_id}/download - Read
Download the maven package file for the instance
This feature was introduced in GitLab 11.6
GET /api/v4/packages/maven/{path}/{file_name} - Read
Download the maven package file for a group
This feature was introduced in GitLab 11.7
GET /api/v4/groups/{id}/-/packages/maven/{path}/{file_name} - Read
Download the maven package file for a project
This feature was introduced in GitLab 11.3
GET /api/v4/projects/{id}/packages/maven/{path}/{file_name} - Read
List all packages for a group
Lists all packages for a specified group. When accessed without authentication, only packages of public projects are returned. By default, packages with `default`, `deprecated`, and `error` status are returned. Use the `status` parameter to view other packages.
GET /api/v4/groups/{id}/packages - Read
List
Get all tagged versions for a given Go module.See `go help goproxy`, GET $GOPROXY/<module>/@v/list. This feature was introduced in GitLab 13.1.
GET /api/v4/projects/{id}/packages/go/{module_name}/@v/list - Read
Version metadata
Get all tagged versions for a given Go module.See `go help goproxy`, GET $GOPROXY/<module>/@v/<version>.info. This feature was introduced in GitLab 13.1
GET /api/v4/projects/{id}/packages/go/{module_name}/@v/{module_version}.info - Read
Download module file
Get the module file of a given module version.See `go help goproxy`, GET $GOPROXY/<module>/@v/<version>.mod. This feature was introduced in GitLab 13.1.
GET /api/v4/projects/{id}/packages/go/{module_name}/@v/{module_version}.mod - Read
Download module source
Get a zip of the source of the given module version.See `go help goproxy`, GET $GOPROXY/<module>/@v/<version>.zip. This feature was introduced in GitLab 13.1.
GET /api/v4/projects/{id}/packages/go/{module_name}/@v/{module_version}.zip - Read
Download package file
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{file_name} - Read
Download package file
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{path}/{file_name} - Destructive
Delete a project package
Deletes a specified project package.
DELETE /api/v4/projects/{id}/packages/{package_id} - Destructive
Delete a package file
Deletes a specified package file.
DELETE /api/v4/projects/{id}/packages/{package_id}/package_files/{package_file_id} - Destructive
Upload the maven package file
This feature was introduced in GitLab 11.3
PUT /api/v4/projects/{id}/packages/maven/{path}/{file_name} - Destructive
Workhorse authorize the maven package file upload
This feature was introduced in GitLab 11.3
PUT /api/v4/projects/{id}/packages/maven/{path}/{file_name}/authorize - Destructive
Workhorse authorize generic package file
This feature was introduced in GitLab 13.5
PUT /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{file_name}/authorize - Destructive
Workhorse authorize generic package file
This feature was introduced in GitLab 13.5
PUT /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{path}/{file_name}/authorize - Destructive
Upload package file
This feature was introduced in GitLab 13.5
PUT /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{file_name} - Destructive
Upload package file
This feature was introduced in GitLab 13.5
PUT /api/v4/projects/{id}/packages/generic/{package_name}/{package_version}/{path}/{file_name}
Projects job token scope
- Read
Retrieve the CI/CD job token access settings for a project
Retrieves the CI/CD job token access settings (job token scope) of a specified project.
GET /api/v4/projects/{id}/job_token_scope - Read
List all projects in a CI/CD job token allowlist
Lists all projects in the CI/CD job token allowlist of a specified project.
GET /api/v4/projects/{id}/job_token_scope/allowlist - Read
List all groups in a CI/CD job token allowlist
Lists all groups in the CI/CD job token allowlist of a specified project.
GET /api/v4/projects/{id}/job_token_scope/groups_allowlist - Write
Update the CI/CD job token access settings for a project
Updates the **Authorized groups and projects** setting (job token scope) of a specified project.
PATCH /api/v4/projects/{id}/job_token_scope - Write
Add a project to a CI/CD job token allowlist
Adds a project to the CI/CD job token allowlist of a specified project.
POST /api/v4/projects/{id}/job_token_scope/allowlist - Write
Add a group to a CI/CD job token allowlist
Adds a group to the CI/CD job token allowlist of a specified project.
POST /api/v4/projects/{id}/job_token_scope/groups_allowlist - Destructive
Delete a group from a CI/CD job token allowlist
Deletes a group from the CI/CD job token allowlist of a specified project.
DELETE /api/v4/projects/{id}/job_token_scope/groups_allowlist/{target_group_id} - Destructive
Delete a project from a CI/CD job token allowlist
Deletes a project from the CI/CD job token allowlist of a specified project.
DELETE /api/v4/projects/{id}/job_token_scope/allowlist/{target_project_id}
Project import
- Read
Retrieve the status of a project import
Retrieves the status of the most recent import for a specified project.
GET /api/v4/projects/{id}/import - Read
Retrieve the status of a project resource import
Retrieves the status of the most recent relation import for a specified project. Because only one relation import can be scheduled at a time, you can use this endpoint to check whether the previous import completed successfully. This feature was introduced in GitLab 16.11.
GET /api/v4/projects/{id}/relation-imports - Read
Retrieve the status of a project export
Retrieves the status of the most recent export for a specified project.
GET /api/v4/projects/{id}/export - Read
Download a project export
Downloads the most recent export of a specified project.
GET /api/v4/projects/{id}/export/download - Read
Download a relations export for a project
Downloads a project relations export file.
GET /api/v4/projects/{id}/export_relations/download - Read
Retrieve the status of an relations export for a project
Retrieves the status of a relations export for a project.
GET /api/v4/projects/{id}/export_relations/status - Write
Workhorse authorize the project import upload
This feature was introduced in GitLab 12.9
POST /api/v4/projects/import/authorize - Write
Import a project from a local archive
Imports a project from a local archive.
POST /api/v4/projects/import - Write
Import a project from a Git URL
Imports a project from a specified Git URL. This feature was introduced in GitLab 18.10.
POST /api/v4/projects/{id}/import/git - Write
Import a project from a remote archive
Imports a project from a remote archive.
POST /api/v4/projects/remote-import - Write
Authorize project relation import
Authorizes uploading a project relation import file. This feature was introduced in GitLab 16.11.
POST /api/v4/projects/import-relation/authorize - Write
Import project resources
Imports project resources included with a project archive. The type of item to import is controlled by the `relation` attribute. Skips items that were previously imported. This feature was introduced in GitLab 16.11.
POST /api/v4/projects/import-relation - Write
Import a project from an AWS S3 bucket
Imports a project from an archive stored in a specified AWS S3 bucket.
POST /api/v4/projects/remote-import-s3 - Write
Export a project
Exports a project. Use the `upload` hash parameter to upload the exported project to a web server or any S3-compatible platform.
POST /api/v4/projects/{id}/export - Write
Schedule a relations export for a project
Schedules a relations export for a specified project.
POST /api/v4/projects/{id}/export_relations - Write
Receive a GitHub webhook delivery for an OAuth-connected repository
Verifies the webhook signature and, once available, triggers repository reconciliation.
POST /api/v4/projects/{id}/github/webhooks - Write
Import a repository from GitHub
Imports a repository from GitHub to GitLab.
POST /api/v4/import/github - Write
Import repository from Bitbucket Server
Imports a repository from Bitbucket Server to GitLab. The Bitbucket Project Key is only used for finding the repository in Bitbucket. You must specify a `target_namespace` if you want to import the repository to a GitLab group.
POST /api/v4/import/bitbucket_server - Write
Import repository from Bitbucket Cloud
Imports a repository from Bitbucket Cloud to GitLab. Prerequisites: - The prerequisites for Bitbucket Cloud importer. This feature was introduced in GitLab 17.0.
POST /api/v4/import/bitbucket - Destructive
Cancel a GitHub project import
Cancels an in-progress import of a GitHub project to GitLab.
POST /api/v4/import/github/cancel
Events
- Read
List all visible events for a project
Lists all visible events for a specified project. When a push exceeds the Push event activities limit, a single bulk push event is returned instead of individual commit events. Bulk push events have limited commit details: `commit_count` is `0`, `ref_count` shows the number of refs pushed, and individual commit attributes are `null`.
GET /api/v4/projects/{id}/events - Read
List all events
Lists all events for the authenticated user. Does not return events associated with epics or merge requests. Returns bulk push events with limited commit details.
GET /api/v4/events - Read
Retrieve contribution events for a user
Retrieves the contribution events for a specified user. Does not return events associated with epics or merge requests. Returns bulk push events with limited commit details.
GET /api/v4/users/{id}/events
Packages: Debian
- Read
List all Debian project distributions
Lists all Debian distributions for a specified project.
GET /api/v4/projects/{id}/debian_distributions - Read
Retrieve a Debian project distribution
Retrieves a specified Debian project distribution for a project.
GET /api/v4/projects/{id}/debian_distributions/{codename} - Read
Retrieve a Debian project distribution key
Retrieves a specified Debian project distribution key for a project.
GET /api/v4/projects/{id}/debian_distributions/{codename}/key.asc - Read
List all Debian group distributions
Lists all Debian distributions for a specified group.
GET /api/v4/groups/{id}/-/debian_distributions - Read
Retrieve a Debian group distribution
Retrieves a specified Debian group distribution for a group.
GET /api/v4/groups/{id}/-/debian_distributions/{codename} - Read
Retrieve a Debian group distribution key
Retrieves a specified Debian group distribution key for a group.
GET /api/v4/groups/{id}/-/debian_distributions/{codename}/key.asc - Read
The Release file signature
This feature was introduced in GitLab 13.5
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/Release.gpg - Read
The unsigned Release file
This feature was introduced in GitLab 13.5
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/Release - Read
The signed Release file
This feature was introduced in GitLab 13.5
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/InRelease - Read
The installer (udeb) binary files index
This feature was introduced in GitLab 15.4
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/debian-installer/binary-{architecture}/Packages - Read
The installer (udeb) binary files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/debian-installer/binary-{architecture}/by-hash/SHA256/{file_sha256} - Read
The source files index
This feature was introduced in GitLab 15.4
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/source/Sources - Read
The source files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/source/by-hash/SHA256/{file_sha256} - Read
The binary files index
This feature was introduced in GitLab 13.5
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/binary-{architecture}/Packages - Read
The binary files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/groups/{id}/-/packages/debian/dists/{distribution}/{component}/binary-{architecture}/by-hash/SHA256/{file_sha256} - Read
Download Debian package
This feature was introduced in GitLab 14.2
GET /api/v4/groups/{id}/-/packages/debian/pool/{distribution}/{project_id}/{letter}/{package_name}/{package_version}/{file_name} - Read
The Release file signature
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/Release.gpg - Read
The unsigned Release file
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/Release - Read
The signed Release file
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/InRelease - Read
The installer (udeb) binary files index
This feature was introduced in GitLab 15.4
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/debian-installer/binary-{architecture}/Packages - Read
The installer (udeb) binary files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/debian-installer/binary-{architecture}/by-hash/SHA256/{file_sha256} - Read
The source files index
This feature was introduced in GitLab 15.4
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/source/Sources - Read
The source files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/source/by-hash/SHA256/{file_sha256} - Read
The binary files index
This feature was introduced in GitLab 13.5
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/binary-{architecture}/Packages - Read
The binary files index by hash
This feature was introduced in GitLab 15.4
GET /api/v4/projects/{id}/packages/debian/dists/{distribution}/{component}/binary-{architecture}/by-hash/SHA256/{file_sha256} - Read
Download a Debian package file
Downloads a specified Debian package file for a project.
GET /api/v4/projects/{id}/packages/debian/pool/{distribution}/{letter}/{package_name}/{package_version}/{file_name} - Write
Create a Debian project distribution
Creates a Debian project distribution for a specified project.
POST /api/v4/projects/{id}/debian_distributions - Write
Create a Debian group distribution
Creates a Debian group distribution for a specified group.
POST /api/v4/groups/{id}/-/debian_distributions - Destructive
Update a Debian project distribution
Updates a specified Debian project distribution for a project.
PUT /api/v4/projects/{id}/debian_distributions/{codename} - Destructive
Delete a Debian project distribution
Deletes a specified Debian project distribution for a project.
DELETE /api/v4/projects/{id}/debian_distributions/{codename} - Destructive
Update a Debian group distribution
Updates a specified Debian group distribution for a group.
PUT /api/v4/groups/{id}/-/debian_distributions/{codename} - Destructive
Delete a Debian group distribution
Deletes a specified Debian group distribution for a group.
DELETE /api/v4/groups/{id}/-/debian_distributions/{codename} - Destructive
Upload a Debian package file
Uploads a Debian package file for a specified project.
PUT /api/v4/projects/{id}/packages/debian/{file_name} - Destructive
Authorize Debian package upload
This feature was introduced in GitLab 13.5
PUT /api/v4/projects/{id}/packages/debian/{file_name}/authorize
Container registry
- Read
List all registry repositories for a project
Lists all registry repositories for a specified project. Responses are paginated and return 20 results by default.
GET /api/v4/projects/{id}/registry/repositories - Read
List all registry repository tags for a project
Lists all tags for a specified registry repository. Responses are paginated and return 20 results by default.
GET /api/v4/projects/{id}/registry/repositories/{repository_id}/tags - Read
Retrieve details of a registry repository tag
Retrieves details of a specified registry repository tag.
GET /api/v4/projects/{id}/registry/repositories/{repository_id}/tags/{tag_name} - Read
List all registry repositories for a group
Lists all registry repositories for a specified group.
GET /api/v4/groups/{id}/registry/repositories - Read
Retrieve details of a container registry repository
Retrieves details of a specified container registry repository.
GET /api/v4/registry/repositories/{id} - Write
Receives notifications from the container registry when an operation occurs
This feature was introduced in GitLab 12.10
POST /api/v4/container_registry_event/events - Destructive
Delete registry repository
Deletes a specified repository in the registry. This operation is executed asynchronously and might take some time to execute.
DELETE /api/v4/projects/{id}/registry/repositories/{repository_id} - Destructive
Delete multiple registry repository tags
Deletes multiple registry repository tags based on the specified criteria.
DELETE /api/v4/projects/{id}/registry/repositories/{repository_id}/tags - Destructive
Delete a registry repository tag
Deletes a specified container registry repository tag.
DELETE /api/v4/projects/{id}/registry/repositories/{repository_id}/tags/{tag_name}
Clusters
- Read
List all clusters in a project
Lists all clusters in a specified project.
GET /api/v4/projects/{id}/clusters - Read
Retrieve a cluster from a project
Retrieves a specified cluster in a project.
GET /api/v4/projects/{id}/clusters/{cluster_id} - Read
List all group clusters
Lists all group clusters for a specified group.
GET /api/v4/groups/{id}/clusters - Read
Retrieve a group cluster
Retrieves a specified group cluster.
GET /api/v4/groups/{id}/clusters/{cluster_id} - Read
List all certificate-based clusters
Lists all certificate-based clusters associated with a project. This feature was introduced in GitLab 17.9.
GET /api/v4/discover-cert-based-clusters - Read
List all instance clusters
Lists all instance clusters for the instance.
GET /api/v4/admin/clusters - Read
Retrieve a single instance cluster
Retrieves a specified instance cluster.
GET /api/v4/admin/clusters/{cluster_id} - Write
Add a cluster to a project
Adds a cluster to a specified project.
POST /api/v4/projects/{id}/clusters/user - Write
Create a group cluster
Creates a group cluster for a specified group by adding an existing Kubernetes cluster.
POST /api/v4/groups/{id}/clusters/user - Write
Create an instance cluster
Creates an instance cluster by adding an existing Kubernetes cluster.
POST /api/v4/admin/clusters/add - Destructive
Update a cluster in a project
Updates a cluster in a specified project.
PUT /api/v4/projects/{id}/clusters/{cluster_id} - Destructive
Delete cluster from a project
Deletes a specified cluster from a project. Does not remove existing resources in the connected Kubernetes cluster.
DELETE /api/v4/projects/{id}/clusters/{cluster_id} - Destructive
Update a group cluster
Updates a specified group cluster.
PUT /api/v4/groups/{id}/clusters/{cluster_id} - Destructive
Delete a group cluster
Deletes a specified group cluster. Does not remove existing resources in the connected Kubernetes cluster.
DELETE /api/v4/groups/{id}/clusters/{cluster_id} - Destructive
Update an instance cluster
Updates an existing instance cluster.
PUT /api/v4/admin/clusters/{cluster_id} - Destructive
Delete instance cluster
Deletes an existing instance cluster. Does not remove existing resources in the connected Kubernetes cluster.
DELETE /api/v4/admin/clusters/{cluster_id}
GitLab Pages
- Read
List all Pages domains
Lists all Pages domains on the instance. You must have administrator access to the instance.
GET /api/v4/pages/domains - Read
List all Pages domains in a project
Lists all Pages domains in a specified project. You must have permissions to view Pages domains.
GET /api/v4/projects/{id}/pages/domains - Read
Retrieve a Pages domain
Retrieves a Pages domain from a specified project. You must have permissions to view Pages domains.
GET /api/v4/projects/{id}/pages/domains/{domain} - Read
Retrieve Pages settings for a project
Retrieves Pages settings for a specified project. You must have the Maintainer or Owner role for the project.
GET /api/v4/projects/{id}/pages - Write
Create Pages domain
Creates a Pages domain in a specified project. You must have permissions to create Pages domains.
POST /api/v4/projects/{id}/pages/domains - Write
Update Pages settings for a project
Updates Pages settings for a specified project. You must have the Maintainer or Owner role for the project.
PATCH /api/v4/projects/{id}/pages - Destructive
Update Pages domain
Updates a specified Pages domain in a project. You must have permissions to change an existing Pages domain.
PUT /api/v4/projects/{id}/pages/domains/{domain} - Destructive
Delete Pages domain
Deletes a specified Pages domain in a project.
DELETE /api/v4/projects/{id}/pages/domains/{domain} - Destructive
Verify Pages domain
Verifies a specified Pages domain in a project. You must have permissions to update Pages domains.
PUT /api/v4/projects/{id}/pages/domains/{domain}/verify - Destructive
Unpublish Pages
Unpublishes Pages from a specified project. You must have the Maintainer or Owner role for the project.
DELETE /api/v4/projects/{id}/pages
Offline transfers
- Read
List all offline transfer exports
Lists all offline transfer exports. For more information, see https://docs.gitlab.com/user/group/import/offline_transfer_migrations/
GET /api/v4/offline_exports - Read
Get offline transfer export details
Retrieves details of an offline transfer export. For more information, see https://docs.gitlab.com/user/group/import/offline_transfer_migrations/
GET /api/v4/offline_exports/{id} - Write
Start a new offline transfer export
Initiates a new offline transfer export. For more information, see https://docs.gitlab.com/user/group/import/offline_transfer_migrations/
POST /api/v4/offline_exports - Write
Start a new offline transfer import
Initiates a new offline transfer import from object storage. For more information, see https://docs.gitlab.com/user/group/import/offline_transfer_migrations/
POST /api/v4/offline_imports
Packages: NuGet
- Read
The NuGet V3 Feed Service Index
This feature was introduced in GitLab 12.6
GET /api/v4/projects/{id}/packages/nuget/index - Read
The NuGet Symbol File Download Endpoint
This feature was introduced in GitLab 16.7
GET /api/v4/projects/{id}/packages/nuget/symbolfiles/{file_name}/{signature}/{same_file_name} - Read
The NuGet V2 Feed Service Index
This feature was introduced in GitLab 16.2
GET /api/v4/projects/{id}/packages/nuget/v2 - Read
The NuGet V2 Feed Package $metadata endpoint
This feature was introduced in GitLab 16.3
GET /api/v4/projects/{id}/packages/nuget/v2/$metadata - Read
The NuGet Metadata Service - Package name level
This feature was introduced in GitLab 12.8
GET /api/v4/projects/{id}/packages/nuget/metadata/{package_name}/index - Read
The NuGet Metadata Service - Package name and version level
This feature was introduced in GitLab 12.8
GET /api/v4/projects/{id}/packages/nuget/metadata/{package_name}/{package_version} - Read
The NuGet Search Service
This feature was introduced in GitLab 12.8
GET /api/v4/projects/{id}/packages/nuget/query - Read
The NuGet Content Service - index request
This feature was introduced in GitLab 12.8
GET /api/v4/projects/{id}/packages/nuget/download/{package_name}/index - Read
The NuGet Content Service - content request
This feature was introduced in GitLab 12.8
GET /api/v4/projects/{id}/packages/nuget/download/{package_name}/{package_version}/{package_filename} - Read
The NuGet V2 Feed Find Packages by ID endpoint
This feature was introduced in GitLab 16.4
GET /api/v4/projects/{project_id}/packages/nuget/v2/FindPackagesById() - Read
The NuGet V2 Feed Enumerate Packages endpoint
This feature was introduced in GitLab 16.4
GET /api/v4/projects/{project_id}/packages/nuget/v2/Packages() - Read
The NuGet V2 Feed Single Package Metadata endpoint
This feature was introduced in GitLab 16.4
GET /api/v4/projects/{project_id}/packages/nuget/v2/Packages(Id='{package_name}',Version='{package_version}') - Read
The NuGet V3 Feed Service Index
This feature was introduced in GitLab 12.6
GET /api/v4/groups/{id}/-/packages/nuget/index - Read
The NuGet Symbol File Download Endpoint
This feature was introduced in GitLab 16.7
GET /api/v4/groups/{id}/-/packages/nuget/symbolfiles/{file_name}/{signature}/{same_file_name} - Read
The NuGet V2 Feed Service Index
This feature was introduced in GitLab 16.2
GET /api/v4/groups/{id}/-/packages/nuget/v2 - Read
The NuGet V2 Feed Package $metadata endpoint
This feature was introduced in GitLab 16.3
GET /api/v4/groups/{id}/-/packages/nuget/v2/$metadata - Read
The NuGet Metadata Service - Package name level
This feature was introduced in GitLab 12.8
GET /api/v4/groups/{id}/-/packages/nuget/metadata/{package_name}/index - Read
The NuGet Metadata Service - Package name and version level
This feature was introduced in GitLab 12.8
GET /api/v4/groups/{id}/-/packages/nuget/metadata/{package_name}/{package_version} - Read
The NuGet Search Service
This feature was introduced in GitLab 12.8
GET /api/v4/groups/{id}/-/packages/nuget/query - Destructive
Upload a NuGet v2 package file for a project
Uploads a NuGet v2 package file for a specified project.
PUT /api/v4/projects/{id}/packages/nuget/v2 - Destructive
Upload a NuGet v3 package file for a project
Uploads a NuGet v3 package file for a specified project.
PUT /api/v4/projects/{id}/packages/nuget - Destructive
The NuGet Package Authorize endpoint
This feature was introduced in GitLab 14.1
PUT /api/v4/projects/{id}/packages/nuget/authorize - Destructive
Upload a NuGet symbol package file
Uploads a specified NuGet symbol package file (`.snupkg`) for a project.
PUT /api/v4/projects/{id}/packages/nuget/symbolpackage - Destructive
The NuGet Symbol Package Authorize endpoint
This feature was introduced in GitLab 14.1
PUT /api/v4/projects/{id}/packages/nuget/symbolpackage/authorize - Destructive
The NuGet Package Delete endpoint
This feature was introduced in GitLab 16.5
DELETE /api/v4/projects/{id}/packages/nuget/{package_name}/{package_version} - Destructive
The NuGet V2 Feed Package Authorize endpoint
This feature was introduced in GitLab 16.2
PUT /api/v4/projects/{id}/packages/nuget/v2/authorize
Packages: NPM
- Read
Get all tags for a given NPM package
This feature was introduced in GitLab 12.7
GET /api/v4/projects/{id}/packages/npm/-/package/{package_name}/dist-tags - Read
Download the NPM tarball
This feature was introduced in GitLab 11.8
GET /api/v4/projects/{id}/packages/npm/{package_name}/-/{file_name} - Read
NPM registry metadata endpoint
This feature was introduced in GitLab 11.8
GET /api/v4/projects/{id}/packages/npm/{package_name} - Read
Get all tags for a given NPM package
This feature was introduced in GitLab 12.7
GET /api/v4/packages/npm/-/package/{package_name}/dist-tags - Read
NPM registry metadata endpoint
This feature was introduced in GitLab 11.8
GET /api/v4/packages/npm/{package_name} - Read
Get all tags for a given NPM package
This feature was introduced in GitLab 12.7
GET /api/v4/groups/{id}/-/packages/npm/-/package/{package_name}/dist-tags - Read
NPM registry metadata endpoint
This feature was introduced in GitLab 11.8
GET /api/v4/groups/{id}/-/packages/npm/{package_name} - Write
NPM registry bulk advisory endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/projects/{id}/packages/npm/-/npm/v1/security/advisories/bulk - Write
NPM registry quick audit endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/projects/{id}/packages/npm/-/npm/v1/security/audits/quick - Write
NPM registry bulk advisory endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/packages/npm/-/npm/v1/security/advisories/bulk - Write
NPM registry quick audit endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/packages/npm/-/npm/v1/security/audits/quick - Write
NPM registry bulk advisory endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/groups/{id}/-/packages/npm/-/npm/v1/security/advisories/bulk - Write
NPM registry quick audit endpoint
This feature was introduced in GitLab 15.6
POST /api/v4/groups/{id}/-/packages/npm/-/npm/v1/security/audits/quick - Destructive
Create or Update the given tag for the given NPM package and version
This feature was introduced in GitLab 12.7
PUT /api/v4/projects/{id}/packages/npm/-/package/{package_name}/dist-tags/{tag} - Destructive
Deletes the given tag
This feature was introduced in GitLab 12.7
DELETE /api/v4/projects/{id}/packages/npm/-/package/{package_name}/dist-tags/{tag} - Destructive
Create or deprecate an NPM package
Creates or deprecates an NPM package for a specified project. Deprecate support was added in GitLab 16.0.
PUT /api/v4/projects/{id}/packages/npm/{package_name} - Destructive
Create or Update the given tag for the given NPM package and version
This feature was introduced in GitLab 12.7
PUT /api/v4/packages/npm/-/package/{package_name}/dist-tags/{tag} - Destructive
Deletes the given tag
This feature was introduced in GitLab 12.7
DELETE /api/v4/packages/npm/-/package/{package_name}/dist-tags/{tag} - Destructive
Create or Update the given tag for the given NPM package and version
This feature was introduced in GitLab 12.7
PUT /api/v4/groups/{id}/-/packages/npm/-/package/{package_name}/dist-tags/{tag} - Destructive
Deletes the given tag
This feature was introduced in GitLab 12.7
DELETE /api/v4/groups/{id}/-/packages/npm/-/package/{package_name}/dist-tags/{tag}
Mobile push subscriptions
- Write
Register a mobile device for push notifications
Idempotently registers the calling user's device token for APNs push notifications. Re-registering an existing token refreshes its attributes; a token previously owned by another user is reassigned to the calling user.
POST /api/v4/user/push_subscriptions - Destructive
Unregister a mobile device from push notifications
Removes the calling user's push subscriptions for the given device token.
DELETE /api/v4/user/push_subscriptions
ML Model Registry
- Read
Download an ml_model package file
This feature was introduced in GitLab 16.8
GET /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{file_name} - Read
Download an ml_model package file
This feature was introduced in GitLab 16.8
GET /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{path}/{file_name} - Destructive
Workhorse authorize model package file
Introduced in GitLab 16.8
PUT /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{file_name}/authorize - Destructive
Workhorse authorize model package file
Introduced in GitLab 16.8
PUT /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{path}/{file_name}/authorize - Destructive
Workhorse upload model package file
Introduced in GitLab 16.8
PUT /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{file_name} - Destructive
Workhorse upload model package file
Introduced in GitLab 16.8
PUT /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{path}/{file_name}
Metadata
- Read
Retrieve metadata information for this GitLab instance
Retrieves metadata information for the GitLab instance.
GET /api/v4/metadata - Read
Retrieves version information for the GitLab instance
This feature was introduced in GitLab 8.13 and deprecated in 15.5. We recommend you instead use the Metadata API.
GET /api/v4/version
Members
- Read
List all direct members of a group
Lists all direct members of a specified group viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.
GET /api/v4/groups/{id}/members - Read
List all members of a group
Lists all members of a specified group viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user is a member of this group and one or more ancestor groups, only returns the highest `access_level`. Members from an invited group are returned if the invited group is public, the requester is a member of an invited group, or the requester is a member of the shared group or project.
GET /api/v4/groups/{id}/members/all - Read
Retrieve a direct group member
Retrieves a specified member of a group. Returns only direct members and not inherited members through ancestor groups.
GET /api/v4/groups/{id}/members/{user_id} - Read
Retrieve a group member
Retrieves a specified member of a group. Returns direct members and members inherited or invited through ancestor groups.
GET /api/v4/groups/{id}/members/all/{user_id} - Read
List all direct members of a project
Lists all direct members of a specified project viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.
GET /api/v4/projects/{id}/members - Read
List all members of a project
Lists all members of a specified project viewable by the authenticated user. Also returns inherited members from ancestor groups or invited groups. If a user is a member of this project and one or more ancestor groups, only returns the highest `access_level`. Members from an invited group are returned if the invited group is public, the requester is a member of an invited group, or the requester is a member of the shared group or project.
GET /api/v4/projects/{id}/members/all - Read
Retrieve a direct project member
Retrieves a specified member of a project. Returns only direct members and not inherited members through ancestor groups.
GET /api/v4/projects/{id}/members/{user_id} - Read
Retrieve a project member
Retrieves a specified member of a project. Returns direct members and members inherited or invited through ancestor groups.
GET /api/v4/projects/{id}/members/all/{user_id} - Read
List all pending group members
Lists all members in an `awaiting` state and those who are invited but do not have a GitLab account for a specified group and any subgroups and projects. This operation works on top-level groups only. It does not work on subgroups.
GET /api/v4/groups/{id}/pending_members - Read
List all memberships for a billable group member
Lists all memberships for a specified billable member of a group. The response represents only direct memberships. Inherited memberships are not included.
GET /api/v4/groups/{id}/billable_members/{user_id}/memberships - Read
List all indirect memberships for a billable group member
Lists all indirect memberships for a billable member of a group. This operation works on top-level groups only. It does not work on subgroups.
GET /api/v4/groups/{id}/billable_members/{user_id}/indirect - Write
Add a member to a group
Adds a member to a specified group.
POST /api/v4/groups/{id}/members - Write
Add a member to a project
Adds a member to a specified project.
POST /api/v4/projects/{id}/members - Write
Set override flag for a member of a group
Sets the override flag for a member of a group. By default, the access level of LDAP group members is set to the value specified by LDAP through Group Sync.
POST /api/v4/groups/{id}/members/{user_id}/override - Write
Approve all pending group members
Approves all pending users for a specified top-level group and any subgroups or projects.
POST /api/v4/groups/{id}/members/approve_all - Destructive
Update a group member
Updates a specified member of a group.
PUT /api/v4/groups/{id}/members/{user_id} - Destructive
Remove a member from a group
Removes a specified user from a group. The user must be a direct member.
DELETE /api/v4/groups/{id}/members/{user_id} - Destructive
Update a project member
Updates a specified member of a project.
PUT /api/v4/projects/{id}/members/{user_id} - Destructive
Remove a member from a project
Removes a specified user from a project. The user must be a direct member.
DELETE /api/v4/projects/{id}/members/{user_id} - Destructive
Remove an LDAP access level override
Removes an LDAP access level override for a member of a group.
DELETE /api/v4/groups/{id}/members/{user_id}/override - Destructive
Approve a group member
Approves a specified pending user for a top-level group and any subgroups or projects.
PUT /api/v4/groups/{id}/members/{member_id}/approve - Destructive
Update group membership state for a user
Updates the membership state for a specified user in a group.
PUT /api/v4/groups/{id}/members/{user_id}/state - Destructive
Remove a billable member from a group
Removes a specified billable member from a group and its subgroups and projects. The user does not need to be a group member to qualify for removal. For example, if the user was added directly to a project in the group, you can still remove them using this operation.
DELETE /api/v4/groups/{id}/billable_members/{user_id}
Markdown
- Write
Render Markdown content
Renders Markdown content as HTML.
POST /api/v4/markdown
CI lint
- Read
Validate existing CI/CD configuration
Validates the `.gitlab-ci.yml` configuration for a specified project.
GET /api/v4/projects/{id}/ci/lint - Read
Validate a CI/CD configuration
Validates a provided CI/CD configuration in the context of a specified project.
POST /api/v4/projects/{id}/ci/lint
Issues
- Read
Retrieve issues statistics for the currently authenticated user
Retrieves statistics for issues accessible by the currently authenticated user. By default, returns only issues created by the current user. To get all issues, set the `scope` attribute to `all`.
GET /api/v4/issues_statistics - Read
List all issues for the currently authenticated user
Lists all issues accessible by the currently authenticated user. By default, returns only issues created by the current user. To list all issues, use parameter `scope=all`.
GET /api/v4/issues - Read
Retrieve an issue
Retrieves a specified issue. Administrators only.
GET /api/v4/issues/{id} - Read
Retrieve time tracking stats for an issue
Retrieves time tracking stats for a specified issue, including time estimate and time spent in seconds and human-readable format (for example, `1h 30m`).
GET /api/v4/projects/{id}/issues/{issue_iid}/time_stats - Read
List all merge requests related to an issue
Lists all merge requests that are related to a specified issue. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/projects/{id}/issues/{issue_iid}/related_merge_requests - Read
List all participants in an issue
Lists all users that are participants in a specified issue. If the project is private or the issue is confidential, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.
GET /api/v4/projects/{id}/issues/{issue_iid}/participants - Read
Retrieve user agent details for an issue
Retrieves user agent details for an issue.
GET /api/v4/projects/{id}/issues/{issue_iid}/user_agent_detail - Read
List all issue links
Lists all linked issues for a specified issue, sorted by the relationship creation datetime (ascending). Issues are filtered according to the user authorizations.
GET /api/v4/projects/{id}/issues/{issue_iid}/links - Read
Retrieve an issue link
Retrieves a specified issue link.
GET /api/v4/projects/{id}/issues/{issue_iid}/links/{issue_link_id} - Write
Set the estimated time for an issue
Sets an estimated time of work for a specified issue.
POST /api/v4/projects/{id}/issues/{issue_iid}/time_estimate - Write
Add spent time for an issue
Adds spent time for a specified issue.
POST /api/v4/projects/{id}/issues/{issue_iid}/add_spent_time - Write
Create an issue link
Creates a two-way relationship between two issues. The user must be allowed to update both issues to succeed.
POST /api/v4/projects/{id}/issues/{issue_iid}/links - Destructive
Reset the estimated time for an issue
Resets the estimated time for a specified issue to `0` seconds.
POST /api/v4/projects/{id}/issues/{issue_iid}/reset_time_estimate - Destructive
Reset spent time for an issue
Resets the total spent time for a specified issue to `0` seconds.
POST /api/v4/projects/{id}/issues/{issue_iid}/reset_spent_time - Destructive
Delete an issue link
Deletes a specified issue link, removing the two-way relationship.
DELETE /api/v4/projects/{id}/issues/{issue_iid}/links/{issue_link_id}
Metric images
- Read
List all metric images for an incident
Lists all metric images for an incident.
GET /api/v4/projects/{id}/issues/{issue_iid}/metric_images - Write
Authorize metric image upload
Authorizes uploading a metric image for a specified incident.
POST /api/v4/projects/{id}/issues/{issue_iid}/metric_images/authorize - Write
Upload a metric image for an incident
Uploads a screenshot of metric charts for an incident. Available only for incidents.
POST /api/v4/projects/{id}/issues/{issue_iid}/metric_images - Destructive
Update a metric image for an incident
Updates a metric image for an incident.
PUT /api/v4/projects/{id}/issues/{issue_iid}/metric_images/{metric_image_id} - Destructive
Delete a metric image from an incident
Deletes a metric image from an incident.
DELETE /api/v4/projects/{id}/issues/{issue_iid}/metric_images/{metric_image_id}
Invitations
- Read
List all pending invitations for a group
Lists all pending invitations for a specified group viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters `page` and `per_page` to restrict the list of members.
GET /api/v4/groups/{id}/invitations - Read
List all pending invitations for a project
Lists all pending invitations for a specified project viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters `page` and `per_page` to restrict the list of members.
GET /api/v4/projects/{id}/invitations - Write
Add a member to a group
Adds a member to a group. You can specify a user ID or invite a user by email.
POST /api/v4/groups/{id}/invitations - Write
Add a member to a project
Adds a member to a project. You can specify a user ID or invite a user by email.
POST /api/v4/projects/{id}/invitations - Destructive
Update an invitation to a group
Updates a pending invitation to a group.
PUT /api/v4/groups/{id}/invitations/{email} - Destructive
Delete an invitation to a group
Deletes a pending invitation to a specified email address for a group.
DELETE /api/v4/groups/{id}/invitations/{email} - Destructive
Update an invitation to a project
Updates a pending invitation to a project.
PUT /api/v4/projects/{id}/invitations/{email} - Destructive
Delete an invitation to a project
Deletes a pending invitation to a specified email address for a project.
DELETE /api/v4/projects/{id}/invitations/{email}
Jira forge subscriptions
- Read
List GitLab for Jira (Forge) namespace subscriptions
Lists the GitLab namespaces subscribed to the Forge installation.
GET /api/v4/integrations/jira_forge/subscriptions - Write
Create a GitLab for Jira (Forge) namespace subscription
Subscribes a GitLab namespace to the Forge installation so its development data syncs to Jira. Authenticated by the Forge Invocation Token (app-context call); the GitLab user is bound via the signed delegation token from the user_delegation endpoint, and the Jira site-admin check runs against Jira with the app system token riding the call.
POST /api/v4/integrations/jira_forge/subscriptions - Destructive
Delete a GitLab for Jira (Forge) namespace subscription
Unsubscribes a GitLab namespace from the Forge installation.
DELETE /api/v4/integrations/jira_forge/subscriptions/{id}
Jira forge user delegation
- Write
Create a GitLab for Jira (Forge) user delegation token
Mints a short-lived GitLab-signed token identifying the signed-in GitLab user, scoped to the Jira account and site it is minted for. Accepts only the OAuth token issued to the Forge app at sign-in. The Forge app stores it at config-page sign-in and presents it on the FIT-authenticated subscribe call, which cannot carry the user OAuth token (Forge attaches the FIT only to app-context calls); the scope claims must match that call's FIT.
POST /api/v4/integrations/jira_forge/user_delegation
Jira forge installation
- Write
Register the GitLab for Jira (Forge) system token for direct dev-info sync
Stores the Forge app system OAuth token (X-Forge-Oauth-System header) and the Jira apiBaseUrl (from the FIT), so GitLab pushes dev-info directly to Jira. See Atlassian::Forge::SystemTokenClient.
POST /api/v4/integrations/jira_forge/installation/forge_token - Destructive
Update the GitLab for Jira (Forge) installation instance URL
Sets the GitLab instance the installation points at. Omit instance_url (or send null) for GitLab.com. Requires a Jira site or organization admin.
PUT /api/v4/integrations/jira_forge/installation - Destructive
Destroy the GitLab for Jira (Forge) installation on app uninstall
Called by the Forge app preUninstall hook. A pure-native install fires no Connect uninstalled event, so this is what removes the installation, its subscriptions, and deactivates the linked jira_cloud_app integrations. FIT authentication carries the same trust as the signed Connect lifecycle event, so no Jira admin check is needed. Succeeds with no change when the installation is already gone.
DELETE /api/v4/integrations/jira_forge/installation
Jira Connect subscriptions
- Write
Subscribe a namespace to a JiraConnectInstallation
Subscribes the namespace to the JiraConnectInstallation
POST /api/v4/integrations/jira_connect/subscriptions
Integrations
- Read
Get Slack interactive component options
Retrieves options for Slack interactive components
POST /api/v4/integrations/slack/options - Read
List all active integrations
Lists all active integrations.
GET /api/v4/projects/{id}/services - Read
Retrieve integration settings
Retrieves the settings for a specified integration.
GET /api/v4/projects/{id}/services/{slug} - Read
List all active integrations
Lists all active integrations.
GET /api/v4/projects/{id}/integrations - Read
Retrieve integration settings
Retrieves the settings for a specified integration.
GET /api/v4/projects/{id}/integrations/{slug} - Read
List all active integrations
Lists all active integrations.
GET /api/v4/groups/{id}/integrations - Read
Retrieve integration settings
Retrieves the settings for a specified integration.
GET /api/v4/groups/{id}/integrations/{slug} - Write
Process Slack interaction events
Processes interaction events from Slack
POST /api/v4/integrations/slack/interactions - Write
Receive Slack events
Receives and processes events sent by the GitLab for Slack app. Requires a valid Slack signature.
POST /api/v4/integrations/slack/events - Write
Trigger a slash command for mattermost-slash-commands
Triggers a slash command for mattermost-slash-commands.
POST /api/v4/projects/{id}/services/mattermost_slash_commands/trigger - Write
Trigger a slash command for mattermost-slash-commands
Triggers a slash command for mattermost-slash-commands.
POST /api/v4/projects/{id}/integrations/mattermost_slash_commands/trigger - Write
Trigger a global slack command
Triggers a global slack command.
POST /api/v4/slack/trigger - Destructive
Create or update the Apple App Store integration
Creates or updates the Apple App Store integration.
PUT /api/v4/projects/{id}/services/apple-app-store - Destructive
Create or update the Asana integration
Creates or updates the Asana integration.
PUT /api/v4/projects/{id}/services/asana - Destructive
Create or update the Assembla integration
Creates or updates the Assembla integration.
PUT /api/v4/projects/{id}/services/assembla - Destructive
Create or update the Bamboo integration
Creates or updates the Bamboo integration.
PUT /api/v4/projects/{id}/services/bamboo - Destructive
Create or update the Bugzilla integration
Creates or updates the Bugzilla integration.
PUT /api/v4/projects/{id}/services/bugzilla - Destructive
Create or update the Buildkite integration
Creates or updates the Buildkite integration.
PUT /api/v4/projects/{id}/services/buildkite - Destructive
Create or update the Campfire integration
Creates or updates the Campfire integration.
PUT /api/v4/projects/{id}/services/campfire - Destructive
Create or update the Confluence integration
Creates or updates the Confluence integration.
PUT /api/v4/projects/{id}/services/confluence - Destructive
Create or update the Custom Issue Tracker integration
Creates or updates the Custom Issue Tracker integration.
PUT /api/v4/projects/{id}/services/custom-issue-tracker - Destructive
Create or update the Datadog integration
Creates or updates the Datadog integration.
PUT /api/v4/projects/{id}/services/datadog - Destructive
Create or update the Diffblue Cover integration
Creates or updates the Diffblue Cover integration.
PUT /api/v4/projects/{id}/services/diffblue-cover - Destructive
Create or update the Discord integration
Creates or updates the Discord integration.
PUT /api/v4/projects/{id}/services/discord - Destructive
Create or update the Drone Ci integration
Creates or updates the Drone Ci integration.
PUT /api/v4/projects/{id}/services/drone-ci - Destructive
Create or update the Emails On Push integration
Creates or updates the Emails On Push integration.
PUT /api/v4/projects/{id}/services/emails-on-push - Destructive
Create or update the External Wiki integration
Creates or updates the External Wiki integration.
PUT /api/v4/projects/{id}/services/external-wiki - Destructive
Create or update the Gitlab Slack Application integration
Creates or updates the Gitlab Slack Application integration.
PUT /api/v4/projects/{id}/services/gitlab-slack-application - Destructive
Create or update the Google Play integration
Creates or updates the Google Play integration.
PUT /api/v4/projects/{id}/services/google-play - Destructive
Create or update the Hangouts Chat integration
Creates or updates the Hangouts Chat integration.
PUT /api/v4/projects/{id}/services/hangouts-chat - Destructive
Create or update the Harbor integration
Creates or updates the Harbor integration.
PUT /api/v4/projects/{id}/services/harbor - Destructive
Create or update the Irker integration
Creates or updates the Irker integration.
PUT /api/v4/projects/{id}/services/irker - Destructive
Create or update the Jenkins integration
Creates or updates the Jenkins integration.
PUT /api/v4/projects/{id}/services/jenkins - Destructive
Create or update the Jira integration
Creates or updates the Jira integration.
PUT /api/v4/projects/{id}/services/jira - Destructive
Create or update the Jira Cloud App integration
Creates or updates the Jira Cloud App integration.
PUT /api/v4/projects/{id}/services/jira-cloud-app - Destructive
Create or update the Linear integration
Creates or updates the Linear integration.
PUT /api/v4/projects/{id}/services/linear - Destructive
Create or update the Matrix integration
Creates or updates the Matrix integration.
PUT /api/v4/projects/{id}/services/matrix - Destructive
Create or update the Mattermost Slash Commands integration
Creates or updates the Mattermost Slash Commands integration.
PUT /api/v4/projects/{id}/services/mattermost-slash-commands - Destructive
Create or update the Packagist integration
Creates or updates the Packagist integration.
PUT /api/v4/projects/{id}/services/packagist - Destructive
Create or update the Phorge integration
Creates or updates the Phorge integration.
PUT /api/v4/projects/{id}/services/phorge - Destructive
Create or update the Pipelines Email integration
Creates or updates the Pipelines Email integration.
PUT /api/v4/projects/{id}/services/pipelines-email - Destructive
Create or update the Pivotaltracker integration
Creates or updates the Pivotaltracker integration.
PUT /api/v4/projects/{id}/services/pivotaltracker - Destructive
Create or update the Pumble integration
Creates or updates the Pumble integration.
PUT /api/v4/projects/{id}/services/pumble - Destructive
Create or update the Pushover integration
Creates or updates the Pushover integration.
PUT /api/v4/projects/{id}/services/pushover - Destructive
Create or update the Redmine integration
Creates or updates the Redmine integration.
PUT /api/v4/projects/{id}/services/redmine - Destructive
Create or update the Ewm integration
Creates or updates the Ewm integration.
PUT /api/v4/projects/{id}/services/ewm - Destructive
Create or update the Youtrack integration
Creates or updates the Youtrack integration.
PUT /api/v4/projects/{id}/services/youtrack - Destructive
Create or update the Clickup integration
Creates or updates the Clickup integration.
PUT /api/v4/projects/{id}/services/clickup - Destructive
Create or update the Slack integration
Creates or updates the Slack integration.
PUT /api/v4/projects/{id}/services/slack - Destructive
Create or update the Microsoft Teams integration
Creates or updates the Microsoft Teams integration.
PUT /api/v4/projects/{id}/services/microsoft-teams - Destructive
Create or update the Mattermost integration
Creates or updates the Mattermost integration.
PUT /api/v4/projects/{id}/services/mattermost - Destructive
Create or update the Teamcity integration
Creates or updates the Teamcity integration.
PUT /api/v4/projects/{id}/services/teamcity - Destructive
Create or update the Telegram integration
Creates or updates the Telegram integration.
PUT /api/v4/projects/{id}/services/telegram - Destructive
Create or update the Unify Circuit integration
Creates or updates the Unify Circuit integration.
PUT /api/v4/projects/{id}/services/unify-circuit - Destructive
Create or update the Webex Teams integration
Creates or updates the Webex Teams integration.
PUT /api/v4/projects/{id}/services/webex-teams - Destructive
Create or update the Zentao integration
Creates or updates the Zentao integration.
PUT /api/v4/projects/{id}/services/zentao - Destructive
Create or update the Squash Tm integration
Creates or updates the Squash Tm integration.
PUT /api/v4/projects/{id}/services/squash-tm - Destructive
Create or update the Github integration
Creates or updates the Github integration.
PUT /api/v4/projects/{id}/services/github - Destructive
Create or update the Git Guardian integration
Creates or updates the Git Guardian integration.
PUT /api/v4/projects/{id}/services/git-guardian - Destructive
Create or update the Google Cloud Platform Artifact Registry integration
Creates or updates the Google Cloud Platform Artifact Registry integration.
PUT /api/v4/projects/{id}/services/google-cloud-platform-artifact-registry - Destructive
Create or update the Google Cloud Platform Workload Identity Federation integration
Creates or updates the Google Cloud Platform Workload Identity Federation integration.
PUT /api/v4/projects/{id}/services/google-cloud-platform-workload-identity-federation - Destructive
Create or update the Mock Ci integration
Creates or updates the Mock Ci integration.
PUT /api/v4/projects/{id}/services/mock-ci - Destructive
Create or update the Mock Monitoring integration
Creates or updates the Mock Monitoring integration.
PUT /api/v4/projects/{id}/services/mock-monitoring - Destructive
Disable an integration
Disables a specified integration. Integration settings are preserved.
DELETE /api/v4/projects/{id}/services/{slug} - Destructive
Create or update the Apple App Store integration
Creates or updates the Apple App Store integration.
PUT /api/v4/projects/{id}/integrations/apple-app-store - Destructive
Create or update the Asana integration
Creates or updates the Asana integration.
PUT /api/v4/projects/{id}/integrations/asana - Destructive
Create or update the Assembla integration
Creates or updates the Assembla integration.
PUT /api/v4/projects/{id}/integrations/assembla - Destructive
Create or update the Bamboo integration
Creates or updates the Bamboo integration.
PUT /api/v4/projects/{id}/integrations/bamboo - Destructive
Create or update the Bugzilla integration
Creates or updates the Bugzilla integration.
PUT /api/v4/projects/{id}/integrations/bugzilla - Destructive
Create or update the Buildkite integration
Creates or updates the Buildkite integration.
PUT /api/v4/projects/{id}/integrations/buildkite - Destructive
Create or update the Campfire integration
Creates or updates the Campfire integration.
PUT /api/v4/projects/{id}/integrations/campfire - Destructive
Create or update the Confluence integration
Creates or updates the Confluence integration.
PUT /api/v4/projects/{id}/integrations/confluence - Destructive
Create or update the Custom Issue Tracker integration
Creates or updates the Custom Issue Tracker integration.
PUT /api/v4/projects/{id}/integrations/custom-issue-tracker - Destructive
Create or update the Datadog integration
Creates or updates the Datadog integration.
PUT /api/v4/projects/{id}/integrations/datadog - Destructive
Create or update the Diffblue Cover integration
Creates or updates the Diffblue Cover integration.
PUT /api/v4/projects/{id}/integrations/diffblue-cover - Destructive
Create or update the Discord integration
Creates or updates the Discord integration.
PUT /api/v4/projects/{id}/integrations/discord - Destructive
Create or update the Drone Ci integration
Creates or updates the Drone Ci integration.
PUT /api/v4/projects/{id}/integrations/drone-ci - Destructive
Create or update the Emails On Push integration
Creates or updates the Emails On Push integration.
PUT /api/v4/projects/{id}/integrations/emails-on-push - Destructive
Create or update the External Wiki integration
Creates or updates the External Wiki integration.
PUT /api/v4/projects/{id}/integrations/external-wiki - Destructive
Create or update the Gitlab Slack Application integration
Creates or updates the Gitlab Slack Application integration.
PUT /api/v4/projects/{id}/integrations/gitlab-slack-application - Destructive
Create or update the Google Play integration
Creates or updates the Google Play integration.
PUT /api/v4/projects/{id}/integrations/google-play - Destructive
Create or update the Hangouts Chat integration
Creates or updates the Hangouts Chat integration.
PUT /api/v4/projects/{id}/integrations/hangouts-chat - Destructive
Create or update the Harbor integration
Creates or updates the Harbor integration.
PUT /api/v4/projects/{id}/integrations/harbor - Destructive
Create or update the Irker integration
Creates or updates the Irker integration.
PUT /api/v4/projects/{id}/integrations/irker - Destructive
Create or update the Jenkins integration
Creates or updates the Jenkins integration.
PUT /api/v4/projects/{id}/integrations/jenkins - Destructive
Create or update the Jira integration
Creates or updates the Jira integration.
PUT /api/v4/projects/{id}/integrations/jira - Destructive
Create or update the Jira Cloud App integration
Creates or updates the Jira Cloud App integration.
PUT /api/v4/projects/{id}/integrations/jira-cloud-app - Destructive
Create or update the Linear integration
Creates or updates the Linear integration.
PUT /api/v4/projects/{id}/integrations/linear - Destructive
Create or update the Matrix integration
Creates or updates the Matrix integration.
PUT /api/v4/projects/{id}/integrations/matrix - Destructive
Create or update the Mattermost Slash Commands integration
Creates or updates the Mattermost Slash Commands integration.
PUT /api/v4/projects/{id}/integrations/mattermost-slash-commands - Destructive
Create or update the Packagist integration
Creates or updates the Packagist integration.
PUT /api/v4/projects/{id}/integrations/packagist - Destructive
Create or update the Phorge integration
Creates or updates the Phorge integration.
PUT /api/v4/projects/{id}/integrations/phorge - Destructive
Create or update the Pipelines Email integration
Creates or updates the Pipelines Email integration.
PUT /api/v4/projects/{id}/integrations/pipelines-email - Destructive
Create or update the Pivotaltracker integration
Creates or updates the Pivotaltracker integration.
PUT /api/v4/projects/{id}/integrations/pivotaltracker - Destructive
Create or update the Pumble integration
Creates or updates the Pumble integration.
PUT /api/v4/projects/{id}/integrations/pumble - Destructive
Create or update the Pushover integration
Creates or updates the Pushover integration.
PUT /api/v4/projects/{id}/integrations/pushover - Destructive
Create or update the Redmine integration
Creates or updates the Redmine integration.
PUT /api/v4/projects/{id}/integrations/redmine - Destructive
Create or update the Ewm integration
Creates or updates the Ewm integration.
PUT /api/v4/projects/{id}/integrations/ewm - Destructive
Create or update the Youtrack integration
Creates or updates the Youtrack integration.
PUT /api/v4/projects/{id}/integrations/youtrack - Destructive
Create or update the Clickup integration
Creates or updates the Clickup integration.
PUT /api/v4/projects/{id}/integrations/clickup - Destructive
Create or update the Slack integration
Creates or updates the Slack integration.
PUT /api/v4/projects/{id}/integrations/slack - Destructive
Create or update the Microsoft Teams integration
Creates or updates the Microsoft Teams integration.
PUT /api/v4/projects/{id}/integrations/microsoft-teams - Destructive
Create or update the Mattermost integration
Creates or updates the Mattermost integration.
PUT /api/v4/projects/{id}/integrations/mattermost - Destructive
Create or update the Teamcity integration
Creates or updates the Teamcity integration.
PUT /api/v4/projects/{id}/integrations/teamcity - Destructive
Create or update the Telegram integration
Creates or updates the Telegram integration.
PUT /api/v4/projects/{id}/integrations/telegram - Destructive
Create or update the Unify Circuit integration
Creates or updates the Unify Circuit integration.
PUT /api/v4/projects/{id}/integrations/unify-circuit - Destructive
Create or update the Webex Teams integration
Creates or updates the Webex Teams integration.
PUT /api/v4/projects/{id}/integrations/webex-teams - Destructive
Create or update the Zentao integration
Creates or updates the Zentao integration.
PUT /api/v4/projects/{id}/integrations/zentao - Destructive
Create or update the Squash Tm integration
Creates or updates the Squash Tm integration.
PUT /api/v4/projects/{id}/integrations/squash-tm - Destructive
Create or update the Github integration
Creates or updates the Github integration.
PUT /api/v4/projects/{id}/integrations/github - Destructive
Create or update the Git Guardian integration
Creates or updates the Git Guardian integration.
PUT /api/v4/projects/{id}/integrations/git-guardian - Destructive
Create or update the Google Cloud Platform Artifact Registry integration
Creates or updates the Google Cloud Platform Artifact Registry integration.
PUT /api/v4/projects/{id}/integrations/google-cloud-platform-artifact-registry - Destructive
Create or update the Google Cloud Platform Workload Identity Federation integration
Creates or updates the Google Cloud Platform Workload Identity Federation integration.
PUT /api/v4/projects/{id}/integrations/google-cloud-platform-workload-identity-federation - Destructive
Create or update the Mock Ci integration
Creates or updates the Mock Ci integration.
PUT /api/v4/projects/{id}/integrations/mock-ci - Destructive
Create or update the Mock Monitoring integration
Creates or updates the Mock Monitoring integration.
PUT /api/v4/projects/{id}/integrations/mock-monitoring - Destructive
Disable an integration
Disables a specified integration. Integration settings are preserved.
DELETE /api/v4/projects/{id}/integrations/{slug} - Destructive
Create or update the Apple App Store integration
Creates or updates the Apple App Store integration.
PUT /api/v4/groups/{id}/integrations/apple-app-store - Destructive
Create or update the Asana integration
Creates or updates the Asana integration.
PUT /api/v4/groups/{id}/integrations/asana - Destructive
Create or update the Assembla integration
Creates or updates the Assembla integration.
PUT /api/v4/groups/{id}/integrations/assembla - Destructive
Create or update the Bamboo integration
Creates or updates the Bamboo integration.
PUT /api/v4/groups/{id}/integrations/bamboo - Destructive
Create or update the Bugzilla integration
Creates or updates the Bugzilla integration.
PUT /api/v4/groups/{id}/integrations/bugzilla - Destructive
Create or update the Buildkite integration
Creates or updates the Buildkite integration.
PUT /api/v4/groups/{id}/integrations/buildkite - Destructive
Create or update the Campfire integration
Creates or updates the Campfire integration.
PUT /api/v4/groups/{id}/integrations/campfire - Destructive
Create or update the Confluence integration
Creates or updates the Confluence integration.
PUT /api/v4/groups/{id}/integrations/confluence - Destructive
Create or update the Custom Issue Tracker integration
Creates or updates the Custom Issue Tracker integration.
PUT /api/v4/groups/{id}/integrations/custom-issue-tracker - Destructive
Create or update the Datadog integration
Creates or updates the Datadog integration.
PUT /api/v4/groups/{id}/integrations/datadog - Destructive
Create or update the Diffblue Cover integration
Creates or updates the Diffblue Cover integration.
PUT /api/v4/groups/{id}/integrations/diffblue-cover - Destructive
Create or update the Discord integration
Creates or updates the Discord integration.
PUT /api/v4/groups/{id}/integrations/discord - Destructive
Create or update the Drone Ci integration
Creates or updates the Drone Ci integration.
PUT /api/v4/groups/{id}/integrations/drone-ci - Destructive
Create or update the Emails On Push integration
Creates or updates the Emails On Push integration.
PUT /api/v4/groups/{id}/integrations/emails-on-push - Destructive
Create or update the External Wiki integration
Creates or updates the External Wiki integration.
PUT /api/v4/groups/{id}/integrations/external-wiki - Destructive
Create or update the Gitlab Slack Application integration
Creates or updates the Gitlab Slack Application integration.
PUT /api/v4/groups/{id}/integrations/gitlab-slack-application - Destructive
Create or update the Google Play integration
Creates or updates the Google Play integration.
PUT /api/v4/groups/{id}/integrations/google-play - Destructive
Create or update the Hangouts Chat integration
Creates or updates the Hangouts Chat integration.
PUT /api/v4/groups/{id}/integrations/hangouts-chat - Destructive
Create or update the Harbor integration
Creates or updates the Harbor integration.
PUT /api/v4/groups/{id}/integrations/harbor - Destructive
Create or update the Irker integration
Creates or updates the Irker integration.
PUT /api/v4/groups/{id}/integrations/irker - Destructive
Create or update the Jenkins integration
Creates or updates the Jenkins integration.
PUT /api/v4/groups/{id}/integrations/jenkins - Destructive
Create or update the Jira integration
Creates or updates the Jira integration.
PUT /api/v4/groups/{id}/integrations/jira - Destructive
Create or update the Jira Cloud App integration
Creates or updates the Jira Cloud App integration.
PUT /api/v4/groups/{id}/integrations/jira-cloud-app - Destructive
Create or update the Linear integration
Creates or updates the Linear integration.
PUT /api/v4/groups/{id}/integrations/linear - Destructive
Create or update the Matrix integration
Creates or updates the Matrix integration.
PUT /api/v4/groups/{id}/integrations/matrix - Destructive
Create or update the Mattermost Slash Commands integration
Creates or updates the Mattermost Slash Commands integration.
PUT /api/v4/groups/{id}/integrations/mattermost-slash-commands - Destructive
Create or update the Packagist integration
Creates or updates the Packagist integration.
PUT /api/v4/groups/{id}/integrations/packagist - Destructive
Create or update the Phorge integration
Creates or updates the Phorge integration.
PUT /api/v4/groups/{id}/integrations/phorge - Destructive
Create or update the Pipelines Email integration
Creates or updates the Pipelines Email integration.
PUT /api/v4/groups/{id}/integrations/pipelines-email - Destructive
Create or update the Pivotaltracker integration
Creates or updates the Pivotaltracker integration.
PUT /api/v4/groups/{id}/integrations/pivotaltracker - Destructive
Create or update the Pumble integration
Creates or updates the Pumble integration.
PUT /api/v4/groups/{id}/integrations/pumble - Destructive
Create or update the Pushover integration
Creates or updates the Pushover integration.
PUT /api/v4/groups/{id}/integrations/pushover - Destructive
Create or update the Redmine integration
Creates or updates the Redmine integration.
PUT /api/v4/groups/{id}/integrations/redmine - Destructive
Create or update the Ewm integration
Creates or updates the Ewm integration.
PUT /api/v4/groups/{id}/integrations/ewm - Destructive
Create or update the Youtrack integration
Creates or updates the Youtrack integration.
PUT /api/v4/groups/{id}/integrations/youtrack - Destructive
Create or update the Clickup integration
Creates or updates the Clickup integration.
PUT /api/v4/groups/{id}/integrations/clickup - Destructive
Create or update the Slack integration
Creates or updates the Slack integration.
PUT /api/v4/groups/{id}/integrations/slack - Destructive
Create or update the Microsoft Teams integration
Creates or updates the Microsoft Teams integration.
PUT /api/v4/groups/{id}/integrations/microsoft-teams - Destructive
Create or update the Mattermost integration
Creates or updates the Mattermost integration.
PUT /api/v4/groups/{id}/integrations/mattermost - Destructive
Create or update the Teamcity integration
Creates or updates the Teamcity integration.
PUT /api/v4/groups/{id}/integrations/teamcity - Destructive
Create or update the Telegram integration
Creates or updates the Telegram integration.
PUT /api/v4/groups/{id}/integrations/telegram - Destructive
Create or update the Unify Circuit integration
Creates or updates the Unify Circuit integration.
PUT /api/v4/groups/{id}/integrations/unify-circuit - Destructive
Create or update the Webex Teams integration
Creates or updates the Webex Teams integration.
PUT /api/v4/groups/{id}/integrations/webex-teams - Destructive
Create or update the Zentao integration
Creates or updates the Zentao integration.
PUT /api/v4/groups/{id}/integrations/zentao - Destructive
Create or update the Squash Tm integration
Creates or updates the Squash Tm integration.
PUT /api/v4/groups/{id}/integrations/squash-tm - Destructive
Create or update the Github integration
Creates or updates the Github integration.
PUT /api/v4/groups/{id}/integrations/github - Destructive
Create or update the Git Guardian integration
Creates or updates the Git Guardian integration.
PUT /api/v4/groups/{id}/integrations/git-guardian - Destructive
Create or update the Google Cloud Platform Artifact Registry integration
Creates or updates the Google Cloud Platform Artifact Registry integration.
PUT /api/v4/groups/{id}/integrations/google-cloud-platform-artifact-registry - Destructive
Create or update the Google Cloud Platform Workload Identity Federation integration
Creates or updates the Google Cloud Platform Workload Identity Federation integration.
PUT /api/v4/groups/{id}/integrations/google-cloud-platform-workload-identity-federation - Destructive
Create or update the Mock Ci integration
Creates or updates the Mock Ci integration.
PUT /api/v4/groups/{id}/integrations/mock-ci - Destructive
Create or update the Mock Monitoring integration
Creates or updates the Mock Monitoring integration.
PUT /api/v4/groups/{id}/integrations/mock-monitoring - Destructive
Disable an integration
Disables a specified integration. Integration settings are preserved.
DELETE /api/v4/groups/{id}/integrations/{slug}
Imports
- Read
List all group or project migrations
Lists all group or project migrations.
GET /api/v4/bulk_imports - Read
List all group or project migration entities
Lists all group or project migration entities.
GET /api/v4/bulk_imports/entities - Read
Retrieve a group or project migration
Retrieves details of a group or project migration.
GET /api/v4/bulk_imports/{import_id} - Read
List all group or project migration entities
Lists all group or project migration entities for a specified migration.
GET /api/v4/bulk_imports/{import_id}/entities - Read
Retrieve a group or project migration entity
Retrieves details of a group or project migration entity.
GET /api/v4/bulk_imports/{import_id}/entities/{entity_id} - Read
List all failed import records for a migration entity
Lists all failed import records for a group or project migration entity. This feature was introduced in GitLab 16.6.
GET /api/v4/bulk_imports/{import_id}/entities/{entity_id}/failures - Write
Import GitHub gists into GitLab snippets
Imports personal GitHub gists into GitLab snippets. You can import gists with up to 10 files. GitHub gists with more than 10 files are skipped. You should manually migrate these GitHub gists. If any gists cannot be imported, an email is sent with a list of gists that were not imported.
POST /api/v4/import/github/gists - Write
Start a group or project migration
Starts a group or project migration. To migrate a project, specify `entities[project_entity]`.
POST /api/v4/bulk_imports - Destructive
Cancel a migration
Cancels a direct transfer migration. This feature was introduced in GitLab 17.1.
POST /api/v4/bulk_imports/{import_id}/cancel
Packages: Helm
- Read
Download a chart index
Downloads a specified chart index for a project.
GET /api/v4/projects/{id}/packages/helm/{channel}/index.yaml - Read
Download a chart
Downloads a specified chart for a project.
GET /api/v4/projects/{id}/packages/helm/{channel}/charts/{file_name}.tgz - Write
Authorize a chart upload from workhorse
This feature was introduced in GitLab 14.0
POST /api/v4/projects/{id}/packages/helm/api/{channel}/charts/authorize - Write
Upload a chart
Uploads a specified chart for a project.
POST /api/v4/projects/{id}/packages/helm/api/{channel}/charts
GLQL
- Read
Retrieve the GLQL schema
Retrieves the GLQL schema: data sources with their filter, display and sort fields, the operator, value kind and reference type vocabularies, the available functions, and the display types a query can be rendered as.
GET /api/v4/glql/schema - Write
Execute a GLQL query
Executes a GLQL query to search and filter GitLab resources.
POST /api/v4/glql
CI variables
- Read
List all group variables
Lists all variables for a specified group. Use the `page` and `per_page` pagination parameters to control the pagination of results.
GET /api/v4/groups/{id}/variables - Read
Retrieve details of a group variable
Retrieves details of a specified group variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
GET /api/v4/groups/{id}/variables/{key} - Read
List all project variables
Lists all variables for a project. Use the `page` and `per_page` pagination parameters to control the pagination of results.
GET /api/v4/projects/{id}/variables - Read
Retrieve a single variable
Retrieves details of a specified variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
GET /api/v4/projects/{id}/variables/{key} - Read
List all instance variables
Lists all instance-level variables. Use the `page` and `per_page` pagination parameters to control the pagination of results.
GET /api/v4/admin/ci/variables - Read
Retrieve instance variable details
Retrieves details of a specified instance-level variable.
GET /api/v4/admin/ci/variables/{key} - Write
Create a group variable
Creates a group variable.
POST /api/v4/groups/{id}/variables - Write
Create a variable
Creates a variable. If a variable with the same `key` already exists, the variable must have a different `environment_scope`. Otherwise, GitLab returns a message similar to: `VARIABLE_NAME has already been taken`.
POST /api/v4/projects/{id}/variables - Write
Create instance variable
Creates a instance-level variable. The maximum number of instance-level variables can be changed.
POST /api/v4/admin/ci/variables - Destructive
Update a group variable
Updates a specified group variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
PUT /api/v4/groups/{id}/variables/{key} - Destructive
Delete a group variable
Deletes a specified group variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
DELETE /api/v4/groups/{id}/variables/{key} - Destructive
Update a variable
Updates a project variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
PUT /api/v4/projects/{id}/variables/{key} - Destructive
Delete a variable
Deletes a project variable. If there are multiple variables with the same key, use `filter` to select the correct `environment_scope`.
DELETE /api/v4/projects/{id}/variables/{key} - Destructive
Update an instance variable
Updates a specified instance variable.
PUT /api/v4/admin/ci/variables/{key} - Destructive
Delete instance variable
Deletes a specified instance variable.
DELETE /api/v4/admin/ci/variables/{key}
Group import and export
- Read
Retrieve a group export download
Retrieves the exported archive for a specified group.
GET /api/v4/groups/{id}/export/download - Read
Download a relations export for a group
Downloads a group relations export file.
GET /api/v4/groups/{id}/export_relations/download - Read
Retrieve the status of an relations export for a group
Retrieves the status of a relations export for a group.
GET /api/v4/groups/{id}/export_relations/status - Write
Workhorse authorize the group import upload
This feature was introduced in GitLab 12.8
POST /api/v4/groups/import/authorize - Write
Create a group import
Creates a group import. The maximum import file size can be set by the Administrator on GitLab Self-Managed (defaults to `0` (unlimited)).
POST /api/v4/groups/import - Write
Create a group export
Creates a group export for a specified group.
POST /api/v4/groups/{id}/export - Write
Schedule a relations export for a group
Schedules a relations export for a specified group.
POST /api/v4/groups/{id}/export_relations
Freeze periods
- Read
List all freeze periods
Lists all freeze periods for a specified project.
GET /api/v4/projects/{id}/freeze_periods - Read
Retrieve a freeze period
Retrieves a freeze period for a specified `freeze_period_id`. You must have the Reporter, Developer, Maintainer, or Owner role for the project.
GET /api/v4/projects/{id}/freeze_periods/{freeze_period_id} - Write
Create a freeze period
Creates a freeze period for a specified project. You must have the Maintainer or Owner role for the project.
POST /api/v4/projects/{id}/freeze_periods - Destructive
Update a freeze period
Updates a freeze period for a specified `freeze_period_id`. You must have the Maintainer or Owner role for the project.
PUT /api/v4/projects/{id}/freeze_periods/{freeze_period_id} - Destructive
Delete a freeze period
Deletes a freeze period for a specified `freeze_period_id`. You must have the Maintainer or Owner role for the project.
DELETE /api/v4/projects/{id}/freeze_periods/{freeze_period_id}
Files
- Read
Retrieve file blame metadata
Retrieves blame metadata for lines in a specified file.
HEAD /api/v4/projects/{id}/repository/files/{file_path}/blame - Read
Retrieve file blame history from a repository
Retrieves blame history for a specified file in a repository. Each blame range contains lines and their corresponding commit information. This endpoint is rate-limited for each authenticated user for a given project, and for each IP address for unauthenticated requests. On GitLab Self-Managed and GitLab Dedicated, an administrator can change these limits in the application settings.
GET /api/v4/projects/{id}/repository/files/{file_path}/blame - Read
Retrieve a raw file from a repository
Retrieves the raw file contents for a specified file in a repository.
GET /api/v4/projects/{id}/repository/files/{file_path}/raw - Read
Retrieve file metadata
Retrieves metadata for a specified file in a repository.
HEAD /api/v4/projects/{id}/repository/files/{file_path} - Read
Retrieve a file from a repository
Retrieves information about a specified file in a repository. This includes information like the name, size, and the file contents. File content is Base64 encoded.
GET /api/v4/projects/{id}/repository/files/{file_path} - Write
Create a file in a repository
Creates a file in a specified repository. Use the Commits API to create multiple files with a single request.
POST /api/v4/projects/{id}/repository/files/{file_path} - Destructive
Update a file in a repository
Updates a specified file in a repository. Use the Commits API to update multiple files with a single request.
PUT /api/v4/projects/{id}/repository/files/{file_path} - Destructive
Delete a file in a repository
Deletes a specified file in a repository. Use the Commits API to delete multiple files with a single request.
DELETE /api/v4/projects/{id}/repository/files/{file_path}
Features
- Read
List all feature flags
Lists all feature flags for the instance.
GET /api/v4/features - Read
List all feature flag definitions
Lists all feature flag definitions.
GET /api/v4/features/definitions - Write
Create or update a feature flag
Creates or updates a feature flag value. If a feature with the given name doesn't exist yet, the operation creates one. The value can be a boolean or an integer to indicate percentage of time.
POST /api/v4/features/{name} - Destructive
Delete a feature
Deletes a feature gate. Returns the same response if the feature gate does not exist.
DELETE /api/v4/features/{name}
Feature flags
- Read
List all feature flag user lists for a project
Lists all feature flag user lists for a specified project.
GET /api/v4/projects/{id}/feature_flags_user_lists - Read
Retrieve a feature flag user list
Retrieves a specified feature flag user list.
GET /api/v4/projects/{id}/feature_flags_user_lists/{iid} - Read
List all feature flags for a project
Lists all feature flags of the requested project. Use the `page` and `per_page` pagination parameters to control the pagination of results.
GET /api/v4/projects/{id}/feature_flags - Read
Retrieve feature flag settings
Retrieves the feature flag settings of a specified project.
GET /api/v4/projects/{id}/feature_flags_settings - Read
Retrieve a feature flag
Retrieves a specified feature flag.
GET /api/v4/projects/{id}/feature_flags/{feature_flag_name} - Write
Create a feature flag user list
Creates a feature flag user list in a specified project.
POST /api/v4/projects/{id}/feature_flags_user_lists - Write
Create a feature flag
Creates a feature flag for a specified project.
POST /api/v4/projects/{id}/feature_flags - Destructive
Update a feature flag user list
Updates a specified feature flag user list.
PUT /api/v4/projects/{id}/feature_flags_user_lists/{iid} - Destructive
Delete feature flag user list
Deletes a specified feature flag user list.
DELETE /api/v4/projects/{id}/feature_flags_user_lists/{iid} - Destructive
Update feature flag settings
Updates the feature flag settings of a specified project.
PUT /api/v4/projects/{id}/feature_flags_settings - Destructive
Update a feature flag
Updates a specified feature flag.
PUT /api/v4/projects/{id}/feature_flags/{feature_flag_name} - Destructive
Delete a feature flag
Deletes a specified feature flag.
DELETE /api/v4/projects/{id}/feature_flags/{feature_flag_name}
Error tracking
- Read
Retrieve Error Tracking settings for a project
Retrieves the Error Tracking settings for a specified project.
GET /api/v4/projects/{id}/error_tracking/settings - Read
List all project client keys
Lists all integrated error tracking client keys for a specified project.
GET /api/v4/projects/{id}/error_tracking/client_keys - Write
Update Error Tracking settings for a project
Updates Error Tracking settings for a specified project. You must have the Maintainer or Owner role for the project.
PATCH /api/v4/projects/{id}/error_tracking/settings - Write
Create a client key
Creates a client key for integrated error tracking in a specified project. The public key attribute is generated automatically.
POST /api/v4/projects/{id}/error_tracking/client_keys - Destructive
Create Error Tracking settings for a project
Creates Error Tracking settings for a specified project. You must have the Maintainer or Owner role for the project.
PUT /api/v4/projects/{id}/error_tracking/settings - Destructive
Delete a client key
Deletes an integrated error tracking client key from a specified project.
DELETE /api/v4/projects/{id}/error_tracking/client_keys/{key_id}
Environments
- Read
List all environments
Lists all environments for a specified project.
GET /api/v4/projects/{id}/environments - Read
Retrieve an environment
Retrieves a specified environment for a project.
GET /api/v4/projects/{id}/environments/{environment_id} - Write
Create an environment
Creates an environment for a specified project.
POST /api/v4/projects/{id}/environments - Destructive
Update an existing environment
Updates an existing environment for a project.
PUT /api/v4/projects/{id}/environments/{environment_id} - Destructive
Delete an environment
Deletes an environment from a project. The environment must be stopped first.
DELETE /api/v4/projects/{id}/environments/{environment_id} - Destructive
Schedule multiple stopped review apps for deletion
Schedules multiple stopped review apps for deletion. The deletion is performed after 1 week. By default, only environments 30 days or older are deleted.
DELETE /api/v4/projects/{id}/environments/review_apps - Destructive
Stop an environment
Stops a specified running environment.
POST /api/v4/projects/{id}/environments/{environment_id}/stop - Destructive
Stop stale environments
Stops all environments that were last modified or deployed to before a specified date. Excludes protected environments.
POST /api/v4/projects/{id}/environments/stop_stale
Draft notes
- Read
List all merge request draft notes
Lists all merge request draft notes.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes - Read
Retrieve a draft note
Retrieves a draft note for a specified merge request.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id} - Write
Create a draft note
Creates a draft note for a specified merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes - Write
Publish all pending draft notes
Publishes all pending draft notes for the current user on the specified merge request. Optionally sets the reviewer state and posts a summary note.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/bulk_publish - Destructive
Update a draft note
Updates a draft note for a specified merge request.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id} - Destructive
Delete a draft note
Deletes a draft note for a specified merge request.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id} - Destructive
Publish a draft note
Publishes a draft note for a specified merge request.
PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}/publish
Database dictionary
- Read
List dictionary tables
Returns database dictionary tables filtered by database and optional table size
GET /api/v4/databases/{database_name}/dictionary/tables - Read
Retrieve dictionary details
Provides table schema and column information from the GitLab database dictionary.
GET /api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}
Packages: Conan
- Read
Verify authentication credentials
Verifies authentication credentials for a Conan package registry.
GET /api/v4/projects/{id}/packages/conan/v2/users/check_credentials - Read
Search for a Conan package
Searches the instance for a specified Conan package.
GET /api/v4/projects/{id}/packages/conan/v2/conans/search - Read
Retrieve package references metadata
Retrieves the metadata for all package references of a specified package. This feature was introduced in GitLab 18.0.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/search - Read
Retrieve latest recipe revision
Retrieves the revision hash and creation date of the latest package recipe. This feature was introduced in GitLab 17.11.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/latest - Read
List all recipe revisions
Lists all revisions for a package recipe. This feature was introduced in GitLab 17.11.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions - Read
List all recipe files
Lists all recipe files from the package registry. This feature was introduced in GitLab 17.11.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files - Read
Retrieve a recipe file
Retrieves a specified recipe file from the package registry. This feature was introduced in GitLab 17.8.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name} - Read
Retrieve package references metadata by recipe revision
Retrieves the metadata for all package references associated with a specified recipe revision. This feature was introduced in GitLab 18.1.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/search - Read
Retrieve latest package revision
Retrieves the revision hash and creation date of the latest package revision for a specified recipe revision and package reference. This feature was introduced in GitLab 17.11.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/latest - Read
List all package revisions
Lists all package revisions for a specified recipe revision and package reference. This feature was introduced in GitLab 18.0.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions - Read
List all package files
Lists all package files. This feature was introduced in GitLab 18.0.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files - Read
Retrieve a package file
Retrieves a specified package file from the package registry. This feature was introduced in GitLab 17.11.
GET /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name} - Read
Verify authentication credentials
Verifies authentication credentials for a Conan package registry.
GET /api/v4/projects/{id}/packages/conan/v1/users/check_credentials - Read
Search for a Conan package
Searches the instance for a specified Conan package.
GET /api/v4/projects/{id}/packages/conan/v1/conans/search - Read
Retrieve package references metadata
Retrieves the metadata for all package references of a specified package. This feature was introduced in GitLab 18.0.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/search - Read
Verify availability of a Conan repository
Verifies availability of a Conan repository.
GET /api/v4/projects/{id}/packages/conan/v1/ping - Read
Retrieve a package snapshot
Retrieves a snapshot of the files for a specified Conan package and reference. The snapshot is a list of filenames with their associated MD5 hash.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference} - Read
Retrieve a recipe snapshot
Retrieves a snapshot of the files for a specified Conan recipe. The snapshot is a list of filenames with their associated MD5 hash.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel} - Read
Retrieve a package manifest
Retrieves a manifest that includes a list of files and associated download URLs for a specified package.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/digest - Read
Retrieve a recipe manifest
Retrieves a manifest that includes a list of files and associated download URLs for a specified recipe.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/digest - Read
List all package download URLs
Lists all files and associated download URLs for a specified package in the package registry. Returns the same payload as the package manifest endpoint.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/download_urls - Read
List all recipe download URLs
Lists all files and associated download URLs for a specified recipe in the package registry. Returns the same payload as the recipe manifest endpoint.
GET /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/download_urls - Read
Retrieve a recipe file
Retrieves a specified recipe file from the package registry. You must use the download URL returned from the recipe download URLs endpoint.
GET /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name} - Read
Retrieve a package file
Retrieves a specified package file from the package registry. You must use the download URL returned from the package download URLs endpoint.
GET /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name} - Read
Verify authentication credentials
Verifies authentication credentials for a Conan package registry.
GET /api/v4/packages/conan/v1/users/check_credentials - Read
Search for a Conan package
Searches the instance for a specified Conan package.
GET /api/v4/packages/conan/v1/conans/search - Read
Retrieve package references metadata
Retrieves the metadata for all package references of a specified package. This feature was introduced in GitLab 18.0.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/search - Read
Verify availability of a Conan repository
Verifies availability of a Conan repository.
GET /api/v4/packages/conan/v1/ping - Read
Retrieve a package snapshot
Retrieves a snapshot of the files for a specified Conan package and reference. The snapshot is a list of filenames with their associated MD5 hash.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference} - Read
Retrieve a recipe snapshot
Retrieves a snapshot of the files for a specified Conan recipe. The snapshot is a list of filenames with their associated MD5 hash.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel} - Read
Retrieve a package manifest
Retrieves a manifest that includes a list of files and associated download URLs for a specified package.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/digest - Read
Retrieve a recipe manifest
Retrieves a manifest that includes a list of files and associated download URLs for a specified recipe.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/digest - Read
List all package download URLs
Lists all files and associated download URLs for a specified package in the package registry. Returns the same payload as the package manifest endpoint.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/download_urls - Read
List all recipe download URLs
Lists all files and associated download URLs for a specified recipe in the package registry. Returns the same payload as the recipe manifest endpoint.
GET /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/download_urls - Read
Retrieve a recipe file
Retrieves a specified recipe file from the package registry. You must use the download URL returned from the recipe download URLs endpoint.
GET /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name} - Read
Retrieve a package file
Retrieves a specified package file from the package registry. You must use the download URL returned from the package download URLs endpoint.
GET /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name} - Write
Retrieve an authentication token
Retrieves an authentication token. Creates a JSON Web Token (JWT) for use as a Bearer header in other requests to the package registry.
GET /api/v4/projects/{id}/packages/conan/v2/users/authenticate - Write
Retrieve an authentication token
Retrieves an authentication token. Creates a JSON Web Token (JWT) for use as a Bearer header in other requests to the package registry.
GET /api/v4/projects/{id}/packages/conan/v1/users/authenticate - Write
List all package upload URLs
Lists all the upload URLs for a specified collection of package files. The request must include a JSON object with the name and size of the individual files.
POST /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/upload_urls - Write
List all recipe upload URLs
Lists all the upload URLs for a specified collection of recipe files. The request must include a JSON object with the name and size of the individual files.
POST /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/upload_urls - Write
Retrieve an authentication token
Retrieves an authentication token. Creates a JSON Web Token (JWT) for use as a Bearer header in other requests to the package registry.
GET /api/v4/packages/conan/v1/users/authenticate - Write
List all package upload URLs
Lists all the upload URLs for a specified collection of package files. The request must include a JSON object with the name and size of the individual files.
POST /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/packages/{conan_package_reference}/upload_urls - Write
List all recipe upload URLs
Lists all the upload URLs for a specified collection of recipe files. The request must include a JSON object with the name and size of the individual files.
POST /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel}/upload_urls - Destructive
Delete recipe revision
Deletes a specified recipe revision from the registry. If the recipe revision is the only one, the package is deleted as well. This feature was introduced in GitLab 18.1.
DELETE /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision} - Destructive
Upload a recipe file
Uploads a specified recipe file to the package registry. This feature was introduced in GitLab 17.10.
PUT /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name} - Destructive
Workhorse authorize the Conan recipe file
Authorizes the Conan recipe file. This feature was introduced in GitLab 17.10.
PUT /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/files/{file_name}/authorize - Destructive
Delete a package revision
Deletes a specified package revision from the registry. If the package reference has only one package revision, the package reference is deleted as well. This feature was introduced in GitLab 18.1.
DELETE /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision} - Destructive
Upload a package file
Uploads a specified package file to the package registry. This feature was introduced in GitLab 17.11.
PUT /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name} - Destructive
Workhorse authorize the Conan package file
Authorizes the Conan package file. This feature was introduced in GitLab 17.11.
PUT /api/v4/projects/{id}/packages/conan/v2/conans/{package_name}/{package_version}/{package_username}/{package_channel}/revisions/{recipe_revision}/packages/{conan_package_reference}/revisions/{package_revision}/files/{file_name}/authorize - Destructive
Delete a recipe and package
Deletes a specified Conan recipe and associated package files from the package registry.
DELETE /api/v4/projects/{id}/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel} - Destructive
Upload a recipe file
Uploads a specified recipe file to the package registry. You must use the upload URL returned from the recipe upload URLs endpoint.
PUT /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name} - Destructive
Workhorse authorize the Conan recipe file
Authorizes the Conan recipe file.
PUT /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}/authorize - Destructive
Upload a package file
Uploads a specified package file to the package registry. You must use the upload URL returned from the package upload URLs endpoint.
PUT /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name} - Destructive
Workhorse authorize the Conan package file
Authorizes the Conan package file.
PUT /api/v4/projects/{id}/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}/authorize - Destructive
Delete a recipe and package
Deletes a specified Conan recipe and associated package files from the package registry.
DELETE /api/v4/packages/conan/v1/conans/{package_name}/{package_version}/{package_username}/{package_channel} - Destructive
Upload a recipe file
Uploads a specified recipe file to the package registry. You must use the upload URL returned from the recipe upload URLs endpoint.
PUT /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name} - Destructive
Workhorse authorize the Conan recipe file
Authorizes the Conan recipe file.
PUT /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/export/{file_name}/authorize - Destructive
Upload a package file
Uploads a specified package file to the package registry. You must use the upload URL returned from the package upload URLs endpoint.
PUT /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name} - Destructive
Workhorse authorize the Conan package file
Authorizes the Conan package file.
PUT /api/v4/packages/conan/v1/files/{package_name}/{package_version}/{package_username}/{package_channel}/{recipe_revision}/package/{conan_package_reference}/{package_revision}/{file_name}/authorize
Packages: Composer
- Read
Retrieve repository URL templates
Retrieves the repository URL templates for requesting individual packages for a group.
GET /api/v4/group/{id}/-/packages/composer/packages - Read
List all packages for a group
Lists all repository packages for a specified group. Composer V2 is recommended over V1.
GET /api/v4/group/{id}/-/packages/composer/p/{sha} - Read
Composer v2 packages p2 endpoint for a group's package versions metadata
This feature was introduced in GitLab 13.1
GET /api/v4/group/{id}/-/packages/composer/p2/{package_name} - Read
Composer packages endpoint for a group's package versions metadata
This feature was introduced in GitLab 12.1
GET /api/v4/group/{id}/-/packages/composer/{package_name} - Read
Composer package endpoint to download a package archive
This feature was introduced in GitLab 13.1
GET /api/v4/projects/{id}/packages/composer/archives/{package_name} - Write
Create a package
Creates a Composer package from a specified Git tag or branch for a project.
POST /api/v4/projects/{id}/packages/composer
Commit statuses
- Read
List all commit statuses
Lists all commit statuses for a specified project.
GET /api/v4/projects/{id}/repository/commits/{sha}/statuses - Write
Create or update a commit pipeline status
Creates or updates the status of a commit represented by a job in an `external` stage. If the commit is associated with a merge request, target the commit in the merge request source branch.
POST /api/v4/projects/{id}/statuses/{sha}
Commits
- Read
List all repository commits
Lists all commits for a specified project repository.
GET /api/v4/projects/{id}/repository/commits - Read
Retrieve a commit
Retrieves a specified commit identified by the commit hash or name of a branch or tag.
GET /api/v4/projects/{id}/repository/commits/{sha} - Read
Retrieve a commit diff
Retrieves the diff of a commit in a project.
GET /api/v4/projects/{id}/repository/commits/{sha}/diff - Read
List all commit comments
Lists all the comments of a commit in a project.
GET /api/v4/projects/{id}/repository/commits/{sha}/comments - Read
Retrieve a commit sequence
Retrieves the commit sequence for a specified commit.
GET /api/v4/projects/{id}/repository/commits/{sha}/sequence - Read
List all references a commit is pushed to
Lists all references (from branches or tags) a commit is pushed to. The pagination parameters `page` and `per_page` can be used to restrict the list of references.
GET /api/v4/projects/{id}/repository/commits/{sha}/refs - Read
List all merge requests associated with a commit
Lists all merge requests associated with a specified commit.
GET /api/v4/projects/{id}/repository/commits/{sha}/merge_requests - Read
Retrieve a commit signature
Retrieves the signature from a commit, if it is signed. For unsigned commits, it results in a 404 response.
GET /api/v4/projects/{id}/repository/commits/{sha}/signature - Write
Create a comment on a commit
Creates a comment on a commit. To comment on a specific line in a file, specify the full commit SHA, `path`, `line`, and set `line_type` to `new`.
POST /api/v4/projects/{id}/repository/commits/{sha}/comments - Write
Cherry-pick a commit
Cherry-picks a commit to a specified branch.
POST /api/v4/projects/{id}/repository/commits/{sha}/cherry_pick - Destructive
Create a commit
This feature was introduced in GitLab 8.13
POST /api/v4/projects/{id}/repository/commits - Destructive
Revert a commit
Reverts a commit in a specified branch.
POST /api/v4/projects/{id}/repository/commits/{sha}/revert
Packages: Cargo
- Read
Get config.json
This will be used by cargo for further requests
GET /api/v4/projects/{id}/packages/cargo/config.json - Read
Get the sparse index for a Cargo crate (1-character name)
Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
GET /api/v4/projects/{id}/packages/cargo/1/{package_name} - Read
Get the sparse index for a Cargo crate (2-character name)
Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
GET /api/v4/projects/{id}/packages/cargo/2/{package_name} - Read
Get the sparse index for a Cargo crate (3-character name)
Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
GET /api/v4/projects/{id}/packages/cargo/3/{first_char}/{package_name} - Read
Get the sparse index for a Cargo crate (4+ character name)
Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
GET /api/v4/projects/{id}/packages/cargo/{prefix_1}/{prefix_2}/{package_name} - Read
Download a Cargo crate
This endpoint serves the .crate file for a given package name and version
GET /api/v4/projects/{id}/packages/cargo/{package_name}/{package_version}/download - Destructive
Publish a Cargo crate
Receives the cargo publish body and extracts the crate asynchronously
PUT /api/v4/projects/{id}/packages/cargo/api/v1/crates/new
CI triggers
- Read
List all project trigger tokens
Lists all pipeline trigger tokens for a specified project.
GET /api/v4/projects/{id}/triggers - Read
Retrieve trigger token details
Retrieves details of a pipeline trigger token for a project.
GET /api/v4/projects/{id}/triggers/{trigger_id} - Write
Trigger a pipeline with a token
Triggers a pipeline with a token. With a CI/CD job token, the triggered pipeline is a multi-project pipeline. The job that authenticates the request becomes associated with the upstream pipeline, which is visible on the pipeline graph. If you use a trigger token in a job, the job is not associated with the upstream pipeline.
POST /api/v4/projects/{id}/trigger/pipeline - Write
Trigger a pipeline with a token
Triggers a pipeline with a token. With a CI/CD job token, the triggered pipeline is a multi-project pipeline. The job that authenticates the request becomes associated with the upstream pipeline, which is visible on the pipeline graph. If you use a trigger token in a job, the job is not associated with the upstream pipeline.
POST /api/v4/projects/{id}/ref/{ref}/trigger/pipeline - Write
Create a trigger token
Creates a pipeline trigger token for a project.
POST /api/v4/projects/{id}/triggers - Destructive
Update a pipeline trigger token
Updates a pipeline trigger token for a project.
PUT /api/v4/projects/{id}/triggers/{trigger_id} - Destructive
Delete a pipeline trigger token
Deletes a pipeline trigger token for a project.
DELETE /api/v4/projects/{id}/triggers/{trigger_id}
Pipelines
- Read
List pipelines triggered by the authenticated user
Lists recently created pipelines across all projects that were triggered by the authenticated user. By default, child pipelines are not included in the results. To return child pipelines, set `source` to `parent_pipeline`. This endpoint only supports keyset pagination.
GET /api/v4/pipelines - Read
List all project pipelines
Lists all pipelines in a project. By default, child pipelines are not included in the results. To return child pipelines, set `source` to `parent_pipeline`.
GET /api/v4/projects/{id}/pipelines - Read
Retrieve the latest pipeline
Retrieves the latest pipeline for the most recent commit on a specified ref in a project. If no pipeline exists for the commit, a `403` status code is returned. Use the `page` and `per_page` pagination parameters to control the pagination of results.
GET /api/v4/projects/{id}/pipelines/latest - Read
Retrieve a pipeline
Retrieves a specified pipeline from a project. You can also get a child pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id} - Read
List all jobs by pipeline
Lists all jobs for a specified pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/jobs - Read
List all bridge jobs by pipeline (deprecated)
Deprecated in GitLab 19.2. Use trigger_jobs endpoint instead.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/bridges - Read
List all trigger jobs by pipeline
Lists all trigger jobs for a specified pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/trigger_jobs - Read
List all pipeline variables
Lists all pipeline variables for a specified pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/variables - Read
Retrieve a test report for a pipeline
Retrieves a test report for a pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/test_report - Read
Retrieve a test report summary for a pipeline
Retrieves a test report summary for a pipeline.
GET /api/v4/projects/{id}/pipelines/{pipeline_id}/test_report_summary - Write
Create a pipeline
Creates a pipeline in the specified project.
POST /api/v4/projects/{id}/pipeline - Write
Retry jobs in a pipeline
Retries failed or canceled jobs in a pipeline. If there are no failed or canceled jobs in the pipeline, calling this endpoint has no effect.
POST /api/v4/projects/{id}/pipelines/{pipeline_id}/retry - Destructive
Delete a pipeline
Deletes a specified pipeline for a project.
DELETE /api/v4/projects/{id}/pipelines/{pipeline_id} - Destructive
Update pipeline metadata
Updates pipeline metadata. The metadata contains the name of the pipeline. This feature was introduced in GitLab 16.6.
PUT /api/v4/projects/{id}/pipelines/{pipeline_id}/metadata - Destructive
Cancel all jobs for a pipeline
Cancels all jobs in a specified pipeline.
POST /api/v4/projects/{id}/pipelines/{pipeline_id}/cancel
Pipeline schedules
- Read
List all pipeline schedules
Lists all pipeline schedules for a project.
GET /api/v4/projects/{id}/pipeline_schedules - Read
Retrieve a pipeline schedule
Retrieves a pipeline schedule for a project.
GET /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id} - Read
List all pipelines triggered by a pipeline schedule
Lists all pipelines triggered by a pipeline schedule in a project.
GET /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/pipelines - Read
Retrieve a variable for a pipeline schedule
Retrieves a specified variable for a pipeline schedule.
GET /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key} - Write
Create a pipeline schedule
Creates a pipeline schedule.
POST /api/v4/projects/{id}/pipeline_schedules - Write
Create or update ownership of a pipeline schedule
Creates or updates the owner of a pipeline schedule for a project.
POST /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/take_ownership - Write
Run a pipeline schedule
Runs a pipeline schedule immediately. The next scheduled run of this pipeline is not affected.
POST /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/play - Write
Create a variable for a pipeline schedule
Creates a variable for a pipeline schedule.
POST /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables - Destructive
Update a pipeline schedule
Updates a pipeline schedule for a project. After the update is done, it is rescheduled automatically.
PUT /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id} - Destructive
Delete a pipeline schedule
Deletes a pipeline schedule for a project.
DELETE /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id} - Destructive
Update a variable for a pipeline schedule
Updates a variable for a pipeline schedule.
PUT /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key} - Destructive
Delete a variable for a pipeline schedule
Deletes a specified variable for a pipeline schedule.
DELETE /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}
Secure files
- Read
List all secure files for a project
Lists all secure files for a specified project.
GET /api/v4/projects/{id}/secure_files - Read
Retrieve details of a secure file
Retrieves details of a specified secure file in a project.
GET /api/v4/projects/{id}/secure_files/{secure_file_id} - Read
Download a secure file
Downloads the contents of a specified secure file in a project.
GET /api/v4/projects/{id}/secure_files/{secure_file_id}/download - Write
Create a secure file
Creates a secure file in a specified project.
POST /api/v4/projects/{id}/secure_files - Destructive
Delete a secure file
Deletes a specified secure file from a project.
DELETE /api/v4/projects/{id}/secure_files/{secure_file_id}
CI runners
- Read
Discover Job Router information
Discovers Job Router information for a runner. You must provide a valid runner authentication token.
GET /api/v4/runners/router/discovery - Write
Create a runner
Creates a runner.
POST /api/v4/runners - Write
Verify authentication for a registered runner
Verifies authentication for a registered runner.
POST /api/v4/runners/verify - Destructive
Delete a registered runner
Deletes a specified registered runner.
DELETE /api/v4/runners - Destructive
Delete a registered runner manager
Deletes a runner manager identified by the runner authentication token and system ID.
DELETE /api/v4/runners/managers - Destructive
Reset a runner authentication token with the current token
Resets a runner authentication token with the token used to authenticate the request.
POST /api/v4/runners/reset_authentication_token
Jobs
- Read
Get the runtime environment key for a job
Retrieves the runtime environment key linked to a job, if the job is resuming a suspended environment.
GET /api/v4/jobs/{id}/runtime_environment_key - Read
Download job artifacts
Downloads artifacts for a specified job.
GET /api/v4/jobs/{id}/artifacts - Write
Request a job
Requests a job for a runner to execute.
POST /api/v4/jobs/request - Write
Update the trace of a job
Updates the trace of a job by appending a chunk of log output. Used by runners while executing a job.
PATCH /api/v4/jobs/{id}/trace - Write
Authorize artifacts upload
Authorizes uploading artifacts for a specified job.
POST /api/v4/jobs/{id}/artifacts/authorize - Write
Upload job artifacts
Uploads artifacts for a specified job.
POST /api/v4/jobs/{id}/artifacts - Destructive
Update a job
Updates the state and other attributes of a job. Used by runners while executing a job.
PUT /api/v4/jobs/{id}
CI resource groups
- Read
List all resource groups
Lists all resource groups for a specified project.
GET /api/v4/projects/{id}/resource_groups - Read
Retrieve a resource group
Retrieves a specified resource group for a project.
GET /api/v4/projects/{id}/resource_groups/{key} - Read
Retrieve current job for a resource group
Retrieves the current job for a specified resource group in a project.
GET /api/v4/projects/{id}/resource_groups/{key}/current_job - Read
List all upcoming jobs for a resource group
Lists all upcoming jobs for a specified resource group.
GET /api/v4/projects/{id}/resource_groups/{key}/upcoming_jobs - Destructive
Update a resource group
Updates the properties for a specified resource group. It returns `200` if the resource group was successfully updated. In case of an error, a status code `400` is returned.
PUT /api/v4/projects/{id}/resource_groups/{key}
CI jobs
- Read
List all jobs for a project
Lists all jobs for a specified project. By default, this request returns 20 results at a time because the API results are paginated.
GET /api/v4/projects/{id}/jobs - Read
Retrieve a job
Retrieves a job with the specified job ID.
GET /api/v4/projects/{id}/jobs/{job_id} - Read
Get a trace of a specific job of a project
Retrieves a log file for a job.
GET /api/v4/projects/{id}/jobs/{job_id}/trace - Read
Retrieve a job by job token
Retrieves a job that was generated by a specified job token.
GET /api/v4/job - Write
Retry a job
Retries a specified job in a project.
POST /api/v4/projects/{id}/jobs/{job_id}/retry - Write
Run a job
Runs a specified job. For a job in manual status, triggers an action to start the job.
POST /api/v4/projects/{id}/jobs/{job_id}/play - Destructive
Cancel a job
Cancels a specified job in a project.
POST /api/v4/projects/{id}/jobs/{job_id}/cancel - Destructive
Erase a job
Erases a specified job in a project. This removes job artifacts and the job log.
POST /api/v4/projects/{id}/jobs/{job_id}/erase
Agents
- Read
List all GitLab agents for Kubernetes by job token
Lists all GitLab agents for Kubernetes with a specified `CI_JOB_TOKEN`.
GET /api/v4/job/allowed_agents
Job artifacts
- Read
Retrieve job artifacts
Retrieves the artifacts archive for the latest successful job on a specified branch or tag.
GET /api/v4/projects/{id}/jobs/artifacts/{ref_name}/download - Read
Download a specific file from artifacts archive from a ref
This feature was introduced in GitLab 11.5
GET /api/v4/projects/{id}/jobs/artifacts/{ref_name}/raw/{artifact_path} - Read
Download an artifact from a job
This feature was introduced in GitLab 8.5. The `file_type` attribute was added in GitLab 19.4.
GET /api/v4/projects/{id}/jobs/{job_id}/artifacts - Read
List all files in an artifacts archive
Lists all files in a specified artifacts archive without extracting them.
GET /api/v4/projects/{id}/jobs/{job_id}/artifacts/tree - Read
Download a specific file from artifacts archive
This feature was introduced in GitLab 10.0
GET /api/v4/projects/{id}/jobs/{job_id}/artifacts/{artifact_path} - Write
Retain job artifacts
Retains job artifacts. Prevents artifacts for a job from being automatically deleted when they reach their expiration date.
POST /api/v4/projects/{id}/jobs/{job_id}/artifacts/keep - Destructive
Delete job artifacts
Deletes job artifacts from a specified job in a project.
DELETE /api/v4/projects/{id}/jobs/{job_id}/artifacts - Destructive
Delete all job artifacts in a project
Deletes job artifacts from all jobs in a specified project.
DELETE /api/v4/projects/{id}/artifacts
CI catalog
- Write
Publish a new component project release as version to the CI/CD catalog
Publishes a release of a catalog resource as version to the CI/CD catalog.
POST /api/v4/projects/{id}/catalog/publish
Branches
- Read
List all repository branches
Lists all repository branches from a specified project, sorted alphabetically by name. Search by name, or use regular expressions to find specific branch patterns. Returns detailed information about the branch, including its protection status, merge status, and commit details.
GET /api/v4/projects/{id}/repository/branches - Read
Check if a branch exists
Checks whether a branch exists in the repository, without returning the branch.
HEAD /api/v4/projects/{id}/repository/branches/{branch} - Read
Retrieve a repository branch
Retrieves a specified project repository branch.
GET /api/v4/projects/{id}/repository/branches/{branch} - Write
Create a repository branch
Creates a branch in the repository.
POST /api/v4/projects/{id}/repository/branches - Destructive
Delete a repository branch
Deletes a specified branch from the repository.
DELETE /api/v4/projects/{id}/repository/branches/{branch} - Destructive
Protect a single branch
Protects a single branch, or updates its protection if it is already protected. Only users with the Maintainer role can push or merge unless `developers_can_push` or `developers_can_merge` is `true`.
PUT /api/v4/projects/{id}/repository/branches/{branch}/protect - Destructive
Unprotect a single branch
Removes the protection from a single protected branch.
PUT /api/v4/projects/{id}/repository/branches/{branch}/unprotect - Destructive
Delete all merged branches
Deletes all branches that are merged into the default branch for a project.
DELETE /api/v4/projects/{id}/repository/merged_branches
Badges
- Read
List all badges for a group
Lists all badges for a specified group.
GET /api/v4/groups/{id}/badges - Read
Retrieve a badge preview for a group
Previews the final `link_url` and `image_url` for a specified group after resolving the placeholder interpolation.
GET /api/v4/groups/{id}/badges/render - Read
Retrieve a badge for a group
Retrieves a specified badge for a group.
GET /api/v4/groups/{id}/badges/{badge_id} - Read
List all badges for a project
Lists all badges for a specified project, including group badges.
GET /api/v4/projects/{id}/badges - Read
Retrieve a badge preview for a project
Previews the final `link_url` and `image_url` for a specified project after resolving the placeholder interpolation.
GET /api/v4/projects/{id}/badges/render - Read
Retrieve a badge for a project
Retrieves a specified badge for a project.
GET /api/v4/projects/{id}/badges/{badge_id} - Write
Create a badge for a group
Creates a badge for a specified group.
POST /api/v4/groups/{id}/badges - Write
Create a badge for a project
Creates a badge for a specified project.
POST /api/v4/projects/{id}/badges - Destructive
Update a badge for a group
Updates a specified badge for a group.
PUT /api/v4/groups/{id}/badges/{badge_id} - Destructive
Delete a badge from a group
Deletes a specified badge from a group.
DELETE /api/v4/groups/{id}/badges/{badge_id} - Destructive
Update a badge for a project
Updates a specified badge for a project.
PUT /api/v4/projects/{id}/badges/{badge_id} - Destructive
Delete a badge from a project
Deletes a specified badge from a project.
DELETE /api/v4/projects/{id}/badges/{badge_id}
Award emoji
- Read
List all emoji reactions for an issue
Lists all emoji reactions for a specified issue. This endpoint can be accessed without authentication if the issue is publicly accessible.
GET /api/v4/projects/{id}/issues/{issue_iid}/award_emoji - Read
Retrieve an emoji reaction from an issue
Retrieves a specified emoji reaction from an issue. This endpoint can be accessed without authentication if the issue is publicly accessible.
GET /api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id} - Read
List all emoji reactions for an issue comment
Lists all emoji reactions for a specified comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji - Read
Retrieve an emoji reaction from an issue comment
Retrieves a specified emoji reaction from a comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id} - Read
List all emoji reactions for a merge request
Lists all emoji reactions for a specified merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji - Read
Retrieve an emoji reaction from a merge request
Retrieves a specified emoji reaction from a merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id} - Read
List all emoji reactions for a merge request comment
Lists all emoji reactions for a specified comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji - Read
Retrieve an emoji reaction from a merge request comment
Retrieves a specified emoji reaction from a comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id} - Read
List all emoji reactions for a snippet
Lists all emoji reactions for a specified snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.
GET /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji - Read
Retrieve an emoji reaction from a snippet
Retrieves a specified emoji reaction from a snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.
GET /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id} - Read
List all emoji reactions for a snippet comment
Lists all emoji reactions for a specified comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji - Read
Retrieve an emoji reaction from a snippet comment
Retrieves a specified emoji reaction from a comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id} - Read
List all emoji reactions for an epic
Lists all emoji reactions for a specified epic. This endpoint can be accessed without authentication if the epic is publicly accessible.
GET /api/v4/groups/{id}/epics/{epic_iid}/award_emoji - Read
Retrieve an emoji reaction from an epic
Retrieves a specified emoji reaction from an epic. This endpoint can be accessed without authentication if the epic is publicly accessible.
GET /api/v4/groups/{id}/epics/{epic_iid}/award_emoji/{award_id} - Read
List all emoji reactions for an epic comment
Lists all emoji reactions for a specified comment on an epic. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji - Read
Retrieve an emoji reaction from an epic comment
Retrieves a specified emoji reaction from a comment on an epic. This endpoint can be accessed without authentication if the comment is publicly accessible.
GET /api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji/{award_id} - Write
Add an emoji reaction to an issue
Adds an emoji reaction to an issue.
POST /api/v4/projects/{id}/issues/{issue_iid}/award_emoji - Write
Add an emoji reaction to an issue comment
Adds an emoji reaction to a comment on an issue.
POST /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji - Write
Add an emoji reaction to a merge request
Adds an emoji reaction to a merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji - Write
Add an emoji reaction to a merge request comment
Adds an emoji reaction to a comment on a merge request.
POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji - Write
Add an emoji reaction to a snippet
Adds an emoji reaction to a snippet.
POST /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji - Write
Add an emoji reaction to a snippet comment
Adds an emoji reaction to a comment on a snippet.
POST /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji - Write
Add an emoji reaction to an epic
Adds an emoji reaction to an epic.
POST /api/v4/groups/{id}/epics/{epic_iid}/award_emoji - Write
Add an emoji reaction to an epic comment
Adds an emoji reaction to a comment on an epic.
POST /api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji - Destructive
Delete an emoji reaction from an issue
Deletes a specified emoji reaction from an issue. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from an issue comment
Deletes a specified emoji reaction from a comment on an issue. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from a merge request
Deletes a specified emoji reaction from a merge request. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from a merge request comment
Deletes a specified emoji reaction from a comment on a merge request. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from a snippet
Deletes a specified emoji reaction from a snippet. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from a snippet comment
Deletes a specified emoji reaction from a comment on a snippet. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from an epic
Deletes a specified emoji reaction from an epic. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/groups/{id}/epics/{epic_iid}/award_emoji/{award_id} - Destructive
Delete an emoji reaction from an epic comment
Deletes a specified emoji reaction from a comment on an epic. Only an administrator or the user who added the reaction can delete it.
DELETE /api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji/{award_id}
Authn
- Read
Return the OIDC ID-token claims for the caller identified by an IAM OAuth token
Authenticates exclusively via an IAM-issued OAuth JWT and returns the subset of OIDC claims documented as "Included in ID Token" in the OpenID Connect provider docs
GET /api/v4/iam/userinfo
Alert management
- Read
List all metric images
Lists all metric images for a specified alert.
GET /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images - Write
Workhorse authorize metric image file upload
Pre-upload authorization endpoint for metric images attached to alerts. Called by GitLab Workhorse.
POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize - Write
Upload a metric image
Uploads a metric image for a specified alert.
POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images - Destructive
Update a metric image
Updates a specified metric image for an alert.
PUT /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} - Destructive
Delete a metric image
Deletes a specified metric image for an alert.
DELETE /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}
Plan limits
- Read
Get current plan limits
List the current limits of a plan on the GitLab instance.
GET /api/v4/application/plan_limits - Destructive
Change plan limits
Modify the limits of a plan on the GitLab instance.
PUT /api/v4/application/plan_limits
Migrations
- Read
List all pending migrations
Lists all pending migrations for the instance.
GET /api/v4/admin/migrations/pending - Write
Update status of a migration
Updates the status of a migration to indicate a successful execution. This prevent them from being executed by the `db:migrate` tasks. Use this API to skip failing migrations after you determine they are safe to skip.
POST /api/v4/admin/migrations/{timestamp}/mark
Broadcast messages
- Read
List all broadcast messages
Lists all broadcast messages for the instance.
GET /api/v4/broadcast_messages - Read
Retrieve a broadcast message
Retrieves a specified broadcast message.
GET /api/v4/broadcast_messages/{id} - Write
Create a broadcast message
Creates a broadcast message.
POST /api/v4/broadcast_messages - Destructive
Update a broadcast message
Updates a specified broadcast message.
PUT /api/v4/broadcast_messages/{id} - Destructive
Delete a broadcast message
Deletes a specified broadcast message.
DELETE /api/v4/broadcast_messages/{id}
Batched background operations
- Read
Get the list of batched background operations
This feature was introduced in GitLab 19.1.
GET /api/v4/admin/batched_background_operations - Read
Retrieve a batched background operation
This feature was introduced in GitLab 19.1.
GET /api/v4/admin/batched_background_operations/{id} - Destructive
Stop a batched background operation
This feature was introduced in GitLab 19.2.
PUT /api/v4/admin/batched_background_operations/{id}/stop - Destructive
Restart a batched background operation
This feature was introduced in GitLab 19.2.
PUT /api/v4/admin/batched_background_operations/{id}/restart
Batched background migrations
- Read
Retrieve a batched background migration
Fetches details of a specific batched migration, with optional filtering by database target.
GET /api/v4/admin/batched_background_migrations/{id} - Read
Get the list of batched background migrations
Lists all batched background migrations with optional filters for database and job class name.
GET /api/v4/admin/batched_background_migrations - Destructive
Resume a batched background migration
Resumes execution of a previously paused batched background migration.
PUT /api/v4/admin/batched_background_migrations/{id}/resume - Destructive
Pause a batched background migration
Pauses an active batched background migration temporarily.
PUT /api/v4/admin/batched_background_migrations/{id}/pause
Access requests
- Read
List all access requests for a group
Lists all access requests for a specified group that are viewable by the authenticated user.
GET /api/v4/groups/{id}/access_requests - Read
List all access requests for a project
Lists all access requests for a specified project that are viewable by the authenticated user.
GET /api/v4/projects/{id}/access_requests - Write
Request access to a group
Requests access to a specified group for the authenticated user.
POST /api/v4/groups/{id}/access_requests - Write
Request access to a project
Requests access to a specified project for the authenticated user.
POST /api/v4/projects/{id}/access_requests - Destructive
Approve an access request
Approves an access request for a specified user in a group.
PUT /api/v4/groups/{id}/access_requests/{user_id}/approve - Destructive
Deny an access request
Denies an access request for a specified user in a group.
DELETE /api/v4/groups/{id}/access_requests/{user_id} - Destructive
Approve an access request
Approves an access request for a specified user in a project.
PUT /api/v4/projects/{id}/access_requests/{user_id}/approve - Destructive
Deny an access request
Denies an access request for a specified user in a project.
DELETE /api/v4/projects/{id}/access_requests/{user_id}
No operations match.
Get started
- Open Space settings → Connections and search for GitLab.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.