How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Harness

Harness Workspaces API

Workspaces Service handles the API for managing workspacesand triggering workflows against them.

Documentation Provider Profile APIs.io OpenAPI GitHub

Harness Workspaces API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 41 operations across 32 paths, and defines 77 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

41 operations 32 paths 77 schemas 5 DELETE19 GET1 PATCH13 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Contact
API Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Harness Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 41

Across 32 paths, the API surfaces 41 operations — 5 DELETE, 19 GET, 1 PATCH, 13 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 41

Workspaces Service handles the API for managing workspaces and triggering workflows against them.

GET
/iacm/api/orgs/{org}/projects/{project}/tags
List all workspace tags
workspaces#list-all-workspace-tags 3 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspace-metrics
Show workspace metrics
workspaces#show-workspace-metrics 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces
List workspaces
workspaces#list-workspaces 9 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces
Create workspace
workspaces#create-workspace 3 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}
Destroy workspace
workspaces#destroy-workspace 4 params → 204400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}
Show workspace
workspaces#show-workspace 4 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}
Update workspace
workspaces#update-workspace 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/force-unlock
Unlock workspace
workspaces#force-unlock-workspace 4 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/lock
Lock workspace
workspaces#lock-workspace 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules
List modules
workspaces#list-workspace-modules 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources
List resources
workspaces#list-resources 7 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/search
List resources using selectors
workspaces#search-resources 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/clone
Clone workspace
workspaces#clone-workspace 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data
List data
workspaces#list-data 11 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data
Create data
workspaces#create-data 14 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}
Show data
workspaces#show-data 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy
Evaluate data
workspaces#evaluate-data 7 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/dependency-graph
Upload dependency graph data
workspaces#upload-dependency-graph 12 params → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config
Disable drift automation for a workspace
workspaces#delete-drift-config 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config
Get drift automation status for a workspace
workspaces#get-drift-config 5 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config
Enable drift automation for a workspace
workspaces#update-drift-config 4 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config
Disable ephemeral TTL for a workspace
workspaces#delete-ephemeral-config 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config
Get ephemeral TTL status for a workspace
workspaces#get-ephemeral-config 5 params → 200400401403404408409423
PUT
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config
Enable ephemeral TTL for a workspace
workspaces#update-ephemeral-config 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/events
Send event
workspaces#send-event 4 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines
List pipelines
workspaces#list-pipelines 6 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions
Create remote execution
workspaces#create-remote-execution 4 params body → 201400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}
Show remote execution
workspaces#find-remote-execution 5 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/download
Download remote execution
workspaces#download-remote-execution 5 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute
execute-remote-execution workspaces
workspaces#execute-remote-execution 5 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/upload
Upload remote execution source
workspaces#upload-remote-execution 7 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types
List workspace resource types
workspaces#list-workspace-resource-types 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types-and-attributes
Map of resource types and their attributes
workspaces#list-workspace-resource-types-and-attributes 4 params → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types/{resource_type}/attributes
List workspace resource type attributes
workspaces#list-workspace-resource-type-attributes 5 params → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources
Delete resources
workspaces#delete-resources 4 params body → 200400401403404408409423
PATCH
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources
Update resources
workspaces#update-resources 4 params body → 200400401403404408409423
DELETE
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources/stale
Delete stale resources
workspaces#delete-stale-resources 4 params body → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment
Upload risk assessment data
workspaces#upload-risk-assessment 12 params → 200400401403404408409423
POST
/iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/state-versions/{data_id}/rollback
Roll back workspace state to a previous version
workspaces#rollback-state 5 params body → 200400401403404408409423
GET
/iacm/api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio
List provisioners ratio
workspaces#list-provisioners-ratio 5 params → 200400401403404408409423
GET
/iacm/api/workspace/templates/{template_id}
List workspaces associated with a template ID
workspaces#list-associated-workspaces 5 params → 200400401403404408409423

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are WorkspacesShowWorkspaceResponseBody (47 properties), CreateWorkspaceRequest (39 properties), ActivityMetadata (36 properties), UpdateWorkspaceRequest (28 properties). Each schema is shown below with its type and property counts.

