Home

Terraform Cloud (version v1.*.*)

get_run_details#

https://www.terraform.io/docs/cloud/api/run.html#get-run-details

This endpoint is used for showing details of a specific run.

Parameters

run_id (required)#

The run ID to get

Type: string

list_organization_memberships#

https://www.terraform.io/docs/cloud/api/organization-memberships.html#list-memberships-for-an-organization

Parameters

organization_name (required)#

The name of the organization to list the memberships of.

Type: string

filter[status]#

Optional. If specified, restricts results to those with the matching status value. Valid values are invited and active.

Type: string

Potential values: invited, active

q#

Optional. A search query string. Organization memberships are searchable by user name and email.

Type: string

list_runs#

https://www.terraform.io/docs/cloud/api/run.html#list-runs-in-a-workspace

Parameters

workspace_id (required)#

The workspace ID to list runs for

Type: string

list_team_access_to_workspace#

https://www.terraform.io/docs/cloud/api/organization-memberships.html#list-memberships-for-an-organization

Parameters

filter[workspace][id] (required)#

Required. The workspace ID to list team access for. Obtain this from the workspace settings or the Show Workspace endpoint.

Type: string

list_workspaces#

https://www.terraform.io/docs/cloud/api/workspaces.html#list-workspaces

Parameters

organization_name (required)#

The name of the organization to list the workspaces of.

Type: string

retrieve_json_execution_plan#

https://www.terraform.io/docs/cloud/api/plans.html#retrieve-the-json-execution-plan

Generates a temporary authenticated URL to the location of the JSON formatted execution plan. When successful, this endpoint responds with a temporary redirect that should be followed. If using a client that can follow redirects, you can use this endpoint to save the .json file locally without needing to save the temporary URL.This temporary URL provided by the redirect has a life of 1 minute, and should not be relied upon beyond the initial request. If you need repeat access, you should use this endpoint to generate a new URL each time.

Parameters

plan_id (required)#

The ID of the plan to show

Type: string

show_organization#

https://www.terraform.io/docs/cloud/api/organizations.html#show-an-organization

Shows an organization

Parameters

organization_name (required)#

The name of the organization to show

Type: string

show_plan#

https://www.terraform.io/docs/cloud/api/plans.html#show-a-plan

There is no endpoint to list plans. You can find the ID for a plan in the relationships.plan property of a run object.

Parameters

plan_id (required)#

The ID of the plan to show

Type: string

show_user#

https://www.terraform.io/docs/cloud/api/organizations.html#show-an-organization

Show details for a given user.

Parameters

user_id (required)#

The ID of the desired user

Type: string

show_workspace_by_id#

https://www.terraform.io/docs/cloud/api/workspaces.html#show-workspace

Parameters

workspace_id (required)#

The workspace ID

Type: string

show_workspace_by_org_and_name#

https://www.terraform.io/docs/cloud/api/workspaces.html#show-workspace

Parameters

organization_name (required)#

The name of the organization the workspace belongs to.

Type: string

workspace_name (required)#

The name of the workspace to show details for, which can only include letters, numbers, dashes, and underscores.

Type: string