{ "opencollection": "1.0.0", "info": { "name": "HCP Terraform Modules Workspaces API", "version": "2.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://app.terraform.io/api/v2/organizations/:organization_name/workspaces", "params": [ { "name": "organization_name", "value": "", "type": "path" }, { "name": "page[number]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" }, { "name": "search[name]", "value": "", "type": "query", "description": "Filter workspaces by name" }, { "name": "search[tags]", "value": "", "type": "query", "description": "Filter workspaces by tags" }, { "name": "filter[project][id]", "value": "", "type": "query", "description": "Filter workspaces by project ID" } ] }, "docs": "Lists workspaces within an organization." }, { "info": { "name": "Create a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://app.terraform.io/api/v2/organizations/:organization_name/workspaces", "params": [ { "name": "organization_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new workspace within an organization." }, { "info": { "name": "Get a Workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.terraform.io/api/v2/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details for a specific workspace." }, { "info": { "name": "Update a Workspace", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.terraform.io/api/v2/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings for an existing workspace." }, { "info": { "name": "Delete a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.terraform.io/api/v2/workspaces/:workspace_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Destroys a workspace and all its contents." }, { "info": { "name": "Lock a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://app.terraform.io/api/v2/workspaces/:workspace_id/actions/lock", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Locks a workspace to prevent runs." }, { "info": { "name": "Unlock a Workspace", "type": "http" }, "http": { "method": "POST", "url": "https://app.terraform.io/api/v2/workspaces/:workspace_id/actions/unlock", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ] }, "docs": "Unlocks a workspace to allow runs." } ] } ], "bundled": true }