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 CI/CD groups API

Operations about groups

GitLab CI/CD groups API is one of 98 APIs that GitLab CI/CD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 40 operations across 33 paths, and defines 38 schemas. It is described by OpenAPI 2.0, at version v4.

Requests are made against the base URL https://gitlab.com/api/v4.

40 operations 33 paths 38 schemas 4 DELETE21 GET14 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v4
Base URL
https://gitlab.com/api/v4
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

GitLab CI/CD groups API declares 2 security schemes for authenticating requests. An API key is passed in the header as PRIVATE-TOKEN (access_token_header). An API key is passed in the query as private_token (access_token_query).

Paths & Operations 40

Across 33 paths, the API surfaces 40 operations — 4 DELETE, 21 GET, 14 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

groups 40

Operations about groups

GET
/api/v4/groups
Get a groups list
getApiV4Groups 17 params → 200
POST
/api/v4/groups
Create a group. Available only for users who can create groups.
postApiV4Groups 1 param → 201
PUT
/api/v4/groups/{id}
Update a group. Available only for users who can administrate groups.
putApiV4GroupsId 2 params → 200
GET
/api/v4/groups/{id}
Get a single group, with containing projects.
getApiV4GroupsId 3 params → 200
DELETE
/api/v4/groups/{id}
Remove a group.
deleteApiV4GroupsId 1 param → 204
POST
/api/v4/groups/{id}/archive
Archive a group
postApiV4GroupsIdArchive 1 param → 200403
POST
/api/v4/groups/{id}/unarchive
Unarchive a group
postApiV4GroupsIdUnarchive 1 param → 200403
POST
/api/v4/groups/{id}/restore
Restore a group.
postApiV4GroupsIdRestore 1 param → 201
GET
/api/v4/groups/{id}/groups/shared
Get a list of shared groups this group was invited to
getApiV4GroupsIdGroupsShared 10 params → 200
GET
/api/v4/groups/{id}/invited_groups
Get a list of invited groups in this group
getApiV4GroupsIdInvitedGroups 7 params → 200
GET
/api/v4/groups/{id}/projects
Get a list of projects in this group.
getApiV4GroupsIdProjects 20 params → 200
GET
/api/v4/groups/{id}/projects/shared
Get a list of shared projects in this group
getApiV4GroupsIdProjectsShared 14 params → 200
GET
/api/v4/groups/{id}/subgroups
Get a list of subgroups in this group.
getApiV4GroupsIdSubgroups 18 params → 200
GET
/api/v4/groups/{id}/descendant_groups
Get a list of descendant groups of this group.
getApiV4GroupsIdDescendantGroups 18 params → 200
POST
/api/v4/groups/{id}/projects/{project_id}
Transfer a project to the group namespace. Available only for admin.
postApiV4GroupsIdProjectsProjectId 2 params → 201
GET
/api/v4/groups/{id}/transfer_locations
Get the groups to where the current group can be transferred to
getApiV4GroupsIdTransferLocations 4 params → 200
POST
/api/v4/groups/{id}/transfer
Transfer a group to a new parent group or promote a subgroup to a top-level group
postApiV4GroupsIdTransfer 2 params → 201
POST
/api/v4/groups/{id}/transfer_to_organization
Transfer a group to an organization
postApiV4GroupsIdTransferToOrganization 2 params → 201400401403404422
POST
/api/v4/groups/{id}/share
Share a group with a group
postApiV4GroupsIdShare 2 params → 201
DELETE
/api/v4/groups/{id}/share/{group_id}
Unshare a group with a group
deleteApiV4GroupsIdShareGroupId 2 params → 204
GET
/api/v4/groups/{id}/audit_events/{audit_event_id}
Get a specific audit event in this group.
getApiV4GroupsIdAuditEventsAuditEventId 2 params → 200
GET
/api/v4/groups/{id}/saml_users
Get a list of SAML users of the group
getApiV4GroupsIdSamlUsers 9 params → 200
GET
/api/v4/groups/{id}/provisioned_users
Get a list of users provisioned by the group
getApiV4GroupsIdProvisionedUsers 9 params → 200
GET
/api/v4/groups/{id}/runners
List group's runners
getApiV4GroupsIdRunners 8 params → 200400403
POST
/api/v4/groups/{id}/runners/reset_registration_token
Reset the runner registration token for a group
postApiV4GroupsIdRunnersResetRegistrationToken 1 param → 201401403404
GET
/api/v4/groups/{id}/placeholder_reassignments
Download the list of pending placeholder assignments for a group
getApiV4GroupsIdPlaceholderReassignments 1 param → 200
POST
/api/v4/groups/{id}/placeholder_reassignments
Upload placeholder reassignments CSV file
postApiV4GroupsIdPlaceholderReassignments 2 params → 201
POST
/api/v4/groups/{id}/placeholder_reassignments/authorize
Workhorse authorization for the reassignment CSV file
postApiV4GroupsIdPlaceholderReassignmentsAuthorize 1 param → 201
GET
/api/v4/groups/{id}/issues
Get a list of group issues
getApiV4GroupsIdIssues 44 params → 200
GET
/api/v4/groups/{id}/issues_statistics
Get statistics for the list of group issues
getApiV4GroupsIdIssuesStatistics 34 params → 200
POST
/api/v4/groups/{id}/uploads/authorize
Workhorse authorize the file upload
postApiV4GroupsIdUploadsAuthorize 1 param → 200404
POST
/api/v4/groups/{id}/uploads
Upload a file to a group
postApiV4GroupsIdUploads 2 params → 201400404
GET
/api/v4/groups/{id}/uploads
Get the list of uploads of a group
getApiV4GroupsIdUploads 3 params → 200403404
GET
/api/v4/groups/{id}/uploads/{upload_id}
Download a single group upload by ID
getApiV4GroupsIdUploadsUploadId 2 params → 200403404
DELETE
/api/v4/groups/{id}/uploads/{upload_id}
Delete a single group upload
deleteApiV4GroupsIdUploadsUploadId 2 params → 204400403404
GET
/api/v4/groups/{id}/uploads/{secret}/{filename}
Download a single group upload by secret and filename
getApiV4GroupsIdUploadsSecretFilename 3 params → 200403404
DELETE
/api/v4/groups/{id}/uploads/{secret}/{filename}
Delete a single group upload by secret and filename
deleteApiV4GroupsIdUploadsSecretFilename 3 params → 204400403404
GET
/api/v4/groups/{id}/billable_members
Gets a list of billable users of top-level group.
getApiV4GroupsIdBillableMembers 5 params → 200
GET
/api/v4/projects/{id}/share_locations
Returns group that can be shared with the given project
getApiV4ProjectsIdShareLocations 2 params → 200
POST
/api/v4/runners/reset_registration_token
Reset instance's runner registration token
postApiV4RunnersResetRegistrationToken → 201403

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Project (156 properties), API_Entities_GroupDetail (73 properties), putApiV4GroupsId (67 properties), API_Entities_Group (50 properties). Each schema is shown below with its type and property counts.

