Introduction to Harness GraphQL API
Query Harness' public GraphQL API using Harness API Explorer, Postman, or your custom applications.
Start Here
Harness Key Concepts
Harness Products and Editions
Get Started with Continuous Efficiency
Harness On-Premise Overview
Built-in App Tour Guide
AWS AMI Quickstart
AWS CodeDeploy Quickstart
AWS ECS Quickstart
AWS Lambda Quickstart
Helm Quickstart
IIS (.NET) Quickstart
Kubernetes Quickstart
Pivotal Cloud Foundry Quickstart
Traditional (SSH) Quickstart
Tour Harness Manager
Supported Platforms and Technologies
Checklist Builder
How-to Guides
Account Setup
1 - Manage Harness Delegates
Harness Delegate Overview
Delegate Requirements and Limitations
Delegate Installation Overview
Install the Harness Shell Script Delegate
Install the Harness Kubernetes Delegate
Install the Harness ECS Delegate
Install the Harness Helm v2 Delegate
Install the Harness Docker Delegate
Approve or Reject Harness Delegates
Run Scripts on Delegates using Profiles
Use Secrets in a Delegate Profile
Delegate Task Category Mapping
Select Delegates with Selectors
Scope Delegates to Harness Components and Commands
Install the AWS CLI on a Delegate
Target Delegates to Specific Namespaces
Automate Harness Kubernetes Delegate Setup
Use Custom Helm Binaries on Harness Delegates
Add Self-Signed Certificates for Delegate Connections
Configure Delegate Proxy Settings
2 - Manage Harness Connectors
Connectors Overview
Add Cloud Providers
Add Cloud Providers
Add Kubernetes Cluster Cloud Provider
Add Google Cloud Platform Cloud Provider
Add Amazon Web Services Cloud Provider
Add Microsoft Azure Cloud Provider
Add Pivotal Cloud Foundry (PCF) Cloud Provider
Add Physical Data Center as Cloud Provider
Add SpotInst Cloud Provider
Add Artifact Servers
Add Artifact Servers
Add Docker Registry Artifact Servers
Add Helm Repository Artifact Servers
Add AWS S3 and Google Cloud Storage Artifact Servers
Add Azure DevOps Artifact Servers
Add Jenkins Artifact Servers
Add Bamboo Artifact Servers
Add Nexus Artifact Servers
Add Artifactory Servers
Add Samba Server Artifact Servers
Add SFTP Artifact Servers
Add Source Repo Providers
Add Source Repo Providers
Add a GitHub Repo
Add a Bitbucket Repo
Add a GitLab Repo
Add a CodeCommit Repo
Add Collaboration Providers
Add Collaboration Providers
Add SMTP Collaboration Provider
Add Jira Collaboration Provider
Add ServiceNow Collaboration Provider
Add Verification Providers
3 - Manage Notifications
Manage User Notifications
Send Notifications Using Slack
Send Slack Messages from Workflows
Send Notifications to Microsoft Teams
Manage Alert Notifications
Harness Editions
Manage App Stacks
Manage Template Libraries
Create an HTTP Workflow Step Template
Create a Shell Script Workflow Step Template
Create a Service Command Template
Add Service Command Templates into Command Units
Link Templates to Services and Workflows
Manage Tags
Continuous Deployments
Deployments Overview
Deployments Overview
Filtering Deployments
View the Delegates Used in a Deployment
Export Deployment Logs
Restrict Deployment Access to Specific Environments
Deploy a Workflow to Multiple Infrastructures Simultaneously
Resume Pipeline Deployments
AWS AMI Deployments
AMI/ASG Deployments How-tos
AMI Basic Deployment
Create an AMI/ASG Canary Deployment
AMI Blue/Green Deployment
AMI Spotinst Elastigroup Deployment
Configure Spotinst Traffic Shift Verification
AWS ECS Deployments
ECS Deployments Overview
1 - Harness ECS Delegate
2 - ECS Connectors and Providers Setup
3 - ECS Services
4 - ECS Environments
5 - ECS Workflows
6 - ECS Blue/Green Workflows
7 - ECS Setup in YAML
8 - ECS Troubleshooting
Deploy Multiple ECS Sidecar Containers
Run an ECS Task
Use Remote ECS Task and Service Definitions in Git Repos
AWS CloudFormation
CloudFormation How-tos
Set Up Your Harness Account for CloudFormation
Add CloudFormation Templates
Map CloudFormation Infrastructure
Provision using CloudFormation Create Stack
Using CloudFormation Outputs in Workflow Steps
Remove Provisioned Infra with CloudFormation Delete Stack
AWS Lambda Deployments
AWS Lambda How-tos
AWS Lambda Deployment Overview
Connect to AWS for Lambda Deployments
Add Lambda Functions
Define Your Lambda Target Infrastructure
Create a Basic Lambda Deployment
View Lambda Deployments in the Serverless Functions Dashboard
Azure Deployments
Azure Virtual Machine Scale Sets (VMSS)
Azure Virtual Machine Scale Set Deployments Overview
Connect to Azure for VMSS Deployments
Add Your Azure VM Image for Deployment
Define Your Azure VMSS Target Infrastructure
Create an Azure VMSS Basic Deployment
Create an Azure VMSS Canary Deployment
Create an Azure VMSS Blue/Green Deployment
Azure VMSS Versioning and Naming
Azure ACR to AKS
CI/CD: Artifact Build and Deploy Pipelines
Build and Deploy Pipeline How-tos
Connect to Your Artifact Build and Deploy Pipeline Platforms
Add Your Build and Deploy Pipeline Artifacts
Create the Build Workflow for Build and Deploy Pipelines
Define Your Build and Deploy Pipeline Target Infrastructure
Create the Deploy Workflow for Build and Deploy Pipelines
Create the Build and Deploy Pipeline
Google Cloud
Native Helm Deployments
Helm Native Deployment Guide Overview
1 - Delegate, Providers, and Helm Setup
2 - Helm Services
3 - Helm Environments
4 - Helm Workflows and Deployments
5 - Helm Troubleshooting
Upgrade Native Helm 2 Deployments to Helm 3
IIS (.NET) Deployments
IIS (.NET) Deployment Overview
1 - Delegate and Connectors for IIS
2 - Services for IIS
3 - IIS Environments in AWS and Azure
4 - IIS Workflows and Pipelines
5 - Best Practices and Troubleshooting
Kubernetes Deployments
Kubernetes How-tos
Connect to Your Target Kubernetes Platform
Add Container Images for Kubernetes Deployments
Pull an Image from a Private Registry for Kubernetes
Define Kubernetes Manifests
Use Go Templating in Kubernetes Manifests
Adding and Editing Inline Kubernetes Manifest Files
Upload Kubernetes Resource Files
Use a Helm Repository with Kubernetes
Link Resource Files or Helm Charts in Git Repos
Using Harness Config Variables in Manifests
Use Harness Config Files in Manifests
Override Values YAML Files
Override Harness Kubernetes Service Settings
Override Variables at the Infrastructure Definition Level
Define Your Kubernetes Target Infrastructure
Provision Kubernetes Infrastructures
Create a Kubernetes Canary Deployment
Create a Kubernetes Rolling Deployment
Create a Kubernetes Blue/Green Deployment
Kubernetes Workflow Variables and Expressions
Create Kubernetes Namespaces based on InfraMapping
Create Kubernetes Namespaces with Workflow Variables
Set Up Kubernetes Traffic Splitting
Traffic Splitting Without Istio
Deploy Manifests Separately using Apply Step
Use Kustomize for Kubernetes Deployments
Ignore a Manifest File During Deployment
Set up Kubernetes Ingress Rules
Scale Kubernetes Pods
Delete Kubernetes Resources
Upgrade to Helm 3 Charts in Kubernetes Services
Using OpenShift with Harness Kubernetes
Harness Kubernetes V2 Changes
Deploy Kubernetes Custom Resources using CRDs
Use Helm Chart Hooks in Kubernetes Deployments
Run Kubernetes Jobs
Deploy Helm Charts
Pivotal Deployments
Pivotal Cloud Foundry Deployments
Connect to Your Target PCF Account
Add Container Images for PCF Deployments
Adding and Editing Inline PCF Manifest Files
Upload Local and Remote PCF Resource Files
Using Harness Config Variables in PCF Manifests
Define Your PCF Target Infrastructure
Override PCF Manifests and Config Variables and Files
Create a Basic PCF Deployment
Create a Canary PCF Deployment
Create a Blue/Green PCF Deployment
Run CF CLI Commands and Scripts in a Workflow
PCF Built-in Variables
Use CLI Plugins in Harness PCF Deployments
Use the App Autoscaler Service
Preprocess PCF Artifacts to Match Supported Types
Terraform
Terraform How-tos
Set Up Your Harness Account for Terraform
Add Terraform Scripts
Map Terraform Infrastructure
Provision using the Terraform Provision Step
Using the Terraform Apply Command
Perform a Terraform Dry Run
Remove Provisioned Infra with Terraform Destroy
Use Terraform Outputs in Workflow Steps
Traditional Deployments (SSH)
Traditional (SSH) Deployments How-tos
Connect to Your Repos and Target SSH Platforms
Add Artifacts and App Stacks for Traditional (SSH) Deployments
Add Scripts for Traditional (SSH) Deployments
Define Your Traditional (SSH) Target Infrastructure
Create a Basic Workflow for Traditional (SSH) Deployments
Custom Deployments
Model Your CD Pipeline
Add Applications
Add Services
Add Specs and Artifacts using a Harness Service
Use Script Based Services
Add Service Config Variables
Add Service Config Files
Using Custom Artifact Sources
Service Types and Artifact Sources
Add a Docker Image
Add an Azure DevOps Artifact Source
Add Environments
Add an Environment
Add an Infrastructure Definition
Migrating from Service Infrastructures to Infrastructure Definitions
Service Infrastructures (Note: Replaced Functionality)
Override a Service Configuration in an Environment
Create Environment-level Variables and Files for All Services
Add Workflows
Workflows
Add a Workflow
Deploy Individual Workflows
Verify Workflow
Add a Workflow Notification Strategy
Define Workflow Failure Strategy
Set Workflow Variables
Use Steps for Different Workflow Tasks
Add Phases to a Workflow
Synchronize Workflow Deployments using Barriers
Templatize a Workflow
Clone a Workflow
Configure Workflows Using YAML
Using the HTTP Command
Run Shell Scripts in Workflows
Run Jenkins Jobs in Workflows
Jira Integration
ServiceNow Integration
Control Resource Usage
Workflow Queuing
Target Specific Hosts During Deployment
Skip Workflow Steps
Rollback Production Deployments
Select Nodes in a Rolling Deployment Workflow
Workflow Steps UI Changes
Integrate Tests into Harness Workflows
Deploy Multiple Services Simultaneously using Barriers
Send an Email from Your Workflow
Add Pipelines
Add Infra Provisioners
Shell Script Provisioning
Infrastructure Provisioners Overview
Provision Infrastructure Without Deploying to It
Add Triggers
Trigger Workflows and Pipelines
Trigger Deployments When a New Artifact is Added to a Repo
Trigger Deployments when Pipelines Complete
Schedule Deployments using Triggers
Trigger Deployments using Git Events
Trigger a Deployment using cURL
Get Deployment Status using REST
Trigger a Deployment when a File Changes
Trigger a Deployment using a URL
Pause All Triggers using Deployment Freeze
Add Approvals
Harness UI Approvals
Jira Approvals
Custom Shell Script Approvals
ServiceNow Approvals
Using Variables in Workflow Approvals
Use Variable Expressions
Harness GitOps
Continuous Efficiency
New to CE? Get started with a Trial
Set Up Cost Visibility
Set Up Cost Visibility for Kubernetes
Set Up Cost Visibility for Kubernetes Using an Existing Delegate
Set Up Cost Visibility for AWS
Set Up Cost Visibility for GCP
Root Cost Analysis
CE Perspectives
CE Budgets
CE Recommendations
Cost Report
Cost Explorer APIs
Continuous Verification
24/7 Service Guard
AppDynamics Verification
Add AppDynamics as a Verification Provider
Monitor Applications 24/7 with AppDynamics
Verify Deployments with AppDynamics
Templatize AppDynamics Verification
Set AppDynamics Environment Variables
Bugsnag Verification
CloudWatch Verification
Datadog Verification
Connect to Datadog
Monitor Applications 24/7 with Datadog Logging
Monitor Applications 24/7 with Datadog Metrics
Verify Deployments with Datadog Logging
Verify Deployments with Datadog Metrics
Dynatrace Verification
ELK Elasticsearch Verification
Connect to Elasticsearch (ELK)
Monitor Applications 24/7 with Elasticsearch
Verify Deployments with Elasticsearch
Troubleshoot Verification with Elasticsearch
Logz.io Verification
New Relic Verification
Connect to New Relic
Monitor Applications 24/7 with New Relic
New Relic Deployment Marker
Verify Deployments with New Relic
Troubleshooting New Relic
Prometheus Verification
Splunk Verification
Stackdriver Verification
Connect to Stackdriver
Monitor Applications 24/7 with Stackdriver Logging
Monitor Applications 24/7 with Stackdriver Metrics
Verify Deployments with Stackdriver Logging
Verify Deployments with Stackdriver Metrics
Sumo Logic Verification
Instana Verification
Custom Metrics and Logs Verification
Custom Verification Overview
Connect to Custom Verification for Custom Logs
Connect to Custom Verification for Custom Metrics
Monitor Applications 24/7 with Custom Logs
Monitor Applications 24/7 with Custom Metrics
Verify Deployments with Custom Logs
Verify Deployments with Custom Metrics
Connect to Datadog as a Custom APM
Verify Deployments with Datadog as a Custom APM
Connect to AppDynamics as a Custom APM
Verify Deployments with AppDynamics as a Custom APM
Tuning and Tracking Verification
Configuration as Code
Configuration as Code Overview
Harness Account-Level Git Sync
Harness Application-Level Git Sync
Edit Harness Components as YAML
Delink Git Sync
View Harness Git Sync Activity
Security
Access Management
Managing Users and Groups (RBAC)
Set Up RBAC for Application Release Process
Authentication Settings
SSO Provider Overview
Single Sign-On (SSO) with OAuth 2.0
Single Sign-On (SSO) with LDAP
Single Sign-On (SSO) with SAML
Provisioning Users with Okta (SCIM)
Two-Factor Authentication
IP Whitelist Management
API Keys
Provision Users and Groups with OneLogin (SCIM)
Provision Azure AD Users and Groups (SCIM)
Secrets Management
Add a Secrets Manager
View Secrets Usage
Add Google KMS as a Harness Secrets Manager
Add an AWS KMS Secrets Manager
Add a HashiCorp Vault Secrets Manager
Add an Azure Key Vault Secrets Manager
Add an AWS Secrets Manager
Add a CyberArk Secrets Manager
Use Encrypted Text Secrets
Use Encrypted File Secrets
Add SSH Keys
Use SSH Key via Kerberos for Server Authentication
Add WinRM Connection Credentials
Create WinRM Connection Using Kerberos
Scope Secret Managers to Applications and Environments
Restrict Secrets Usage
Reference Existing Secret Manager Secrets
Migrate Secrets between Secrets Managers
Add and Use a Custom Secrets Manager
Select Secrets in Scripts at Runtime
Auditing
Governance
Monitoring
Monitor Deployments in Dashboards
Custom Dashboards Overview
Primary Widgets
Custom Widgets
Filters, Groups, and Tags in Primary and Custom Widgets
Completed Custom Dashboards
Create and Manage Custom Dashboards
Add and Configure Primary Widgets
Add and Configure Custom Widgets
Share a Custom Dashboard
Harness On-Prem
Technical Reference
Harness API
Introduction to Harness GraphQL API
Harness API Explorer
API Schema and Structure
Building Applications Using Postman
Trigger Workflows or Pipelines Using GraphQL API
Filter Harness Entities using Harness Tags in the API
Fetch Artifact Source Details Using GraphQL APIs
Use Cloud Providers API
Use Harness Applications API
Use Workflows API
Use Services API
Use Pipelines API
Use Trigger APIs
Fetch Artifact Type Details Using GraphQL APIs
Use Users and Groups API
Use Audit Trails API
Use API to Retrieve IDs by Name
Encrypted Text API
Encrypted Files API
SSH Credentials API
WinRM Credentials API
Add Git Connectors Using API
Add a Docker Artifact Source Using API
Add a Nexus Artifact Source Using API
Add a Helm Artifact Source Using API
Fetch Users By Email Address
Use HashiCorp Vault Secrets Manager API
Deprecated API Features
Leverage Harness GraphQL APIs in Automation Scripts
Harness StartExecution API Deep Dive
Harness YAML
Variables and Expressions
What is a Harness Variable Expression?
Built-in Variables List
Availability and Scope of Harness Variables
Variable Override Priority
JSON and XML Functors
Extracting Characters from Harness Variable Expressions
Monitoring
Account
Continuous Deployment
Continuous Verification
Security
Troubleshoot
Concepts
Continuous Deployment
Deployment Concepts and Strategies
CI/CD with the Build Workflow
Artifact Build and Deploy Pipelines Overview
AWS AMI Deployments Overview
AMI Spotinst Elastigroup Deployments Overview
AWS ECS Deployments Overview
AWS Lambda Deployments Overview
Azure Kubernetes Service (AKS) Deployments Overview
Native Helm Deployments Overview
IIS (.NET) Deployments Overview
Kubernetes Deployments Overview
Pivotal Deployments Overview
Terraform Provisioning with Harness
CloudFormation Provisioning with Harness
Shell Script Provisioning with Harness
Account and Application Templates
Harness HashiCorp Integrations
Traditional Deployments (SSH) Overview
Triggers and RBAC
Continuous Efficiency
Continuous Verification
What Is Continuous Verification (CV)?
Why Perform Continuous Verification?
When Does Harness Verify Deployments?
How Does Harness Perform Continuous Verification?
Who Are Harness' Verification Providers?
Verification Results Overview
Harness Verification Feedback Overview
24/7 Service Guard Overview
CV Strategies, Tuning, and Best Practices
Continuous Verification Metric Types
AppDynamics Verification Overview
Bugsnag Verification Overview
CloudWatch Verification Overview
Datadog Verification Overview
Dynatrace Verification Overview
Elasticsearch Verification Overview
Instana Verification Overview
Google Operations (formerly Stackdriver) Overview
New Relic Verification Overview
Prometheus Verification Overview
Splunk Verification Overview
Sumo Logic Verification Overview
Drone and Harness
Security
FAQs
Continuous Deployment FAQs
Continuous Efficiency FAQs
Continuous Verification FAQs
Harness Security FAQs
Harness GraphQL API FAQs
Harness Delegate FAQs
Release History
Videos
All Categories > Technical Reference > Harness API
Harness API
30 articles
