History

This endpoint is used to see terraform states changes over time for a Terrakube workspace.

To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace

Entity fields:

Path	Type	Description
data.type	string	Should be "history"
data.attributes.output	string	Unique variable name

Example:

{
  "data": {
    "type": "history",
    "attributes": {
      "output": "Terraform JSON State URL"
    }
  }
}

Supported Operations

Returns the relationship history

get

/workspace/{workspaceId}/history

Path parameters

workspaceIdstringrequired

workspace Identifier

Query parameters

sortstring · enum[]

Sorts the collection on the selected attributes. A prefix of '-' sorts descending

fields[history]string · enum[]

Selects the set of history fields that should be returned in the result.

includestring · enum[]

Selects the set of relationships that should be expanded as a compound document in the result.

filter[history]string

Filters the collection of history using a 'disjoint' RSQL expression

page[number]integer

Number of pages to return. Can be used with page[size]

page[size]integer

Number of elements per page. Can be used with page[number]

page[offset]integer

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer

Maximum number of items to return. Can be used with page[offset]

page[totals]string

For requesting total pages/records be included in the response page meta data

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/workspace/{workspaceId}/history'

200

200

{
  "data": [],
  "included": [
    {
      "attributes": {},
      "id": "text",
      "relationships": {},
      "type": "text"
    }
  ]
}

Successful response

For a complete list of organization operation please visit the OpenAPI specification