Harness API

42 articles

​Introduction to Harness GraphQL API

Query Harness' public GraphQL API using Harness API Explorer, Postman, or your custom applications.

Updated 4 months ago by Archana Singh

Harness API Explorer

Describes how to use Harness API Explorer.

Updated 5 months ago by Archana Singh

API Schema and Structure

Describes about Harness API schema and structure.

Updated 5 months ago by Archana Singh

Building Applications Using Postman

Describes how to build browser-based queries in Postman for Harness GraphQL APIs.

Updated 5 months ago by Archana Singh

Trigger Workflows or Pipelines Using GraphQL API

Describes how to trigger a Workflow or a Pipeline using GraphQL API.

Updated 3 months ago by Archana Singh

Filter Harness Entities using Harness Tags in the API

Harness provides advanced tagging features for all or your Harness Application entities (Services, Environments, Workflows, etc), as described in Assign Metadata Using Tags and Apply Filters Using Ta…

Updated 5 months ago by Michael Cretzman

Fetch Artifact Source Details Using GraphQL APIs

This topic describes how to add connections for Artifacts in ArtifactSources.

Updated 5 months ago by Archana Singh

Use Cloud Providers API

Use the Cloud Providers API

Updated 5 months ago by Michael Cretzman

Use Harness Applications API

Shows how to create and update Harness Applications using API calls.

Updated 5 months ago by Archana Singh

Use Services API

Provides detail of some common basic queries that your applications can execute against the Harness API.

Updated 5 months ago by Archana Singh

Use Workflows API

Show queries that your applications can execute against the Harness Workflows API.

Updated 5 months ago by Archana Singh

Use Infrastructure Definition API

Query the Harness Infrastructure Definition API.

Updated 5 months ago by Archana Singh

Use Pipelines API

Lists sample queries on how to use Pipeline APIs.

Updated 6 days ago by Archana Singh

Use Approvals API

Query and approve pending Approval steps and stages using Harness approvalDetails GraphQL API.

Updated 2 months ago by Michael Cretzman

Resume Pipeline Executions using API

You can use the resumeExecution API to resume Pipeline deployment executions that meet the following criteria: Failed. Aborted. Expired. Rejected. You cannot resume Successful or Paused executions. T…

Updated 5 months ago by Michael Cretzman

Use Trigger APIs

This topic provides information on how to create, read, update, and delete Triggers using the Harness API.

Updated 3 months ago by Archana Singh

Fetch Artifact Type Details Using GraphQL APIs

Describes how to fetch details of Artifact Type using GraphQL APIs.

Updated 5 months ago by Archana Singh

Fetch Deployment Artifact Information using GraphQL APIs

This topic explains how to fetch artifact information when deployments are successes, failures, or still running. You can use the WorkflowExecution API to obtain details on all of the artifacts in th…

Updated 5 months ago by Michael Cretzman

Sync and Clean Up Artifact Stream using the Harness API

Harness provides a the artifactCleanup() mutation to sync the artifact versions collected by Harness with the artifact source you set up in your Harness Service.

Updated 1 month ago by Archana Singh

Use Users and Groups API

Provides examples of how to create Harness users and user groups, and how to assign permissions to the users and User Groups, using API calls.

Updated 5 months ago by Archana Singh

Use Audit Trails API

Lists common audit trail queries.

Updated 5 months ago by Archana Singh

Use API to Retrieve IDs by Name

Describes how to use API to retrieve IDs by name.

Updated 5 months ago by Archana Singh

Encrypted Text API

Sample GraphQL queries for CRUD operations to create, read, update, and delete Harness secrets that rely on encrypted text.

Updated 2 months ago by Michael Katz

Encrypted Files API

Sample GraphQL queries to read and delete Harness secrets that rely on encrypted files.

Updated 2 months ago by Michael Katz

SSH Credentials API

Sample queries for CRUD operations to create, read, update, and delete Harness secrets that manage SSH keys.

Updated 5 months ago by Michael Katz

WinRM Credentials API

Sample queries for CRUD operations to create, read, update, and delete Harness Secrets that manage WinRM credentials.

Updated 5 months ago by Michael Katz

Add Git Connectors Using API

Describes how to add Git connectors using Harness GraphQL APIs.

Updated 5 months ago by Archana Singh

Add a Docker Artifact Source Using API

Describes how to add a Docker Artifact Source using Harness GraphQL API.

Updated 5 months ago by Archana Singh

Add a Nexus Artifact Source Using API

Describes how to create, read, update, and delete Nexus Artifact Source using Harness GraphQL APIs.

Updated 5 months ago by Archana Singh

Add a Helm Artifact Source Using the API

Describes how to create, read, update, and delete Helm Artifact Source using Harness GraphQL APIs.

Updated 3 months ago by Archana Singh

Fetch Users By Email Address

You can fetch a user by email address using the Harness API, including users that have not accepted invites. In this topic: Before You Begin. Step 1: Fetch Users by Email Address. Limitations. See Al…

Updated 5 months ago by Michael Cretzman

Use HashiCorp Vault Secrets Manager API

This topic describes how to create, read, update, and delete HashiCorp Vault Secrets Manager using Harness API.

Updated 5 months ago by Archana Singh

Deprecated API Features

Contains a list of currently-deprecated API features with their replacements.

Updated 5 months ago by Archana Singh

Leverage Harness GraphQL APIs in Automation Scripts

Describes how to leverage on Harness GraphQL APIs to query information around Harness deployment.

Updated 5 months ago by Archana Singh

Harness StartExecution API Deep Dive

This topic describes how to start executions using the StartExecution Harness API. You can start a Workflow and a Pipeline using APIs. For more information, see Trigger Workflows or Pipelines Using G…

Updated 5 months ago by Archana Singh

Use Tags API

Provides details on how to get details of resources that are associated with tags and their value using APIs.

Updated 5 months ago by Rashmi Nanda Sahoo

Deploy Helm Charts Using the API

Deploy the Helm chart without adding your artifact to Harness using the Harness API.

Updated 2 months ago by Archana Singh

Use Custom Secrets Manager API

This topic describes how to create, read, update, and delete Custom Secrets Manager using Harness API.

Updated 1 month ago by Rashmi Nanda Sahoo

Publish Pipeline Events to an HTTP Endpoint using the API

To help you analyze how Pipelines are performing, Harness can send key Pipeline deployment events to a URL endpoint as a JSON payload. Next, you can use other tools to consume and build dashboards for the events.

Updated 2 months ago by Michael Cretzman

Manage API Keys using the Harness API

This topic describes how to create an API Key using Harness API.

Updated 6 days ago by Rashmi Nanda Sahoo

Use Metrics Collection API for Custom Dashboards

This topic describes how to collect metrics for Custom Dashboards.

Updated 3 weeks ago by Rashmi Nanda Sahoo

Use Deployment Freeze API

This topic explains how to freeze Harness deployments using API.

Updated 3 weeks ago by Rashmi Nanda Sahoo