applies

get_apply

GET /api/iacp/v3/applies/{apply}

Show details of a specific apply.

Parameters
  • apply (string) –

Example request:

GET /api/iacp/v3/applies/{apply} HTTP/1.1
Host: example.com
Status Codes

configuration-versions

get_configuration_version

GET /api/iacp/v3/configuration-versions/{configuration_version}

Return the Configuration Version.

Parameters
  • configuration_version (string) –

Example request:

GET /api/iacp/v3/configuration-versions/{configuration_version} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-queue-runs": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "download-url": "string",
                "error": "string",
                "error-message": "string",
                "source": "tfe-api",
                "speculative": true,
                "status": "errored",
                "status-timestamps": {},
                "upload-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "ingress-attributes": {
                    "data": {
                        "id": "string",
                        "type": "ingress-attributes"
                    }
                },
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "configuration-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

get_ingress_attributes

GET /api/iacp/v3/configuration-versions/{configuration_version}/ingress-attributes

Return Ingress Attributes for the Configuration Version.

Parameters
  • configuration_version (string) –

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/configuration-versions/{configuration_version}/ingress-attributes HTTP/1.1
Host: example.com
Status Codes

get_workspace_configuration_versions

GET /api/iacp/v3/workspaces/{workspace}/configuration-versions

List `Configuration Version`s for a specific workspace.

Parameters
  • workspace (string) –

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/workspaces/{workspace}/configuration-versions HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-queue-runs": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "download-url": "string",
                "error": "string",
                "error-message": "string",
                "source": "tfe-api",
                "speculative": true,
                "status": "errored",
                "status-timestamps": {},
                "upload-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "ingress-attributes": {
                    "data": {
                        "id": "string",
                        "type": "ingress-attributes"
                    }
                },
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "configuration-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

create_configuration_version

POST /api/iacp/v3/workspaces/{workspace}/configuration-versions

Create a Configuration Version.

Parameters
  • workspace (string) –

Example request:

POST /api/iacp/v3/workspaces/{workspace}/configuration-versions HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "auto-queue-runs": true,
            "speculative": true
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "type": "configuration-versions"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-queue-runs": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "download-url": "string",
                "error": "string",
                "error-message": "string",
                "source": "tfe-api",
                "speculative": true,
                "status": "errored",
                "status-timestamps": {},
                "upload-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "ingress-attributes": {
                    "data": {
                        "id": "string",
                        "type": "ingress-attributes"
                    }
                },
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "configuration-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

cost-estimates

get_cost_estimate

GET /api/iacp/v3/cost-estimates/{cost_estimate}

Show details of a specific cost estimation.

Parameters
  • cost_estimate (string) –

Example request:

GET /api/iacp/v3/cost-estimates/{cost_estimate} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "delta-monthly-cost": "string",
                "error-message": "string",
                "matched-resources-count": 1,
                "prior-monthly-cost": "string",
                "proposed-monthly-cost": "string",
                "resources": {},
                "resources-count": 1,
                "status": "pending",
                "status-timestamps": {},
                "unmatched-resources-count": 1
            },
            "id": "string",
            "links": {
                "output": "string",
                "self": "string"
            },
            "relationships": {},
            "type": "cost-estimates"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

get_log

GET /api/iacp/v3/cost-estimates/{cost_estimate}/output

Generate URL to the location of the finished cost estimation stage logs.

Parameters
  • cost_estimate (string) –

Example request:

GET /api/iacp/v3/cost-estimates/{cost_estimate}/output HTTP/1.1
Host: example.com
Status Codes

organizations

get_organizations

GET /api/iacp/v3/organizations

List Organizations.

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/organizations HTTP/1.1
Host: example.com
Status Codes

get_organization

GET /api/iacp/v3/organizations/{organization}

Show an Organization.

Parameters
  • organization (string) –

Example request:

GET /api/iacp/v3/organizations/{organization} HTTP/1.1
Host: example.com
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "cost-estimation-enabled": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "email": "string",
                "name": "string",
                "permissions": {},
                "session-remember": 1,
                "session-timeout": 1
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {},
            "type": "organizations"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

modules

create_module

POST /api/iacp/v3/organizations/{organization}/registry-modules

Create a new registry module without a backing VCS repository.

Parameters
  • organization (string) –

Example request:

