API Reference
Log InSign UpBlog

Update a Workspace

patch
https://{Domain}/api/iacp/v3/workspaces/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the workspace to be updated.

Body Params

JSON:API Document.

see: https://jsonapi.org/format/#document-structure

data
object

A Workspace is where Terraform runs are performed for a specific configuration, and where the resulting state file(s) are stored.

Workspaces belong to environments and can have variables configured to provide inputs to the configuration, authenticate providers etc.

The extra fields below are not available in response by default. Ask for them explicitly in the query parameter fields[workspaces]:

  • module
Responses

404

Workspace not found, or user unauthorized to perform action.

422

Malformed request body (missing attributes, wrong types, etc.).

4XX

Client error.

5XX

Server error.

Updated 12 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 12 days ago