Skip to main content

API Schema and Structure

Harness' schema determines what parameters your queries can specify as arguments, and what data can be returned.

Following GraphQL conventions, Harness schema is represented in terms of fields, types, enums, nodes, edges, and connections.


The ! following the type means that this field is required.

Before You Begin


The Harness API's schema includes fields representing the following Harness entities. Note that many of these <entityId> or <entity> fields are also transformed within the schema into an <entity>Aggregation, <entity>Connection, and/or <entity>Filter. Use the API Explorer's search box to discover the available fields and their usage.

Field NameHarness Entity/Notes
applicationIdHarness Application.
serviceIdHarness Service.
environmentIdHarness Environment.
workflowIdHarness Workflow.
pipelineIdHarness Pipeline.
executionIdA Harness deployment (execution).
artifactIdArtifact deployed via Harness.
cloudProviderIdCloud Provider configured in Harness.
InstanceInstance deployed via Harness.
connectorIdConnector configured in Harness.
descriptionDescription of a Workflow, Pipeline, etc.
idUnique ID of a Harness entity.
nameName of a Workflow, Pipeline, etc.
totalTotal number of a parent Harness entity.
status, ExecutionStatusDeployment's execution status.
createdAtTime when deployment was queued in Harness.
startedAtTime when deployment's execution began.
TimeSeriesAggregationUsed to group returned statistics (on deployments, instances, etc.) by time.
TriggerFilterOne or more Harness Triggers.
limitPagination throttler.
offsetPagination pointer.

Next Steps