GitLab Licenses API

openapi: 3.2.0
info:
  title: GitLab REST Licenses 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: Licenses
  description: 'Use this API to add, retrieve, and delete the license that

    activates GitLab Enterprise Edition.


    These endpoints require administrator access to the instance.'
  x-displayName: Licenses
  externalDocs:
    url: https://docs.gitlab.com/api/license/
paths:
  /api/v4/projects/{id}/managed_licenses:
    get:
      operationId: getApiV4ProjectsIdManagedLicenses
      summary: List all software license policies
      description: Lists all software license policies for a specified project.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesManagedLicense'
        '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: 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
    post:
      operationId: postApiV4ProjectsIdManagedLicenses
      summary: Create a software license policy
      description: Creates a software license policy for a specified project.
      tags:
      - Licenses
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesManagedLicense'
        '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:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdManagedLicensesRequest'
  /api/v4/projects/{id}/managed_licenses/{managed_license_id}:
    get:
      operationId: getApiV4ProjectsIdManagedLicensesManagedLicenseId
      summary: Retrieve a software license policy
      description: Retrieves a specified software license policy from a project.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesManagedLicense'
        '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: managed_license_id
        required: true
        description: ID of the managed license.
        schema:
          type: string
        in: path
    patch:
      operationId: patchApiV4ProjectsIdManagedLicensesManagedLicenseId
      summary: Update a software license policy
      description: Updates a specified software license policy for a project.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesManagedLicense'
        '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: managed_license_id
        required: true
        description: ID of the managed license.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4ProjectsIdManagedLicensesManagedLicenseIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdManagedLicensesManagedLicenseId
      summary: Delete a software license policy
      description: Deletes a specified software license policy from a project.
      tags:
      - Licenses
      responses:
        '204':
          description: No Content
        '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: managed_license_id
        required: true
        description: ID of the managed license.
        schema:
          type: string
        in: path
  /api/v4/license:
    get:
      operationId: getApiV4License
      summary: Retrieve license information
      description: Retrieves information about the current license.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGitlabLicenseWithActiveUsers'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
    post:
      operationId: postApiV4License
      summary: Create a license
      description: Creates a license.
      tags:
      - Licenses
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGitlabLicenseWithActiveUsers'
        '400':
          description: Bad request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4LicenseRequest'
  /api/v4/license/usage_export:
    get:
      operationId: getApiV4LicenseUsageExport
      summary: Download license usage data
      description: Downloads usage data for the currently active license.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/v4/license/{id}:
    get:
      operationId: getApiV4LicenseId
      summary: Retrieve a license
      description: Retrieves information about a specified license.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGitlabLicenseWithActiveUsers'
        '404':
          description: Not Found
        '403':
          description: Forbidden
        '401':
          description: Unauthorized
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the GitLab license.
        schema:
          type: integer
        in: path
    delete:
      operationId: deleteApiV4LicenseId
      summary: Delete a license
      description: Deletes a specified license.
      tags:
      - Licenses
      responses:
        '204':
          description: Resource deleted
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the GitLab license.
        schema:
          type: integer
        in: path
  /api/v4/license/{id}/refresh_billable_users:
    put:
      operationId: putApiV4LicenseIdRefreshBillableUsers
      summary: Trigger recalculation of billable users
      description: Triggers recalculation of billable users for a specified license.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBasicSuccess'
        '404':
          description: Not found
        '403':
          description: Forbidden
        '401':
          description: Unauthorized
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the GitLab license.
        schema:
          type: integer
        in: path
  /api/v4/licenses:
    get:
      operationId: getApiV4Licenses
      summary: List all licenses
      description: Lists all information about all licenses.
      tags:
      - Licenses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesGitlabLicense'
        '403':
          description: Forbidden
components:
  schemas:
    APIEntitiesBasicSuccess:
      type: object
      properties:
        success:
          type: object
    patchApiV4ProjectsIdManagedLicensesManagedLicenseIdRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the license.
          example: MIT
        approval_status:
          type:
          - string
          - 'null'
          enum:
          - allowed
          - denied
          - null
          description: Approval status of the license.
    APIEntitiesGitlabLicenseWithActiveUsers:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        plan:
          type: string
          example: silver
        created_at:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        starts_at:
          type: string
          format: date
          example: '2018-01-27'
        expires_at:
          type: string
          format: date
          example: '2022-01-27'
        historical_max:
          type: integer
          example: 300
        maximum_user_count:
          type: integer
          example: 300
        licensee:
          type: object
          example:
            Name: John Doe1
        add_ons:
          type: object
          example:
            GitLab_FileLocks: 1
            GitLab_Auditor_User: 1
        expired:
          type: boolean
        overage:
          type: integer
          description: Difference between the number of billable users and the number of licensed users. Calculated differently depending on whether the license has expired or not.
          example: 200
        user_limit:
          type: integer
          example: 200
        active_users:
          type: integer
    APIEntitiesGitlabLicense:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        plan:
          type: string
          example: silver
        created_at:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        starts_at:
          type: string
          format: date
          example: '2018-01-27'
        expires_at:
          type: string
          format: date
          example: '2022-01-27'
        historical_max:
          type: integer
          example: 300
        maximum_user_count:
          type: integer
          example: 300
        licensee:
          type: object
          example:
            Name: John Doe1
        add_ons:
          type: object
          example:
            GitLab_FileLocks: 1
            GitLab_Auditor_User: 1
        expired:
          type: boolean
        overage:
          type: integer
          description: Difference between the number of billable users and the number of licensed users. Calculated differently depending on whether the license has expired or not.
          example: 200
        user_limit:
          type: integer
          example: 200
    postApiV4ProjectsIdManagedLicensesRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the license.
          example: MIT
        approval_status:
          type: string
          enum:
          - allowed
          - denied
          description: Approval status of the license.
          minLength: 1
      required:
      - name
      - approval_status
    APIEntitiesManagedLicense:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        approval_status:
          type: string
    postApiV4LicenseRequest:
      type: object
      properties:
        license:
          type:
          - string
          - 'null'
          description: License string.
      required:
      - license
  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