GitLab Packages: Cargo API

openapi: 3.2.0
info:
  title: 'GitLab REST Packages: Cargo 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: 'Packages: Cargo'
  description: 'Use this API to interact with the Cargo package registry, including its sparse index, registry

    configuration, and crate downloads. Generally these endpoints are used by Cargo itself and are not

    meant for manual consumption. For more information, see the

    package registry.'
  x-displayName: 'Packages: Cargo'
paths:
  /api/v4/projects/{id}/packages/cargo/config.json:
    get:
      operationId: getApiV4ProjectsIdPackagesCargoConfigJson
      summary: Get config.json
      description: This will be used by cargo for further requests
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '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
  /api/v4/projects/{id}/packages/cargo/1/{package_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesCargo1PackageName
      summary: Get the sparse index for a Cargo crate (1-character name)
      description: Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: package_name
        required: true
        description: Name of the Cargo package.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/cargo/2/{package_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesCargo2PackageName
      summary: Get the sparse index for a Cargo crate (2-character name)
      description: Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: package_name
        required: true
        description: Name of the Cargo package.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/cargo/3/{first_char}/{package_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesCargo3FirstCharPackageName
      summary: Get the sparse index for a Cargo crate (3-character name)
      description: Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: first_char
        required: true
        description: First character of the Cargo package name.
        schema:
          type: string
        in: path
      - name: package_name
        required: true
        description: Name of the Cargo package.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/cargo/{prefix_1}/{prefix_2}/{package_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesCargoPrefix1Prefix2PackageName
      summary: Get the sparse index for a Cargo crate (4+ character name)
      description: Returns newline-delimited JSON, one line per published version, most recently published first. Limited to the 500 most recently published versions.
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: prefix_1
        required: true
        description: First two characters of the Cargo package name.
        schema:
          type: string
        in: path
      - name: prefix_2
        required: true
        description: Next two characters of the Cargo package name.
        schema:
          type: string
        in: path
      - name: package_name
        required: true
        description: Name of the Cargo package.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/cargo/{package_name}/{package_version}/download:
    get:
      operationId: getApiV4ProjectsIdPackagesCargoPackageNamePackageVersionDownload
      summary: Download a Cargo crate
      description: This endpoint serves the .crate file for a given package name and version
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '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
      - name: package_name
        required: true
        description: Name of the Cargo package.
        schema:
          type: string
        in: path
      - name: package_version
        required: true
        description: Version of the Cargo package.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/cargo/api/v1/crates/new:
    put:
      operationId: putApiV4ProjectsIdPackagesCargoApiV1CratesNew
      summary: Publish a Cargo crate
      description: Receives the cargo publish body and extracts the crate asynchronously
      tags:
      - 'Packages: Cargo'
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      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:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesCargoApiV1CratesNewRequest'
components:
  schemas:
    putApiV4ProjectsIdPackagesCargoApiV1CratesNewRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The cargo publish body, uploaded by workhorse
      required:
      - file
  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