POST /api/iacp/v3/organizations/{organization}/registry-modules HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "name": "string",
            "provider": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "type": "registry-modules"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "name": "string",
                "permissions": {},
                "provider": "string",
                "status": "no_version_tags",
                "updated-at": "2020-05-20T12:41:43.944500",
                "version-statuses": [
                    {}
                ]
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "registry-modules"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

publish_module

POST /api/iacp/v3/registry-modules

Publish a new registry module from a VCS repository.

Example request:

POST /api/iacp/v3/registry-modules HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "vcs-repo": {
                "display-identifier": "string",
                "identifier": "string",
                "oauth-token-id": "string"
            }
        },
        "id": "string",
        "links": {},
        "relationships": {
            "organization": {
                "data": {
                    "id": "string",
                    "type": "organizations"
                }
            }
        },
        "type": "registry-modules"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "name": "string",
                "permissions": {},
                "provider": "string",
                "status": "no_version_tags",
                "updated-at": "2020-05-20T12:41:43.944500",
                "version-statuses": [
                    {}
                ]
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "registry-modules"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

delete_module

POST /api/iacp/v3/registry-modules/actions/delete/{organization}/{module_name}

Deletes terraform Module.

Parameters
  • organization (string) –

  • module_name (string) –

Status Codes

delete_module_provider

POST /api/iacp/v3/registry-modules/actions/delete/{organization}/{module_name}/{provider_name}

Deletes terraform Provider of the specific Module.

Parameters
  • organization (string) –

  • module_name (string) –

  • provider_name (string) –

Status Codes

delete_module_version

POST /api/iacp/v3/registry-modules/actions/delete/{organization}/{module_name}/{provider_name}/{version}

Delete terraform Module Version.

Parameters
  • organization (string) –

  • module_name (string) –

  • provider_name (string) –

  • version (string) –

Status Codes

get_module

GET /api/iacp/v3/registry-modules/{module}

Return the Module.

Parameters
  • module (string) –

Example request:

GET /api/iacp/v3/registry-modules/{module} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "name": "string",
                "permissions": {},
                "provider": "string",
                "status": "no_version_tags",
                "updated-at": "2020-05-20T12:41:43.944500",
                "version-statuses": [
                    {}
                ]
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "registry-modules"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

get_module_by_name_and_provider

GET /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider}

Return the Module by name and provider.

Parameters
  • organization (string) –

  • module_name (string) –

  • module_provider (string) –

Example request:

GET /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "name": "string",
                "permissions": {},
                "provider": "string",
                "status": "no_version_tags",
                "updated-at": "2020-05-20T12:41:43.944500",
                "version-statuses": [
                    {}
                ]
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "registry-modules"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

resync_module

POST /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider}/resync

Trigger resync of the Registry Module associated with VCS repository.

Parameters
  • organization (string) –

  • module_name (string) –

  • module_provider (string) –

Status Codes

create_module_version

POST /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider}/versions

Create a new registry module version.

Parameters
  • organization (string) –

  • module_name (string) –

  • module_provider (string) –

Example request:

POST /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider}/versions HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "version": "string"
        },
        "id": "string",
        "links": {
            "upload": "string"
        },
        "type": "registry-module-versions"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "source": "string",
                "status": "pending",
                "updated-at": "2020-05-20T12:41:43.944500",
                "version": "string"
            },
            "id": "string",
            "links": {
                "upload": "string"
            },
            "relationships": {
                "registry-module": {
                    "data": {
                        "id": "string",
                        "type": "registry-modules"
                    }
                }
            },
            "type": "registry-module-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

resync_module_version

POST /api/iacp/v3/registry-modules/{organization}/{module_name}/{module_provider}/{version}/resync

Trigger resync of the Registry Module of some version associated with VCS revision.

Parameters
  • organization (string) –

  • module_name (string) –

  • module_provider (string) –

  • version (string) –

Status Codes

workspaces

get_workspaces

GET /api/iacp/v3/organizations/{organization}/workspaces

This endpoint list the organizations workspaces.

Parameters
  • organization (string) –

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/organizations/{organization}/workspaces HTTP/1.1
Host: example.com
Status Codes

create_workspace

POST /api/iacp/v3/organizations/{organization}/workspaces

Create a Workspace.

Parameters
  • organization (string) –

Example request:

POST /api/iacp/v3/organizations/{organization}/workspaces HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "auto-apply": true,
            "name": "string",
            "queue-all-runs": true,
            "terraform-version": "string",
            "vcs-repo": {
                "branch": "string",
                "identifier": "string",
                "ingress-submodules": true,
                "oauth-token-id": "string",
                "webhook-url": "string"
            },
            "working-directory": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "current-run": {
                "data": {
                    "id": "string",
                    "type": "deferred-runs"
                }
            }
        },
        "type": "workspaces"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

