GitLab Terraform API

openapi: 3.2.0
info:
  title: GitLab REST Terraform 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: Terraform
  description: 'Use this API to interact with the Terraform CLI.


    > [!warning]

    > This API is used by the Terraform CLI

    > and is generally not meant for manual consumption. Undocumented authentication methods might be removed in the future.'
  x-displayName: Terraform
  externalDocs:
    url: https://docs.gitlab.com/api/packages/terraform-modules/
paths:
  /api/v4/projects/{id}/terraform/state/{name}/versions/{serial}:
    get:
      operationId: getApiV4ProjectsIdTerraformStateNameVersionsSerial
      summary: Retrieve a Terraform state version
      description: Retrieves a specified Terraform state version.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      - name: serial
        required: true
        description: Version number of the Terraform state.
        schema:
          type: integer
        in: path
    delete:
      operationId: deleteApiV4ProjectsIdTerraformStateNameVersionsSerial
      summary: Delete a Terraform state version
      description: Deletes a specified Terraform state version.
      tags:
      - Terraform
      responses:
        '204':
          description: No Content
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      - name: serial
        required: true
        description: Version number of the Terraform state.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/terraform/state/{name}:
    get:
      operationId: getApiV4ProjectsIdTerraformStateName
      summary: Retrieve a Terraform state
      description: Retrieves a Terraform state by name for a specified project.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '204':
          description: Empty state
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Validation failure
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      - name: ID
        required: false
        description: Terraform state lock ID.
        schema:
          type:
          - string
          - 'null'
          maxLength: 255
        in: query
    post:
      operationId: postApiV4ProjectsIdTerraformStateName
      summary: Create or update a Terraform state
      description: Creates or updates a Terraform state for a specified project.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '204':
          description: No data provided
        '403':
          description: Forbidden
        '422':
          description: Validation failure
        '413':
          description: Request Entity Too Large
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdTerraformStateNameRequest'
    delete:
      operationId: deleteApiV4ProjectsIdTerraformStateName
      summary: Delete a Terraform state
      description: Deletes a Terraform state for a specified project.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Validation failure
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/terraform/state/{name}/authorize:
    post:
      operationId: postApiV4ProjectsIdTerraformStateNameAuthorize
      summary: Authorize Terraform state upload
      description: Authorizes uploading a Terraform state for a specified project. This feature was introduced in GitLab 18.5.
      tags:
      - Terraform
      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
      - name: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/terraform/state/{name}/lock:
    post:
      operationId: postApiV4ProjectsIdTerraformStateNameLock
      summary: Lock a Terraform state
      description: Locks a Terraform state for a specified project.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '422':
          description: Validation failure
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdTerraformStateNameLockRequest'
    delete:
      operationId: deleteApiV4ProjectsIdTerraformStateNameLock
      summary: Unlock a Terraform state
      description: Unlocks a Terraform state for a specified project.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '422':
          description: Validation failure
        '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: name
        required: true
        description: Name of the Terraform state.
        schema:
          type: string
        in: path
      - name: ID
        required: false
        description: Terraform state lock ID.
        schema:
          type:
          - string
          - 'null'
          maxLength: 255
        in: query
  /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}:
    get:
      operationId: getApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystem
      summary: Download the latest version of a module
      description: Downloads the latest version of a specified module. This feature was introduced in GitLab 16.7.
      tags:
      - Terraform
      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: module_name
        required: true
        description: Module name.
        schema:
          type: string
        in: path
        example: infra-registry
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
        example: aws
      - name: terraform-get
        required: false
        description: Terraform get redirection flag.
        schema:
          type:
          - string
          - 'null'
          enum:
          - '1'
          - null
        in: query
  /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}:
    get:
      operationId: getApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystemModuleVersion
      summary: Download a specific version of a module
      description: This feature was introduced in GitLab 16.7
      tags:
      - Terraform
      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: module_name
        required: true
        description: Module name.
        schema:
          type: string
        in: path
        example: infra-registry
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
        example: aws
      - name: module_version
        required: true
        description: Module version
        schema:
          type: string
        in: path
      - name: terraform-get
        required: false
        description: Terraform get redirection flag.
        schema:
          type:
          - string
          - 'null'
          enum:
          - '1'
          - null
        in: query
  /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file/authorize:
    put:
      operationId: putApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystemModuleVersionFileAuthorize
      summary: Workhorse authorize Terraform Module package file
      description: This feature was introduced in GitLab 13.11
      tags:
      - Terraform
      responses:
        '200':
          description: OK
        '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: module_name
        required: true
        description: Module name.
        schema:
          type: string
        in: path
        example: infra-registry
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
        example: aws
      - name: module_version
        required: true
        description: Module version
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file:
    put:
      operationId: putApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystemModuleVersionFile
      summary: Upload Terraform Module package file
      description: This feature was introduced in GitLab 13.11
      tags:
      - Terraform
      responses:
        '201':
          description: Created
        '400':
          description: Invalid file
        '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: module_name
        required: true
        description: Module name.
        schema:
          type: string
        in: path
        example: infra-registry
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
        example: aws
      - name: module_version
        required: true
        description: Module version
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystemModuleVersionFileRequest'
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/versions:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystemVersions
      summary: List all available versions for a module
      description: Lists all available versions for a specified module.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesTerraformModuleVersions'
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/download:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystemDownload
      summary: Retrieve download URL for latest module version
      description: Retrieves download URL for latest module version.
      tags:
      - Terraform
      responses:
        '302':
          description: Found
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystem
      summary: Retrieve latest version for a module
      description: Retrieves latest version for a specified module.
      tags:
      - Terraform
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTerraformModuleVersion'
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/download:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystemModuleVersionDownload
      summary: Get download location for specific version of a module
      description: Download specific version of a module
      tags:
      - Terraform
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
      - name: module_version
        required: true
        description: Version of the module
        schema:
          type: string
        in: path
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/file:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystemModuleVersionFile
      summary: Download specific version of a module
      tags:
      - Terraform
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
      - name: module_version
        required: true
        description: Version of the module
        schema:
          type: string
        in: path
  /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}:
    get:
      operationId: getApiV4PackagesTerraformModulesV1ModuleNamespaceModuleNameModuleSystemModuleVersion
      summary: Get details about specific version of a module
      tags:
      - Terraform
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesTerraformModuleVersion'
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: module_namespace
        required: true
        description: Group's ID or slug.
        schema:
          type: string
        in: path
      - name: module_name
        required: true
        description: Name of the module.
        schema:
          type: string
        in: path
      - name: module_system
        required: true
        description: Name of the module system, or [provider](https://developer.hashicorp.com/terraform/registry/providers).
        schema:
          type: string
        in: path
      - name: module_version
        required: true
        description: Version of the module
        schema:
          type: string
        in: path
components:
  schemas:
    postApiV4ProjectsIdTerraformStateNameRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The package file to be published (generated by Multipart middleware)
      required:
      - file
    putApiV4ProjectsIdPackagesTerraformModulesModuleNameModuleSystemModuleVersionFileRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The package file to be published (generated by Multipart middleware)
      required:
      - file
    postApiV4ProjectsIdTerraformStateNameLockRequest:
      type: object
      properties:
        ID:
          type:
          - string
          - 'null'
          description: Terraform state lock ID.
          maxLength: 255
        Operation:
          type:
          - string
          - 'null'
          description: Terraform operation.
        Info:
          type:
          - string
          - 'null'
          description: Terraform info
        Who:
          type:
          - string
          - 'null'
          description: Terraform state lock owner
        Version:
          type:
          - string
          - 'null'
          description: Terraform version
        Created:
          type:
          - string
          - 'null'
          description: Terraform state lock timestamp
        Path:
          type:
          - string
          - 'null'
          description: Terraform path
      required:
      - ID
      - Operation
      - Info
      - Who
      - Version
      - Created
      - Path
    APIEntitiesTerraformModuleVersions:
      type: object
      properties:
        modules:
          type: string
    APIEntitiesTerraformModuleVersion:
      type: object
      properties:
        name:
          type: string
        provider:
          type: string
        providers:
          type: string
        root:
          type: string
        source:
          type: string
        submodules:
          type: string
        version:
          type: string
        versions:
          type: string
  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