Terraform

Use this API to interact with the Terraform CLI.

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.

Retrieve latest version for a module

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}

Retrieves latest version for a specified module.

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider

Responses

Code	Description	Schema
`200`	OK	APIEntitiesTerraformModuleVersion
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Retrieve download URL for latest module version

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/download

Retrieves download URL for latest module version.

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider

Responses

Code	Description	Schema
`302`	Found	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

List all available versions for a module

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/versions

Lists all available versions for a specified module.

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesTerraformModuleVersions
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

Get details about specific version of a module

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider
`module_version` Path, required	String	Version of the module

Responses

Code	Description	Schema
`200`	OK	APIEntitiesTerraformModuleVersion
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Get download location for specific version of a module

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/download

Download specific version of a module

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider
`module_version` Path, required	String	Version of the module

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Download specific version of a module

GET /api/v4/packages/terraform/modules/v1/{module_namespace}/{module_name}/{module_system}/{module_version}/file

Parameters

Name	Type	Description
`module_namespace` Path, required	String	Group’s ID or slug
`module_name` Path, required	String	Name of the module
`module_system` Path, required	String	Name of the module system, or provider
`module_version` Path, required	String	Version of the module

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Download the latest version of a module

GET /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}

Downloads the latest version of a specified module. This feature was introduced in GitLab 16.7.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`module_name` Path, required	String	Module name Example: `infra-registry`
`module_system` Path, required	String	Name of the module system, or provider Example: `aws`
`terraform-get` Query	String	Terraform get redirection flag Allowed values: `1`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Download a specific version of a module

GET /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}

This feature was introduced in GitLab 16.7

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`module_name` Path, required	String	Module name Example: `infra-registry`
`module_system` Path, required	String	Name of the module system, or provider Example: `aws`
`module_version` Path, required	String	Module version
`terraform-get` Query	String	Terraform get redirection flag Allowed values: `1`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Upload Terraform Module package file

PUT /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file

This feature was introduced in GitLab 13.11

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`module_name` Path, required	String	Module name Example: `infra-registry`
`module_system` Path, required	String	Name of the module system, or provider Example: `aws`
`module_version` Path, required	String	Module version

Request body (multipart/form-data)

Property	Type	Description
`file` Required	String (binary)	The package file to be published (generated by Multipart middleware)

Responses

Code	Description	Schema
`201`	Created	—
`400`	Invalid file	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not found	—

Workhorse authorize Terraform Module package file

PUT /api/v4/projects/{id}/packages/terraform/modules/{module_name}/{module_system}/{module_version}/file/authorize

This feature was introduced in GitLab 13.11

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`module_name` Path, required	String	Module name Example: `infra-registry`
`module_system` Path, required	String	Name of the module system, or provider Example: `aws`
`module_version` Path, required	String	Module version

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

Retrieve a Terraform state

GET /api/v4/projects/{id}/terraform/state/{name}

Retrieves a Terraform state by name for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state
`ID` Query	String	Terraform state lock ID Maximum length: `255`

Responses

Code	Description	Schema
`200`	OK	—
`204`	Empty state	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Validation failure	—

Create or update a Terraform state

POST /api/v4/projects/{id}/terraform/state/{name}

Creates or updates a Terraform state for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state

Request body (multipart/form-data)

Property	Type	Description
`file` Required	String (binary)	The package file to be published (generated by Multipart middleware)

Responses

Code	Description	Schema
`200`	OK	—
`204`	No data provided	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—
`413`	Request Entity Too Large	—
`422`	Validation failure	—

Delete a Terraform state

DELETE /api/v4/projects/{id}/terraform/state/{name}

Deletes a Terraform state for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—
`422`	Validation failure	—

Authorize Terraform state upload

POST /api/v4/projects/{id}/terraform/state/{name}/authorize

Authorizes uploading a Terraform state for a specified project. This feature was introduced in GitLab 18.5.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

Lock a Terraform state

POST /api/v4/projects/{id}/terraform/state/{name}/lock

Locks a Terraform state for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state

Request body (application/json)

Property	Type	Description
`Created` Required	String	Terraform state lock timestamp
`ID` Required	String	Terraform state lock ID Maximum length: `255`
`Info` Required	String	Terraform info
`Operation` Required	String	Terraform operation
`Path` Required	String	Terraform path
`Version` Required	String	Terraform version
`Who` Required	String	Terraform state lock owner

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Validation failure	—

Unlock a Terraform state

DELETE /api/v4/projects/{id}/terraform/state/{name}/lock

Unlocks a Terraform state for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state
`ID` Query	String	Terraform state lock ID Maximum length: `255`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—
`422`	Validation failure	—

Retrieve a Terraform state version

GET /api/v4/projects/{id}/terraform/state/{name}/versions/{serial}

Retrieves a specified Terraform state version.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state
`serial` Path, required	Integer	Version number of the Terraform state

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Delete a Terraform state version

DELETE /api/v4/projects/{id}/terraform/state/{name}/versions/{serial}

Deletes a specified Terraform state version.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`name` Path, required	String	Name of the Terraform state
`serial` Path, required	Integer	Version number of the Terraform state

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesTerraformModuleVersion

Property	Type	Description
`name`	String	—
`provider`	String	—
`providers`	String	—
`root`	String	—
`source`	String	—
`submodules`	String	—
`version`	String	—
`versions`	String	—

APIEntitiesTerraformModuleVersions

Property	Type	Description
`modules`	String	—

Retrieve latest version for a module

Retrieve download URL for latest module version

List all available versions for a module

Get details about specific version of a module

Get download location for specific version of a module

Download specific version of a module

Download the latest version of a module

Download a specific version of a module

Upload Terraform Module package file

Workhorse authorize Terraform Module package file

Retrieve a Terraform state

Create or update a Terraform state

Delete a Terraform state

Authorize Terraform state upload

Lock a Terraform state

Unlock a Terraform state

Retrieve a Terraform state version

Delete a Terraform state version

Schemas

APIEntitiesTerraformModuleVersion

APIEntitiesTerraformModuleVersions

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC compliance report

Thank you

Error

Request partner program details

Request received

Error