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/api/v1/workspace/{workspaceId}/history

Path parameters

workspaceId*string

workspace Identifier

Query parameters

Response

200

Successful response

Body

application/vnd.api+json

dataarray of history (object)

includedarray of object

Included resources

Request

JavaScriptCurl

const response = await fetch('/api/v1/workspace/{workspaceId}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "createdBy": "text",
        "createdDate": "2024-04-20T09:12:07.508Z",
        "output": "text",
        "updatedBy": "text",
        "updatedDate": "2024-04-20T09:12:07.508Z"
      },
      "relationships": {
        "workspace": {
          "id": "text",
          "type": "workspace"
        }
      }
    }
  ],
  "included": [
    {
      "id": "text",
      "type": "text"
    }
  ]
}

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