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 badges API

Operations about badges

GitLab CI/CD badges 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 Badges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

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

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

12 operations 6 paths 6 schemas 2 DELETE6 GET2 POST2 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 badges 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 12

Across 6 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

badges 12

Operations about badges

GET
/api/v4/groups/{id}/badges
Gets a list of group badges viewable by the authenticated user.
getApiV4GroupsIdBadges 4 params → 200
POST
/api/v4/groups/{id}/badges
Adds a badge to a group.
postApiV4GroupsIdBadges 2 params → 201
GET
/api/v4/groups/{id}/badges/render
Preview a badge from a group.
getApiV4GroupsIdBadgesRender 3 params → 200
GET
/api/v4/groups/{id}/badges/{badge_id}
Gets a badge of a group.
getApiV4GroupsIdBadgesBadgeId 2 params → 200
PUT
/api/v4/groups/{id}/badges/{badge_id}
Updates a badge of a group.
putApiV4GroupsIdBadgesBadgeId 3 params → 200
DELETE
/api/v4/groups/{id}/badges/{badge_id}
Removes a badge from the group.
deleteApiV4GroupsIdBadgesBadgeId 2 params → 204
GET
/api/v4/projects/{id}/badges
Gets a list of project badges viewable by the authenticated user.
getApiV4ProjectsIdBadges 4 params → 200
POST
/api/v4/projects/{id}/badges
Adds a badge to a project.
postApiV4ProjectsIdBadges 2 params → 201
GET
/api/v4/projects/{id}/badges/render
Preview a badge from a project.
getApiV4ProjectsIdBadgesRender 3 params → 200
GET
/api/v4/projects/{id}/badges/{badge_id}
Gets a badge of a project.
getApiV4ProjectsIdBadgesBadgeId 2 params → 200
PUT
/api/v4/projects/{id}/badges/{badge_id}
Updates a badge of a project.
putApiV4ProjectsIdBadgesBadgeId 3 params → 200
DELETE
/api/v4/projects/{id}/badges/{badge_id}
Removes a badge from the project.
deleteApiV4ProjectsIdBadgesBadgeId 2 params → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are API_Entities_Badge (7 properties), API_Entities_BasicBadgeDetails (5 properties), postApiV4ProjectsIdBadges (3 properties), putApiV4ProjectsIdBadgesBadgeId (3 properties). Each schema is shown below with its type and property counts.

API_Entities_BasicBadgeDetails
object
APIEntitiesBasicBadgeDetails model
5 properties 5 required
putApiV4GroupsIdBadgesBadgeId
object
Updates a badge of a group.
3 properties
postApiV4GroupsIdBadges
object
Adds a badge to a group.
3 properties 2 required
API_Entities_Badge
object
APIEntitiesBadge model
7 properties 7 required
putApiV4ProjectsIdBadgesBadgeId
object
Updates a badge of a project.
3 properties
postApiV4ProjectsIdBadges
object
Adds a badge to a project.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitlab-ci-badges-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 batched_background_migrations API
GitLab CI/CD branches API
Where this information came from

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