GitLab CI/CD

GitLab CI/CD badges API

Operations about badges

GitHub OpenAPI

Operations 12

GET /api/v4/groups/{id}/badges Gets a list of group badges viewable by the authenticated user. #
POST /api/v4/groups/{id}/badges Adds a badge to a group. #
GET /api/v4/groups/{id}/badges/render Preview a badge from a group. #
GET /api/v4/groups/{id}/badges/{badge_id} Gets a badge of a group. #
PUT /api/v4/groups/{id}/badges/{badge_id} Updates a badge of a group. #
DELETE /api/v4/groups/{id}/badges/{badge_id} Removes a badge from the group. #
GET /api/v4/projects/{id}/badges Gets a list of project badges viewable by the authenticated user. #
POST /api/v4/projects/{id}/badges Adds a badge to a project. #
GET /api/v4/projects/{id}/badges/render Preview a badge from a project. #
GET /api/v4/projects/{id}/badges/{badge_id} Gets a badge of a project. #
PUT /api/v4/projects/{id}/badges/{badge_id} Updates a badge of a project. #
DELETE /api/v4/projects/{id}/badges/{badge_id} Removes a badge from the project. #

Documentation

📖
Documentation
https://docs.gitlab.com/api/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-badges-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://docs.gitlab.com/api/openapi/openapi_v2.yaml
🔗
InteractiveDocs
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab-ci-badges-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-badges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab access_requests Badges API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: badges
  description: Operations about badges
paths:
  /api/v4/groups/{id}/badges:
    get:
      summary: Gets a list of group badges viewable by the authenticated user.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: query
        name: page
        description: Current page number
        required: false
        example: 1
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        description: Number of items per page
        required: false
        example: 20
        schema:
          type: integer
          format: int32
          default: 20
      - in: query
        name: name
        description: Name for the badge
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Gets a list of group badges viewable by the authenticated user.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: getApiV4GroupsIdBadges
    post:
      summary: Adds a badge to a group.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Adds a badge to a group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: postApiV4GroupsIdBadges
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdBadges'
        required: true
  /api/v4/groups/{id}/badges/render:
    get:
      summary: Preview a badge from a group.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: query
        name: link_url
        description: URL of the badge link
        required: true
        schema:
          type: string
      - in: query
        name: image_url
        description: URL of the badge image
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Preview a badge from a group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BasicBadgeDetails'
      tags:
      - badges
      operationId: getApiV4GroupsIdBadgesRender
  /api/v4/groups/{id}/badges/{badge_id}:
    get:
      summary: Gets a badge of a group.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        description: The badge ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Gets a badge of a group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: getApiV4GroupsIdBadgesBadgeId
    put:
      summary: Updates a badge of a group.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Updates a badge of a group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: putApiV4GroupsIdBadgesBadgeId
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdBadgesBadgeId'
        required: true
    delete:
      summary: Removes a badge from the group.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the group owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        description: The badge ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Removes a badge from the group.
      tags:
      - badges
      operationId: deleteApiV4GroupsIdBadgesBadgeId
  /api/v4/projects/{id}/badges:
    get:
      summary: Gets a list of project badges viewable by the authenticated user.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: query
        name: page
        description: Current page number
        required: false
        example: 1
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        description: Number of items per page
        required: false
        example: 20
        schema:
          type: integer
          format: int32
          default: 20
      - in: query
        name: name
        description: Name for the badge
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Gets a list of project badges viewable by the authenticated user.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: getApiV4ProjectsIdBadges
    post:
      summary: Adds a badge to a project.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Adds a badge to a project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: postApiV4ProjectsIdBadges
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdBadges'
        required: true
  /api/v4/projects/{id}/badges/render:
    get:
      summary: Preview a badge from a project.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: query
        name: link_url
        description: URL of the badge link
        required: true
        schema:
          type: string
      - in: query
        name: image_url
        description: URL of the badge image
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Preview a badge from a project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BasicBadgeDetails'
      tags:
      - badges
      operationId: getApiV4ProjectsIdBadgesRender
  /api/v4/projects/{id}/badges/{badge_id}:
    get:
      summary: Gets a badge of a project.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        description: The badge ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Gets a badge of a project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: getApiV4ProjectsIdBadgesBadgeId
    put:
      summary: Updates a badge of a project.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Updates a badge of a project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Badge'
      tags:
      - badges
      operationId: putApiV4ProjectsIdBadgesBadgeId
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdBadgesBadgeId'
        required: true
    delete:
      summary: Removes a badge from the project.
      description: This feature was introduced in GitLab 10.6.
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project owned by the authenticated user.
        required: true
        schema:
          type: string
      - in: path
        name: badge_id
        description: The badge ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Removes a badge from the project.
      tags:
      - badges
      operationId: deleteApiV4ProjectsIdBadgesBadgeId
components:
  schemas:
    postApiV4GroupsIdBadges:
      type: object
      properties:
        link_url:
          type: string
          description: URL of the badge link
        image_url:
          type: string
          description: URL of the badge image
        name:
          type: string
          description: Name for the badge
      required:
      - link_url
      - image_url
      description: Adds a badge to a group.
    API_Entities_BasicBadgeDetails:
      type: object
      properties:
        name:
          type: string
          example: Pipeline Status
        link_url:
          type: string
          example: https://example.gitlab.com
        image_url:
          type: string
          example: https://example.gitlab.com
        rendered_link_url:
          type: string
          example: https://example.gitlab.com
        rendered_image_url:
          type: string
          example: https://example.gitlab.com
      required:
      - name
      - link_url
      - image_url
      - rendered_link_url
      - rendered_image_url
      description: API_Entities_BasicBadgeDetails model
    putApiV4GroupsIdBadgesBadgeId:
      type: object
      properties:
        link_url:
          type: string
          description: URL of the badge link
        image_url:
          type: string
          description: URL of the badge image
        name:
          type: string
          description: Name for the badge
      description: Updates a badge of a group.
    API_Entities_Badge:
      type: object
      properties:
        name:
          type: string
          example: Pipeline Status
        link_url:
          type: string
          example: https://example.gitlab.com
        image_url:
          type: string
          example: https://example.gitlab.com
        rendered_link_url:
          type: string
          example: https://example.gitlab.com
        rendered_image_url:
          type: string
          example: https://example.gitlab.com
        id:
          type: integer
          format: int32
          example: 1
        kind:
          type: string
          example: project
      required:
      - name
      - link_url
      - image_url
      - rendered_link_url
      - rendered_image_url
      - id
      - kind
      description: API_Entities_Badge model
    postApiV4ProjectsIdBadges:
      type: object
      properties:
        link_url:
          type: string
          description: URL of the badge link
        image_url:
          type: string
          description: URL of the badge image
        name:
          type: string
          description: Name for the badge
      required:
      - link_url
      - image_url
      description: Adds a badge to a project.
    putApiV4ProjectsIdBadgesBadgeId:
      type: object
      properties:
        link_url:
          type: string
          description: URL of the badge link
        image_url:
          type: string
          description: URL of the badge image
        name:
          type: string
          description: Name for the badge
      description: Updates a badge of a project.
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query