delete_organization_workspace

DELETE /api/iacp/v3/organizations/{organization}/workspaces/{workspace_name}

Delete a workspace.

Parameters
  • organization (string) –

  • workspace_name (string) –

Status Codes

get_organization_workspace

GET /api/iacp/v3/organizations/{organization}/workspaces/{workspace_name}

Return Workspace for the Organization.

Parameters
  • organization (string) –

  • workspace_name (string) –

Example request:

GET /api/iacp/v3/organizations/{organization}/workspaces/{workspace_name} HTTP/1.1
Host: example.com
Status Codes

update_organization_workspace

PATCH /api/iacp/v3/organizations/{organization}/workspaces/{workspace_name}

No docstring

Parameters
  • organization (string) –

  • workspace_name (string) –

Example request:

PATCH /api/iacp/v3/organizations/{organization}/workspaces/{workspace_name} HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "auto-apply": true,
            "name": "string",
            "queue-all-runs": true,
            "terraform-version": "string",
            "vcs-repo": {
                "branch": "string",
                "identifier": "string",
                "ingress-submodules": true,
                "oauth-token-id": "string",
                "webhook-url": "string"
            },
            "working-directory": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "current-run": {
                "data": {
                    "id": "string",
                    "type": "deferred-runs"
                }
            }
        },
        "type": "workspaces"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

delete_workspace

DELETE /api/iacp/v3/workspaces/{workspace}

Delete a workspace.

Parameters
  • workspace (string) –

Status Codes

get_workspace

GET /api/iacp/v3/workspaces/{workspace}

Show workspace.

Parameters
  • workspace (string) –

Example request:

GET /api/iacp/v3/workspaces/{workspace} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

update_workspace

PATCH /api/iacp/v3/workspaces/{workspace}

No docstring

Parameters
  • workspace (string) –

Example request:

PATCH /api/iacp/v3/workspaces/{workspace} HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "auto-apply": true,
            "name": "string",
            "queue-all-runs": true,
            "terraform-version": "string",
            "vcs-repo": {
                "branch": "string",
                "identifier": "string",
                "ingress-submodules": true,
                "oauth-token-id": "string",
                "webhook-url": "string"
            },
            "working-directory": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "current-run": {
                "data": {
                    "id": "string",
                    "type": "deferred-runs"
                }
            }
        },
        "type": "workspaces"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

lock_workspace

POST /api/iacp/v3/workspaces/{workspace}/actions/lock

Lock a workspace.

Parameters
  • workspace (string) –

Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

unlock_workspace

POST /api/iacp/v3/workspaces/{workspace}/actions/unlock

Unlock a workspace.

Parameters
  • workspace (string) –

Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "auto-apply": true,
                "can-queue-destroy-plan": true,
                "created-at": "2020-05-20T12:41:43.944500",
                "environment": "string",
                "locked": true,
                "name": "string",
                "operations": true,
                "permissions": {},
                "queue-all-runs": true,
                "terraform-version": "string",
                "vcs-repo": {
                    "branch": "string",
                    "identifier": "string",
                    "ingress-submodules": true,
                    "oauth-token-id": "string",
                    "webhook-url": "string"
                },
                "working-directory": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "current-run": {
                    "data": {
                        "id": "string",
                        "type": "deferred-runs"
                    }
                },
                "organization": {
                    "data": {
                        "id": "string",
                        "type": "organizations"
                    }
                }
            },
            "type": "workspaces"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

plans

get_plan

GET /api/iacp/v3/plans/{plan}

Show details of a specific plan.

Parameters
  • plan (string) –

Example request:

GET /api/iacp/v3/plans/{plan} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "has-changes": true,
                "log-read-url": "string",
                "resource-additions": 1,
                "resource-changes": 1,
                "resource-destructions": 1,
                "status": "pending",
                "status-timestamps": {}
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {},
            "type": "plans"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

runs

create_run

POST /api/iacp/v3/runs

Create new Terraform Run.

Example request:

