Search
Introduction
How it works
Get started
Authentication
Requests and Responses
Common Parameters [Beta]
Status Codes
Versioning [Beta]
Pagination [Beta]
Organizations
Organization
post
Create an organization [Beta]
get
List organizations [Beta]
get
Retrieve an organization [Beta]
put
Update an organization [Beta]
del
Delete an organization [Beta]
get
List Organizations by filter
post
Create an Organization
get
List Organization details
put
Update an Organization
del
Delete an Organization
Projects
Project [Beta]
post
Create a project
get
List projects
get
Retrieve a project
put
Update a project
del
Delete a project
Project
get
List all Projects for a user
post
Create a Project
get
List Project details
put
Update a Project
del
Delete a Project
get
List user's project with support to filter by multiple organizations
Secrets
Account Secrets [Beta]
post
Create a secret
get
List secrets
post
Validate secret reference
get
Retrieve a secret
del
Deletes a secret
put
Update a secret
Organization Secrets [Beta]
post
Create a secret
get
List secrets
post
Validate secret reference
get
Retrieve a secret
del
Delete a secret
put
Update a secret
Project Secrets [Beta]
post
Create a secret
get
List secrets
post
Validate secret reference
get
Retrieve a secret
del
Delete a secret
put
Update a secret
Secrets
get
Fetches the list of Secrets corresponding to the request's filter criteria.
post
Creates a Secret at given Scope
post
Creates a Secret File
post
Creates a secret via YAML
get
Get the Secret by ID and Scope
put
Updates the Secret by ID and Scope
del
Deletes Secret by ID and Scope
post
Fetches the list of Secrets corresponding to the request's filter criteria.
post
Fetches the list of Secrets corresponding to the request's filter criteria.
put
Updates the Secret file by ID and Scope
put
Updates the Secret by ID and Scope via YAML
post
Validates Secret with the provided ID and Scope
get
Checks whether the identifier is unique or not
Connectors
Account Connectors [Beta]
post
Create a Connector
get
Retrieve a connector
put
Update a connector
del
Delete a connector
get
Test a connector
Organization Connectors [Beta]
post
Create a Connector
get
Retrieve a connector
put
Update a connector
del
Delete a connector
get
Test a connector
Project Connectors [Beta]
post
Create a Connector
get
Retrieve a connector
put
Update a connector
del
Delete a connector
get
Test a connector
Connectors
post
Fetches the list of CMC K8S Connectors corresponding to the request's filter criteria.
get
List all Connectors using filters
put
Update a Connector
post
Create a Connector
get
Return Connector details
del
Delete a Connector
get
List all the configured field values for the given Connector type.
post
Get the Template URL of connector
get
Lists all Connectors for an account
get
Gets the connector's statistics by Account Identifier, Project Identifier and Organization Identifier
post
Fetches the list of Connectors corresponding to the request's filter criteria.
post
Get list of Connectors by FQN
post
Test Harness Connector connection with third-party tool
post
Test Git Connector sync with repo
get
Test a Harness Connector
GoogleSecretManagerConnector
get
Get list of GCP Regions
Roles
Account Roles [Beta]
get
List Roles
post
Create a Role
get
Retrieve a Role
put
Update a Role
del
Delete a Role
Organization Roles [Beta]
get
List Roles
post
Create a Role
get
Retrieve a Role
put
Update a Role
del
Delete a Role
Project Roles [Beta]
get
List Roles
post
Create a Role
get
Retrieve a Role
put
Update a Role
del
Delete a Role
Roles
get
List Roles
post
Create Role
get
Get Role
put
Update Role
del
Delete Role
Resource Groups
Account Resource Groups [Beta]
get
List Resource Groups
post
Create a Resource Group
get
Retrieve a Resource Group
put
Update a Resource Group
del
Delete a Resource Group
Organization Resource Groups [Beta]
get
List Resource Groups
post
Create a Resource Group
get
Retrieve a Resource Group
put
Update a Resource Group
del
Delete a Resource Group
Project Resource Groups [Beta]
get
List Resource Groups
post
Create a Resource Group
get
Retrieve a Resource Group
put
Update a Resource Group
del
Delete a Resource Group
Filter Resource Groups [Beta]
post
Filter Resource Groups
Harness Resource Group
get
List Resource Groups
post
Create Resource Group
get
Get Resource Group
put
Update Resource Group
del
Delete Resource Group
post
List Resource Groups by filter
Zendesk
post
create zendesk ticket for given user
get
get short live token for Coveo
Role Assignments
Account Role Assignments [Beta]
get
List role assignments
post
Create a role assignment
get
Retrieve a role assignment
del
Delete a role assignment
Organization Role Assignments [Beta]
get
List role assignments
post
Create a role assignment
get
Retrieve a role assignment
del
Delete a role assignment
Project Role Assignments [Beta]
get
List role assignments
post
Create a role assignment
get
Retrieve a role assignment
del
Delete a role assignment
Role Assignments
post
Bulk Delete Role Assignment
post
Create Role Assignments
get
List Role Assignments
post
Create Role Assignment
get
Get Role Assignment
del
Delete Role Assignment
post
List Role Assignments by filter
post
List Aggregated Role Assignments by filter
post
List Role Assignments by scope filter
post
Validate Role Assignment
Platform
Accounts
get
Gets an account
get
Checks if immutable delegate is enabled for account
put
License update from UI
put
Update Account Name
put
Update Default Experience
AccountSetting
get
Get the AccountSetting by accountIdentifier
put
Updates account settings
get
Get the AccountSetting by accountIdentifier
Access Control List
post
Check Permission
AuditFilters
get
Get the list of Filters of type Audit satisfying the criteria (if any) in the request
put
Updates the Filter of type Audit
post
Creates a Filter
get
Gets a Filter of type Audit by identifier
del
Delete a Filter of type Audit by identifier
Audit
post
List Audit Events
EULA [Beta]
post
Sign an End User License Agreement
get
Validate specified agreement is signed or not
Filter
get
List Filters
put
Update a Filter
post
Create a Filter
get
Return Filter Details
del
Delete a Filter
get
List Filters
put
Update a Filter
post
Create a Filter
get
Return Filter Details
del
Delete a Filter
get
List Filters
put
Update a Filter
post
Create a Filter
get
Return Filter Details
del
Delete a Filter
get
List Filters
put
Update a Filter
post
Create a Filter
get
Return Filter Details
del
Delete a Filter
Invite
put
Resend invite
del
Delete Invite
get
Get Invite
get
List Invites
post
Get pending users
IP Allowlist [Beta]
post
Create a IP Allowlist config
get
List IP Allowlist Configs
get
Retrieve a IP Allowlist config
put
Update IP Allowlist config
del
Delete an IP Allowlist config
get
Validate unique IP Allowlist config identifier
get
Validate IP address lies in a specified range or not
Oidc-Access-Token
post
Generate an OIDC IAM Role Credential for AWS
post
Generates an OIDC Service Account Access Token for GCP
post
Generates an OIDC Workload Access Token for GCP
Oidc-ID-Token
post
Generates an OIDC ID Token for GCP
post
Generates an OIDC ID Token for GCP
post
Generates an OIDC ID Token for AWS
OIDC
get
Get the openid configuration for Harness
get
Get the openid configuration for Harness
Canny
post
create Canny Post for given user
post
create Canny Post for given user
get
Get a list of boards available on Canny
get
Get a list of categories available for a board in Canny
ApiKey
get
Fetches the list of API Keys corresponding to the request's filter criteria.
post
Creates an API key
put
Updates API Key for the provided ID
del
Deletes the API Key corresponding to the provided ID.
get
Fetches the API Keys details corresponding to the provided ID and Scope.
get
Fetches the list of Aggregated API Keys corresponding to the request's filter criteria.
Source Code Manager
put
Updates Source Code Manager Details with the given Source Code Manager Id
del
Deletes the Source Code Manager corresponding to the specified Source Code Manager Id
get
Lists Source Code Managers for the given account
post
Creates Source Code Manager
Nextgen Ldap
get
Get the NgLdap Setting
post
Test LDAP authentication
get
Return Ldap groups matching name
Harness Resource Type
get
Gets all resource types available at this scope
Authentication Settings
get
Return configured Ldap settings for the account
put
Updates Ldap setting
post
Create Ldap setting
del
Delete Ldap settings
del
Delete SAML meta data
del
Delete SAML meta data for given SAML sso id
put
Update authentication enabled or not for given SAML setting
get
Gets authentication settings for the given Account ID
get
Gets authentication settings version 2 for the given Account ID
get
Get password strength
get
Test SAML connectivity
get
Test SAML connectivity
del
Delete OAuth Setting
put
Enable/disable public access at account level
put
Set session timeout at account level
put
Set two factor authorization
put
Update Auth mechanism
put
Update Oauth providers
put
Update SAML metadata
post
Upload SAML metadata
put
Update SAML metadata for a given SAML SSO Id
put
Updates the whitelisted domains
Permissions
get
List Permissions
get
List Resource Types
Secret Managers
post
Gets the metadata of Secret Manager
Setting
get
Get a setting value by identifier
get
Get list of settings under the specified category
put
Update settings
Service Account
get
Get Service Accounts
post
Create a Service Account
put
Update a Service Account
del
Delete a Service Account
get
Get Service Account In Scope
get
List aggregated Service Accounts
SMTP
del
Delete Smtp Config by identifier
get
Gets Smtp config by accountId
put
Updates the Smtp Config
post
Creates SMTP config
post
Tests the config's connectivity by sending a test email
post
Checks whether other connectors exist with the same name
Token
post
Create a Token
put
Update a Token
del
Delete a Token
get
List all Tokens
post
Rotate a Token
post
Validate a Token
User
put
Add user to user groups
post
Add user(s) to scope
put
Change user password
get
Check if user is last admin
put
Disable two factor authentication
get
Get detailed user information
post
Get list of users
get
Gets Two Factor Auth Settings
get
Get Current User Info
post
Get users list
put
Update User
del
Remove user from scope
get
Reset two factor authorization
put
Unlock user
put
Enable two factor authentication
put
Update User
User Group
get
Check user membership
put
Add user to User Group
del
Remove user from User Group
put
Copy User Group
get
List the User Groups in an account/org/project
put
Update User Group
post
Create User Group
get
Get User Group
del
Delete a User Group in an account/org/project
get
Get Inheriting Child Scopes
post
List users in User Group
put
Link LDAP Group to the User Group to an account/org/project
put
Link SAML Group to the User Group in an account/org/project
post
List User Groups by filter
post
Get filtered User Groups
put
Unlink SSO Group from the User Group in an account/org/project
put
Update User Group
post
Create User Group
get
Get User Group
Variables
get
Fetches the list of Variables.
put
Updates the Variable.
post
Creates a Variable.
get
Get the Variable by scope identifiers and variable identifier.
del
Deletes Variable by ID.
post
Get list of Variable by scope identifiers and variable identifiers.
Delegate
Agent mTLS Endpoint Management
get
Gets the agent mTLS endpoint for an account.
put
Updates the existing agent mTLS endpoint for an account.
post
Creates the agent mTLS endpoint for an account.
del
Removes the agent mTLS endpoint for an account.
patch
Updates selected properties of the existing agent mTLS endpoint for an account.
get
Checks whether a given agent mTLS endpoint domain prefix is available.
Delegate Download Resource
post
Downloads a docker delegate yaml file.
post
Downloads a kubernetes delegate yaml file.
Delegate Group Tags Resource
get
Retrieves list of tags attached with Delegate group
put
Clears all existing tags with delegate group and attach given set of tags to delegate group.
post
Add given list of tags to the Delegate group
del
Deletes all tags from the Delegate group
post
List delegate groups that are having mentioned tags.
Delegate Setup Resource
del
Deletes a Delegate by its identifier.
get
Generates delegate terraform example module file from the account
post
Generates helm values yaml file from the data specified in request body (Delegate setup details).
post
Lists all delegates in NG filtered by provided conditions
get
Gets the latest supported delegate version. The version has YY.MM.XXXXX format. You can use any version lower than the returned results(upto 3 months old)
put
Overrides delegate image tag for account
Delegate Token Resource
get
Retrieves Delegate Tokens by Account, Organization, Project and status.
put
Revokes Delegate Token.
post
Creates Delegate Token.
get
Lists delegate groups that are using the specified delegate token.
Pipelines
Pipelines [Beta]
get
List Pipelines
post
Create a Pipeline
get
Retrieve a Pipeline
put
Update a Pipeline
del
Delete a Pipeline
patch
Patch API for pipeline
post
Move Pipeline YAML from inline to remote
post
Get Pipeline YAML from Git Repository
put
Update GitMetadata for Remote Pipelines
Input Sets [Beta]
post
Create an Input Set
get
List Input Sets
get
Retrieve an Input Set
put
Update an Input Set
del
Delete an Input Set
post
Move InputSet YAML from inline to remote
post
Get Input Set YAML from Git Repository
put
Update GitMetadata for Remote InputSet
Approvals
get
Gets Approval Instances by Execution Id
post
Approve or Reject an Execution by Pipeline Execution ID
post
Approve or Reject a Pipeline Execution
Pipeline Execution [Beta]
post
Execute Pipeline
get
Get Stages execution List for a given Pipeline execution.
post
Re-run Stages Execution of a Pipeline
post
Execute given Stages of a Pipeline
Pipeline Dashboard
get
Fetch Execution Details for an Interval
Pipeline Input Set
get
List Input Sets
post
Create an Input Set
post
Create an Overlay Input Set for a pipeline
get
Fetch an Input Set
put
Update an Input Set
del
Delete an Input Set
get
Gets an Overlay Input Set by identifier
put
Update an Overlay Input Set for a pipeline
post
Fetch Runtime Input Template
put
Update git-metadata in remote input-set
Pipeline
get
Download file from GCS using filePath
get
Returns a file uploaded or filtered based on the fileIdentifier provided for a given nodeExecutionId
post
Create a Pipeline
post
Create a Pipeline
get
Fetch a Pipeline
put
Update a Pipeline
del
Delete a Pipeline
post
List Pipelines
get
Fetch Pipeline Summary
post
Import and Create Pipeline from Git Repository
post
Import and Create Pipeline from Git Repository
put
Update git-metadata in remote pipeline Entity
put
Update a Pipeline
Pipeline Execution Details
get
Fetch Execution Details
get
Fetch Execution Details
get
Fetch Execution SubGraph for a Given Retried StepGroup NodeExecution ID
post
Fetch Execution Url
get
Get the Input Set YAML used for given Plan Execution
post
List Execution Identifier
post
List Executions
post
List Executions Outline
get
Get Notes for a pipelineExecution
put
Updates Notes for a pipelineExecution
Pipeline Execute
get
Retry History for a given execution
put
Execute an Interrupt
put
Handles the interrupt for a given stage in a pipeline
post
Retry a executed pipeline with inputSet pipeline yaml
post
Execute a Pipeline with Input Set References
post
Execute a Pipeline with Runtime Input YAML
post
Execute given Stages of a Pipeline
Pipeline Refresh
post
This recursively refresh and update template inputs in pipeline
get
Validates template inputs in a pipeline's YAML specification.
Pipeline data retention
get
Get retention period for pipeline executions
Triggers [Beta]
get
Gets the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier.
post
Creates Trigger for triggering target pipeline identifier.
get
Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier.
put
Updates trigger for pipeline with target pipeline identifier.
del
Deletes Trigger by identifier.
get
Lists all Triggers
get
Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier.
get
Get event history for a trigger
TriggersEvents
get
Get all the polled response for a given trigger
get
Get event history for a trigger
get
Get event history for a trigger using filters.
get
Get Trigger history event correlation
get
Get Trigger history event correlation V2
get
Get artifact and manifest trigger event history based on build source type
Webhook Triggers
get
Gets webhook event processing details for input eventId.
get
Gets webhook event processing details for input eventId.
get
Gets webhook event processing details for input eventId when the trigger is queued and has not triggered the pipeline yet.
post
Handles event payload for webhook triggers.
post
Handles event payload for custom webhook triggers.
post
Handles event payload for custom webhook triggers.
post
Handles event payload for custom webhook triggers.
Webhook Event Handler
post
Process event payload for webhook triggers.
Artifact Registry [Beta]
Registries
post
Create Registry.
del
Delete a Registry
get
Returns Registry Details
put
Updates a Registry
get
List Artifacts for Registry
get
Returns CLI Client Setup Details
Artifacts
get
Redirect to Harness Artifact Page
del
Delete Artifact
put
Update Artifact Labels
get
Get Artifact Stats
get
Get Artifact Summary
del
Delete an Artifact Version
get
Describe Artifact Deployments
get
Get Artifact Version Summary
get
List Artifact Versions
get
List Artifact Labels
get
Get Artifact Stats
get
Get Artifact Stats
Docker Artifacts
get
Describe Docker Artifact Detail
get
Describe Docker Artifact Integration Detail
get
Describe Docker Artifact Layers
get
Describe Docker Artifact Manifest
get
Describe Docker Artifact Manifests
Helm Artifacts
get
Describe Helm Artifact Detail
get
Describe Helm Artifact Manifest
Spaces
get
List Harness Artifacts
get
List Registries
CD
K8s Release Service Mapping [Beta]
get
List service and environment details using namespace and releasename
CustomDeployment
post
Gets Custom Deployment Entity References
post
Gets Custom Deployment Expression Variables
get
Gets Infra Variables from a Custom Deployment Template by identifier
post
Return the updated yaml for infrastructure based on Deployment template
get
This validates whether Infrastructure is valid or not
Environments
get
Gets Environment list for a project
put
Update an Environment by identifier
post
Create an Environment
get
Gets an Environment by identifier
del
Delete an Environment by identifier
get
Gets Service Overrides list
post
upsert a Service Override for an Environment
del
Delete a ServiceOverride entity
post
Import and Create Environment from Git Repository
get
Gets Environment Access list
post
Move environment YAML from inline to remote
put
Update git-metadata in remote environment Entity
put
Upsert an Environment by identifier
EnvironmentGroup
post
Create an Environment Group
get
Gets an Environment Group by identifier
put
Update an Environment Group by Identifier
del
Delete en Environment Group by Identifier
post
Gets Environment Group list
Infrastructures
get
Gets Infrastructure list
put
Update an Infrastructure by identifier
post
Create an Infrastructure in an Environment
get
Gets an Infrastructure by identifier
del
Delete an Infrastructure by identifier
post
Import and Create Infrastructure from Git Repository
post
Move infra YAML from inline to remote
put
Update git-metadata in remote infrastructure Entity
Usage
get
Download CD Usage CSV report
get
Download CSV Active Services report
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Download CSV Active Services report
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Gets License Usage By Module, Timestamp, and Account Identifier
get
Download CSV Active Monitored Services report
get
Download CSV Active Services Monitored report
get
CvgetLicenseUsage
get
getSRMLicenseUsage
post
Returns a List of active monitored services along with identifier,Active Monitored Services Count and other details
File Store
get
List Files and Folders metadata
post
Create Folder or File including content
post
Creates File or Folder metadata via YAML
get
Get the Folder or File metadata
put
Update Folder or File including content
del
Delete File or Folder by identifier
get
Download File
get
Get list of created by user details
get
Get file content of scopedFilePath
post
Get file content of scopedFilePathV2
get
Get list of entities where file is referenced by queried entity type
get
Get the list of supported entity types for files
post
Get filtered list of Files or Folders
post
Get folder nodes at first level, not including sub-nodes
put
Update File or Folder metadata via YAML
Service Dashboard
get
Get pipeline execution count for a service with grouping support on artifact and deployment status
ServiceOverrides
put
Update an ServiceOverride Entity
post
Create an ServiceOverride Entity
get
Gets Service Overrides by Identifier
del
Delete a ServiceOverride entity
post
Move ServiceOverride YAML from inline to remote or remote to inline
put
Update git-metadata in remote ServiceOverride Entity
Rollback
post
Verification for rollback eligibility for service
post
Trigger the rollback for specific service
tas
get
Return the Tas organizations
get
Return the Tas spaces
get
Return the Tas spaces
Deployment Freeze
Freeze CRUD
post
Create a Freeze
get
Get a Freeze
put
Updates a Freeze
del
Delete a Freeze
post
Delete many Freezes
post
Gets Freeze list
get
Get list of freeze acted on a frozen execution
get
Get Global Freeze Yaml
post
Create Global Freeze
post
Update the status of Freeze to active or inactive
Freeze Evaluation
Freeze Schema
Services
Account Services [Beta]
get
Retrieve a service
put
Update service
del
Delete a service
get
List services
post
Create a service
Organization Services [Beta]
get
Retrieve a service
put
Update Service
del
Delete a service
get
List Services
post
Create a service
Project Services [Beta]
get
Retrieve a service
put
Update Service
del
Delete a Service
get
List Services
post
Create a Service
Services
get
Gets Service list
put
Update a Service by identifier
post
Create a Service
post
Create Services
get
Gets a Service by identifier
del
Delete a Service by identifier
get
Retrieving the list of Kubernetes Command Options
get
Retrieving the list of Kustomize Command Flags
get
Retrieving the list of actions available for service hooks
post
Get Service YAML from Git Repository
get
Gets Service Access list
post
Move Service YAML from inline to remote
put
Update git-metadata in remote service Entity
put
Upsert a Service by identifier
Rancher Infrastructures
Account Rancher Infrastructure [Beta]
get
List rancher clusters using account level connector
get
List rancher clusters using account level env and infra def
Org Rancher Infrastructure [Beta]
get
List rancher clusters using org level connector
get
List rancher clusters using org level env and infra def
Project Rancher Infrastructure [Beta]
get
List rancher clusters using project level connector
get
List rancher clusters using project level env and infra def
Templates
Account Templates [Beta]
post
Create Template
get
Get Templates List
put
Update Git details
get
Get Stable Template
get
Retrieve a Template
put
Update Template
del
Delete Template
put
Update Stable Template
post
Import Template
Organization Templates [Beta]
put
Update Git details
post
Create Template
get
Get Templates List
get
Get Stable Template
get
Retrieve a Template
put
Update Template
del
Delete Template
put
Update Stable Template
post
Import template
Project Templates [Beta]
put
Update Git details
post
Create Template
get
Get Templates List
get
Get Stable Template
get
Retrieve a Template
put
Update Template
del
Delete Template
put
Update Stable Template
post
Import Template
Templates
post
Get YAML with updated Template Inputs
get
Validate Template Inputs in a YAML
post
Create a Template
del
Delete Template Version
get
Get Template
get
Gets Template Input Set YAML
post
Gets all metadata of template list
post
Move Template YAML from inline to remote
put
Update Template Version
post
Update git metadata details for a remote template
put
Update Stable Template Version
Global Templates
GitOps
Agents
get
AgentServiceForServer_List
post
AgentServiceForServer_Create
post
AgentServiceForServer_Search
put
AgentServiceForServer_Update
get
AgentServiceForServer_GetDeployYaml
post
AgentServiceForServer_PostDeployHelmChart
post
AgentServiceForServer_PostDeployYaml
get
AgentServiceForServer_GetDeployHelmChart
get
AgentServiceForServer_GetDeployOverrides
post
AgentServiceForServer_PostDeployOverrides
patch
AgentServiceForServer_SetPrimaryNode
get
AgentServiceForServer_Get
del
AgentServiceForServer_Delete
post
AgentServiceForServer_RegenerateCredentials
post
AgentServiceForServer_Scale
get
AgentServiceForServer_Unique
get
VersionUpgradeService_UpgradeAvailableV2
Application
post
List applications
Applications
get
List applications for a specific agent
post
Create an application
get
Get parent application
get
Get ManagedResources
get
Get resource tree
get
Get application
get
List resource events
get
PodLogs returns stream of log entries for the specified pod(s).
get
Get application manifest
get
PodLogs returns stream of log entries for the specified pod(s).
get
Get revision metadata
get
Get sync windows of the application
put
Update an application
del
Delete an application
patch
Patch an application
del
Terminate operation
get
Get an application resource
del
Delete resource
post
Patch an application resource
get
List resource actions
post
Run resource action
post
Rollback syncs an application to its target state
put
Update application spec
post
Sync an application
get
Watch returns stream of application change events
get
WatchResourceTree returns stream of application resource tree
get
List attributes for applications
get
Check if multisource feature is enabled
post
List namespaces for a specific query
get
List ApplicationSets
post
List application sync status
get
Check if an application exists
Certificates
get
List certificates
Clusters
get
Get a Cluster linked to an environment by identifier
del
Unlink a cluster by identifier
get
Gets cluster list
post
Link a Cluster
post
Link Clusters
post
Unlink Clusters
get
Get a cluster managed by an agent by name
get
Get a cluster managed by an agent by URL
get
List returns list of clusters
post
Create creates a cluster
get
Get returns a cluster by identifier
del
Delete deletes a cluster
put
Update updates a cluster
get
List all available repository certificates
post
CreateHosted creates a harness hosted cluster
post
List clusters
get
Check if a cluster exists
Dashboard Aggregates
post
Get recent deployment statistics
get
List top 5 most deployed apps
Dashboards
get
Get recently created app, cluster, repo counts
get
Get dashboard overview
GnuPGP Keys
post
Create one or more GPG public keys in the server's configuration
get
Get information about specified GPG public key from the server
del
Delete specified GPG public key from the server's configuration
GPG Keys
get
List all GPG keys
Hosts
post
Gets the list of hosts filtered by accountIdentifier and connectorIdentifier
post
Validates hosts connectivity credentials
Project mappings
get
Get Harness-Argo project mapping by agent
post
Create Harness-Argo project mapping
del
Delete Harness-Arog project mapping
get
Get Harness-Argo project mappings
post
Create Harness-Argo project mapping V2
get
Get Harness-Argo project mapping V2
del
Delete Harness-Argo project mapping
put
Update Harness-Argo project mappings V2
get
Get Harness-Argo project mapping list by agent V2
Projects
get
List returns list of Argo projects
post
Create a new Argo project
get
Get returns an Argo project by name
del
Delete deletes an Argo project
put
Update updates an Argo project
Reconciler
post
Collect entity counts on cluster via agent
post
Import data from cluster via agent
Repositories
get
ListRepositories gets a list of all configured repositories
post
CreateRepository creates a new repository configuration
get
Checks whether External Secrets Operator is installed
get
Returns a list of ESO generators installed in agent namespace.
post
Returns the Repository type of OCI repo
post
ValidateAccess gets connection state for a repository
get
Get returns a repository or its credentials
del
DeleteRepository deletes a repository from the configuration
put
UpdateRepository updates a repository configuration
get
GetAppDetails returns application details by given path
get
ListApps returns list of apps in the repo
get
GetHelmCharts returns list of helm charts in the specified repository
get
Returns a list of refs (e.g. branches and tags) in the repo
get
GetAppDetailsByUrl returns application details by given path for repositories by URL
get
ListAppsByUrl returns list of apps in the repo
get
GetHelmChartsByUrl returns list of helm charts in the repository by URL
get
Returns a list of refs (e.g. branches and tags) in the repo by URL
get
Get a repository configured in gitops by URL from Harness
get
List Repositories by repository credential template
post
List repositories
get
Check if a repository exists
Repository Certificates
get
List all available repository certificates
del
Delete the certificates that match the RepositoryCertificateQuery
post
Creates repository certificates on the server
Repository credentials
post
Create a new repository credential
post
Get credentials for repository url
get
Get repository credential by identifier
del
Delete a repository credential
put
Update a repository credential
post
List repository credentials
ValidateHost
post
Validates hosts connectivity credentials
GitX
Account GitX Webhooks
post
Create a GitX webhook at Account level
get
Lists all the GitX Webhooks at Account level
get
Fetch GitX Webhook at Account level
put
Updates a GitX Webhook at Account level
del
Deletes a GitX Webhook at Account level
Org Gitx Webhooks
get
Lists all the GitX Webhooks at Org level
post
Create Org Level GitX webhook
get
Fetch GitX Webhook at org level
put
Updates a GitX Webhook at org level
del
Deletes a GitX Webhook at org level
Project Gitx Webhooks
get
Lists all the GitX Webhooks at project level
post
Create Project level GitX webhook
get
Fetch GitX Webhook at project level
put
Updates a GitX Webhook at project level
del
Deletes a GitX Webhook at project level
CCM
Cloud Cost Anomalies
post
List Anomalies
post
Returns the list of distinct values for all the specified Anomaly fields.
post
List Anomalies
post
List ignore list anomalies
post
List Anomalies for Perspective
put
Report Anomaly feedback
Cloud Cost BI Dashboards
get
List all the BI Dashboards for CCM
Cloud Cost Budget Groups
get
Fetch Budget group details
put
Update an existing budget group
del
Delete a budget group
post
Get aggregated amount for given budget groups/budgets
get
Get list of budget and budget group summaries
get
List all the Budget groups
post
Create a Budget Group
Cloud Cost Budgets
get
Fetch Budget details
put
Update an existing budget
post
Clone a budget
del
Delete a budget
get
Fetch the cost details of a Budget
get
List all the Budgets associated with a Perspective
get
List all the Budgets
post
Create a Budget
Cloud Cost K8S Connectors Metadata
post
Get CCM K8S Metadata
Cloud Cost Details
post
Returns an overview of the cost
post
Returns cluster data in a tabular format
post
Returns cost details in a tabular format
post
Returns cost details in a time series format
Cloud Cost Overview
get
Fetch high level overview details about CCM feature.
Cloud Cost Cost Categories
get
Fetch details of a Cost category
del
Delete a Cost category
get
Return details of all the Cost categories
put
Update a Cost category
post
Create Cost category
RuleEnforcement
put
Update a Rule enforcement
post
Add a new rule Enforcement
del
Delete a rule enforcement
post
Fetch Rule Enforcements for given RuleIds/RuleSetIds
get
Get Rule Enforcement details for given Enforcement Id
get
Fetch Rule Enforcements for account
put
Enable/Disable a Rule Enforcement for given Enforcement Id
Rule
post
Clone a rule
put
Update a Rule
post
Add a rule
del
Delete a rule
post
Enqueues job for execution
post
Simple Request to enqueue rule for execution
get
List resources for which cost co-relation is supported.
get
Custodian Schema
post
Fetch rules for account
get
Governance Targets
get
List of Regions for Aws/Azure
put
Enable/Disable a custom Rule to be considered for recommendation
post
Validate Governance Rule
Rule Executions
post
Fetch RuleExecution for account
get
Rule Execution Filter Values
get
Return actioned resources for a rule execution
get
Resources/logs for a rule execution
get
Return logs for a rule execution
get
Return resources for a rule execution
post
Find last execution given rules list
get
Governance recommendation details
get
Refresh cost for a rule execution
Rule Sets
put
Update a Rule set
post
Add a rule Set
del
Delete a rule set
post
Fetch rule sets for account
Governance Overview
post
Return day wise total evaluations grouped by evaluation status.
get
Return total number of active enforcements.
get
Return total number of evaluations.
post
Return total realised Savings.
get
Return total realised Savings grouped by cloud provider/resource type.
Cloud Cost Perspectives Folders
post
Create a Perspective folder
del
Delete a folder
get
Fetch folders for an account
put
Update a folder
get
Return details of all the Perspectives
post
Move a Perspective
Cloud Cost Perspective Reports
get
Fetch details of a cost Report
put
Update a cost Perspective Report
post
Create a schedule for a Report
del
Delete cost Perspective report
Cloud Cost Perspectives
get
Fetch details of a Perspective
put
Update a Perspective
post
Create a Perspective
del
Delete a Perspective
get
Return details of all the Perspectives
get
Get the last period cost for a Perspective
get
Get the last twelve month cost for a Perspective
Cloud Cost Recommendations Details
get
Return Azure VM Recommendation
get
Return EC2 Recommendation
get
Return ECS Recommendation
get
Return node pool Recommendation
get
Return workload Recommendation
Cloud Cost Recommendations
post
Return void
post
Return the number of Recommendations
post
Return the list of filter values for the Recommendations
post
Return the list of Recommendations
post
Return Recommendations statistics Grouped on Resource Type
post
Return Recommendations statistics
Cloud Cost Recommendation Jira
post
Create jira for recommendation
Cloud Cost Recommendation Servicenow
post
Create servicenow ticket for recommendation
Cloud Cost Recommendation Ignore List
post
Add resources to recommendations ignore list
get
Get resources in recommendations ignore list
post
Remove resources from recommendations ignore list
Cloud Cost AutoStopping Rules
get
List AutoStopping Rules
post
Create an AutoStopping Rule
get
Return AutoStopping Rule details
del
Delete an AutoStopping Rule
get
Return health status of an AutoStopping Rule
get
Return savings details for an AutoStopping Rule
get
List all the resources for an AutoStopping Rule
get
Return diagnostics result of an AutoStopping Rule
post
Warm up an AutoStopping Rule
post
Cool down an AutoStopping Rule
get
Return metadata of cool down of an AutoStopping Rule
get
Return cumulative savings for all the AutoStopping Rules
put
Disable/Enable an Autostopping Rule
Cloud Cost AutoStopping Rules V2
post
Create an AutoStopping Rule
put
Update an existing AutoStopping Rule
Cloud Cost AutoStopping Load Balancers
get
Return all the load balancers
put
Update a load balancer
post
Create a load balancer
del
Delete load balancers and the associated resources
get
Return details of a load balancer
get
Return all the AutoStopping Rules in a load balancer
get
Return last activity details of a load balancer
Cloud Cost AutoStopping Fixed Schedules
get
Return all the AutoStopping Rule fixed schedules
post
Create a fixed schedule for an AutoStopping Rule
del
Delete a fixed schedule for AutoStopping Rule.
Commitment Orchestrator Events APIs
post
List event logs
Feature Flags
API Keys
get
Returns API Keys for an Environment
post
Creates an API key for the given Environment
del
Deletes an API Key
get
Returns API keys
put
Updates an API Key
Feature Flags
get
Returns all Feature Flags for the project
post
Creates a Feature Flag
del
Delete a Feature Flag
get
Returns a Feature Flag
patch
Updates a Feature Flag
put
Updates a Feature Flag
get
Return a list of dependant flags
post
Restore a Feature Flag
Targets
get
Returns all Targets
post
Creates a Target
post
Add Target details
del
Deletes a Target
get
Returns details of a Target
patch
Updates a Target
put
Modifies a Target
get
Returns Target Groups for the given Target
Target Groups
get
Returns all Target Groups
post
Creates a Target Group
del
Deletes a Target Group
get
Returns Target Group details for the given identifier
patch
Updates a Target Group
get
Returns Feature Flags that are available to be added to the given Target Group
get
Returns Feature Flags in a Target Group
Environment Perspectives
del
Delete a Perspective - Environment link.
put
Upsert a Perspective to an Environment.
Anomalies
put
Dismisses an Anomaly
Proxy
get
Returns all Proxy keys in an account
post
Creates a Proxy Key in the account & org
del
Deletes a ProxyKey
get
Returns a ProxyKey
patch
Updates a Proxy Key in the account & org
Tags
get
Returns all Tags
post
Creates a Tag
del
Delete a Tag
get
Returns a Tag
SRM
Monitored Services
post
createDefaultMonitoredService
get
Get monitored service data
put
Updates monitored service data
del
Delete monitored service data
put
delete template reference from monitored service
get
getAllMonitoredServicesWithHealthSources
get
CvgetAnomaliesSummary
get
getCountOfServices
get
getEnvironments
get
getHealthSources
get
getHealthSourcesForMonitoredServiceIdentifier
get
getList
get
getListV2
get
getMSSecondaryEvents
get
getMSSecondaryEventsDetails
get
getMonitoredServiceChangeDetails
get
getMonitoredServiceDetails
get
getMonitoredServiceDetails_1
get
getMonitoredServiceFromServiceAndEnvironment
get
getMonitoredServiceLogs
get
fetch reconciliation status for template referenced monitored services
get
get monitored service resolved template inputs
get
getMonitoredServiceScore
get
Get notification rules for MonitoredService
get
getOverAllHealthScore
get
getServices
get
getSloMetrics
get
check if a template referenced monitored service(s) require reconciliation
get
list
post
Saves monitored service data
post
Saves monitored service from template input
post
saveMonitoredServiceFromYaml
put
setHealthMonitoringFlag
put
Update monitored service from yaml or template
put
updateMonitoredServiceFromYaml
get
yamlTemplate
SLOs dashboard
get
getSLOAssociatedEnvironmentIdentifiers
get
getSLOAssociatedMonitoredServices
get
getSecondaryEventDetails
get
getSecondaryEvents
get
Get all SLOs count by risk
get
Get SLO consumption breakdown
get
Get SLO dashboard details
get
Get SLO list view
post
Get SLO list view
NG SLOs
get
Get SLO data
put
Update SLO data
del
Delete SLO data
post
Get onBoarding graph for composite slo
post
Get SLO list view
get
Get all SLOs
post
Saves SLO data
SLOs
get
Get Error budget reset history
get
Get notification rules for SLO
get
Get SLO logs
post
Reset Error budget history
get
Get Metric Graph For SLO
get
List SLOs
Downtime
get
getDowntime
put
updateDowntimeData
del
deleteDowntimeData
get
getAssociatedMonitoredServices
get
getDowntimeAssociatedMonitoredServices
get
getHistory
get
listDowntimes
post
saveDowntime
put
updateDowntimeEnabled
Srm Notification
get
getNotificationRuleData
put
updateNotificationRuleData
del
deleteNotificationRuleData
get
getNotificationRuleData_1
post
saveNotificationRuleData
IDP
IDP App Configurations
post
Toggle Plugin
post
Save Or Update Plugin Config
Connector Information
get
Get Connector Info
post
Create or Update Connector Info
get
Get Connector Info by Provider Type
DataSource Information
get
Get Datasources Present In Account
get
Get DataPoints present in DataSources for an account
get
Get Data Sources and Data Points Map for Account
Kubernetes DataPoints Information
post
Get data points data for kubernetes data source
Layout Proxy
post
Ingest plugin layout
Plugin Information
get
List Available Plugins
get
Get Plugin
post
Request for a Plugin
get
Get all plugin requests for an account
Scores Information
get
Get Score Summary for Scorecards
get
Get Scores for Scorecards
post
Get Aggregated Scores for backstage entities
Custom Dashboards
dashboards
get
Download data within a Dashboard
post
clone_dashboard
get
Download a Dashboard CSV
get
Download a Dashboard PDF
post
Runs a schedule delivery once that is then immediately sent via email to recipients
Policy Management
dashboard
get
dashboard#metrics
examples
get
examples#list
policies
get
policies#list
post
policies#create
del
policies#delete
get
policies#find
patch
policies#update
evaluate
post
evaluate#evaluate
evaluations
get
evaluations#list
get
evaluations#find
policysets
get
policysets#list
post
policysets#create
del
policysets#delete
get
policysets#find
patch
policysets#update
system
get
system#health
get
system#version
get
health system
post
latest-plugin-version system
get
list-supported-provisioner-versions system
get
version system
Code
repository
get
List repositories
post
Create repository
del
Soft delete repository
get
Get repository
patch
Update repository
get
Download repo in archived format
get
Get git blame
get
List branches
post
Create branch
del
Delete branch
get
Get branch
get
Validate code owners file
get
List commits
post
Commit files
get
Get commit
get
Get raw git diff of a commit
post
Get commit divergence
get
Get content of a file
post
Update default branch
get
Get diff stats
get
Get raw diff
post
Get raw diff
post
Check mergeability
post
Get commit details
get
List all paths
post
Purge repository
get
Get raw file content
post
Rebase a branch relative to another branch or a commit
post
Restore repository
get
List protection rules
post
Add protection rule
del
Delete protection rule
get
Get protection rule
patch
Update protection rule
get
Get general settings
patch
Update general settings
get
Get security settings
patch
Update security settings
post
Squashes commits in a branch relative to another branch or a commit
get
Get repository summary
get
List tags
post
Create tag
del
Delete tag
post
Import repository
status_checks
get
List status check results
put
Report status check results
get
List recent status check
pullreq
get
List pull requests
post
Create pull request
get
Get pull request
patch
Update pull request
get
List activities
post
Restore source branch
get
Get status checks
get
Get code owners
post
Create new pull request comment
del
Delete pull request comment
patch
Update pull request comment
put
Update status of pull request comment
post
Apply pull request code comment suggestions
get
List commits
get
Get file changes
post
Get file changes
get
List viewed files
put
Mark file as viewed
del
Remove file view
post
Merge
get
Get metadata
get
List reviewers
put
Add reviewer
del
Remove reviewer
post
Submit review
post
Update state of pull request
upload
post
Repo artifact upload
get
Repo artifact download
webhook
get
List repo webhooks
post
Create repo webhook
del
Delete repo webhook
get
Get repo webhook
patch
Update repo webhook
get
List repo webhook executions
get
Get repo webhook execution
post
Retrigger repo webhook execution
get
List acc, org or proj webhooks
post
Create acc, org or proj webhook
del
Delete acc, org or proj webhook
get
Get acc, org or proj webhook
patch
Update acc, org or proj webhook
get
List acc, org or proj webhook executions
get
Get acc, org or proj webhook execution
post
Retrigger acc, org or proj webhook execution
resource
get
List available gitignore names
get
List available license names
IaCM
usage
put
Show usage
get
Show licence
approvals
get
List approvals
post
Create approval
get
Show approval
put
Update approval
costs
get
List costs
get
List costs per workspace
executions
get
List executions
post
Create execution
get
Show execution
post
Update execution
get
List cost changes
get
List resource changes
module-registry
get
List modules
post
Create module
del
Delete module
get
List module by id
put
Update module
post
Sync module metadata
post
Create test execution by module id
get
List test executions
post
Create test execution module version
del
Disable testing
post
Enable testing
get
List module metadata
get
List module readme
post
Create module data
post
Create module readme
post
Create module tags
get
List connectors
get
Download module
get
List module versions
workspaces
get
List workspaces
post
Create workspace
del
Destroy workspace
get
Show workspace
put
Update workspace
post
Force unlock workspace
get
List modules
get
List resources
post
Clone workspace
get
List data
post
Create data
get
Show data
get
Evaluate data
post
Send event
get
List pipelines
post
Create remote execution
get
Show remote execution
get
Download remote exectution
post
execute-remote-execution workspaces
post
Upload remote execution source
settings
del
Delete default pipeline
get
List default pipelines
put
Upsert default pipeline
get
Check push data
tf-standard-backend
get
Show terraform state
post
Create terraform state
del
Unlock workspace
post
Lock workspace
variables
get
List workspace variables
post
Create workspace variable
del
Destroy workspace variable
get
Show workspace variable
put
Update workspace variable
STO
Exemptions
get
Exemptions#ListExemptions
post
Exemptions#CreateExemption
get
Exemptions#FindExemptionById
put
Exemptions#UpdateExemption
put
Exemptions#ApproveExemption
Issues
get
Issues#ListIssues
post
Issues#CreateIssue
get
Issues#FindIssueById
put
Issues#UpdateIssue
post
Issues#IssuesAugmentRemediation
Scans
get
Scans#ListScans
post
Scans#CreateScan
get
Scans#FindScanById
put
Scans#UpdateScan
get
Scans#ScanIssue
get
Scans#ScanIssues
get
Scans#ScanIssueCounts
Products
get
Products#ListProducts
get
Products#FindProductById
Test Targets
get
Targets#ListTargets
post
Targets#CreateTarget
get
Targets#FindTargetById
patch
Targets#PatchTarget
put
Targets#UpdateTarget
Target Variants
get
Target Variants#ListTargetVariants
post
Target Variants#CreateTargetVariant
get
Target Variants#FindTargetVariantById
put
Target Variants#UpdateTargetVariant
SEI
Collection categories
post
List all Collection categories
post
Create a new Collection category
del
Delete multiple Collection categories
put
Update an existing Collection category
del
Delete a specific Collection category
Collections
post
Retrieve a list of collections
post
Create a new collection
put
Edit an existing collection
del
Delete an existing collection
Contributors
get
Retrieve the list of active versions
get
Retrieve the Ccontributor data schema
post
Retrieve the list of current active licensed contributors
put
Update existing contributors
post
Retrieve SEI contributors list
DORA
post
Retrieve lead time data
post
Retrieve deployment frequency data
post
Retrieve change failure rate data
post
Retrieve Mean Time to Restore (MTTR) data
Git Sync (deprecated)
Git Branches
post
Sync the content of new Git Branch into harness with Git Sync Config Id
get
Lists branches with their status(Synced, Unsynced) by Git Sync Config Id for the given scope
Git Full Sync
get
Fetch Configuration for Git Full Sync for the provided scope
put
Update Configuration for Git Full Sync for the provided scope
post
Create Configuration for Git Full Sync for the provided scope
post
List files in full sync along with their status
post
Trigger Full Sync
Git Sync Settings
get
Get Git Sync Setting for the given scope
put
This updates the existing Git Sync settings within the scope. Only changing Connectivity Mode is allowed
post
Creates Git Sync Setting in a scope
Git Sync
get
Lists Git Sync Config for the given scope
put
Update existing Git Sync Config by Identifier
post
Creates Git Sync Config in given scope
get
Check whether Git Sync is enabled for given scope or not
put
Update existing Git Sync Config default root folder by Identifier
Git Sync Errors
get
Get Errors Count for the given scope, Repo and Branch
get
Lists Git to Harness Errors by file or connectivity errors for the given scope, Repo and Branch
get
Lists Git to Harness Errors for the given Commit Id
get
Lists Git to Harness Errors grouped by Commits for the given scope, Repo and Branch
Error Models
Error Response [Beta]
Governance Metadata [Beta]
Chaos Engineering
Chaos Engineering
resource
List available gitignore names
Security
x-api-key
Responses
200
OK
401
Unauthorized
403
Forbidden
500
Internal Server Error
get
/code/api/v1/resources/gitignore
Try it
Request samples
curl
Java
Go
Copy
Response samples
200
401
403
500
application/json
Copy
[
"string"
]
List available license names
Security
x-api-key
Responses
200
OK
401
Unauthorized
403
Forbidden
500
Internal Server Error
get
/code/api/v1/resources/license
Try it
Request samples
curl
Java
Go
Copy
Response samples
200
401
403
500
application/json
Copy
Expand all
Collapse all
[
{
"label"
:
"string"
,
"value"
:
"string"
}
]
➔ Next to
usage