GitLab Badges API

openapi: 3.2.0
info:
  title: GitLab REST Badges API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Badges
  description: 'Use this API to manage badges for projects and groups.


    ## Placeholders


    Badges support placeholders that are replaced in real time in both the link and image URL.

    The following placeholders are available:


    - `%{project_path}`: replaced by the project path.

    - `%{project_title}`: replaced by the project title.

    - `%{project_name}`: replaced by the project name.

    - `%{project_id}`: replaced by the project ID.

    - `%{project_namespace}`: replaced by the project''s namespace full path.

    - `%{group_name}`: replaced by the project''s top-level group name.

    - `%{gitlab_server}`: replaced by the project''s server name.

    - `%{gitlab_pages_domain}`: replaced by the domain name hosting GitLab Pages.

    - `%{default_branch}`: replaced by the project default branch.

    - `%{commit_sha}`: replaced by the project''s last commit SHA.

    - `%{latest_tag}`: replaced by the project''s last tag.


    Group badge endpoints operate outside a project''s context, so placeholder values are taken from the

    group''s earliest-created project. If no projects exist in the group, the URL is returned unchanged.'
  x-displayName: Badges
  externalDocs:
    url: https://docs.gitlab.com/api/group_badges/
paths:
  /api/v4/groups/{id}/badges:
    get:
      operationId: getApiV4GroupsIdBadges
      summary: List all badges for a group
      description: Lists all badges for a specified group.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: name
        required: false
        description: Name of the badge.
        schema:
          type:
          - string
          - 'null'
        in: query
    post:
      operationId: postApiV4GroupsIdBadges
      summary: Create a badge for a group
      description: Creates a badge for a specified group.
      tags:
      - Badges
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdBadgesRequest'
  /api/v4/groups/{id}/badges/render:
    get:
      operationId: getApiV4GroupsIdBadgesRender
      summary: Retrieve a badge preview for a group
      description: Previews the final `link_url` and `image_url` for a specified group after resolving the placeholder interpolation.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBasicBadgeDetails'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: link_url
        required: true
        description: URL of the badge link.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: image_url
        required: true
        description: URL of the badge image.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/groups/{id}/badges/{badge_id}:
    get:
      operationId: getApiV4GroupsIdBadgesBadgeId
      summary: Retrieve a badge for a group
      description: Retrieves a specified badge for a group.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
    put:
      operationId: putApiV4GroupsIdBadgesBadgeId
      summary: Update a badge for a group
      description: Updates a specified badge for a group.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdBadgesBadgeIdRequest'
    delete:
      operationId: deleteApiV4GroupsIdBadgesBadgeId
      summary: Delete a badge from a group
      description: Deletes a specified badge from a group.
      tags:
      - Badges
      responses:
        '204':
          description: Resource deleted
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/badges:
    get:
      operationId: getApiV4ProjectsIdBadges
      summary: List all badges for a project
      description: Lists all badges for a specified project, including group badges.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: name
        required: false
        description: Name of the badge.
        schema:
          type:
          - string
          - 'null'
        in: query
    post:
      operationId: postApiV4ProjectsIdBadges
      summary: Create a badge for a project
      description: Creates a badge for a specified project.
      tags:
      - Badges
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdBadgesRequest'
  /api/v4/projects/{id}/badges/render:
    get:
      operationId: getApiV4ProjectsIdBadgesRender
      summary: Retrieve a badge preview for a project
      description: Previews the final `link_url` and `image_url` for a specified project after resolving the placeholder interpolation.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBasicBadgeDetails'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: link_url
        required: true
        description: URL of the badge link.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: image_url
        required: true
        description: URL of the badge image.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/projects/{id}/badges/{badge_id}:
    get:
      operationId: getApiV4ProjectsIdBadgesBadgeId
      summary: Retrieve a badge for a project
      description: Retrieves a specified badge for a project.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
    put:
      operationId: putApiV4ProjectsIdBadgesBadgeId
      summary: Update a badge for a project
      description: Updates a specified badge for a project.
      tags:
      - Badges
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBadge'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdBadgesBadgeIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdBadgesBadgeId
      summary: Delete a badge from a project
      description: Deletes a specified badge from a project.
      tags:
      - Badges
      responses:
        '204':
          description: Resource deleted
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: badge_id
        required: true
        description: ID of the badge.
        schema:
          type: integer
        in: path
components:
  schemas:
    putApiV4GroupsIdBadgesBadgeIdRequest:
      type: object
      properties:
        link_url:
          type:
          - string
          - 'null'
          description: URL of the badge link.
        image_url:
          type:
          - string
          - 'null'
          description: URL of the badge image.
        name:
          type:
          - string
          - 'null'
          description: Name of the badge.
    postApiV4GroupsIdBadgesRequest:
      type: object
      properties:
        link_url:
          type:
          - string
          - 'null'
          description: URL of the badge link.
        image_url:
          type:
          - string
          - 'null'
          description: URL of the badge image.
        name:
          type:
          - string
          - 'null'
          description: Name of the badge.
      required:
      - link_url
      - image_url
    APIEntitiesBadge:
      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: int64
          example: 1
        kind:
          type: string
          example: project
    APIEntitiesBasicBadgeDetails:
      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
    postApiV4ProjectsIdBadgesRequest:
      type: object
      properties:
        link_url:
          type:
          - string
          - 'null'
          description: URL of the badge link.
        image_url:
          type:
          - string
          - 'null'
          description: URL of the badge image.
        name:
          type:
          - string
          - 'null'
          description: Name of the badge.
      required:
      - link_url
      - image_url
    putApiV4ProjectsIdBadgesBadgeIdRequest:
      type: object
      properties:
        link_url:
          type:
          - string
          - 'null'
          description: URL of the badge link.
        image_url:
          type:
          - string
          - 'null'
          description: URL of the badge image.
        name:
          type:
          - string
          - 'null'
          description: Name of the badge.
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header