ResourceDeleteSummary
object
Summary of a resource delete operation
4 properties 4 required
HarnessIacmWorkspacedata
object
WorkspaceDataResource is the representation for a single item of data associated with a workspace.
14 properties 12 required
WorkspaceModuleCollection
array
OutputCollection
array
WorkspaceTerraformVariableFiles
object
WorkspaceTerraformVarFiles defines a variable file that lives in another repository than the workspace files.
6 properties 1 required
ListPipelinesResponse
object
4 properties 3 required
CloneWorkspaceRequest
object
2 properties 2 required
ActivityMetadata
object
36 properties
ListResourcesResponse
object
5 properties 4 required
DeleteStaleResourcesResponse
object
1 property 1 required
UpdateDriftConfigRequest
object
4 properties 3 required
WorkspaceResourceSummary
object
WorkspaceResource is the representation for a single workspace definition. (summary view)
9 properties 8 required
UpdateEphemeralConfigRequest
object
9 properties 1 required
UploadRiskAssessmentResponse
object
4 properties 1 required
RemoteExecution
object
remote execution details for a specific workspace.
12 properties 11 required
WorkspaceProviderConnector
object
Workspace provider connector
7 properties 2 required
IaCMEvaluationDetail
object
13 properties 13 required
SearchResourcesResponse
object
5 properties 4 required
CreateRemoteExecutionRequest
object
1 property 7 required
Counts
object
6 properties 4 required
UploadRemoteExecutionResponse
object
12 properties 11 required
SearchResourcesRequest
object
3 properties
RollbackStateResponse
object
3 properties 3 required
IaCMEvaluation
object
The result of a single evaluation
12 properties 12 required
LockWorkspaceResponse
object
7 properties 7 required
UpdateResourcesRequest
object
3 properties 1 required
WorkspacesCreateWorkspaceResponseBody
object
Create-WorkspaceResponseBody result type (default view)
1 property
HarnessIacmWorkspacemodule
object
Represents an individual OpenTofu or Terraform module.
5 properties 4 required
ShowRemoteExecutionResponse
object
12 properties 11 required
ResourceDeleteResult
object
Result of a resource delete operation
6 properties 4 required
IaCMError
object
6 properties 6 required
TerragruntDetail
object
13 properties
DeleteEphemeralConfigResponse
object
1 property 1 required
DefaultPipelineOverride
object
Per-workspace override to the assigned default pipelines.
2 properties
UpdateResourcesResponse
object
2 properties 2 required
GetEphemeralConfigResponse
object
14 properties 1 required
CreateDataResponse
object
4 properties 1 required
ResourceUpdate
object
Resource update information
10 properties 6 required
ResourcesSelector
object
5 properties
DeleteStaleResourcesRequest
object
1 property 1 required
CreateWorkspaceRequest
object
39 properties 6 required
DeleteDriftConfigResponse
object
1 property 1 required
EvaluateDataResponse
object
4 properties 1 required
UpdateDriftConfigResponse
object
1 property 1 required
ResourceCollection
array
SendEventRequest
object
5 properties 1 required
CreateRemoteExecutionResponse
object
12 properties 11 required
WorkspaceDataPolicyEvaluation
object
6 properties 6 required
IaCMEvaluatedPolicy
object
5 properties 5 required
WorkspacesShowWorkspaceResponseBody
object
Show-WorkspaceResponseBody result type (default view)
47 properties 15 required
UpdateEphemeralConfigResponse
object
3 properties 1 required
PolicyViolationError
object
7 properties 6 required
ResourceDelete
object
Resource delete information
5 properties 4 required
HarnessIacmWorkspaceTemplate
object
WorkspaceTemplateResource is the representation for a workspace-template association.
8 properties 7 required
ShowWorkspaceMetricsRequest
object
1 property
WorkspaceDataResourceCollection
array
ListProvisionersRatioResponse
object
List of provisioners ratio
2 properties 2 required
UpdateWorkspaceResponse
object
1 property
IaCMPolicy
object
8 properties 8 required
ResourceUpdateResult
object
Result of a resource update operation
7 properties 5 required
DeleteResourcesResponse
object
2 properties 2 required
ResourceUpdateSummary
object
Summary of a resource update operation
4 properties 4 required
UploadDependencyGraphResponse
object
4 properties 1 required
UpdateWorkspaceRequest
object
28 properties 5 required
HarnessIacmOutput
object
Represents an individual output variable.
5 properties 3 required
LockWorkspacePayload2
object
1 property
WorkspaceResourceSummaryCollection
array
WorkspaceResourceCollection is the result type for an array of WorkspaceResource (summary view)
GetDriftConfigResponse
object
5 properties 1 required
DeleteResourcesRequest
object
1 property 1 required
WorkspaceLock
object
workspaceLock holds the details of an active workspace lock. Fields are populated for manual (user-initiated) locks and left empty for automatic (Terraform CLI…
7 properties
ResourcesSelectorConditions
object
3 properties 3 required
AssociatedTemplate
object
AssociatedTemplate defines the template details with templateid and version.
2 properties
VariableResource
object
Variable is the representation for a single variable associated with a workspace.
5 properties 6 required
IaCMVariable
object
Variable is the representation for a single variable associated with a workspace.
3 properties 4 required
RollbackStateRequest
object
1 property
Stacks
object
Stack details for multi-stack deployments
12 properties
HarnessIacmResource
object
Represents an individual provisioned resource.
16 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-workspaces-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
AE Profile APIs.io
Harness Continuous Delivery and GitOps API
AE Profile APIs.io
Harness Feature Management and Experimentation API
AE Profile APIs.io
Harness Cloud Cost Management API
AE Profile APIs.io
Harness Chaos Engineering API
AE Profile APIs.io
Harness Security Testing Orchestration API
AE Profile APIs.io
Harness Internal Developer Portal API
AE Profile APIs.io
Harness Code Repository API
AE Profile APIs.io
Harness Service Reliability Management API
AE Profile APIs.io
Harness Infrastructure as Code Management API
AE Profile APIs.io
Harness Supply Chain Security API
AE Profile APIs.io
Harness Software Engineering Insights API
AE Profile APIs.io
#Workspace
← Back to H APIs
API Details
ID
harness:harness-workspaces-api
Base URL
https://app.harness.io
Docs
https://apidocs.harness.io
Provider
Harness
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=harness-workspaces-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/harness-workspaces-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Harness Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.