GitLab REST API
Emulate the GitLab REST API in seconds. An OpenAPI definition for the GitLab REST API.
[01]
About
Mock the GitLab REST API as a turnkey Mockzilla sim with 72 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. An OpenAPI definition for the GitLab REST API. Methods: 33x GET, 14x PUT, 14x POST, 11x DELETE. Top resource groups: badges, access_requests, branches, bulk_imports. Hit https://api.justmocks.com/gitlab for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
72 across 17 resource groups
Methods
GET 33 · POST 14 · PUT 14 · DEL 11 none deprecated
OpenAPI
3.0.1 spec version v4
Source spec
110 KB · YAML
[02]
Endpoints
| GET |
/groups/{id}/badges/{badge_id}
|
Gets a badge of a group. This feature was introduced in GitLab 10.6. Mocked via Mockzilla.
|
| PUT |
/groups/{id}/badges/{badge_id}
|
Updates a badge of a group. This feature was introduced in GitLab 10.6.
|
| DEL |
/groups/{id}/badges/{badge_id}
|
Removes a badge from the group. This feature was introduced in GitLab 10.6.
|
| GET |
/groups/{id}/badges
|
Gets a list of group badges viewable by the authenticated user. This feature was introduced in GitLab 10.6.
|
| POST |
/groups/{id}/badges
|
Adds a badge to a group. This feature was introduced in GitLab 10.6.
|
| GET |
/groups/{id}/badges/render
|
Preview a badge from a group. This feature was introduced in GitLab 10.6. Available as a Mockzilla mock endpoint.
|
| DEL |
/groups/{id}/access_requests/{user_id}
|
Denies an access request for the given user. This feature was introduced in GitLab 8.11.
|
| PUT |
/groups/{id}/access_requests/{user_id}/approve
|
Approves an access request for the given user. This feature was introduced in GitLab 8.11.
|
| GET |
/groups/{id}/access_requests
|
Gets a list of access requests for a group. This feature was introduced in GitLab 8.11.
|
| POST |
/groups/{id}/access_requests
|
Requests access for the authenticated user to a group. This feature was introduced in GitLab 8.11.
|
| DEL |
/projects/{id}/repository/merged_branches
|
Delete all merged branches. Mockzilla mock: no signup, no API key.
|
| GET |
/projects/{id}/repository/branches/{branch}
|
Get a single repository branch
|
| DEL |
/projects/{id}/repository/branches/{branch}
|
Delete a branch
|
| GET |
/projects/{id}/repository/branches
|
Get a project repository branches
|
| POST |
/projects/{id}/repository/branches
|
Create branch
|
| PUT |
/projects/{id}/repository/branches/{branch}/unprotect
|
Unprotect a single branch. Served by the Mockzilla mock runtime.
|
| PUT |
/projects/{id}/repository/branches/{branch}/protect
|
Protect a single branch
|
| GET |
/projects/{id}/badges/{badge_id}
|
Gets a badge of a project. This feature was introduced in GitLab 10.6.
|
| PUT |
/projects/{id}/badges/{badge_id}
|
Updates a badge of a project. This feature was introduced in GitLab 10.6.
|
| DEL |
/projects/{id}/badges/{badge_id}
|
Removes a badge from the project. This feature was introduced in GitLab 10.6.
|
| GET |
/projects/{id}/badges
|
Gets a list of project badges viewable by the authenticated user. This feature was introduced in GitLab 10.6. Mocked via Mockzilla.
|
| POST |
/projects/{id}/badges
|
Adds a badge to a project. This feature was introduced in GitLab 10.6.
|
| GET |
/projects/{id}/badges/render
|
Preview a badge from a project. This feature was introduced in GitLab 10.6.
|
| DEL |
/projects/{id}/access_requests/{user_id}
|
Denies an access request for the given user. This feature was introduced in GitLab 8.11.
|
| PUT |
/projects/{id}/access_requests/{user_id}/approve
|
Approves an access request for the given user. This feature was introduced in GitLab 8.11.
|
| GET |
/projects/{id}/access_requests
|
Gets a list of access requests for a project. This feature was introduced in GitLab 8.11. Available as a Mockzilla mock endpoint.
|
| POST |
/projects/{id}/access_requests
|
Requests access for the authenticated user to a project. This feature was introduced in GitLab 8.11.
|
| PUT |
/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}
|
Update a metric image for an alert
|
| DEL |
/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}
|
Remove a metric image for an alert
|
| GET |
/projects/{id}/alert_management_alerts/{alert_iid}/metric_images
|
Metric Images for alert
|
| POST |
/projects/{id}/alert_management_alerts/{alert_iid}/metric_images
|
Upload a metric image for an alert. Mockzilla mock: no signup, no API key.
|
| POST |
/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize
|
Workhorse authorize metric image file upload
|
| GET |
/admin/batched_background_migrations/{id}
|
Retrieve a batched background migration
|
| GET |
/admin/batched_background_migrations
|
Get the list of batched background migrations
|
| PUT |
/admin/batched_background_migrations/{id}/resume
|
Resume a batched background migration
|
| PUT |
/admin/batched_background_migrations/{id}/pause
|
Pause a batched background migration. Served by the Mockzilla mock runtime.
|
| GET |
/admin/ci/variables/{key}
|
Get the details of a specific instance-level variable
|
| PUT |
/admin/ci/variables/{key}
|
Update an instance-level variable
|
| DEL |
/admin/ci/variables/{key}
|
Delete an existing instance-level variable
|
| GET |
/admin/ci/variables
|
List all instance-level variables
|
| POST |
/admin/ci/variables
|
Create a new instance-level variable. Mocked via Mockzilla.
|
| GET |
/admin/databases/{database_name}/dictionary/tables/{table_name}
|
Retrieve dictionary details
|
| GET |
/admin/clusters/{cluster_id}
|
Get a single instance cluster This feature was introduced in GitLab 13.2. Returns a single instance cluster.
|
| PUT |
/admin/clusters/{cluster_id}
|
Edit instance cluster This feature was introduced in GitLab 13.2. Updates an existing instance cluster.
|
| DEL |
/admin/clusters/{cluster_id}
|
Delete instance cluster This feature was introduced in GitLab 13.2. Deletes an existing instance cluster. Does not remove existing resources within the connected Kubernetes cluster.
|
| POST |
/admin/clusters/add
|
Add existing instance cluster This feature was introduced in GitLab 13.2. Adds an existing Kubernetes instance cluster. Available as a Mockzilla mock endpoint.
|
| GET |
/admin/clusters
|
List instance clusters This feature was introduced in GitLab 13.2. Returns a list of instance clusters.
|
| POST |
/admin/migrations/{timestamp}/mark
|
Mark the migration as successfully executed
|
| DEL |
/applications/{id}
|
Delete an application Delete a specific application
|
| GET |
/applications
|
Get applications List all registered applications
|
| POST |
/applications
|
Create a new application This feature was introduced in GitLab 10.5. Mockzilla mock: no signup, no API key.
|
| GET |
/avatar
|
Return avatar url for a user
|
| GET |
/broadcast_messages/{id}
|
Get a specific broadcast message This feature was introduced in GitLab 8.12.
|
| PUT |
/broadcast_messages/{id}
|
Update a broadcast message This feature was introduced in GitLab 8.12.
|
| DEL |
/broadcast_messages/{id}
|
Delete a broadcast message This feature was introduced in GitLab 8.12.
|
| GET |
/broadcast_messages
|
Get all broadcast messages This feature was introduced in GitLab 8.12. Served by the Mockzilla mock runtime.
|
| POST |
/broadcast_messages
|
Create a broadcast message This feature was introduced in GitLab 8.12.
|
| GET |
/bulk_imports/{import_id}/entities/{entity_id}
|
Get GitLab Migration entity details This feature was introduced in GitLab 14.1.
|
| GET |
/bulk_imports/{import_id}/entities
|
List GitLab Migration entities This feature was introduced in GitLab 14.1.
|
| GET |
/bulk_imports/{import_id}
|
Get GitLab Migration details This feature was introduced in GitLab 14.1.
|
| GET |
/bulk_imports/entities
|
List all GitLab Migrations' entities This feature was introduced in GitLab 14.1. Mocked via Mockzilla.
|
| GET |
/bulk_imports
|
List all GitLab Migrations This feature was introduced in GitLab 14.1.
|
| POST |
/bulk_imports
|
Start a new GitLab Migration This feature was introduced in GitLab 14.2.
|
| GET |
/application/appearance
|
Get the current appearance
|
| PUT |
/application/appearance
|
Modify appearance
|
| GET |
/application/plan_limits
|
Get current plan limits List the current limits of a plan on the GitLab instance. Available as a Mockzilla mock endpoint.
|
| PUT |
/application/plan_limits
|
Change plan limits Modify the limits of a plan on the GitLab instance.
|
| GET |
/metadata
|
Retrieve metadata information for this GitLab instance This feature was introduced in GitLab 15.2.
|
| GET |
/version
|
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 |
/projects/{id}/jobs
|
List jobs for a project
|
| GET |
/projects/{id}/jobs/{job_id}
|
Get a single job by ID
|
| POST |
/projects/{id}/jobs/{job_id}/play
|
Run a manual job
|