GitLab Project alias API

openapi: 3.2.0
info:
  title: GitLab REST Project alias 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: Project alias
  description: 'Use this API to manage project aliases.

    After you create an alias for a project, users can clone the repository with that alias, which can be

    helpful when migrating repositories.


    All endpoints require administrator authorization.'
  x-displayName: Project alias
  externalDocs:
    url: https://docs.gitlab.com/api/project_aliases/
paths:
  /api/v4/project_aliases:
    get:
      operationId: getApiV4ProjectAliases
      summary: List all project aliases
      description: Lists all project aliases for the instance.
      tags:
      - Project alias
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectAlias'
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - 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
      x-gitlab-tier: premium
    post:
      operationId: postApiV4ProjectAliases
      summary: Create a project alias
      description: Creates a project alias.
      tags:
      - Project alias
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectAlias'
        '400':
          description: Bad request
        '403':
          description: Forbidden
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectAliasesRequest'
      x-gitlab-tier: premium
  /api/v4/project_aliases/{name}:
    get:
      operationId: getApiV4ProjectAliasesName
      summary: Retrieve a project alias
      description: Retrieves details of a specified project alias.
      tags:
      - Project alias
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectAlias'
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Name of the alias. Must be unique.
        schema:
          type: string
        in: path
      x-gitlab-tier: premium
    delete:
      operationId: deleteApiV4ProjectAliasesName
      summary: Delete a project alias
      description: Deletes a specified project alias. Administrators only.
      tags:
      - Project alias
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Name of the alias. Must be unique.
        schema:
          type: string
        in: path
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesProjectAlias:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        project_id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: gitlab
    postApiV4ProjectAliasesRequest:
      type: object
      properties:
        project_id:
          type:
          - string
          - 'null'
          description: ID or URL-encoded path of the project.
          example: gitlab-org/gitlab
        name:
          type:
          - string
          - 'null'
          description: Name of the alias. Must be unique.
          example: gitlab
      required:
      - project_id
      - name
  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