POST /api/iacp/v3/runs HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "is-destroy": true,
            "message": "string",
            "source": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "configuration-version": {
                "data": {
                    "id": "string",
                    "type": "configuration-versions"
                }
            },
            "workspace": {
                "data": {
                    "id": "string",
                    "type": "workspaces"
                }
            }
        },
        "type": "runs"
    },
    "meta": {}
}
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "actions": {},
                "created-at": "2020-05-20T12:41:43.944500",
                "created-by": "string",
                "force-cancel-available-at": "2020-05-20T12:41:43.944500",
                "has-changes": true,
                "is-destroy": true,
                "message": "string",
                "permissions": {},
                "position-in-queue": 1,
                "source": "string",
                "status": "pending",
                "status-timestamps": {}
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "apply": {
                    "data": {
                        "id": "string",
                        "type": "applies"
                    }
                },
                "configuration-version": {
                    "data": {
                        "id": "string",
                        "type": "configuration-versions"
                    }
                },
                "cost-estimate": {
                    "data": {
                        "id": "string",
                        "type": "cost-estimates"
                    }
                },
                "plan": {
                    "data": {
                        "id": "string",
                        "type": "plans"
                    }
                },
                "policy-checks": {
                    "data": [
                        {
                            "id": "string",
                            "type": "policy-checks"
                        }
                    ]
                },
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "runs"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

get_run

GET /api/iacp/v3/runs/{run}

Show details of a specific run.

Parameters
  • run (string) –

Example request:

GET /api/iacp/v3/runs/{run} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "actions": {},
                "created-at": "2020-05-20T12:41:43.944500",
                "created-by": "string",
                "force-cancel-available-at": "2020-05-20T12:41:43.944500",
                "has-changes": true,
                "is-destroy": true,
                "message": "string",
                "permissions": {},
                "position-in-queue": 1,
                "source": "string",
                "status": "pending",
                "status-timestamps": {}
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "apply": {
                    "data": {
                        "id": "string",
                        "type": "applies"
                    }
                },
                "configuration-version": {
                    "data": {
                        "id": "string",
                        "type": "configuration-versions"
                    }
                },
                "cost-estimate": {
                    "data": {
                        "id": "string",
                        "type": "cost-estimates"
                    }
                },
                "plan": {
                    "data": {
                        "id": "string",
                        "type": "plans"
                    }
                },
                "policy-checks": {
                    "data": [
                        {
                            "id": "string",
                            "type": "policy-checks"
                        }
                    ]
                },
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "runs"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

confirm_run

POST /api/iacp/v3/runs/{run}/actions/apply

Apply a run that is paused waiting for confirmation after a plan.

Parameters
  • run (string) –

Status Codes

cancel_run

POST /api/iacp/v3/runs/{run}/actions/cancel

Interrupt a run that is currently planning or applying.

Parameters
  • run (string) –

Status Codes

discard_run

POST /api/iacp/v3/runs/{run}/actions/discard

Skip any remaining work on runs that are paused waiting for confirmation or priority.

Parameters
  • run (string) –

Status Codes

force_cancel_run

POST /api/iacp/v3/runs/{run}/actions/force-cancel

End the run immediately.

Parameters
  • run (string) –

Status Codes

download_policy_input

POST /api/iacp/v3/runs/{run}/policy-input

Get zip archive with policy check input data generated for given run.

Parameters
  • run (string) –

Status Codes

get_runs

GET /api/iacp/v3/workspaces/{workspace}/runs

List Terraform runs.

Parameters
  • workspace (string) –

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/workspaces/{workspace}/runs HTTP/1.1
Host: example.com
Status Codes

state-versions

list_state_versions

GET /api/iacp/v3/state-versions

List the all state versions.

Query Parameters
  • filter[organization][name] (string) – The name of the organization that owns the desired workspace. If included, you must also included the workspace name filter. (Required)

  • filter[workspace][name] (string) – The name of one workspace to list variables for. If included, you must also include the organization name filter. (Required)

  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/state-versions?filter%5Borganization%5D%5Bname%5D=string&filter%5Bworkspace%5D%5Bname%5D=string HTTP/1.1
Host: example.com
Status Codes

get_state_version

GET /api/iacp/v3/state-versions/{state_version}

Show state version.

Parameters
  • state_version (string) –

Example request:

GET /api/iacp/v3/state-versions/{state_version} HTTP/1.1
Host: example.com
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "hosted-state-download-url": "string",
                "lineage": "string",
                "md5": "string",
                "serial": 1,
                "state": "string",
                "vcs-commit-sha": "string",
                "vcs-commit-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "run": {
                    "data": {
                        "id": "string",
                        "type": "runs"
                    }
                }
            },
            "type": "state-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

