GitLab CI catalog API

openapi: 3.2.0
info:
  title: GitLab REST CI catalog 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: CI catalog
  description: 'Use this API to publish a release of a component project to the

    CI/CD catalog.


    This endpoint is intended for CLI tooling and must be authenticated with a

    job token.'
  x-displayName: CI catalog
paths:
  /api/v4/projects/{id}/catalog/publish:
    post:
      operationId: postApiV4ProjectsIdCatalogPublish
      summary: Publish a new component project release as version to the CI/CD catalog
      description: Publishes a release of a catalog resource as version to the CI/CD catalog.
      tags:
      - CI catalog
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiCatalogResourcesVersion'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdCatalogPublishRequest'
components:
  schemas:
    APIEntitiesCiCatalogResourcesVersion:
      type: object
      properties:
        catalog_url:
          type: string
          example: https://gitlab.example.com/explore/catalog/my-namespace/my-component-project
    postApiV4ProjectsIdCatalogPublishRequest:
      type: object
      properties:
        metadata:
          type:
          - object
          - 'null'
          description: Metadata for the release.
      required:
      - metadata
  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