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

Harness Orchestration Executions API

The Orchestration Executions API from Harness — 18 operation(s) for orchestration executions.

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

Tagged areas include Orchestration Executions. 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 19 operations across 18 paths, and defines 34 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}.

19 operations 18 paths 34 schemas 1 DELETE12 GET3 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Orchestration Executions 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 19

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

Orchestration Executions 19
POST
/rmg/api/orchestration/execution/startRelease/{id}
Start Release Execution
startReleaseExecution 4 params body → 200400403404500
GET
/rmg/api/orchestration/execution/{releaseId}/phases
Get Phases by Release ID
get-orchestration-execution-phases 5 params → 200400403404500
GET
/rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activities
Get Activities by Release and Phase ID
get-orchestration-execution-activities 7 params → 200400403404500
GET
/rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/tasks
Get Orchestration Execution Tasks by Activity
get-orchestration-execution-tasks 7 params → 200400403404500
GET
/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/retry-history
Get Activity Retry History By Identifiers
get-activity-retry-history-by-identifiers 10 params → 200400403404500
GET
/rmg/api/orchestration/execution/activity/{activityId}/input
Get Activity Execution Inputs
get-orchestration-execution-activity-inputs 4 params → 200400403404500
GET
/rmg/api/orchestration/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}
Get Activity Execution Detail
get-orchestration-execution-activity 8 params → 200400403404500
GET
/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/output
Get Phase Execution Outputs
get-orchestration-execution-phase-outputs 6 params → 200400403404500
GET
/rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/output
Get Activity Execution Outputs
get-orchestration-execution-activity-outputs 7 params → 200400403404500
POST
/rmg/api/orchestration/execution/activity/{activityId}/output
Submit Activity Execution Outputs
post-activity-execution-output 4 params body → 200404409422
POST
/rmg/api/orchestration/execution/task/{taskExecutionId}/comment
Create Task Comment
createTaskComment 4 params body → 200400403404500
PUT
/rmg/api/orchestration/execution/task/comment/{commentId}
Update Task Comment
updateTaskComment 4 params body → 200400403404500
DELETE
/rmg/api/orchestration/execution/task/comment/{commentId}
Delete Task Comment
deleteTaskComment 4 params → 204400403404500
GET
/rmg/api/orchestration/execution/task/{taskExecutionId}/comment/summary
Get Task Comments Summary
getTaskCommentsSummary 6 params → 200400403404500
PUT
/rmg/api/orchestration/execution/task/{taskExecutionId}/status
Update Execution Task Status
updateExecutionTaskStatus 4 params body → 200400403404500
PUT
/rmg/api/orchestration/execution/task/{taskExecutionId}/metadata
Update Execution Task Metadata
updateExecutionTaskMetadata 4 params body → 200400403404500
GET
/rmg/api/orchestration/{entityType}/events/{entityId}
Get Events by Entity Type and Entity ID
getEventsByEntityTypeAndId 8 params → 200400403404500
GET
/rmg/api/release/{releaseId}/execution/activities
Get Paginated Activities by Release ID
get-orchestration-execution-activities-paginated 13 params → 200400403404500
GET
/rmg/api/orchestration/execution/releaseInput/{releaseId}
Get Latest Release Input by Release ID
get-orchestration-execution-release-input 4 params → 200400403404500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OrchestrationExecutionActivityPaginated (19 properties), OrchestrationExecutionActivityDetail (18 properties), ActivityRetryInfo (15 properties), OrchestrationExecutionPhase (13 properties). Each schema is shown below with its type and property counts.

RmError
object
Error Response
2 properties 1 required
EventMetadata
object
Metadata for an event
2 properties 2 required
ActivityRetryHistoryResponse
object
Response containing the retry history for an activity execution
3 properties 3 required
OrchestrationExecutionActivity
object
Represents an activity in the orchestration execution
13 properties 5 required
AnyValue
Flexible type that accepts any JSON value (string, number, boolean, object, or array)
EventEntity
string
Type of entity for events
OrchestrationExecutionActivityPaginated
object
Represents an activity in the paginated orchestration execution activities response
19 properties 9 required
SubprocessActivityInfo
object
Subprocess execution information for activities
2 properties 2 required
OrchestrationExecutionPhase
object
Represents a phase in the orchestration execution
13 properties 6 required
ActivityExecutionInputDTO
object
Input value for an activity execution
3 properties 3 required
StringOrBool
Flexible type that accepts either a boolean or a string
ActivityTypeCounts
object
Counts of activities by status for a specific activity type
2 properties 2 required
PipelineActivityInfo
object
Pipeline execution information for activities
2 properties 2 required
EventType
string
Type of event
ActivityRetryInfo
object
Information about a single retry attempt
15 properties 7 required
ActivityCounts
object
Activity counts grouped by type and status
3 properties 3 required
CreatedByDTO
object
Details of the user who created the event
3 properties 2 required
TaskCommentsListResponseDTO
object
Paginated response containing task comments
3 properties 3 required
TaskCommentDTO
object
Represents a comment on an execution task
6 properties 6 required
RmFailureInfo
object
Information about a failure that occurred
2 properties 1 required
OrchestrationStatus
string
Status of orchestration execution activities
CommentedByDTO
object
2 properties 2 required
OrchestrationExecutionActivityDetail
object
Detailed information about an activity execution
18 properties 9 required
ManualActivityInfo
object
Manual activity execution information
1 property
ExecutionTaskStatus
string
Current status of the execution task
InputVariableType
string
Type of an input variable for parameters and process inputs.
RmPageable
object
6 properties
NextRequest
object
2 properties
StringOrStringArray
Flexible type that accepts either a single string or an array of strings for user references
PageableSort
object
3 properties
ActivityTriggerInfo
object
Trigger information for an activity
3 properties
ExecutionOutputDTO
object
Output value for a phase execution
2 properties 2 required
EventDTO
object
Represents an event for an entity
6 properties 6 required
ExecutionTaskDTO
object
Represents an execution task for a specific activity
12 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-orchestration-executions-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Orchestration Executions 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.