---
canonical_url: "https://docs.composio.dev/toolkits/harness"
markdown_url: "https://docs.composio.dev/toolkits/harness.md"
product: "platform"
version: null
last_updated: null
---

# Harness

Harness Core CD APIs for managing pipelines, executions, services, environments, infrastructure, input sets, triggers, and templates.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `HARNESS`
- **Version:** 00000000_00

## Tools

### List Environments

**Slug:** `HARNESS_LIST_ENVIRONMENTS`

List one page of environments in a Harness project, optionally filtered by identifiers or search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort criteria written as field,direction, where direction is ASC or DESC. |
| `cursor` | string | No | Continuation cursor from a previous response; omit for the first page and pass the returned value unchanged to fetch the next page. |
| `page_size` | integer | No | Maximum environments to return in this page. |
| `search_term` | string | No | Filter environments by matching name or identifier. |
| `org_identifier` | string | No | Harness organization identifier; omit to use the connection default. |
| `project_identifier` | string | No | Harness project identifier; omit to use the connection default. |
| `environment_identifiers` | array | No | Return only environments with these identifiers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipeline Executions

**Slug:** `HARNESS_LIST_EXECUTIONS`

List one page of pipeline executions in a Harness project, optionally filtered by pipeline, status, search text, or current-user ownership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort criteria written as field,direction, where direction is ASC or DESC. |
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `statuses` | array | No | Return executions whose status is one of these Harness execution states. |
| `page_size` | integer | No | Maximum executions to return in this page. |
| `search_term` | string | No | Filter executions by matching pipeline name, identifier, or tags. |
| `org_identifier` | string | No | Harness organization identifier; omit to use the connection default. |
| `triggered_by_me` | boolean | No | Whether to return only executions triggered by the connected Harness user. |
| `project_identifier` | string | No | Harness project identifier; omit to use the connection default. |
| `pipeline_identifier` | string | No | Return executions for this exact pipeline identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organizations

**Slug:** `HARNESS_LIST_ORGANIZATIONS`

List one page of Harness organizations accessible to the connected account, optionally filtered by identifier or search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a previous response; omit for the first page and pass the returned value unchanged to fetch the next page. |
| `page_size` | integer | No | Maximum organizations to return in this page (1-100). |
| `identifiers` | array | No | Return only organizations with these identifiers. |
| `search_term` | string | No | Filter organizations by matching name, identifier, or tag. |
| `sort_orders` | array | No | Ordered sort criteria, each supplied as a JSON-encoded object string with fieldName and orderType, for example ['{"fieldName":"name","orderType":"ASC"}']. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pipelines

**Slug:** `HARNESS_LIST_PIPELINES`

List one page of pipelines in a Harness project, optionally filtered by search text or Git branch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort criteria written as field,direction, where direction is ASC or DESC. |
| `branch` | string | No | Filter Git-backed pipeline definitions by branch. |
| `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `page_size` | integer | No | Maximum pipelines to return in this page (1-200). |
| `search_term` | string | No | Filter pipelines by matching name, identifier, or tags. |
| `org_identifier` | string | No | Harness organization identifier; omit to use the connection default. |
| `project_identifier` | string | No | Harness project identifier; omit to use the connection default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `HARNESS_LIST_PROJECTS`

List one page of Harness projects accessible to the connected account, optionally within an organization or filtered by module and search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `page_size` | integer | No | Maximum projects to return in this page (1-100). |
| `identifiers` | array | No | Return only projects with these identifiers. |
| `module_type` | string ("CD" | "CI" | "CV" | "CF" | "CE" | "STO" | "CHAOS" | "AI_TEST_AUTOMATION" | "SRM" | "IACM" | "CET" | "IDP" | "CODE" | "SSCA" | "AISRE" | "CORE" | "PMS" | "TEMPLATESERVICE" | "RMG" | "GOVERNANCE" | "PLATFORM" | "SEI" | "HAR" | "DevopsEssentials" | "FME" | "DBOPS" | "AI_AGENT_MLOPS" | "AASP" | "AARP" | "AAST" | "AISEC") | No | Return projects that have this Harness module, such as CD for Continuous Delivery. |
| `search_term` | string | No | Filter projects by matching name, identifier, or tag. |
| `sort_orders` | array | No | Ordered sort criteria, each supplied as a JSON-encoded object string with fieldName and orderType, for example ['{"fieldName":"name","orderType":"ASC"}']. |
| `only_favorites` | boolean | No | Whether to return only projects marked as favorites. |
| `org_identifier` | string | No | Organization identifier to filter projects; when omitted, use the connection default if configured or search across accessible organizations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Services

**Slug:** `HARNESS_LIST_SERVICES`

List one page of services in a Harness project, optionally filtered by identifiers, deployment type, tags, storage, GitOps state, or search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | array | No | Sort criteria written as field,direction, where direction is ASC or DESC. |
| `tags` | array | No | Filter by tags written as key:value or key; a service may match any supplied tag. |
| `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `page_size` | integer | No | Maximum services to return in this page (1-1000). |
| `store_type` | string ("INLINE" | "REMOTE" | "INLINE_HC") | No | Filter by entity storage: Harness inline, Git remote, or Harness Code inline. |
| `search_term` | string | No | Filter services by matching name or identifier. |
| `service_type` | string ("Kubernetes" | "NativeHelm" | "Ssh" | "WinRm" | "ServerlessAwsLambda" | "AzureWebApp" | "AzureFunction" | "CustomDeployment" | "ECS" | "Elastigroup" | "TAS" | "Asg" | "GoogleCloudFunctions" | "AwsLambda" | "AWS_SAM" | "SERVICE_YAML_V1_TYPE" | "GoogleCloudRun" | "Salesforce" | "GoogleManagedInstanceGroup" | "AzureContainerApps" | "AiAgent") | No | Filter by Harness service deployment type. |
| `gitops_enabled` | boolean | No | Filter services by whether GitOps is enabled. |
| `org_identifier` | string | No | Harness organization identifier; omit to use the connection default. |
| `project_identifier` | string | No | Harness project identifier; omit to use the connection default. |
| `service_identifiers` | array | No | Return only services with these identifiers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `HARNESS_LIST_TEMPLATES`

List one page of account-scoped Harness templates, optionally filtered by template state, entity or child type, identifier, name, description, or search text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `names` | array | No | Return only templates with these names. |
| `cursor` | string | No | Continuation cursor from a previous call; omit for the first page. |
| `sort_by` | string ("identifier" | "name" | "updated") | No | Template field to sort by. |
| `page_size` | integer | No | Maximum templates to return in this page (1-100). |
| `recursive` | boolean | No | Whether to include all accessible templates below the account scope. |
| `sort_order` | string ("ASC" | "DESC") | No | Sort direction; use with sort_by. |
| `child_types` | array | No | Filter templates by step or stage child type. |
| `description` | string | No | Filter templates by description text. |
| `identifiers` | array | No | Return only templates with these identifiers. |
| `search_term` | string | No | Filter templates by matching resource attributes. |
| `entity_types` | array | No | Filter templates by the Harness entities they define. |
| `template_type` | string ("STABLE_TEMPLATE" | "LAST_UPDATES_TEMPLATE" | "ALL") | No | Which template revisions to list: stable, latest updates, or all. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |