How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitLab Admin API

The Admin API from GitLab — 11 operation(s) for admin.

GitLab Admin API is one of 44 APIs that GitLab publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, rate-limit docs, and an AsyncAPI specification.

This API exposes 16 operations across 11 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://www.gitlab.com/api/.

16 operations 11 paths 9 schemas 2 DELETE7 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://gitlab.com/api/graphql
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

GitLab Admin API declares 1 security scheme for authenticating requests. An API key is passed in the header as Private-Token (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 7 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin 16
GET
/api/v4/admin/batched_background_migrations/{id}
Retrieve a batched background migration
getApiV4AdminBatchedBackgroundMigrationsId 2 params → 200401403404
GET
/api/v4/admin/batched_background_migrations
Get the list of batched background migrations
getApiV4AdminBatchedBackgroundMigrations 1 param → 200401403
PUT
/api/v4/admin/batched_background_migrations/{id}/resume
Resume a batched background migration
putApiV4AdminBatchedBackgroundMigrationsIdResume 1 param body → 200401403404422
PUT
/api/v4/admin/batched_background_migrations/{id}/pause
Pause a batched background migration
putApiV4AdminBatchedBackgroundMigrationsIdPause 1 param body → 200401403404422
GET
/api/v4/admin/ci/variables/{key}
Get the details of a specific instance-level variable
getApiV4AdminCiVariablesKey 1 param → 200404
PUT
/api/v4/admin/ci/variables/{key}
Update an instance-level variable
putApiV4AdminCiVariablesKey 1 param body → 200404
DELETE
/api/v4/admin/ci/variables/{key}
Delete an existing instance-level variable
deleteApiV4AdminCiVariablesKey 1 param → 204404
GET
/api/v4/admin/ci/variables
List all instance-level variables
getApiV4AdminCiVariables 2 params → 200
POST
/api/v4/admin/ci/variables
Create a new instance-level variable
postApiV4AdminCiVariables body → 201400
GET
/api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}
Retrieve dictionary details
getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName 2 params → 200401403404
GET
/api/v4/admin/clusters/{cluster_id}
GitLab Get a Single Instance Cluster
getApiV4AdminClustersClusterId 1 param → 200403404
PUT
/api/v4/admin/clusters/{cluster_id}
GitLab Edit Instance Cluster
putApiV4AdminClustersClusterId 1 param body → 200400403404
DELETE
/api/v4/admin/clusters/{cluster_id}
GitLab Delete Instance Cluster
deleteApiV4AdminClustersClusterId 1 param → 204403404
POST
/api/v4/admin/clusters/add
GitLab Add Existing Instance Cluster
postApiV4AdminClustersAdd body → 201400403404
GET
/api/v4/admin/clusters
GitLab List Instance Clusters
getApiV4AdminClusters → 200403
POST
/api/v4/admin/migrations/{timestamp}/mark
Mark the migration as successfully executed
postApiV4AdminMigrationsTimestampMark 1 param body → 201401403404422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Cluster (15 properties), API_Entities_UserBasic (9 properties), API_Entities_Ci_Variable (7 properties), API_Entities_ProjectIdentity (7 properties). Each schema is shown below with its type and property counts.

API_Entities_Ci_Variable
object
APIEntitiesCiVariable model
7 properties
API_Entities_Dictionary_Table
object
APIEntitiesDictionaryTable model
2 properties
API_Entities_ProjectIdentity
object
7 properties
API_Entities_CustomAttribute
object
2 properties
API_Entities_Provider_Gcp
object
7 properties
API_Entities_Platform_Kubernetes
object
4 properties
API_Entities_UserBasic
object
9 properties
API_Entities_Cluster
object
APIEntitiesCluster model
15 properties
API_Entities_BatchedBackgroundMigration
object
APIEntitiesBatchedBackgroundMigration model
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-admin-api-openapi.yml Raw ↑

Other APIs GitLab publishes across the network.

GitLab GraphQL API
GitLab Issues API
GitLab Merge Requests API
GitLab Pipelines API
GitLab Jobs API
GitLab Runners API
GitLab Users API
GitLab Repositories API
GitLab Commits API
GitLab Branches API
GitLab Tags API
GitLab Releases API
Where this information came from

This is an independent, third-party profile of GitLab Admin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.