Orchestration Processes [Beta]
Create a new orchestration process
Organisation Identifier
Project Identifier
Account Identifier
YAML configuration for the orchestration process
Response for successful orchestration process creation
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
POST /api/orchestration/process HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
},
"yaml": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Organisation Identifier
Project Identifier
Optional search string to filter releases by name.
Sort parameters as an array. Format: [field_name, direction] where direction is asc or desc.
Supported fields: start_ts, startTs, end_ts, endTs, last_updated_at, lastUpdatedAt, created_at, createdAt, name, identifier, status, type.
When used in query params, use format: sort=field_name&sort=direction (e.g., sort=start_ts&sort=desc).
{"value":["created_at","asc"]}Optional list of process identifiers to filter by. Supports scope prefixes: "account.", "org.", or plain "" (project scope).
Account Identifier
This wraps the list of all orchestration processes along with pagination
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/summary HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Get orchestration process by identifier
Identifier of the orchestration process
Organisation Identifier
Project Identifier
Optional git branch to fetch the process YAML from (for remote/git-backed processes)
Account Identifier
Response for Get Orchestration Process API
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
GET /api/orchestration/process/{identifier} HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Update an orchestration process with the provided YAML configuration
The identifier of the orchestration process to update
Organisation Identifier
Project Identifier
Account Identifier
Response for successful orchestration process update
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
PUT /api/orchestration/process/{identifier} HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
},
"yaml": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Delete an orchestration process by identifier
The identifier of the orchestration process to delete
Organisation Identifier
Project Identifier
Account Identifier
Orchestration process deleted successfully
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
DELETE /api/orchestration/process/{identifier} HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Retrieve a paginated list of release groups attached to orchestration processes with optional filtering
The identifier of the orchestration process
Organisation Identifier
Project Identifier
Sort parameters as an array. Format: [field_name, direction] where direction is asc or desc.
Supported fields: start_ts, startTs, end_ts, endTs, last_updated_at, lastUpdatedAt, created_at, createdAt, name, identifier, status, type.
When used in query params, use format: sort=field_name&sort=direction (e.g., sort=start_ts&sort=desc).
{"value":["created_at","asc"]}Optional search string to filter releases by name.
Account Identifier
Optional organization identifier to filter processes
Optional project identifier to filter processes
Paginated list of release groups attached to orchestration processes
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{identifier}/attachedReleaseGroups HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"filterOrgIdentifier": "text",
"filterProjectIdentifier": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Execute an orchestration process without creating a release (on-the-go execution)
The identifier of the orchestration process to execute
Organisation Identifier
Project Identifier
Account Identifier
Optional branch to fetch remote process/activity YAMLs from. If omitted, the default branch is used.
Process input identifier to use for this execution (required)
Input YAML to configure global and phase inputs for this execution
Execution started successfully
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{identifier}/execute HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"gitBranch": "text",
"inputIdentifier": "text",
"inputYaml": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Get list of all executions (on-the-go runs) for a specific process
The identifier of the orchestration process
Organisation Identifier
Project Identifier
Sort parameters as an array. Format: [field_name, direction] where direction is asc or desc.
Supported fields: start_ts, startTs, end_ts, endTs, last_updated_at, lastUpdatedAt, created_at, createdAt, name, identifier, status, type.
When used in query params, use format: sort=field_name&sort=direction (e.g., sort=start_ts&sort=desc).
{"value":["created_at","asc"]}Filter by execution type (PROCESS for on-the-go executions, RELEASE for release-based executions). If not provided, returns all executions.
Filter executions created on or after this timestamp (milliseconds)
Filter executions created on or before this timestamp (milliseconds)
Filter executions by the git branch they were triggered on (remote processes only)
Account Identifier
Process execution history retrieved successfully
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/{identifier}/executions HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Create a new orchestration process input with the provided YAML configuration
The identifier of the orchestration process
Organisation Identifier
Project Identifier
Account Identifier
YAML configuration for the orchestration process input
Response for successful orchestration process input creation
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{identifier}/input HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
},
"yaml": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Retrieve metadata for an orchestration process without its YAML content
Identifier of the orchestration process
Organisation Identifier
Project Identifier
Account Identifier
Metadata for a single orchestration process (no YAML)
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/{identifier}/metadata HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Move an inline orchestration process to a remote git repository. Processes already stored remotely cannot be moved. Existing process inputs are left unchanged (may remain INLINE).
The identifier of the orchestration process to move
Organisation Identifier
Project Identifier
Account Identifier
Response for Get Orchestration Process API
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{identifier}/move-config HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
}
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Retrieve a paginated list of orchestration process inputs for a specific process
The identifier of the orchestration process
Organisation Identifier
Project Identifier
Sort parameters as an array. Format: [field_name, direction] where direction is asc or desc.
Supported fields: start_ts, startTs, end_ts, endTs, last_updated_at, lastUpdatedAt, created_at, createdAt, name, identifier, status, type.
When used in query params, use format: sort=field_name&sort=direction (e.g., sort=start_ts&sort=desc).
{"value":["created_at","asc"]}Optional search string to filter releases by name.
Account Identifier
Paginated list of orchestration process inputs
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/{processIdentifier}/input/summary HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Get an orchestration process input by process identifier and input identifier
The identifier of the orchestration process
The identifier of the orchestration process input
Organisation Identifier
Project Identifier
Optional git branch to fetch the process input YAML from (for remote/git-backed process inputs)
Account Identifier
Response for successful orchestration process input retrieval
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/{processIdentifier}/input/{identifier} HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Update an orchestration process input with the provided YAML configuration
The identifier of the orchestration process
The identifier of the orchestration process input to update
Organisation Identifier
Project Identifier
Account Identifier
YAML configuration for the orchestration process input
Response for successful orchestration process input update
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
PUT /api/orchestration/process/{processIdentifier}/input/{identifier} HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
},
"yaml": "text"
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Delete an orchestration process input by process identifier and input identifier
The identifier of the orchestration process
The identifier of the orchestration process input to delete
Organisation Identifier
Project Identifier
Account Identifier
Orchestration process input deleted successfully
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
DELETE /api/orchestration/process/{processIdentifier}/input/{identifier} HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Move an inline process input to a remote git repository. Parent process must be remote. Input already stored remotely cannot be moved. Git repository and connector must match the parent process. Branch is required but is not validated against a process-pinned branch (processes do not persist a branch; Save-to-Git may commit to a new branch).
The identifier of the orchestration process
The identifier of the orchestration process input
Organisation Identifier
Project Identifier
Account Identifier
Response for successful orchestration process input retrieval
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{processIdentifier}/input/{identifier}/move-config HTTP/1.1
Harness-Account: text
Content-Type: application/json
Accept: */*
Content-Length: 186
{
"git_details": {
"base_branch": "text",
"branch": "text",
"commit_msg": "text",
"connector_ref": "text",
"file_url": "text",
"is_new_branch": true,
"path": "text",
"repo": "text",
"store_type": "INLINE"
}
}{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}On-demand cross-entity validation for a process input. Checks that all activity with keys are recognised (X4 warning) and that all required activity inputs are covered (X5 error). Returns HTTP 200 with a validation report regardless of outcome — never modifies any state.
The identifier of the orchestration process
The identifier of the orchestration process input
Organisation Identifier
Project Identifier
Account Identifier
Result of an on-demand process input cross-entity validation
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
POST /api/orchestration/process/{processIdentifier}/input/{identifier}/validate HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Retrieve metadata for an orchestration process input without its YAML content
Identifier of the orchestration process
Identifier of the orchestration process input
Organisation Identifier
Project Identifier
Account Identifier
Metadata for a single orchestration process input (no YAML)
Error Response body
Error Response
canonical error code name
additional context about why the error occurred
error message detail
suggested actions to resolve the error
Error Response body
Error Response body
Error Response body
GET /api/orchestration/process/{processIdentifier}/input/{inputIdentifier}/metadata HTTP/1.1
Harness-Account: text
Accept: */*
{
"code": "BAD_REQUEST",
"explanation": "text",
"governanceMetadata": {
"accountId": "text",
"action": "text",
"created": "text",
"deny": true,
"details": [
{
"accountId": "text",
"created": "text",
"deny": true,
"description": "text",
"identifier": "text",
"orgId": "text",
"policyMetadata": [
{
"accountId": "text",
"created": "text",
"denyMessages": [
"text"
],
"error": "text",
"identifier": "text",
"orgId": "text",
"policyId": "text",
"policyName": "text",
"projectId": "text",
"severity": "text",
"status": "text",
"updated": "text"
}
],
"policySetId": "text",
"policySetName": "text",
"projectId": "text",
"status": "text"
}
],
"entity": "text",
"id": "text",
"message": "text",
"orgId": "text",
"projectId": "text",
"status": "text",
"timestamp": "text",
"type": "text"
},
"message": "text",
"probable_fixes": [
"text"
]
}Last updated
Was this helpful?