get_current_state_version

GET /api/iacp/v3/workspaces/{workspace}/current-state-version

Fetch the current state version for the given workspace.

Parameters
  • workspace (string) –

Example request:

GET /api/iacp/v3/workspaces/{workspace}/current-state-version HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "hosted-state-download-url": "string",
                "lineage": "string",
                "md5": "string",
                "serial": 1,
                "state": "string",
                "vcs-commit-sha": "string",
                "vcs-commit-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "run": {
                    "data": {
                        "id": "string",
                        "type": "runs"
                    }
                }
            },
            "type": "state-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

create_state_version

POST /api/iacp/v3/workspaces/{workspace}/state-versions

Create a state version and set it as the current state version for the given workspace.

Parameters
  • workspace (string) –

Example request:

POST /api/iacp/v3/workspaces/{workspace}/state-versions HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "lineage": "string",
            "md5": "string",
            "serial": 1,
            "state": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "run": {
                "data": {
                    "id": "string",
                    "type": "runs"
                }
            }
        },
        "type": "state-versions"
    },
    "meta": {}
}
Status Codes
  • 201 Created

    Example response:

    HTTP/1.1 201 Created
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "created-at": "2020-05-20T12:41:43.944500",
                "hosted-state-download-url": "string",
                "lineage": "string",
                "md5": "string",
                "serial": 1,
                "state": "string",
                "vcs-commit-sha": "string",
                "vcs-commit-url": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "run": {
                    "data": {
                        "id": "string",
                        "type": "runs"
                    }
                }
            },
            "type": "state-versions"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

variables

get_variables

GET /api/iacp/v3/vars

Return the list of the Terraform Variables.

Query Parameters
  • filter[organization][name] (string) – The name of the organization that owns the desired workspace. If included, you must also included the workspace name filter.

  • filter[workspace][name] (string) – The name of one workspace to list variables for. If included, you must also include the organization name filter.

  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example request:

GET /api/iacp/v3/vars HTTP/1.1
Host: example.com
Status Codes

create_variable

POST /api/iacp/v3/vars

Create new Terraform Variable.

Example request:

POST /api/iacp/v3/vars HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "category": "terraform",
            "description": "string",
            "hcl": true,
            "key": "string",
            "sensitive": true,
            "value": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "workspace": {
                "data": {
                    "id": "string",
                    "type": "workspaces"
                }
            }
        },
        "type": "vars"
    },
    "meta": {}
}
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "category": "terraform",
                "description": "string",
                "hcl": true,
                "key": "string",
                "sensitive": true,
                "value": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "vars"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

delete_variable

DELETE /api/iacp/v3/vars/{var}

Delete terraform variable.

Parameters
  • var (string) –

Status Codes

get_variable

GET /api/iacp/v3/vars/{var}

Show a terraform variable.

Parameters
  • var (string) –

Example request:

GET /api/iacp/v3/vars/{var} HTTP/1.1
Host: example.com
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "category": "terraform",
                "description": "string",
                "hcl": true,
                "key": "string",
                "sensitive": true,
                "value": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "vars"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity

update_variable

PATCH /api/iacp/v3/vars/{var}

Updates terraform variable.

Parameters
  • var (string) –

Example request:

PATCH /api/iacp/v3/vars/{var} HTTP/1.1
Host: example.com
Content-Type: application/vnd.api+json

{
    "data": {
        "attributes": {
            "category": "terraform",
            "description": "string",
            "hcl": true,
            "key": "string",
            "sensitive": true,
            "value": "string"
        },
        "id": "string",
        "links": {
            "self": "string"
        },
        "relationships": {
            "workspace": {
                "data": {
                    "id": "string",
                    "type": "workspaces"
                }
            }
        },
        "type": "vars"
    },
    "meta": {}
}
Status Codes
  • 200 OK

    Example response:

    HTTP/1.1 200 OK
    Content-Type: application/vnd.api+json
    
    {
        "data": {
            "attributes": {
                "category": "terraform",
                "description": "string",
                "hcl": true,
                "key": "string",
                "sensitive": true,
                "value": "string"
            },
            "id": "string",
            "links": {
                "self": "string"
            },
            "relationships": {
                "workspace": {
                    "data": {
                        "id": "string",
                        "type": "workspaces"
                    }
                }
            },
            "type": "vars"
        },
        "meta": {}
    }
    

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 409 Conflict

  • 422 Unprocessable Entity