Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Orchestration Processes [Beta]

Create Orchestration Process

post

Create a new orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
yamlstringRequired

YAML configuration for the orchestration process

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process
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"
  ]
}

Fetch List of Orchestration Processes

get
Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

searchTermstringOptional

Optional search string to filter releases by name.

pageintegerOptional
sizeintegerOptional
sortstring[]Optional

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).

Example: {"value":["created_at","asc"]}
processIdentifiersstring[]Optional

Optional list of process identifiers to filter by. Supports scope prefixes: "account.", "org.", or plain "" (project scope).

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/summary
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

get

Get orchestration process by identifier

Path parameters
identifierstringRequired

Identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

git_branchstringOptional

Optional git branch to fetch the process YAML from (for remote/git-backed processes)

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{identifier}
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 Orchestration Process

put

Update an orchestration process with the provided YAML configuration

Path parameters
identifierstringRequired

The identifier of the orchestration process to update

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
yamlstringRequired
Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

put/orchestration/process/{identifier}
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 Orchestration Process

delete

Delete an orchestration process by identifier

Path parameters
identifierstringRequired

The identifier of the orchestration process to delete

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

delete/orchestration/process/{identifier}
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"
  ]
}

Fetch List of Attached Release Groups for Orchestration Process

post

Retrieve a paginated list of release groups attached to orchestration processes with optional filtering

Path parameters
identifierstringRequired

The identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

pageintegerOptional
sizeintegerOptional
sortstring[]Optional

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).

Example: {"value":["created_at","asc"]}
searchTermstringOptional

Optional search string to filter releases by name.

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
filterOrgIdentifierstringOptional

Optional organization identifier to filter processes

filterProjectIdentifierstringOptional

Optional project identifier to filter processes

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{identifier}/attachedReleaseGroups
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 Orchestration Process

post

Execute an orchestration process without creating a release (on-the-go execution)

Path parameters
identifierstringRequired

The identifier of the orchestration process to execute

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
gitBranchstringOptional

Optional branch to fetch remote process/activity YAMLs from. If omitted, the default branch is used.

inputIdentifierstringRequired

Process input identifier to use for this execution (required)

inputYamlstringRequired

Input YAML to configure global and phase inputs for this execution

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{identifier}/execute
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 Process Execution History

get

Get list of all executions (on-the-go runs) for a specific process

Path parameters
identifierstringRequired

The identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

pageintegerOptional
sizeintegerOptional
sortstring[]Optional

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).

Example: {"value":["created_at","asc"]}
executionTypestring · enumOptional

Filter by execution type (PROCESS for on-the-go executions, RELEASE for release-based executions). If not provided, returns all executions.

Possible values:
startTsinteger · int64Optional

Filter executions created on or after this timestamp (milliseconds)

endTsinteger · int64Optional

Filter executions created on or before this timestamp (milliseconds)

git_branchstringOptional

Filter executions by the git branch they were triggered on (remote processes only)

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{identifier}/executions
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 Orchestration Process Input

post

Create a new orchestration process input with the provided YAML configuration

Path parameters
identifierstringRequired

The identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
yamlstringRequired

YAML configuration for the orchestration process input

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{identifier}/input
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"
  ]
}

Get Orchestration Process Metadata

get

Retrieve metadata for an orchestration process without its YAML content

Path parameters
identifierstringRequired

Identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{identifier}/metadata
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 Orchestration Process to Git

post

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).

Path parameters
identifierstringRequired

The identifier of the orchestration process to move

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{identifier}/move-config
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"
  ]
}

Fetch List of Orchestration Process Inputs

get

Retrieve a paginated list of orchestration process inputs for a specific process

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

pageintegerOptional
sizeintegerOptional
sortstring[]Optional

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).

Example: {"value":["created_at","asc"]}
searchTermstringOptional

Optional search string to filter releases by name.

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{processIdentifier}/input/summary
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 Orchestration Process Input

get

Get an orchestration process input by process identifier and input identifier

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

identifierstringRequired

The identifier of the orchestration process input

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

git_branchstringOptional

Optional git branch to fetch the process input YAML from (for remote/git-backed process inputs)

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{processIdentifier}/input/{identifier}
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 Orchestration Process Input

put

Update an orchestration process input with the provided YAML configuration

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

identifierstringRequired

The identifier of the orchestration process input to update

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
yamlstringRequired

YAML configuration for the orchestration process input

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

put/orchestration/process/{processIdentifier}/input/{identifier}
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 Orchestration Process Input

delete

Delete an orchestration process input by process identifier and input identifier

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

identifierstringRequired

The identifier of the orchestration process input to delete

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

delete/orchestration/process/{processIdentifier}/input/{identifier}
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 Orchestration Process Input to Git

post

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).

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

identifierstringRequired

The identifier of the orchestration process input

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Body
Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{processIdentifier}/input/{identifier}/move-config
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"
  ]
}

Validate Orchestration Process Input

post

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.

Path parameters
processIdentifierstringRequired

The identifier of the orchestration process

identifierstringRequired

The identifier of the orchestration process input

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

post/orchestration/process/{processIdentifier}/input/{identifier}/validate
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"
  ]
}

Get Orchestration Process Input Metadata

get

Retrieve metadata for an orchestration process input without its YAML content

Path parameters
processIdentifierstringRequired

Identifier of the orchestration process

inputIdentifierstringRequired

Identifier of the orchestration process input

Query parameters
orgIdentifierstringOptional

Organisation Identifier

projectIdentifierstringOptional

Project Identifier

Header parameters
Harness-AccountstringRequired

Account Identifier

Responses
400

Error Response body

application/json

Error Response

codestring · enumOptional

canonical error code name

Possible values:
explanationstringOptional

additional context about why the error occurred

messagestringRequired

error message detail

probable_fixesstring[]Optional

suggested actions to resolve the error

get/orchestration/process/{processIdentifier}/input/{inputIdentifier}/metadata
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?