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

get

Returns the relationship history

Path parameters

workspaceIdanyRequired

workspace Identifier

Query parameters

filter[history]stringOptional

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

page[number]integerOptional

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

page[size]integerOptional

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

page[offset]integerOptional

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

page[limit]integerOptional

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

page[totals]stringOptional

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

Responses

200

Successful response

application/vnd.api+json

get

HTTPcURLJavaScriptPython

GET /api/v1/workspace/{workspaceId}/history HTTP/1.1
Host: 
Accept: */*

200

Successful response

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

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