Admiral
StateApiV1StateComponent_idEnvEnvironment_id

Push Terraform state

POST
/api/v1/state/{component_id}/env/{environment_id}

Stores a new state version; the body is the full .tfstate document. Maps to the Terraform HTTP backend POST. Authenticate with a PAT/SAT; requires the state:write scope.

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Path Parameters

component_id*string

The infrastructure component (UUID).

Formatuuid
environment_id*string

The environment the state is scoped to (UUID).

Formatuuid

Query Parameters

ID?string

The held lock ID, when the state is locked.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?any

Response Body

application/json

curl -X POST "https://api.admiral.io/api/v1/state/497f6eca-6276-4993-bfeb-53cbbbba6f08/env/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
{  "ID": "string",  "Operation": "string",  "Info": "string",  "Who": "string",  "Version": "string",  "Created": "2019-08-24T14:15:22Z",  "Path": "string"}

Fetch current Terraform state GET

Returns the current `.tfstate` document for the component+environment, or 204 when no state exists yet. Maps to the Terraform HTTP backend GET. Authenticate with a PAT/SAT (HTTP Basic password or Bearer token); requires the `state:read` scope.

Create a personal access token POST

Scope: `token:write`