API_Entities_CustomAttribute
object
APIEntitiesCustomAttribute model
2 properties 2 required
API_Entities_Iteration
object
12 properties 12 required
API_Entities_Ci_Runner
object
APIEntitiesCiRunner model
13 properties 12 required
postApiV4GroupsIdTransfer
object
Transfer a group to a new parent group or promote a subgroup to a top-level group
1 property
postApiV4Groups
object
Create a group. Available only for users who can create groups.
41 properties 2 required
API_Entities_UserBasic
object
APIEntitiesUserBasic model
10 properties 8 required
postApiV4GroupsIdShare
object
Share a group with a group
4 properties 2 required
API_Entities_IssuableTimeStats
object
APIEntitiesIssuableTimeStats model
4 properties 4 required
API_Entities_Issue
object
APIEntitiesIssue model
44 properties 37 required
API_Entities_UserPublic
object
APIEntitiesUserPublic model
46 properties 40 required
API_Entities_Group
object
APIEntitiesGroup model
50 properties 36 required
API_Entities_MarkdownUploadAdmin
object
APIEntitiesMarkdownUploadAdmin model
5 properties 5 required
API_Entities_Member
object
APIEntitiesMember model
21 properties 12 required
API_Entities_AuditEvent
object
APIEntitiesAuditEvent model
7 properties 7 required
API_Entities_ScimIdentity
object
3 properties 3 required
API_Entities_Namespace_RootStorageStatistics
object
12 properties 12 required
API_Entities_Milestone
object
13 properties 11 required
API_Entities_Identity
object
3 properties 3 required
API_Entities_Project
object
APIEntitiesProject model
156 properties 83 required
API_Entities_MemberRole
object
43 properties 43 required
API_Entities_NamespaceBasic
object
8 properties 8 required
API_Entities_LdapGroupLink
object
5 properties 3 required
API_Entities_SamlGroupLink
object
4 properties 3 required
API_Entities_BasicProjectDetails
object
APIEntitiesBasicProjectDetails model
24 properties 17 required
API_Entities_Ci_ResetTokenResult
object
APIEntitiesCiResetTokenResult model
2 properties 1 required
postApiV4GroupsIdUploads
object
Upload a file to a group
1 property 1 required
EpicBaseEntity
object
7 properties 5 required
API_Entities_ContainerExpirationPolicy
object
7 properties 7 required
API_Entities_UserSafe
object
4 properties 4 required
API_Entities_IssuableReferences
object
3 properties 3 required
API_Entities_GroupUpload
object
APIEntitiesGroupUpload model
5 properties 5 required
putApiV4GroupsId
object
Update a group. Available only for users who can administrate groups.
67 properties
postApiV4GroupsIdTransferToOrganization
object
Transfer a group to an organization
1 property 1 required
API_Entities_ProjectStatistics
object
11 properties 11 required
postApiV4GroupsIdPlaceholderReassignments
object
Upload placeholder reassignments CSV file
1 property 1 required
API_Entities_TaskCompletionStatus
object
2 properties 2 required
API_Entities_GroupDetail
object
APIEntitiesGroupDetail model
73 properties 41 required
API_Entities_LicenseBasic
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-groups-api-openapi.yml Raw ↑

Other APIs GitLab CI/CD publishes across the network.

GitLab GraphQL API
GitLab CI/CD access_requests API
GitLab CI/CD access_tokens API
GitLab CI/CD agents API
GitLab CI/CD alert_management API
GitLab CI/CD applications API
GitLab CI/CD attestations API
GitLab CI/CD audit_events API
GitLab CI/CD avatars API
GitLab CI/CD award_emoji API
GitLab CI/CD badges API
GitLab CI/CD batched_background_migrations API
Where this information came from

This is an independent, third-party profile of GitLab CI/CD groups 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.