# Harness NextGen Software Delivery Platform API Reference The Harness Software Delivery Platform uses OpenAPI Specification v3.0. Harness constantly improves these APIs. Please be aware that some improvements could cause breaking changes. # Introduction The Harness API allows you to integrate and use all the services and modules we provide on the Harness Platform. If you use client-side SDKs, Harness functionality can be integrated with your client-side automation, helping you reduce manual efforts and deploy code faster. For more information about how Harness works, read our [documentation](https://developer.harness.io/docs/getting-started) or visit the [Harness Developer Hub](https://developer.harness.io/). ## How it works The Harness API is a RESTful API that uses standard HTTP verbs. You can send requests in JSON, YAML, or form-data format. The format of the response matches the format of your request. You must send a single request at a time and ensure that you include your authentication key. For more information about this, go to [Authentication](#section/Introduction/Authentication). ## Get started Before you start integrating, get to know our API better by reading the following topics: * [Harness key concepts](https://developer.harness.io/docs/getting-started/learn-harness-key-concepts/) * [Authentication](#section/Introduction/Authentication) * [Requests and responses](#section/Introduction/Requests-and-Responses) * [Common Parameters](#section/Introduction/Common-Parameters-Beta) * [Status Codes](#section/Introduction/Status-Codes) * [Errors](#tag/Error-Response) * [Versioning](#section/Introduction/Versioning-Beta) * [Pagination](/#section/Introduction/Pagination-Beta) The methods you need to integrate with depend on the functionality you want to use. Work with your Harness Solutions Engineer to determine which methods you need. ## Authentication To authenticate with the Harness API, you need to: 1. Generate an API token on the Harness Platform. 2. Send the API token you generate in the `x-api-key` header in each request. ### Generate an API token To generate an API token, complete the following steps: 1. Go to the [Harness Platform](https://app.harness.io/). 2. On the left-hand navigation, click **My Profile**. 3. Click **+API Key**, enter a name for your key and then click **Save**. 4. Within the API Key tile, click **+Token**. 5. Enter a name for your token and click **Generate Token**. **Important**: Make sure to save your token securely. Harness does not store the API token for future reference, so make sure to save your token securely before you leave the page. ### Send the API token in your requests Send the token you created in the Harness Platform in the x-api-key header. For example: `x-api-key: YOUR_API_KEY_HERE` ## Requests and Responses The structure for each request and response is outlined in the API documentation. We have examples in JSON and YAML for every request and response. You can use our online editor to test the examples. ## Common Parameters [Beta] | Field Name | Type | Default | Description | |------------|---------|---------|----------------| | identifier | string | none | URL-friendly version of the name, used to identify a resource within it's scope and so needs to be unique within the scope. | | name | string | none | Human-friendly name for the resource. | | org | string | none | Limit to provided org identifiers. | | project | string | none | Limit to provided project identifiers. | | description| string | none | More information about the specific resource. | | tags | map[string]string | none | List of labels applied to the resource. | | order | string | desc | Order to use when sorting the specified fields. Type: enum(asc,desc). | | sort | string | none | Fields on which to sort. Note: Specify the fields that you want to use for sorting. When doing so, consider the operational overhead of sorting fields. | | limit | int | 30 | Pagination: Number of items to return. | | page | int | 1 | Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page. | | created | int64 | none | Unix timestamp that shows when the resource was created (in milliseconds). | | updated | int64 | none | Unix timestamp that shows when the resource was last edited (in milliseconds). | ## Status Codes Harness uses conventional HTTP status codes to indicate the status of an API request. Generally, 2xx responses are reserved for success and 4xx status codes are reserved for failures. A 5xx response code indicates an error on the Harness server. | Error Code | Description | |-------------|-------------| | 200 | OK | | 201 | Created | | 202 | Accepted | | 204 | No Content | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 412 | Precondition Failed | | 415 | Unsupported Media Type | | 500 | Server Error | To view our error response structures, go [here](#tag/Error-Response). ## Versioning [Beta] ### Harness Version The current version of our Beta APIs is yet to be announced. The version number will use the date-header format and will be valid only for our Beta APIs. ### Generation All our beta APIs are versioned as a Generation, and this version is included in the path to every API resource. For example, v1 beta APIs begin with `app.harness.io/v1/`, where v1 is the API Generation. The version number represents the core API and does not change frequently. The version number changes only if there is a significant departure from the basic underpinnings of the existing API. For example, when Harness performs a system-wide refactoring of core concepts or resources. ## Pagination [Beta] We use pagination to place limits on the number of responses associated with list endpoints. Pagination is achieved by the use of limit query parameters. The limit defaults to 30. Its maximum value is 100. Following are the pagination headers supported in the response bodies of paginated APIs: 1. X-Total-Elements : Indicates the total number of entries in a paginated response. 2. X-Page-Number : Indicates the page number currently returned for a paginated response. 3. X-Page-Size : Indicates the number of entries per page for a paginated response. For example: ``` X-Total-Elements : 30 X-Page-Number : 0 X-Page-Size : 10 ``` Version: 1.0 ## Servers Harness host URL ``` https://app.harness.io ``` Vanity URL ``` https://{vanity} ``` Variables: - `vanity` Default: "app.harness.io" ## Security ### x-api-key API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint. Type: apiKey In: header Name: x-api-key ## Download OpenAPI description [Harness NextGen Software Delivery Platform API Reference](https://apidocs.harness.io/_bundle/index.yaml) ## Organization Create and manage organizations in your account. You use organizations to group together related projects. For example, you can use an organization to group together projects within a business unit or division. ### Create an organization [Beta] - [POST /v1/orgs](https://apidocs.harness.io/organization/create-organization.md): Creates a new organization. ### List organizations [Beta] - [GET /v1/orgs](https://apidocs.harness.io/organization/get-organizations.md): Retrieves the information of the organizations. ### Retrieve an organization [Beta] - [GET /v1/orgs/{org}](https://apidocs.harness.io/organization/get-organization.md): Retrieves the information of the organization with the matching organization identifier. ### Update an organization [Beta] - [PUT /v1/orgs/{org}](https://apidocs.harness.io/organization/update-organization.md): Updates the information of the organization with the matching organization identifier. ### Delete an organization [Beta] - [DELETE /v1/orgs/{org}](https://apidocs.harness.io/organization/delete-organization.md): Deletes the information of the organization with the matching organization identifier. ### List Organizations by filter - [GET /ng/api/organizations](https://apidocs.harness.io/organization/getorganizationlist.md): List all Organizations matching the given search criteria. ### Create an Organization - [POST /ng/api/organizations](https://apidocs.harness.io/organization/postorganization.md): Creates a new Organization. ### List Organization details - [GET /ng/api/organizations/{identifier}](https://apidocs.harness.io/organization/getorganization.md): Lists Organization details using an Account and Organization ID. ### Update an Organization - [PUT /ng/api/organizations/{identifier}](https://apidocs.harness.io/organization/putorganization.md): Updates Organization settings. ### Delete an Organization - [DELETE /ng/api/organizations/{identifier}](https://apidocs.harness.io/organization/deleteorganization.md): Deletes Organization for the given ID. ## Project [Beta] This contains APIs for projects. ### Create a project - [POST /v1/orgs/{org}/projects](https://apidocs.harness.io/org-project/create-org-scoped-project.md): Creates a new project ### List projects - [GET /v1/orgs/{org}/projects](https://apidocs.harness.io/org-project/get-org-scoped-projects.md): Retrieves the information of the projects. ### Retrieve a project - [GET /v1/orgs/{org}/projects/{project}](https://apidocs.harness.io/org-project/get-org-scoped-project.md): Retrieves the information of the project with the matching project identifier. ### Update a project - [PUT /v1/orgs/{org}/projects/{project}](https://apidocs.harness.io/org-project/update-org-scoped-project.md): Updates the information of the project with the matching project identifier. ### Delete a project - [DELETE /v1/orgs/{org}/projects/{project}](https://apidocs.harness.io/org-project/delete-org-scoped-project.md): Deletes the information of the project with the matching project identifier. ## Project This contains APIs related to Project as defined in Harness ### List all Projects for a user - [GET /ng/api/projects](https://apidocs.harness.io/project/getprojectlist.md): Lists all Projects the user is a member of by using the user's API key token. ### Create a Project - [POST /ng/api/projects](https://apidocs.harness.io/project/postproject.md): Creates a new Harness Project. ### List Project details - [GET /ng/api/projects/{identifier}](https://apidocs.harness.io/project/getproject.md): Lists a Project's details for the given ID. ### Update a Project - [PUT /ng/api/projects/{identifier}](https://apidocs.harness.io/project/putproject.md): Updates Project details for the given ID. ### Delete a Project - [DELETE /ng/api/projects/{identifier}](https://apidocs.harness.io/project/deleteproject.md): Deletes a Project corresponding to the given ID. ### List user's project with support to filter by multiple organizations - [GET /ng/api/projects/list](https://apidocs.harness.io/project/getprojectlistwithmultiorgfilter.md) ## Account Secrets [Beta] This contains APIs for account-scoped secrets. ### Create a secret - [POST /v1/secrets](https://apidocs.harness.io/account-secret/create-account-scoped-secret.md): Creates a new secret ### List secrets - [GET /v1/secrets](https://apidocs.harness.io/account-secret/get-account-scoped-secrets.md): Retrieves the information of the secrets. ### Validate secret reference - [POST /v1/secrets/validate-secret-ref](https://apidocs.harness.io/account-secret/validate-account-secret-ref.md): Validates if the secret at the secretManager path can be referenced ### Retrieve a secret - [GET /v1/secrets/{secret}](https://apidocs.harness.io/account-secret/get-account-scoped-secret.md): Retrieves the information of the secret. ### Deletes a secret - [DELETE /v1/secrets/{secret}](https://apidocs.harness.io/account-secret/delete-account-scoped-secret.md): Deletes the information of the secret with the matching secret identifier. ### Update a secret - [PUT /v1/secrets/{secret}](https://apidocs.harness.io/account-secret/update-account-scoped-secret.md): Updates the information of the secret with the matching secret identifier. ## Organization Secrets [Beta] This contains APIs for organization-scoped secrets. ### Create a secret - [POST /v1/orgs/{org}/secrets](https://apidocs.harness.io/org-secret/create-org-scoped-secret.md): Creates a new secret ### List secrets - [GET /v1/orgs/{org}/secrets](https://apidocs.harness.io/org-secret/get-org-scoped-secrets.md): Retrieves the information of the secrets. ### Validate secret reference - [POST /v1/orgs/{org}/secrets/validate-secret-ref](https://apidocs.harness.io/org-secret/validate-org-secret-ref.md): Validates if the secret at the secretManager path can be referenced ### Retrieve a secret - [GET /v1/orgs/{org}/secrets/{secret}](https://apidocs.harness.io/org-secret/get-org-scoped-secret.md): Retrieves the information of the secret. ### Delete a secret - [DELETE /v1/orgs/{org}/secrets/{secret}](https://apidocs.harness.io/org-secret/delete-org-scoped-secret.md): Deletes the information of the secret with the matching secret identifier. ### Update a secret - [PUT /v1/orgs/{org}/secrets/{secret}](https://apidocs.harness.io/org-secret/update-org-scoped-secret.md): Updates the information of the secret with the matching secret identifier. ## Project Secrets [Beta] This contains APIs for project-scoped secrets. ### Create a secret - [POST /v1/orgs/{org}/projects/{project}/secrets](https://apidocs.harness.io/project-secret/create-project-scoped-secret.md): Creates a new secret ### List secrets - [GET /v1/orgs/{org}/projects/{project}/secrets](https://apidocs.harness.io/project-secret/get-project-scoped-secrets.md): Retrieves the information of the secrets. ### Validate secret reference - [POST /v1/orgs/{org}/projects/{project}/secrets/validate-secret-ref](https://apidocs.harness.io/project-secret/validate-project-secret-ref.md): Validates if the secret at the secretManager path can be referenced ### Retrieve a secret - [GET /v1/orgs/{org}/projects/{project}/secrets/{secret}](https://apidocs.harness.io/project-secret/get-project-scoped-secret.md): Retrieves the information of the secret. ### Delete a secret - [DELETE /v1/orgs/{org}/projects/{project}/secrets/{secret}](https://apidocs.harness.io/project-secret/delete-project-scoped-secret.md): Deletes the information of the secret with the matching secret identifier. ### Update a secret - [PUT /v1/orgs/{org}/projects/{project}/secrets/{secret}](https://apidocs.harness.io/project-secret/update-project-scoped-secret.md): Updates the information of the secret with the matching secret identifier. ## Secrets This contains APIs related to Secrets as defined in Harness ### countSecretsForScope - [GET /ng/api/v2/secrets/count](https://apidocs.harness.io/secrets/countsecretsforscope.md) ### Creates a Secret at given Scope - [POST /ng/api/v2/secrets](https://apidocs.harness.io/secrets/postsecret.md) ### Creates a Secret File - [POST /ng/api/v2/secrets/files](https://apidocs.harness.io/secrets/postsecretfilev2.md) ### Get the Secret by ID and Scope - [GET /ng/api/v2/secrets/{identifier}](https://apidocs.harness.io/secrets/getsecretv2.md) ### Updates the Secret by ID and Scope - [PUT /ng/api/v2/secrets/{identifier}](https://apidocs.harness.io/secrets/putsecret.md) ### Deletes Secret by ID and Scope - [DELETE /ng/api/v2/secrets/{identifier}](https://apidocs.harness.io/secrets/deletesecretv2.md) ### Fetches the list of Secrets corresponding to the request's filter criteria. - [POST /ng/api/v2/secrets/list/secrets](https://apidocs.harness.io/secrets/listsecretsv4.md) ### Fetches the list of Secrets corresponding to the request's filter criteria. - [POST /ng/api/v2/secrets/list](https://apidocs.harness.io/secrets/listsecretsv3.md) ### Updates the Secret file by ID and Scope - [PUT /ng/api/v2/secrets/files/{identifier}](https://apidocs.harness.io/secrets/putsecretfilev2.md) ### Updates the Secret by ID and Scope via YAML - [PUT /ng/api/v2/secrets/{identifier}/yaml](https://apidocs.harness.io/secrets/putsecretviayaml.md) ### Validates Secret with the provided ID and Scope - [POST /ng/api/v2/secrets/validate](https://apidocs.harness.io/secrets/validatesecret.md) ### Checks whether the identifier is unique or not - [GET /ng/api/v2/secrets/validateUniqueIdentifier/{identifier}](https://apidocs.harness.io/secrets/validatesecretidentifierisunique.md) ### Fetches the list of Secrets corresponding to the request's filter criteria. (deprecated) - [GET /ng/api/v2/secrets](https://apidocs.harness.io/secrets/listsecretsv2.md) ### Creates a secret via YAML (deprecated) - [POST /ng/api/v2/secrets/yaml](https://apidocs.harness.io/secrets/postsecretviayaml.md) ## Account Connectors [Beta] This contains APIs for Account-scoped Connectors. ### Create a Connector - [POST /v1/connectors](https://apidocs.harness.io/account-connector/create-account-scoped-connector.md): Creates a new connector ### List connectors - [GET /v1/connectors](https://apidocs.harness.io/account-connector/get-account-scoped-connectors.md): Retrieves the information of the connectors. ### Retrieve a connector - [GET /v1/connectors/{connector}](https://apidocs.harness.io/account-connector/get-account-scoped-connector.md): Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Update a connector - [PUT /v1/connectors/{connector}](https://apidocs.harness.io/account-connector/update-account-scoped-connector.md): Updates the information of the secret with the matching secret identifier. ### Delete a connector - [DELETE /v1/connectors/{connector}](https://apidocs.harness.io/account-connector/delete-account-scoped-connector.md): Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Test a connector - [GET /v1/connectors/{connector}/test-connection](https://apidocs.harness.io/account-connector/test-account-scoped-connector.md): Tests connection of the connector with the matching connector identifier. ## Organization Connectors [Beta] This contains APIs for Organization-scoped Connectors. ### Create a Connector - [POST /v1/orgs/{org}/connectors](https://apidocs.harness.io/org-connector/create-org-scoped-connector.md): Creates a new connector ### List connectors - [GET /v1/orgs/{org}/connectors](https://apidocs.harness.io/org-connector/get-org-scoped-connectors.md): Retrieves the information of the connectors. ### Retrieve a connector - [GET /v1/orgs/{org}/connectors/{connector}](https://apidocs.harness.io/org-connector/get-org-scoped-connector.md): Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Update a connector - [PUT /v1/orgs/{org}/connectors/{connector}](https://apidocs.harness.io/org-connector/update-org-scoped-connector.md): Updates the information of the secret with the matching secret identifier. ### Delete a connector - [DELETE /v1/orgs/{org}/connectors/{connector}](https://apidocs.harness.io/org-connector/delete-org-scoped-connector.md): Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Test a connector - [GET /v1/orgs/{org}/connectors/{connector}/test-connection](https://apidocs.harness.io/org-connector/test-org-scoped-connector.md): Tests connection of the connector with the matching connector identifier. ## Project Connectors [Beta] This contains APIs for Project-scoped Connectors. ### Create a Connector - [POST /v1/orgs/{org}/projects/{project}/connectors](https://apidocs.harness.io/project-connector/create-project-scoped-connector.md): Creates a new connector ### List connectors - [GET /v1/orgs/{org}/projects/{project}/connectors](https://apidocs.harness.io/project-connector/get-project-scoped-connectors.md): Retrieves the information of the connectors. ### Retrieve a connector - [GET /v1/orgs/{org}/projects/{project}/connectors/{connector}](https://apidocs.harness.io/project-connector/get-project-scoped-connector.md): Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Update a connector - [PUT /v1/orgs/{org}/projects/{project}/connectors/{connector}](https://apidocs.harness.io/project-connector/update-project-scoped-connector.md): Updates the information of the secret with the matching secret identifier. ### Delete a connector - [DELETE /v1/orgs/{org}/projects/{project}/connectors/{connector}](https://apidocs.harness.io/project-connector/delete-project-scoped-connector.md): Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE. ### Test a connector - [GET /v1/orgs/{org}/projects/{project}/connectors/{connector}/test-connection](https://apidocs.harness.io/project-connector/test-project-scoped-connector.md): Tests connection of the connector with the matching connector identifier. ## Connectors This contains APIs related to Connectors as defined in Harness ### Fetches the list of CCM K8S Connectors corresponding to the request's filter criteria. - [POST /ng/api/connectors/ccmK8sList](https://apidocs.harness.io/connectors/getccmk8sconnectorlist.md) ### Update a Connector - [PUT /ng/api/connectors](https://apidocs.harness.io/connectors/updateconnector.md): Updates a Connector for the given ID. ### Create a Connector - [POST /ng/api/connectors](https://apidocs.harness.io/connectors/createconnector.md): Creates a new Harness Connector. ### Return Connector details - [GET /ng/api/connectors/{identifier}](https://apidocs.harness.io/connectors/getconnector.md): Returns the Connector's details for the given Account and Connector ID. ### Delete a Connector - [DELETE /ng/api/connectors/{identifier}](https://apidocs.harness.io/connectors/deleteconnector.md): Deletes a Connector for the given ID. ### List all the configured field values for the given Connector type. - [GET /ng/api/connectors/fieldValues](https://apidocs.harness.io/connectors/getallallowedfieldvalues.md): Returns all the configured field values for the given Connector type, which can be used during connector creation. ### Lists all Connectors for an account - [GET /ng/api/connectors/catalogue](https://apidocs.harness.io/connectors/getconnectorcatalogue.md): Lists all the Connectors for the given Account ID. ### Gets the connector's statistics by Account Identifier, Project Identifier and Organization Identifier - [GET /ng/api/connectors/stats](https://apidocs.harness.io/connectors/getconnectorstatistics.md) ### Get list of GCP Projects - [GET /ng/api/connectors/{connectorRef}/gcp-projects](https://apidocs.harness.io/connectors/getgcpprojects.md): Returns the list of GCP project IDs that the connector has access to. ### Fetches the list of Connectors corresponding to the request's filter criteria. - [POST /ng/api/connectors/listV2](https://apidocs.harness.io/connectors/getconnectorlistv2.md) ### Get list of Connectors by FQN - [POST /ng/api/connectors/listbyfqn](https://apidocs.harness.io/connectors/listconnectorbyfqn.md): Lists all Connectors for an Account by Fully Qualified Name (FQN) with a limit of max 1000 FQNs per request. ### Test Harness Connector connection with third-party tool - [POST /ng/api/connectors/testConnection/{identifier}](https://apidocs.harness.io/connectors/gettestconnectionresult.md): Tests if a Harness Connector can successfully connect Harness to a third-party tool. ### Test Git Connector sync with repo - [POST /ng/api/connectors/testGitRepoConnection/{identifier}](https://apidocs.harness.io/connectors/gettestgitrepoconnectionresult.md): Tests if a Git Repo Connector can successfully connect Harness to a Git provider. ### Test a Harness Connector - [GET /ng/api/connectors/validateUniqueIdentifier](https://apidocs.harness.io/connectors/validatetheidentifierisunique.md): Tests if a Connector can successfully connect Harness to a third-party tool using the an Account and Connector ID. ### List all Connectors using filters (deprecated) - [GET /ng/api/connectors](https://apidocs.harness.io/connectors/getconnectorlist.md): Lists all the Connectors matching the specified filters. ### Get the Template URL of connector (deprecated) - [POST /ng/api/connectors/getceawstemplateurl](https://apidocs.harness.io/connectors/getceawstemplate.md) ## GoogleSecretManagerConnector This contains APIs specific to Google Secret Manager Connector as defined in Harness ### Get list of GCP Regions - [GET /ng/api/google-secret-manager-connector/gcp-regions](https://apidocs.harness.io/googlesecretmanagerconnector/getgcpregions.md): Lists all GCP Regions ## Account Roles [Beta] This contains APIs for Account-scoped Roles. ### List Roles - [GET /v1/roles](https://apidocs.harness.io/account-roles/list-roles-acc.md): Returns a list of Roles present in the Account scope. ### Create a Role - [POST /v1/roles](https://apidocs.harness.io/account-roles/create-role-acc.md): Creates a custom Role in the Account scope. ### Retrieve a Role - [GET /v1/roles/{role}](https://apidocs.harness.io/account-roles/get-role-acc.md): Retrieves a Role from Account scope. ### Update a Role - [PUT /v1/roles/{role}](https://apidocs.harness.io/account-roles/update-role-acc.md): Updates a Role from Account scope. ### Delete a Role - [DELETE /v1/roles/{role}](https://apidocs.harness.io/account-roles/delete-role-acc.md): Deletes a custom Role from Account scope. ### Get roles count for an account - [GET /v1/roles/count](https://apidocs.harness.io/account-roles/get-roles-count.md): Get roles count for an account. ## Organization Roles [Beta] This contains APIs for Organization-scoped Roles. ### List Roles - [GET /v1/orgs/{org}/roles](https://apidocs.harness.io/organization-roles/list-roles-org.md): Returns a list of Roles present in the Organization scope. ### Create a Role - [POST /v1/orgs/{org}/roles](https://apidocs.harness.io/organization-roles/create-role-org.md): Creates a custom Role in the Organization scope. ### Retrieve a Role - [GET /v1/orgs/{org}/roles/{role}](https://apidocs.harness.io/organization-roles/get-role-org.md): Retrieves a Role from Organization scope. ### Update a Role - [PUT /v1/orgs/{org}/roles/{role}](https://apidocs.harness.io/organization-roles/update-role-org.md): Updates a Role from Organization scope. ### Delete a Role - [DELETE /v1/orgs/{org}/roles/{role}](https://apidocs.harness.io/organization-roles/delete-role-org.md): Deletes a custom Role from Organization scope. ## Project Roles [Beta] This contains APIs for Project-scoped Roles. ### List Roles - [GET /v1/orgs/{org}/projects/{project}/roles](https://apidocs.harness.io/project-roles/list-roles-project.md): Returns a list of Roles present in the Project scope. ### Create a Role - [POST /v1/orgs/{org}/projects/{project}/roles](https://apidocs.harness.io/project-roles/create-role-project.md): Creates a custom Role in the Project scope. ### Retrieve a Role - [GET /v1/orgs/{org}/projects/{project}/roles/{role}](https://apidocs.harness.io/project-roles/get-role-project.md): Retrieves a Role from Project scope. ### Update a Role - [PUT /v1/orgs/{org}/projects/{project}/roles/{role}](https://apidocs.harness.io/project-roles/update-role-project.md): Updates a Role from Project scope. ### Delete a Role - [DELETE /v1/orgs/{org}/projects/{project}/roles/{role}](https://apidocs.harness.io/project-roles/delete-role-project.md): Deletes a custom Role from Project scope. ## Roles This contains APIs for CRUD on roles ### List Roles - [GET /authz/api/roles](https://apidocs.harness.io/roles/getrolelist.md): List roles in the given scope ### Create Role - [POST /authz/api/roles](https://apidocs.harness.io/roles/postrole.md): Create a Custom Role in a scope ### Get Role - [GET /authz/api/roles/{identifier}](https://apidocs.harness.io/roles/getrole.md): Get a Role by identifier ### Update Role - [PUT /authz/api/roles/{identifier}](https://apidocs.harness.io/roles/putrole.md): Update a Custom Role by identifier ### Delete Role - [DELETE /authz/api/roles/{identifier}](https://apidocs.harness.io/roles/deleterole.md): Delete a Custom Role in a scope ## Account Resource Groups [Beta] This contains APIs for Account-scoped Resource Groups. ### List Resource Groups - [GET /v1/resource-groups](https://apidocs.harness.io/account-resource-groups/list-resource-groups-acc.md): Returns a list of Resource Groups present in the Account scope. ### Create a Resource Group - [POST /v1/resource-groups](https://apidocs.harness.io/account-resource-groups/create-resource-group-acc.md): Creates a custom Resource Group in the Account scope. ### Retrieve a Resource Group - [GET /v1/resource-groups/{resource-group}](https://apidocs.harness.io/account-resource-groups/get-resource-group-acc.md): Retrieves a Resource Group from Account scope. ### Update a Resource Group - [PUT /v1/resource-groups/{resource-group}](https://apidocs.harness.io/account-resource-groups/update-resource-group-acc.md): Updates a Resource Group from Account scope. ### Delete a Resource Group - [DELETE /v1/resource-groups/{resource-group}](https://apidocs.harness.io/account-resource-groups/delete-resource-group-acc.md): Deletes a custom Resource Group from Account scope. ## Organization Resource Groups [Beta] This contains APIs for Organization-scoped Resource Groups. ### List Resource Groups - [GET /v1/orgs/{org}/resource-groups](https://apidocs.harness.io/organization-resource-groups/list-resource-groups-org.md): Returns a list of Resource Groups present in the Organization scope. ### Create a Resource Group - [POST /v1/orgs/{org}/resource-groups](https://apidocs.harness.io/organization-resource-groups/create-resource-group-org.md): Creates a custom Resource Group in the Organization scope. ### Retrieve a Resource Group - [GET /v1/orgs/{org}/resource-groups/{resource-group}](https://apidocs.harness.io/organization-resource-groups/get-resource-group-org.md): Retrieves a Resource Group from Organization scope. ### Update a Resource Group - [PUT /v1/orgs/{org}/resource-groups/{resource-group}](https://apidocs.harness.io/organization-resource-groups/update-resource-group-org.md): Updates a Resource Group from Organization scope. ### Delete a Resource Group - [DELETE /v1/orgs/{org}/resource-groups/{resource-group}](https://apidocs.harness.io/organization-resource-groups/delete-resource-group-org.md): Deletes a custom Resource Group from Organization scope. ## Project Resource Groups [Beta] This contains APIs for Project-scoped Resource Groups. ### List Resource Groups - [GET /v1/orgs/{org}/projects/{project}/resource-groups](https://apidocs.harness.io/project-resource-groups/list-resource-groups-project.md): Returns a list of Resource Groups present in the Project scope. ### Create a Resource Group - [POST /v1/orgs/{org}/projects/{project}/resource-groups](https://apidocs.harness.io/project-resource-groups/create-resource-group-project.md): Creates a custom Resource Group in the Project scope. ### Retrieve a Resource Group - [GET /v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}](https://apidocs.harness.io/project-resource-groups/get-resource-group-project.md): Retrieves a Resource Group from Project scope. ### Update a Resource Group - [PUT /v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}](https://apidocs.harness.io/project-resource-groups/update-resource-group-project.md): Updates a Resource Group from Project scope. ### Delete a Resource Group - [DELETE /v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}](https://apidocs.harness.io/project-resource-groups/delete-resource-group-project.md): Deletes a custom Resource Group from Project scope. ## Filter Resource Groups [Beta] This contains the filter endpoint for Resource Groups. ### Filter Resource Groups - [POST /v1/resource-groups/filter](https://apidocs.harness.io/filter-resource-groups/filter-resource-groups.md): Returns a list of Resource Groups based on filter criteria. ## Harness Resource Group This contains APIs specific to the Harness Resource Group ### List Resource Groups - [GET /authz/api/v2/resourcegroup](https://apidocs.harness.io/harness-resource-group/getresourcegrouplistv2.md): Get list of resource groups ### Create Resource Group - [POST /authz/api/v2/resourcegroup](https://apidocs.harness.io/harness-resource-group/createresourcegroupv2.md): Create a resource group ### Get Resource Group - [GET /authz/api/v2/resourcegroup/{identifier}](https://apidocs.harness.io/harness-resource-group/getresourcegroupv2.md): Get a resource group by identifier ### Update Resource Group - [PUT /authz/api/v2/resourcegroup/{identifier}](https://apidocs.harness.io/harness-resource-group/updateresourcegroupv2.md): Update a resource group ### Delete Resource Group - [DELETE /authz/api/v2/resourcegroup/{identifier}](https://apidocs.harness.io/harness-resource-group/deleteresourcegroupv2.md): Delete a resource group ### List Resource Groups by filter - [POST /authz/api/v2/resourcegroup/filter](https://apidocs.harness.io/harness-resource-group/getfilterresourcegrouplistv2.md): This fetches a filtered list of Resource Groups ## Zendesk This contains APIs specific to the creation of zendesk ticket ### create zendesk ticket for given user - [POST /authz/api/zendesk](https://apidocs.harness.io/zendesk/createzendeskticket.md) ### get short live token for Coveo - [GET /authz/api/zendesk/token](https://apidocs.harness.io/zendesk/getcoveotoken.md) ## Account Role Assignments [Beta] This contains APIs for Account-scoped Role Assignments. ### List role assignments - [GET /v1/role-assignments](https://apidocs.harness.io/account-role-assignments/get-account-scoped-role-assignments.md): Retrieves the information of the role assignments ### Create a role assignment - [POST /v1/role-assignments](https://apidocs.harness.io/account-role-assignments/create-account-scoped-role-assignments.md): Create a role assignment ### Retrieve a role assignment - [GET /v1/role-assignments/{role-assignment}](https://apidocs.harness.io/account-role-assignments/get-account-scoped-role-assignment.md): Retrieves the information of the role assignment with the matching role assignment identifier. ### Delete a role assignment - [DELETE /v1/role-assignments/{role-assignment}](https://apidocs.harness.io/account-role-assignments/delete-account-scoped-role-assignment.md): Deletes the information of the role assignment with the matching role assignment identifier. ### Get role assignments count for an account - [GET /v1/role-assignments/count](https://apidocs.harness.io/account-role-assignments/get-role-assignments-count.md): Get role assignments count for an account. ## Organization Role Assignments [Beta] This contains APIs for Organization-scoped Role Assignments. ### List role assignments - [GET /v1/orgs/{org}/role-assignments](https://apidocs.harness.io/org-role-assignments/get-org-scoped-role-assignments.md): Retrieves the information of the role assignments ### Create a role assignment - [POST /v1/orgs/{org}/role-assignments](https://apidocs.harness.io/org-role-assignments/create-org-scoped-role-assignments.md): Create a role assignment ### Retrieve a role assignment - [GET /v1/orgs/{org}/role-assignments/{role-assignment}](https://apidocs.harness.io/org-role-assignments/get-org-scoped-role-assignment.md): Retrieves the information of the role assignment with the matching role assignment identifier. ### Delete a role assignment - [DELETE /v1/orgs/{org}/role-assignments/{role-assignment}](https://apidocs.harness.io/org-role-assignments/delete-org-scoped-role-assignment.md): Deletes the information of the role assignment with the matching role assignment identifier. ## Project Role Assignments [Beta] This contains APIs for Project-scoped Role Assignments. ### List role assignments - [GET /v1/orgs/{org}/projects/{project}/role-assignments](https://apidocs.harness.io/project-role-assignments/get-project-scoped-role-assignments.md): Retrieves the information of the role assignments ### Create a role assignment - [POST /v1/orgs/{org}/projects/{project}/role-assignments](https://apidocs.harness.io/project-role-assignments/create-project-scoped-role-assignments.md): Create a role assignment ### Retrieve a role assignment - [GET /v1/orgs/{org}/projects/{project}/role-assignments/{role-assignment}](https://apidocs.harness.io/project-role-assignments/get-project-scoped-role-assignment.md): Retrieves the information of the role assignment with the matching role assignment identifier. ### Delete a role assignment - [DELETE /v1/orgs/{org}/projects/{project}/role-assignments/{role-assignment}](https://apidocs.harness.io/project-role-assignments/delete-project-scoped-role-assignment.md): Deletes the information of the role assignment with the matching role assignment identifier. ## Role Assignments This contains APIs for CRUD on role assignments ### Bulk Delete Role Assignment - [POST /authz/api/roleassignments/delete/batch](https://apidocs.harness.io/role-assignments/bulkdeleteroleassignment.md): Bulk delete role assignments by identifiers ### Create Role Assignments - [POST /authz/api/roleassignments/multi](https://apidocs.harness.io/role-assignments/postroleassignments.md): Create multiple role assignments in a scope. Returns all successfully created role assignments. Ignores failures and duplicates. ### List Role Assignments - [GET /authz/api/roleassignments](https://apidocs.harness.io/role-assignments/getroleassignmentlist.md): List role assignments in the given scope ### Create Role Assignment - [POST /authz/api/roleassignments](https://apidocs.harness.io/role-assignments/postroleassignment.md): Creates role assignment within the specified scope. ### Get Role Assignment - [GET /authz/api/roleassignments/{identifier}](https://apidocs.harness.io/role-assignments/getroleassignment.md): Get an existing role assignment by identifier ### Delete Role Assignment - [DELETE /authz/api/roleassignments/{identifier}](https://apidocs.harness.io/role-assignments/deleteroleassignment.md): Delete an existing role assignment by identifier ### List Role Assignments by filter - [POST /authz/api/roleassignments/filter](https://apidocs.harness.io/role-assignments/getfilteredroleassignmentlist.md): List role assignments in the scope according to the given filter ### List Aggregated Role Assignments by filter - [POST /authz/api/roleassignments/aggregate](https://apidocs.harness.io/role-assignments/getroleassignmentaggregatelist.md): List role assignments in the scope according to the given filter with added metadata ### List Role Assignments by scope filter - [POST /authz/api/roleassignments/v2/filter](https://apidocs.harness.io/role-assignments/getfilteredroleassignmentbyscopelist.md): List role assignments in the scope according to the given filter ### Validate Role Assignment - [POST /authz/api/roleassignments/validate](https://apidocs.harness.io/role-assignments/validateroleassignment.md): Check whether a proposed role assignment is valid. ## Access Control List This contains the APIs to perform access control checks ### Check Permission - [POST /authz/api/acl](https://apidocs.harness.io/access-control-list/getaccesscontrollist.md): Check for permission on resource(s) for a principal ### Get ACL Count - [GET /authz/api/acl/get-acl-count](https://apidocs.harness.io/access-control-list/getaclcount.md): Returns the total number of ACL entries for the given scope ## Account Banner This contains APIs for Account Banners. ### Retrieves the list of Banners in account scope - [GET /v1/banners](https://apidocs.harness.io/account-banner/get-account-scoped-banners.md): Retrieves the list of Banners in account scope ### Creates a new Banner in account scope - [POST /v1/banners](https://apidocs.harness.io/account-banner/create-account-scoped-banners.md): Creates a new Banner in Account Scope. ### Validate if the specified Banner identifier is available for use in account scope - [GET /v1/banners/validate-unique-identifier/{bannerId}](https://apidocs.harness.io/account-banner/validate-account-scoped-banner-identifier.md): Validate if the specified BannerDTO identifier is available for use in account scope ### Check for a current account max 5 banners are enabled or not - [GET /v1/banners/allowed](https://apidocs.harness.io/account-banner/banners-allowed.md): Check for a current account max 5 banners are enabled or not. ### Updates the specified Banner in account scope - [PUT /v1/banners/{banner}](https://apidocs.harness.io/account-banner/update-account-scoped-banner.md): Updates the specified Banner in account scope ### Deletes the specified Banner in account scope - [DELETE /v1/banners/{banner}](https://apidocs.harness.io/account-banner/delete-account-scoped-banner.md): Deletes the specified Banner in account scope ### Return Active Banners - [GET /v1/banners/active](https://apidocs.harness.io/account-banner/get-account-scoped-active-banners.md): This API endpoint will return max 5 banners as that is the enabled banners count. ### Retrieves the list of Banners in account scope - [GET /v1/banners](https://apidocs.harness.io/account-banner/get-account-scoped-banners.md): Retrieves the list of Banners in account scope ### Creates a new Banner in account scope - [POST /v1/banners](https://apidocs.harness.io/account-banner/create-account-scoped-banners.md): Creates a new Banner in Account Scope. ### Validate if the specified Banner identifier is available for use in account scope - [GET /v1/banners/validate-unique-identifier/{bannerId}](https://apidocs.harness.io/account-banner/validate-account-scoped-banner-identifier.md): Validate if the specified BannerDTO identifier is available for use in account scope ### Check for a current account max 5 banners are enabled or not - [GET /v1/banners/allowed](https://apidocs.harness.io/account-banner/banners-allowed.md): Check for a current account max 5 banners are enabled or not. ### Updates the specified Banner in account scope - [PUT /v1/banners/{banner}](https://apidocs.harness.io/account-banner/update-account-scoped-banner.md): Updates the specified Banner in account scope ### Deletes the specified Banner in account scope - [DELETE /v1/banners/{banner}](https://apidocs.harness.io/account-banner/delete-account-scoped-banner.md): Deletes the specified Banner in account scope ### Return Active Banners - [GET /v1/banners/active](https://apidocs.harness.io/account-banner/get-account-scoped-active-banners.md): This API endpoint will return max 5 banners as that is the enabled banners count. ## Account Licensed Modules This contains APIs for Account Licensed Modules. ### Get Licensed Modules for an account - [GET /v1/licensedModules](https://apidocs.harness.io/account-licensed-modules/get-account-licensed-modules.md): Get Licensed Modules for an account ## Account License Type ### Retrieve type of licenses for an account - [GET /v1/subscription/{accountIdentifier}](https://apidocs.harness.io/account-license-type/get-license-type.md) ## Account Webhooks This contains APIs for Account Webhooks. ### Lists all the Webhooks at Account level - [POST /v1/webhooks/list](https://apidocs.harness.io/account-webhooks/list-account-webhooks.md): Lists webhooks ### Create a webhook at Account level - [POST /v1/webhooks](https://apidocs.harness.io/account-webhooks/create-account-webhooks.md): Create webhooks at account level ### Fetch Webhook at Account level - [GET /v1/webhooks/{webhook}](https://apidocs.harness.io/account-webhooks/get-account-webhook.md): Fetch Webhook at Account level ### Updates a Webhook at Account level - [PUT /v1/webhooks/{webhook}](https://apidocs.harness.io/account-webhooks/update-account-webhook.md): Updates a Webhook at Account level ### Deletes a Webhook at account level - [DELETE /v1/webhooks/{webhook}](https://apidocs.harness.io/account-webhooks/delete-account-webhook.md): Deletes a Webhook at account level ## AccountSetting This contains APIs related to Account Settings as defined in Harness ### Get the AccountSetting by accountIdentifier - [GET /ng/api/account-setting](https://apidocs.harness.io/accountsetting/getaccountsetting.md) ### Updates account settings - [PUT /ng/api/account-setting](https://apidocs.harness.io/accountsetting/updateaccountsetting.md) ### Get the AccountSetting by accountIdentifier - [GET /ng/api/account-setting/list](https://apidocs.harness.io/accountsetting/listaccountsetting.md) ## Accounts This contains APIs related to accounts as defined in Harness ### Gets an account - [GET /ng/api/accounts/{accountIdentifier}](https://apidocs.harness.io/accounts/getaccountng.md) ### Returns a list of all enabled feature flags in the account - [GET /ng/api/accounts/feature-flags/{accountIdentifier}](https://apidocs.harness.io/accounts/enabledfeatureflags.md) ### Checks if immutable delegate is enabled for account - [GET /ng/api/accounts/{accountIdentifier}/immutable-delegate-enabled](https://apidocs.harness.io/accounts/isimmutabledelegateenabled.md) ### License update from UI - [PUT /ng/api/accounts/license/update/{accountIdentifier}](https://apidocs.harness.io/accounts/licenseupdatefromuing.md) ### Update Account Name - [PUT /ng/api/accounts/{accountIdentifier}/name](https://apidocs.harness.io/accounts/updateaccountnameng.md) ### Update Default Experience - [PUT /ng/api/accounts/{accountIdentifier}/default-experience](https://apidocs.harness.io/accounts/updateaccountdefaultexperienceng.md) ### Accounts#DeleteAccountData - [DELETE /sto/api/v2/accounts/{id}/data](https://apidocs.harness.io/accounts/accounts_deleteaccountdata.md): Delete all account data ## Analyze Account Access Policy ### Analyze access policies within account - [POST /v1/analyze-access-policies](https://apidocs.harness.io/analyze-account-access-policy/analyze-account-access-policies.md): Analyze access policies within account ## Analyze Organization Access Policy ### Analyze access policies within a organization - [POST /v1/orgs/{org}/analyze-access-policies](https://apidocs.harness.io/analyze-organization-access-policy/analyze-org-access-policies.md): Analyze access policies within a organization ## Analyze Project Access Policy ### Analyze access policies within a project - [POST /v1/orgs/{org}/projects/{project}/analyze-access-policies](https://apidocs.harness.io/analyze-project-access-policy/analyze-project-access-policies.md): Analyze access policies within a project ## ApiKey This fetches API keys defined in Harness ### Fetches the list of API Keys corresponding to the request's filter criteria. - [GET /ng/api/apikey](https://apidocs.harness.io/apikey/listapikeys_1.md) ### Creates an API key - [POST /ng/api/apikey](https://apidocs.harness.io/apikey/createapikey.md) ### Updates API Key for the provided ID - [PUT /ng/api/apikey/{identifier}](https://apidocs.harness.io/apikey/updateapikey.md) ### Deletes the API Key corresponding to the provided ID. - [DELETE /ng/api/apikey/{identifier}](https://apidocs.harness.io/apikey/deleteapikey.md) ### Fetches the API Keys details corresponding to the provided ID and Scope. - [GET /ng/api/apikey/aggregate/{identifier}](https://apidocs.harness.io/apikey/getaggregatedapikey.md) ### Fetches the list of Aggregated API Keys corresponding to the request's filter criteria. - [GET /ng/api/apikey/aggregate](https://apidocs.harness.io/apikey/listapikeys.md) ## Audit This contains APIs related to Audit as defined in Harness ### List Audit Events - [POST /audit/api/audits/list](https://apidocs.harness.io/audit/getauditeventlist.md) ### List Audit Events - [POST /audit/api/audits/listV2](https://apidocs.harness.io/audit/getauditeventlistv2.md) ## AuditFilters This contains APIs related to Filter of type Audit as defined in Harness ### Get the list of Filters of type Audit satisfying the criteria (if any) in the request - [GET /audit/api/auditFilters](https://apidocs.harness.io/auditfilters/getauditfilterlist.md) ### Updates the Filter of type Audit - [PUT /audit/api/auditFilters](https://apidocs.harness.io/auditfilters/updateauditfilter.md) ### Creates a Filter - [POST /audit/api/auditFilters](https://apidocs.harness.io/auditfilters/postauditfilter.md) ### Gets a Filter of type Audit by identifier - [GET /audit/api/auditFilters/{identifier}](https://apidocs.harness.io/auditfilters/getauditfilter.md) ### Delete a Filter of type Audit by identifier - [DELETE /audit/api/auditFilters/{identifier}](https://apidocs.harness.io/auditfilters/deleteauditfilter.md) ## Authentication Settings This contains APIs related to Authentication settings as defined in Harness ### Return configured Ldap settings for the account - [GET /ng/api/authentication-settings/ldap/settings](https://apidocs.harness.io/authentication-settings/getldapsettings.md): Returns configured Ldap settings and its details for the account. ### Updates Ldap setting - [PUT /ng/api/authentication-settings/ldap/settings](https://apidocs.harness.io/authentication-settings/updateldapsettings.md): Updates configured Ldap settings along with the user, group queries. ### Create Ldap setting - [POST /ng/api/authentication-settings/ldap/settings](https://apidocs.harness.io/authentication-settings/createldapsettings.md): Creates Ldap settings along with the user, group queries. ### Delete Ldap settings - [DELETE /ng/api/authentication-settings/ldap/settings](https://apidocs.harness.io/authentication-settings/deleteldapsettings.md): Delete configured Ldap settings on this account. ### Delete SAML meta data - [DELETE /ng/api/authentication-settings/delete-saml-metadata](https://apidocs.harness.io/authentication-settings/deletesamlmetadata.md): Deletes SAML metadata for the given Account ID. ### Delete SAML meta data for given SAML sso id - [DELETE /ng/api/authentication-settings/saml-metadata/{samlSSOId}/delete](https://apidocs.harness.io/authentication-settings/deletesamlmetadataforsamlssoid.md): Deletes SAML metadata for the given Account and SAML sso id ### Update authentication enabled or not for given SAML setting - [PUT /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}/authentication](https://apidocs.harness.io/authentication-settings/enabledisableauthenticationforsamlsetting.md): Updates if authentication is enabled or not for given SAML setting in Account ID. ### Gets authentication settings for the given Account ID - [GET /ng/api/authentication-settings](https://apidocs.harness.io/authentication-settings/getauthenticationsettings.md): Gets authentication settings for the given Account ID. ### Gets authentication settings version 2 for the given Account ID - [GET /ng/api/authentication-settings/v2](https://apidocs.harness.io/authentication-settings/getauthenticationsettingsv2.md): Gets authentication settings version 2 for the given Account ID. ### Get password strength - [GET /ng/api/authentication-settings/login-settings/password-strength](https://apidocs.harness.io/authentication-settings/getpasswordstrengthsettings.md): Gets password strength for the given Account ID. ### Test SAML connectivity - [GET /ng/api/authentication-settings/saml-login-test](https://apidocs.harness.io/authentication-settings/getsamllogintest.md): Tests SAML connectivity for the given Account ID. ### Test SAML connectivity - [GET /ng/api/authentication-settings/saml-login-test/{samlSSOId}](https://apidocs.harness.io/authentication-settings/getsamllogintestv2.md): Tests SAML connectivity for the given Account ID and SAML setting. ### Delete OAuth Setting - [DELETE /ng/api/authentication-settings/oauth/remove-mechanism](https://apidocs.harness.io/authentication-settings/removeoauthmechanism.md): Deletes OAuth settings for a given Account ID. ### Enable/disable public access at account level - [PUT /ng/api/authentication-settings/public-access](https://apidocs.harness.io/authentication-settings/setpublicaccess.md): Enable/disable public access for the given Account ID. ### Set session timeout at account level - [PUT /ng/api/authentication-settings/session-timeout-account-level](https://apidocs.harness.io/authentication-settings/setsessiontimeoutataccountlevel.md): Sets session timeout of all users for the given Account ID. ### Set two factor authorization - [PUT /ng/api/authentication-settings/two-factor-admin-override-settings](https://apidocs.harness.io/authentication-settings/settwofactorauthataccountlevel.md): Sets Two-Factor authorization for the given Account ID. ### Update Auth mechanism - [PUT /ng/api/authentication-settings/update-auth-mechanism](https://apidocs.harness.io/authentication-settings/updateauthmechanism.md): Updates the authentication mechanism for the given Account ID. ### Update Oauth providers - [PUT /ng/api/authentication-settings/oauth/update-providers](https://apidocs.harness.io/authentication-settings/updateoauthproviders.md): Updates OAuth providers for the given Account ID. ### Update SAML metadata - [PUT /ng/api/authentication-settings/saml-metadata-upload](https://apidocs.harness.io/authentication-settings/updatesamlmetadata.md): Updates SAML metadata of the SAML configuration configured for an account ### Upload SAML metadata - [POST /ng/api/authentication-settings/saml-metadata-upload](https://apidocs.harness.io/authentication-settings/uploadsamlmetadata.md): Updates the SAML metadata for the given Account ID. ### Update SAML metadata for a given SAML SSO Id - [PUT /ng/api/authentication-settings/saml-metadata-upload/{samlSSOId}](https://apidocs.harness.io/authentication-settings/updatesamlmetadataforsamlssoid.md): Updates SAML metadata of the SAML configuration with given SSO Id, configured for an account ### Updates the whitelisted domains - [PUT /ng/api/authentication-settings/whitelisted-domains](https://apidocs.harness.io/authentication-settings/updatewhitelisteddomains.md): Updates whitelisted domains configured for an account. ### Upload SAML metadata - [POST /ng/api/authentication-settings/saml-metadata](https://apidocs.harness.io/authentication-settings/uploadsamlmetadatads.md): Updates the SAML metadata for the given Account ID. ## Canny This contains APIs required for the creation of Canny tickets ### create Canny Post for given user - [POST /ng/api/canny/post](https://apidocs.harness.io/canny/createcannypost.md) ### create Canny Post for given user - [POST /ng/api/canny/postV2](https://apidocs.harness.io/canny/createcannypostv2.md) ### Get a list of boards available on Canny - [GET /ng/api/canny/boards](https://apidocs.harness.io/canny/getcannyboards.md) ### Get a list of categories available for a board in Canny - [GET /ng/api/canny/categories](https://apidocs.harness.io/canny/getcannyboards_1.md) ## Devops Essentials License Data By Account ### Get subscriptions information for the Devops Essentials package for an accountIdentifier. - [GET /v1/subscription/devops/{accountIdentifier}](https://apidocs.harness.io/devops-essentials-license-data-by-account/get-devops-essentials-license.md) ## EULA [Beta] This contains APIs for EULA. ### Sign an End User License Agreement - [POST /v1/eula/sign](https://apidocs.harness.io/eula/sign-eula.md): Sign an End User License Agreement. ### Validate specified agreement is signed or not - [GET /v1/eula/validate-sign](https://apidocs.harness.io/eula/validate-eula-sign.md): Check whether End User License Agreement has been signed for specified agreement type. ## Filter This contains APIs related to Filter as defined in Harness ### List Filters - [GET /ng/api/filters](https://apidocs.harness.io/filter/getfilterlist.md): Lists Filters for the given criteria. ### Update a Filter - [PUT /ng/api/filters](https://apidocs.harness.io/filter/updatefilter.md): Updates the filter for the given ID. ### Create a Filter - [POST /ng/api/filters](https://apidocs.harness.io/filter/postfilter.md): Creates a Filter. ### Return Filter Details - [GET /ng/api/filters/{identifier}](https://apidocs.harness.io/filter/getfilter.md): Returns the settings of a filter for the given ID. ### Delete a Filter - [DELETE /ng/api/filters/{identifier}](https://apidocs.harness.io/filter/deletefilter.md): Deletes a filter for the given ID. ### List Filters - [GET /pipeline/api/filters](https://apidocs.harness.io/filter/pipelinegetfilterlist.md): Lists Filters for the given criteria. ### Update a Filter - [PUT /pipeline/api/filters](https://apidocs.harness.io/filter/pipelineupdatefilter.md): Updates the filter for the given ID. ### Create a Filter - [POST /pipeline/api/filters](https://apidocs.harness.io/filter/pipelinepostfilter.md): Creates a Filter. ### Return Filter Details - [GET /pipeline/api/filters/{identifier}](https://apidocs.harness.io/filter/pipelinegetfilter.md): Returns the settings of a filter for the given ID. ### Delete a Filter - [DELETE /pipeline/api/filters/{identifier}](https://apidocs.harness.io/filter/pipelinedeletefilter.md): Deletes a filter for the given ID. ### List Filters - [GET /ccm/api/filters](https://apidocs.harness.io/filter/ccmgetfilterlist.md): Lists Filters for the given criteria. ### Update a Filter - [PUT /ccm/api/filters](https://apidocs.harness.io/filter/ccmupdatefilter.md): Updates the filter for the given ID. ### Create a Filter - [POST /ccm/api/filters](https://apidocs.harness.io/filter/ccmpostfilter.md): Creates a Filter. ### Return Filter Details - [GET /ccm/api/filters/{identifier}](https://apidocs.harness.io/filter/ccmgetfilter.md): Returns the settings of a filter for the given ID. ### Delete a Filter - [DELETE /ccm/api/filters/{identifier}](https://apidocs.harness.io/filter/ccmdeletefilter.md): Deletes a filter for the given ID. ### List Filters - [GET /template/api/filters](https://apidocs.harness.io/filter/templategetfilterlist.md): Lists Filters for the given criteria. ### Update a Filter - [PUT /template/api/filters](https://apidocs.harness.io/filter/templateupdatefilter.md): Updates the filter for the given ID. ### Create a Filter - [POST /template/api/filters](https://apidocs.harness.io/filter/templatepostfilter.md): Creates a Filter. ### Return Filter Details - [GET /template/api/filters/{identifier}](https://apidocs.harness.io/filter/templategetfilter.md): Returns the settings of a filter for the given ID. ### Delete a Filter - [DELETE /template/api/filters/{identifier}](https://apidocs.harness.io/filter/templatedeletefilter.md): Deletes a filter for the given ID. ## Harness Resource Type This contains APIs related to Harness Resource Type ### Gets all resource types available at this scope - [GET /authz/api/resourcetype](https://apidocs.harness.io/harness-resource-type/getresourcetypes.md) ## Invite This contains APIs related to Invite as defined in Harness ### Resend invite - [PUT /ng/api/invites/{inviteId}](https://apidocs.harness.io/invite/updateinvite.md): Resend the invite email ### Delete Invite - [DELETE /ng/api/invites/{inviteId}](https://apidocs.harness.io/invite/deleteinvite.md): Delete an Invite by Identifier ### Get Invite - [GET /ng/api/invites/invite](https://apidocs.harness.io/invite/getinvite.md): Gets an Invite by either Invite Id or JwtToken ### List Invites - [GET /ng/api/invites](https://apidocs.harness.io/invite/getinvites.md): List all the Invites for a Project or Organization ### Get pending users - [POST /ng/api/invites/aggregate](https://apidocs.harness.io/invite/getpendingusersaggregated.md): List of all the pending users in a scope ## IP Allowlist [Beta] This contains APIs for IP Allowlist. ### Create a IP Allowlist config - [POST /v1/ip-allowlist](https://apidocs.harness.io/ip-allowlist/create-ip-allowlist-config.md): Creates a new IP Allowlist config ### List IP Allowlist Configs - [GET /v1/ip-allowlist](https://apidocs.harness.io/ip-allowlist/get-ip-allowlist-configs.md): Retrieves the information of the IP Allowlist Config ### Retrieve a IP Allowlist config - [GET /v1/ip-allowlist/{ip-config-identifier}](https://apidocs.harness.io/ip-allowlist/get-ip-allowlist-config.md): Retrieves the specified IP Allowlist config ### Update IP Allowlist config - [PUT /v1/ip-allowlist/{ip-config-identifier}](https://apidocs.harness.io/ip-allowlist/update-ip-allowlist-config.md): Updates the specified IP Allowlist config ### Delete an IP Allowlist config - [DELETE /v1/ip-allowlist/{ip-config-identifier}](https://apidocs.harness.io/ip-allowlist/delete-ip-allowlist-config.md): Deletes the specified IP Allowlist config ### Validate unique IP Allowlist config identifier - [GET /v1/ip-allowlist/validate-unique-identifier/{ip-config-identifier}](https://apidocs.harness.io/ip-allowlist/validate-unique-ip-allowlist-config-identifier.md): Checks whether the IP Allowlist config identifier is unique or not ### Validate IP address lies in a specified range or not - [GET /v1/ip-allowlist/validate/ip-address](https://apidocs.harness.io/ip-allowlist/validate-ip-address-allowlisted-or-not.md): Checks whether the IP address is allowed or not. It also supports checking against a specific IP block range. ### Check if IP address is allowed or not - [GET /v1/ip-allowlist/allowed/ip-address](https://apidocs.harness.io/ip-allowlist/allowed-ip-address.md): Checks whether the IP address is allowed or not. ## Nextgen Ldap This contains APIs related to Nextgen Ldap as defined in Harness ### Get the NgLdap Setting - [GET /ng/api/ldap/ngLdapSettings](https://apidocs.harness.io/nextgen-ldap/getngldapsettings.md): For the given accountId fetch and return the ng ldap settings ### Test LDAP authentication - [POST /ng/api/ldap/ldap-login-test](https://apidocs.harness.io/nextgen-ldap/postldapauthenticationtest.md): Tests LDAP authentication for the given Account ID, with a valid test email and password ### Return Ldap groups matching name - [GET /ng/api/ldap/{ldapId}/search/group](https://apidocs.harness.io/nextgen-ldap/searchldapgroups.md): Returns all userGroups for the configured Ldap in the account matching a given name. ## Notification Channels This contains APIs for Notification Channels ### List Notification channels - [GET /v1/orgs/{org}/projects/{project}/notification-channels](https://apidocs.harness.io/notification-channels/list-notification-channels.md): Returns a list of notification channels for the scope. ### Create Notification channel - [POST /v1/orgs/{org}/projects/{project}/notification-channels](https://apidocs.harness.io/notification-channels/create-notification-channel.md): Create Notification Channel ### Get Notification channel - [GET /v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/get-notification-channel.md): Get Notification Channel ### Delete Notification Channel - [DELETE /v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/delete-notification-channel.md): Delete notification channel ### Update Notification Channel - [PUT /v1/orgs/{org}/projects/{project}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/update-notification-channel.md): Update Notification Channel ### List Notification channels at org level - [GET /v1/orgs/{org}/notification-channels](https://apidocs.harness.io/notification-channels/list-notification-channels-org.md): Returns a list of notification channels for the scope. ### Create Notification channel - [POST /v1/orgs/{org}/notification-channels](https://apidocs.harness.io/notification-channels/create-notification-channel-org.md): Create Notification Channel ### List Notification channels at account level - [GET /v1/notification-channels](https://apidocs.harness.io/notification-channels/list-notification-channels-account.md): Returns a list of notification channels for the scope. ### Create Notification channel - [POST /v1/notification-channels](https://apidocs.harness.io/notification-channels/create-notification-channel-account.md): Create Notification Channel ### Get Notification channel - [GET /v1/orgs/{org}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/get-notification-channel-org.md): Get Notification Channel ### Delete Notification Channel - [DELETE /v1/orgs/{org}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/delete-notification-channel-org.md): Delete notification channel ### Update Notification Channel - [PUT /v1/orgs/{org}/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/update-notification-channel-org.md): Update Notification Channel ### Get Notification channel - [GET /v1/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/get-notification-channel-account.md): Get Notification Channel ### Delete Notification Channel - [DELETE /v1/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/delete-notification-channel-account.md): Delete notification channel ### Update Notification Channel - [PUT /v1/notification-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/update-notification-channel-account.md): Update Notification Channel ### Validate unique identifier for notification channel - [GET /v1/orgs/{org}/validate-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/validate-notification-channel-identifier-org.md) ### Validate Notification Channel Identifier - [GET /v1/orgs/{org}/projects/{project}/validate-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/validate-notification-channel-identifier.md) ### Validate Notification channel identifier - [GET /v1/validate-channels/{notification-channel}](https://apidocs.harness.io/notification-channels/validate-notification-channel-identifier-account.md): Validate Notification Channel Indetifier ## Notification Rules This contains APIs for Notification Rules ### List Notification rules - [GET /v1/orgs/{org}/projects/{project}/notification-rules](https://apidocs.harness.io/notification-rules/list-notification-rules.md): Get list of notification rules ### Create Notification Rule - [POST /v1/orgs/{org}/projects/{project}/notification-rules](https://apidocs.harness.io/notification-rules/create-notification-rule.md): Create Notification Rule ### Get Notification Rule - [GET /v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/get-notification-rule.md): Get notification rule ### Delete Notification Rule - [DELETE /v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/delete-notification-rule.md): Delete notification rule ### Update Notification Rule - [PUT /v1/orgs/{org}/projects/{project}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/update-notification-rule.md): Update Notification Rule ### List Notification rules at org level - [GET /v1/orgs/{org}/notification-rules](https://apidocs.harness.io/notification-rules/list-notification-rules-org.md): Get list of notification rules ### Create Notification Rule - [POST /v1/orgs/{org}/notification-rules](https://apidocs.harness.io/notification-rules/create-notification-rule-org.md): Create Notification Rule ### List Notification rules at account level - [GET /v1/notification-rules](https://apidocs.harness.io/notification-rules/list-notification-rules-account.md): Get list of notification rules for account ### Create Notification Rule - [POST /v1/notification-rules](https://apidocs.harness.io/notification-rules/create-notification-rule-account.md): Create Notification Rule ### Get Notification Rule - [GET /v1/orgs/{org}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/get-notification-rule-org.md): Get notification rule ### Delete Notification Rule - [DELETE /v1/orgs/{org}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/delete-notification-rule-org.md): Delete notification rule ### Update Notification Rule - [PUT /v1/orgs/{org}/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/update-notification-rule-org.md): Update Notification Rule ### Get Notification Rule - [GET /v1/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/get-notification-rule-account.md): Get notification rule ### Delete Notification Rule - [DELETE /v1/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/delete-notification-rule-account.md): Delete notification rule ### Update Notification Rule - [PUT /v1/notification-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/update-notification-rule-account.md): Update Notification Rule ### Validate notification rule identifier - [GET /v1/orgs/{org}/projects/{project}/notification-rules/validate-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/validate-notification-rule-identifier.md): Validate notification rule identifier ### Validate notification rule identifier - [GET /v1/orgs/{org}/validate-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/validate-notification-rule-identifier-org.md): Validate notification rule identifier org level ### Validate notification rule identifier - [GET /v1/validate-rules/{notification-rule}](https://apidocs.harness.io/notification-rules/validate-notification-rule-identifier-account.md): Validate notification rule identifier ### List of notification entities and events - [GET /v1/notification-resource-list](https://apidocs.harness.io/notification-rules/notification-resource-list.md) ## OIDC This contains APIs related to the Harness OIDC config ### Get the openid configuration for Harness - [GET /ng/api/oidc/account/{accountId}/.wellknown/jwks](https://apidocs.harness.io/oidc/getharnessopenidconfig.md) ### Get the openid configuration for Harness - [GET /ng/api/oidc/account/{accountId}/.well-known/openid-configuration](https://apidocs.harness.io/oidc/getharnessopenidconfig_1.md) ## Oidc-Access-Token This contains APIs related to OIDC Access Token generation as defined in Harness ### Generate an OIDC IAM Role Credential for AWS - [POST /ng/api/oidc/access-token/aws/webidentity-session-access](https://apidocs.harness.io/oidc-access-token/generateoidciamrolecredentialforaws.md) ### Generates an OIDC Service Account Access Token for GCP - [POST /ng/api/oidc/access-token/gcp/service-account-access](https://apidocs.harness.io/oidc-access-token/getoidcserviceaccountaccesstokenforgcp.md) ### Exchanges an OIDC token for Azure credentials - [POST /ng/api/oidc/access-token/azure](https://apidocs.harness.io/oidc-access-token/exchangeoidctokenforazurecredentials.md) ### Generates an OIDC Workload Access Token for GCP - [POST /ng/api/oidc/access-token/gcp/workload-access](https://apidocs.harness.io/oidc-access-token/oidcworkloadaccesstokenresponse.md) ## Oidc-ID-Token This contains APIs related to OIDC ID Token generation as defined in Harness ### Generates an OIDC ID Token for Azure - [POST /ng/api/oidc/id-token/azure](https://apidocs.harness.io/oidc-id-token/generateoidcidtokenforazure.md) ### Generates an OIDC ID Token for GCP - [POST /ng/api/oidc/id-token/gcp](https://apidocs.harness.io/oidc-id-token/generateoidcidtokenforgcp.md) ### Generates an OIDC ID Token for GCP - [POST /ng/api/oidc/id-token/gcp-v2](https://apidocs.harness.io/oidc-id-token/generateoidcidtokenforgcp_1.md) ### Generate a custom OIDC ID Token - [POST /ng/api/oidc/id-token/custom](https://apidocs.harness.io/oidc-id-token/generatecustomoidcidtoken.md) ### Generates an OIDC ID Token for AWS - [POST /ng/api/oidc/id-token/aws](https://apidocs.harness.io/oidc-id-token/generateoidcidtokenforaws.md) ## Org Webhooks This contains APIs for Org Webhooks. ### Lists all the Webhooks at Org level - [POST /v1/orgs/{org}/webhooks/list](https://apidocs.harness.io/org-webhooks/list-org-webhooks.md): List org level webhooks ### Create a webhook at Org level - [POST /v1/orgs/{org}/webhooks](https://apidocs.harness.io/org-webhooks/create-org-webhooks.md): Create webhooks at org level ### Fetch Webhook at org level - [GET /v1/orgs/{org}/webhooks/{webhook}](https://apidocs.harness.io/org-webhooks/get-org-webhook.md): Fetch Webhook at org level ### Updates a Webhook at Org level - [PUT /v1/orgs/{org}/webhooks/{webhook}](https://apidocs.harness.io/org-webhooks/update-org-webhook.md): Updates a Webhook at Org level ### Deletes a Webhook at org level - [DELETE /v1/orgs/{org}/webhooks/{webhook}](https://apidocs.harness.io/org-webhooks/delete-org-webhook.md): Deletes a Webhook at org level ## Permissions This contains the APIs related to permissions ### List Permissions - [GET /authz/api/permissions](https://apidocs.harness.io/permissions/getpermissionlist.md): Get all permissions in a scope or all permissions in the system ### List Resource Types - [GET /authz/api/permissions/resourcetypes](https://apidocs.harness.io/permissions/getpermissionresourcetypeslist.md): Get all resource types for permissions in a scope or in the system. ## Project Webhooks This contains APIs for Project Webhooks. ### List all the Webhooks at Project level - [POST /v1/orgs/{org}/projects/{project}/webhooks/list](https://apidocs.harness.io/project-webhooks/list-project-webhooks.md): List project level webhooks ### Create a webhook at Project level - [POST /v1/orgs/{org}/projects/{project}/webhooks](https://apidocs.harness.io/project-webhooks/create-project-webhooks.md): Create webhooks at project level ### Fetch Webhook at project level - [GET /v1/orgs/{org}/projects/{project}/webhooks/{webhook}](https://apidocs.harness.io/project-webhooks/get-project-webhook.md): Fetch Webhook at project level ### Updates a Webhook at Project level - [PUT /v1/orgs/{org}/projects/{project}/webhooks/{webhook}](https://apidocs.harness.io/project-webhooks/update-project-webhook.md): Updates a Webhook at Project level ### Deletes a Webhook at project level - [DELETE /v1/orgs/{org}/projects/{project}/webhooks/{webhook}](https://apidocs.harness.io/project-webhooks/delete-project-webhook.md): Deletes a Webhook at project level ## Secret Managers This contains APIs related to SecretManagers as defined in Harness ### Gets the metadata of Secret Manager - [POST /ng/api/secret-managers/meta-data](https://apidocs.harness.io/secret-managers/getmetadata.md) ## Service Account This has all the APIs specific to the Service Accounts in Harness. ### Get Service Accounts - [GET /ng/api/serviceaccount](https://apidocs.harness.io/service-account/listserviceaccount.md): Fetches list of Service Accounts for the given filter criteria. ### Create a Service Account - [POST /ng/api/serviceaccount](https://apidocs.harness.io/service-account/createserviceaccount.md): Creates a new Service Account. ### Update a Service Account - [PUT /ng/api/serviceaccount/{identifier}](https://apidocs.harness.io/service-account/updateserviceaccount.md): Updates details of the Service Account for the given Service Account ID. ### Delete a Service Account - [DELETE /ng/api/serviceaccount/{identifier}](https://apidocs.harness.io/service-account/deleteserviceaccount.md): Deletes a Service Account corresponding to the given Service Account ID. ### Get Service Account In Scope - [GET /ng/api/serviceaccount/aggregate/{identifier}](https://apidocs.harness.io/service-account/getaggregatedserviceaccount.md): Gets the list of Service Accounts in the given scope. ### Get Inheriting Child Scopes - [GET /ng/api/serviceaccount/{identifier}/scopes](https://apidocs.harness.io/service-account/getinheritingchildscopelistforserviceaccount.md): List the Child Scopes inheriting this User Group ### List aggregated Service Accounts - [GET /ng/api/serviceaccount/aggregate](https://apidocs.harness.io/service-account/listaggregatedserviceaccounts.md): Fetches the list of Aggregated Service Accounts corresponding to the request's filter criteria. ### List manageable Service Accounts - [GET /ng/api/serviceaccount/manageable](https://apidocs.harness.io/service-account/listmanageableserviceaccounts.md): Fetches the list of Service Accounts for which the user has manage API key permission. ## Setting This contains APIs related to Settings as defined in Harness ### Get a setting value by identifier - [GET /ng/api/settings/{identifier}](https://apidocs.harness.io/setting/getsettingvalue.md) ### Get list of settings under the specified category - [GET /ng/api/settings](https://apidocs.harness.io/setting/getsettingslist.md) ### Update settings - [PUT /ng/api/settings](https://apidocs.harness.io/setting/updatesettingvalue.md) ## SMTP This contains APIs related to SmtpConfig as defined in Harness ### Delete Smtp Config by identifier - [DELETE /ng/api/smtpConfig/{identifier}](https://apidocs.harness.io/smtp/deletesmtpconfig.md) ### Gets Smtp config by accountId - [GET /ng/api/smtpConfig](https://apidocs.harness.io/smtp/getsmtpconfig.md) ### Updates the Smtp Config - [PUT /ng/api/smtpConfig](https://apidocs.harness.io/smtp/updatesmtp.md) ### Creates SMTP config - [POST /ng/api/smtpConfig](https://apidocs.harness.io/smtp/createsmtpconfig.md) ### Tests the config's connectivity by sending a test email - [POST /ng/api/smtpConfig/validate-connectivity](https://apidocs.harness.io/smtp/validateconnectivity.md) ### Checks whether other connectors exist with the same name - [POST /ng/api/smtpConfig/validateName](https://apidocs.harness.io/smtp/validatename.md) ## Source Code Manager Contains APIs related to Source Code Manager ### Updates Source Code Manager Details with the given Source Code Manager Id - [PUT /ng/api/source-code-manager/{identifier}](https://apidocs.harness.io/source-code-manager/updatesourcecodemanager.md) ### Deletes the Source Code Manager corresponding to the specified Source Code Manager Id - [DELETE /ng/api/source-code-manager/{identifier}](https://apidocs.harness.io/source-code-manager/deletesourcecodemanager.md) ### Lists Source Code Managers for the given account - [GET /ng/api/source-code-manager](https://apidocs.harness.io/source-code-manager/getsourcecodemanagers.md) ### Creates Source Code Manager - [POST /ng/api/source-code-manager](https://apidocs.harness.io/source-code-manager/createsourcecodemanager.md) ## Token This contains APIs related to Token as defined in Harness ### Create a Token - [POST /ng/api/token](https://apidocs.harness.io/token/createtoken.md): Creates a Token for the given API Key Type. ### Update a Token - [PUT /ng/api/token/{identifier}](https://apidocs.harness.io/token/updatetoken.md): Updates a Token for the given API Key Type. ### Delete a Token - [DELETE /ng/api/token/{identifier}](https://apidocs.harness.io/token/deletetoken.md): Deletes a Token for the given API Key Type. ### List all Tokens - [GET /ng/api/token/aggregate](https://apidocs.harness.io/token/listaggregatedtokens.md): Lists all the Tokens matching the given search criteria. ### Rotate a Token - [POST /ng/api/token/rotate/{identifier}](https://apidocs.harness.io/token/rotatetoken.md): Rotates a Token for the given API Key Type. ### Validate a Token - [POST /ng/api/token/validate](https://apidocs.harness.io/token/validatetoken.md): Validate a Token for the given account. ### Token#IssueToken - [GET /sto/api/v2/token](https://apidocs.harness.io/token/token_issuetoken.md): Issue a cross-service token ### Issue a cross-service token - [GET /v1/token](https://apidocs.harness.io/token/token_issuetoken1.md): Issue a cross-service token ## User This contains APIs related to User as defined in Harness ### Add user to user groups - [PUT /ng/api/user/add-user-to-groups/{userId}](https://apidocs.harness.io/user/addusertousergroups.md): Adds the user to the specified user group IDs passed in the body and removes all other user groups for user except harness managed user groups ### Add user(s) to scope - [POST /ng/api/user/users](https://apidocs.harness.io/user/addusers.md) ### Change user password - [PUT /ng/api/user/password](https://apidocs.harness.io/user/changeuserpassword.md): Updates the User password ### Check if user is last admin - [GET /ng/api/user/last-admin](https://apidocs.harness.io/user/checkiflastadmin.md): Check whether the user is last admin at scope or not ### Disable two factor authentication - [PUT /ng/api/user/disable-two-factor-auth](https://apidocs.harness.io/user/disablettwofactorauth.md): Disables two-factor-auth for an user in an account ### end impersonation session for user - [POST /ng/api/user/endImpersonation/{userId}](https://apidocs.harness.io/user/endimpersonation.md) ### Get detailed user information - [GET /ng/api/user/aggregate/{userId}](https://apidocs.harness.io/user/getaggregateduser.md): Returns the user metadata along with rolesAssignments by userId and scope ### Get list of users - [POST /ng/api/user/aggregate](https://apidocs.harness.io/user/getaggregatedusers.md): List of all the user's metadata along with rolesAssignments who have access to given scope ### Gets Two Factor Auth Settings - [GET /ng/api/user/two-factor-auth/{authMechanism}](https://apidocs.harness.io/user/gettwofactorauthsettings.md): Gets two factor authentication settings information of the current logged in user ### Get Current User Info - [GET /ng/api/user/currentUser](https://apidocs.harness.io/user/getcurrentuserinfo.md): Gets current logged in User information ### Get users list - [POST /ng/api/user/batch](https://apidocs.harness.io/user/getusers.md): Get list of user's for a given scope ### impersonate User - [POST /ng/api/user/impersonate/{userId}](https://apidocs.harness.io/user/impersonateuser.md) ### Update User - [PUT /ng/api/user/{userId}](https://apidocs.harness.io/user/updateuserinfo_1.md): Updates the User information ### Remove user from scope - [DELETE /ng/api/user/{userId}](https://apidocs.harness.io/user/removeuser.md): Remove user as the collaborator from the scope ### Reset two factor authorization - [GET /ng/api/user/reset-two-factor-auth/{userId}](https://apidocs.harness.io/user/reset2fa.md): Reset Two-Factor authorization. ### Unlock user - [PUT /ng/api/user/unlock-user/{userId}](https://apidocs.harness.io/user/unlockuser.md): unlock user in a given scope ### Enable two factor authentication - [PUT /ng/api/user/enable-two-factor-auth](https://apidocs.harness.io/user/enabletwofactorauth.md): Enables two-factor-auth for an user in an account ### Update User - [PUT /ng/api/user](https://apidocs.harness.io/user/updateuserinfo.md): Updates the User information ## User Group This contains APIs related to User Group as defined in Harness ### Check user membership - [GET /ng/api/user-groups/{identifier}/member/{userIdentifier}](https://apidocs.harness.io/user-group/getmember.md): Check if the user is part of the user group in an account/org/project ### Add user to User Group - [PUT /ng/api/user-groups/{identifier}/member/{userIdentifier}](https://apidocs.harness.io/user-group/putmember.md): Add a user to the user group in an account/org/project ### Remove user from User Group - [DELETE /ng/api/user-groups/{identifier}/member/{userIdentifier}](https://apidocs.harness.io/user-group/deletemember.md): Remove a user from the user group in an account/org/project ### List the User Groups in an account/org/project - [GET /ng/api/user-groups](https://apidocs.harness.io/user-group/getusergrouplist.md): List User Groups ### Update User Group - [PUT /ng/api/user-groups](https://apidocs.harness.io/user-group/putusergroup.md): Update a User Group in an account/org/project ### Create User Group - [POST /ng/api/user-groups](https://apidocs.harness.io/user-group/postusergroup.md): Create a User Group in an account/org/project ### Get User Group - [GET /ng/api/user-groups/{identifier}](https://apidocs.harness.io/user-group/getusergroup.md): Get a User Group in an account/org/project ### Delete a User Group in an account/org/project - [DELETE /ng/api/user-groups/{identifier}](https://apidocs.harness.io/user-group/deleteusergroup.md): Delete User Group ### Get Inheriting Child Scopes - [GET /ng/api/user-groups/{identifier}/scopes](https://apidocs.harness.io/user-group/getinheritingchildscopelist.md): List the Child Scopes inheriting this User Group ### List users in User Group - [POST /ng/api/user-groups/{identifier}/users](https://apidocs.harness.io/user-group/getuserlistinusergroup.md): List the users in a User Group in an account/org/project ### Link LDAP Group to the User Group to an account/org/project - [PUT /ng/api/user-groups/{userGroupId}/link/ldap/{ldapId}](https://apidocs.harness.io/user-group/linkusergrouptoldap.md) ### Link OIDC Group to the User Group in an account/org/project - [PUT /ng/api/user-groups/{userGroupId}/link/oidc/{providerId}](https://apidocs.harness.io/user-group/linkusergrouptooidc.md) ### Link SAML Group to the User Group in an account/org/project - [PUT /ng/api/user-groups/{userGroupId}/link/saml/{samlId}](https://apidocs.harness.io/user-group/linkusergrouptosaml.md) ### List User Groups by filter - [POST /ng/api/user-groups/batch](https://apidocs.harness.io/user-group/getbatchusersgrouplist.md): List the User Groups selected by a filter in an account/org/project. This api supports maximum of 10K User Group in response. ### Get filtered User Groups - [POST /ng/api/user-groups/filter](https://apidocs.harness.io/user-group/getfilteredusergroupslist.md): List the User Groups selected by a filter in an account/org/project ### Unlink SSO Group from the User Group in an account/org/project - [PUT /ng/api/user-groups/{userGroupId}/unlink](https://apidocs.harness.io/user-group/unlinkusergroupfromsso.md) ### Update User Group - [PUT /ng/api/v2/user-groups](https://apidocs.harness.io/user-group/putusergroupv2.md): Update a User Group in an account/org/project ### Create User Group - [POST /ng/api/v2/user-groups](https://apidocs.harness.io/user-group/postusergroupv2.md): Create a User Group in an account/org/project ### Get User Group - [GET /ng/api/v2/user-groups/{identifier}](https://apidocs.harness.io/user-group/getusergroupv2.md): Get a User Group in an account/org/project ### Copy User Group (deprecated) - [PUT /ng/api/user-groups/copy](https://apidocs.harness.io/user-group/copyusergroup.md): Copy a User Group in an account/org/project ## Variables This contains APIs related to Variables as defined in Harness. ### Fetches the list of Variables. - [GET /ng/api/variables](https://apidocs.harness.io/variables/getvariablelist.md) ### Updates the Variable. - [PUT /ng/api/variables](https://apidocs.harness.io/variables/updatevariable.md) ### Creates a Variable. - [POST /ng/api/variables](https://apidocs.harness.io/variables/createvariable.md) ### Get the Variable by scope identifiers and variable identifier. - [GET /ng/api/variables/{identifier}](https://apidocs.harness.io/variables/getvariable.md) ### Deletes Variable by ID. - [DELETE /ng/api/variables/{identifier}](https://apidocs.harness.io/variables/deletevariable.md) ### Get list of Variable by scope identifiers and variable identifiers. - [POST /ng/api/variables/list](https://apidocs.harness.io/variables/listvariable.md) ## Agent mTLS Endpoint Management Contains APIs related to Agent mTLS Endpoint management. ### Gets the agent mTLS endpoint for an account. - [GET /ng/api/agent/mtls/endpoint](https://apidocs.harness.io/agent-mtls-endpoint-management/getagentmtlsendpointforaccount.md) ### Updates the existing agent mTLS endpoint for an account. - [PUT /ng/api/agent/mtls/endpoint](https://apidocs.harness.io/agent-mtls-endpoint-management/updateagentmtlsendpointforaccount.md) ### Creates the agent mTLS endpoint for an account. - [POST /ng/api/agent/mtls/endpoint](https://apidocs.harness.io/agent-mtls-endpoint-management/createagentmtlsendpointforaccount.md) ### Removes the agent mTLS endpoint for an account. - [DELETE /ng/api/agent/mtls/endpoint](https://apidocs.harness.io/agent-mtls-endpoint-management/deleteagentmtlsendpointforaccount.md) ### Updates selected properties of the existing agent mTLS endpoint for an account. - [PATCH /ng/api/agent/mtls/endpoint](https://apidocs.harness.io/agent-mtls-endpoint-management/patchagentmtlsendpointforaccount.md) ### Checks whether a given agent mTLS endpoint domain prefix is available. - [GET /ng/api/agent/mtls/check-availability](https://apidocs.harness.io/agent-mtls-endpoint-management/checkagentmtlsendpointdomainprefixavailability.md) ## Delegate Download Resource Contains APIs related to Downloading Delegates ### Downloads a docker delegate yaml file. - [POST /ng/api/download-delegates/docker](https://apidocs.harness.io/delegate-download-resource/downloaddockerdelegateyaml.md) ### Downloads a kubernetes delegate yaml file. - [POST /ng/api/download-delegates/kubernetes](https://apidocs.harness.io/delegate-download-resource/downloadkubernetesdelegateyaml.md) ## Delegate Group Tags Resource Contains APIs related to Delegate Group Tags management ### Retrieves list of tags attached with Delegate group - [GET /ng/api/delegate-group-tags/{groupIdentifier}](https://apidocs.harness.io/delegate-group-tags-resource/listtagsfordelegategroup.md) ### Clears all existing tags with delegate group and attach given set of tags to delegate group. - [PUT /ng/api/delegate-group-tags/{groupIdentifier}](https://apidocs.harness.io/delegate-group-tags-resource/updatetagsofdelegategroup.md) ### Add given list of tags to the Delegate group - [POST /ng/api/delegate-group-tags/{groupIdentifier}](https://apidocs.harness.io/delegate-group-tags-resource/addtagstodelegategroup.md) ### Deletes all tags from the Delegate group - [DELETE /ng/api/delegate-group-tags/{groupIdentifier}](https://apidocs.harness.io/delegate-group-tags-resource/deletetagsfromdelegategroup.md) ### List delegate groups that are having mentioned tags. - [POST /ng/api/delegate-group-tags/delegate-groups](https://apidocs.harness.io/delegate-group-tags-resource/listdelegategroupsusingtags.md) ## Delegate Setup Resource Contains Delegate Setup APIs ### Deletes a Delegate by its identifier. - [DELETE /ng/api/delegate-setup/delegate/{delegateIdentifier}](https://apidocs.harness.io/delegate-setup-resource/deletedelegate.md) ### Delete delegate image tag override - [DELETE /ng/api/delegate-setup/delete-delegate-override](https://apidocs.harness.io/delegate-setup-resource/overridedelegateimagetag.md) ### Generates delegate terraform example module file from the account - [GET /ng/api/delegate-setup/delegate-terraform-module-file](https://apidocs.harness.io/delegate-setup-resource/generateterraformmodule.md) ### Generates helm values yaml file from the data specified in request body (Delegate setup details). - [POST /ng/api/delegate-setup/generate-helm-values](https://apidocs.harness.io/delegate-setup-resource/generatenghelmvaluesyaml.md) ### Lists all delegates overrides in NG filtered by provided conditions - [GET /ng/api/delegate-setup/override-delegate-tag](https://apidocs.harness.io/delegate-setup-resource/listoverridedelegateimagetag.md) ### Overrides delegate image tag for account - [PUT /ng/api/delegate-setup/override-delegate-tag](https://apidocs.harness.io/delegate-setup-resource/overridedelegateimagetag_1.md) ### Lists all delegates in NG filtered by provided conditions - [POST /ng/api/delegate-setup/listDelegates](https://apidocs.harness.io/delegate-setup-resource/listdelegates.md) ### 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) - [GET /ng/api/delegate-setup/latest-supported-version](https://apidocs.harness.io/delegate-setup-resource/publisheddelegateversion.md) ## Delegate Token Resource Contains APIs related to Delegate Token management ### Retrieves Delegate Tokens by Account, Organization, Project and status. - [GET /ng/api/delegate-token-ng](https://apidocs.harness.io/delegate-token-resource/getcgdelegatetokens.md) ### Revokes Delegate Token. - [PUT /ng/api/delegate-token-ng](https://apidocs.harness.io/delegate-token-resource/revokecgdelegatetoken.md) ### Creates Delegate Token. - [POST /ng/api/delegate-token-ng](https://apidocs.harness.io/delegate-token-resource/createdelegatetoken.md) ### Deletes a revoked Delegate Token. - [DELETE /ng/api/delegate-token-ng](https://apidocs.harness.io/delegate-token-resource/deletengdelegatetoken.md) ### Lists delegate groups that are using the specified delegate token. - [GET /ng/api/delegate-token-ng/delegate-groups](https://apidocs.harness.io/delegate-token-resource/getdelegategroupsusingtoken.md) ## Pipelines [Beta] This contains APIs for performing CRUD operations on Pipelines. ### List Pipelines - [GET /v1/orgs/{org}/projects/{project}/pipelines](https://apidocs.harness.io/pipelines/list-pipelines.md): Returns a list of Pipelines. ### Create a Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines](https://apidocs.harness.io/pipelines/create-pipeline.md): Creates a Pipeline. ### Retrieve a Pipeline - [GET /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}](https://apidocs.harness.io/pipelines/get-pipeline.md): Retrieves a Pipeline. ### Update a Pipeline - [PUT /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}](https://apidocs.harness.io/pipelines/update-pipeline.md): Updates a Pipeline. ### Delete a Pipeline - [DELETE /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}](https://apidocs.harness.io/pipelines/delete-pipeline.md): Deletes a Pipeline. ### Patch API for pipeline - [PATCH /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}](https://apidocs.harness.io/pipelines/patch-pipeline.md): Patch API for pipeline ### Start a Pipeline Validation Event - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate](https://apidocs.harness.io/pipelines/start-pipeline-validation-event.md): Starts a Pipeline Validation Event and returns the UUID of the Event created ### Get Pipeline Validation Result - [GET /v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}](https://apidocs.harness.io/pipelines/get-pipeline-validate-result.md): Get Pipeline Validation Result for given UUID ### Move Pipeline YAML from inline to remote - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config](https://apidocs.harness.io/pipelines/moveconfig.md): Creates a remote entity by fetching pipeline YAML from Harness. ### Get Pipeline YAML from Git Repository - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import](https://apidocs.harness.io/pipelines/importpipelinefromgit.md): Fetches Pipeline YAML from Git Repository and saves a record for it in Harness ### Update GitMetadata for Remote Pipelines - [PUT /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata](https://apidocs.harness.io/pipelines/update-pipeline-git-metadata.md): Update git-metadata in remote pipeline ### Get inputs schema details - [GET /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema](https://apidocs.harness.io/pipelines/get-inputs-schema-details.md) ## Input Sets [Beta] This contains APIs for Input Sets. ### Create an Input Set - [POST /v1/orgs/{org}/projects/{project}/input-sets](https://apidocs.harness.io/input-sets/create-input-set.md): Creates an Input Set for a Pipeline. ### List Input Sets - [GET /v1/orgs/{org}/projects/{project}/input-sets](https://apidocs.harness.io/input-sets/list-input-sets.md): Returns a List of Input Sets for a Pipeline. ### Retrieve an Input Set - [GET /v1/orgs/{org}/projects/{project}/input-sets/{input-set}](https://apidocs.harness.io/input-sets/get-input-set.md): Retrieves an Input Set for a Pipeline. ### Update an Input Set - [PUT /v1/orgs/{org}/projects/{project}/input-sets/{input-set}](https://apidocs.harness.io/input-sets/update-input-set.md): Updates an Input Set for a Pipeline. ### Delete an Input Set - [DELETE /v1/orgs/{org}/projects/{project}/input-sets/{input-set}](https://apidocs.harness.io/input-sets/delete-input-set.md): Deletes an Input Set for a Pipeline. ### Move InputSet YAML from inline to remote - [POST /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/move-config](https://apidocs.harness.io/input-sets/inputsetsmoveconfig.md): Creates a remote entity by fetching the input set YAML from Harness. ### Get Input Set YAML from Git Repository - [POST /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/import](https://apidocs.harness.io/input-sets/importinputsetfromgit.md): Fetches InputSet YAML from Git Repository and saves a record for it in Harness ### Update GitMetadata for Remote InputSet - [PUT /v1/orgs/{org}/projects/{project}/input-sets/{input-set}/git-metadata](https://apidocs.harness.io/input-sets/update-input-set-git-metadata.md): Update git-metadata in remote inputSet and return the updated inputSet ### merged-input-sets - [POST /v1/orgs/{org}/projects/{project}/input-sets/merge](https://apidocs.harness.io/input-sets/merged-input-sets.md): Gets merged input sets ## Approvals This contains APIs for Approvals. ### Gets Approval Instances by Execution Id - [GET /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}](https://apidocs.harness.io/approvals/getapprovalinstancesbyexecutionid.md): Gets Approval Instances by Execution Id [Beta] ### Approve or Reject an Execution by Pipeline Execution ID - [POST /v1/orgs/{org}/projects/{project}/approvals/execution/{execution-id}](https://apidocs.harness.io/approvals/addharnessapprovalactivitybypipelineexecutionid.md): Approve or Reject an Execution by Pipeline Execution ID [Beta] ### Approve or Reject a Pipeline Execution - [POST /pipeline/api/approvals/{approvalInstanceId}/harness/activity](https://apidocs.harness.io/approvals/addharnessapprovalactivity.md) ## Pipeline Execution [Beta] This contains APIs for Pipeline Execution. ### Execute Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute](https://apidocs.harness.io/pipeline-execution/execute-pipeline.md): Pipeline Execution API ### Rerun Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}](https://apidocs.harness.io/pipeline-execution/rerun-pipeline.md): Rerun Pipeline Execution ### Retry Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/retry/{execution-id}](https://apidocs.harness.io/pipeline-execution/retry-pipeline-with-inputset-pipeline-yaml.md): Retry a executed Pipeline with inputSet Pipeline yaml. ### Get Stages execution List for a given Pipeline execution. - [GET /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages-execution-list](https://apidocs.harness.io/pipeline-execution/get-stages-execution-list.md): Returns list of Stage identifiers with their names and stage dependencies ### Re-run Stages Execution of a Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}/stages](https://apidocs.harness.io/pipeline-execution/rerun-stages-execution-of-pipeline.md) ### Execute Pipeline with dynamic Input YAML - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/dynamic](https://apidocs.harness.io/pipeline-execution/rundynamicexecutionwithinputyaml.md): API for executing a dynamic pipeline input YAML. Refer to the developer documentation for detailed usage and configuration instructions https://developer.harness.io/docs/platform/pipelines/dynamic-execution-pipeline/#dynamic-execution-api ### Execute given Stages of a Pipeline - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages](https://apidocs.harness.io/pipeline-execution/execute-stages-with-input-yaml.md): Execute given Stages of a Pipeline with Input Yaml ## Pipeline Dashboard This contains APIs related to Pipeline Dashboard ### Fetch Execution Details for an Interval (deprecated) - [GET /pipeline/api/pipelines/pipelineExecution](https://apidocs.harness.io/pipeline-dashboard/getpipelineexecution.md): Returns Pipeline Execution Details for a Given Interval (Presented in Day Wise Format) ## Pipeline Input Set This contains APIs related to Input Sets ### List Input Sets - [GET /pipeline/api/inputSets](https://apidocs.harness.io/pipeline-input-set/listinputset.md): Lists all Input Sets for a Pipeline ### Create an Input Set - [POST /pipeline/api/inputSets](https://apidocs.harness.io/pipeline-input-set/postinputset.md): Creates an Input Set for a Pipeline ### Create an Overlay Input Set for a pipeline - [POST /pipeline/api/inputSets/overlay](https://apidocs.harness.io/pipeline-input-set/postoverlayinputset.md) ### Fetch an Input Set - [GET /pipeline/api/inputSets/{inputSetIdentifier}](https://apidocs.harness.io/pipeline-input-set/getinputset.md): Returns Input Set for a Given Identifier (Throws an Error if no Input Set Exists) ### Update an Input Set - [PUT /pipeline/api/inputSets/{inputSetIdentifier}](https://apidocs.harness.io/pipeline-input-set/putinputset.md): Updates the Input Set for a Pipeline ### Delete an Input Set - [DELETE /pipeline/api/inputSets/{inputSetIdentifier}](https://apidocs.harness.io/pipeline-input-set/deleteinputset.md): Deletes the Input Set by Identifier ### List regular Input Sets for multiple pipelines (excludes overlay input sets) - [POST /pipeline/api/inputSets/get/batch-input-sets-metadata](https://apidocs.harness.io/pipeline-input-set/getbatchinputsetsmetadata.md): Lists regular Input Sets for multiple pipelines (excludes overlay input sets). If pipeline identifiers are not provided, fetches all accessible input sets based on RBAC permissions. ### Get multiple input sets by identifiers (non-deleted only) - [POST /pipeline/api/inputSets/get/bulk](https://apidocs.harness.io/pipeline-input-set/getbulkinputsets.md): Gets multiple input sets by their identifiers for a specific pipeline. Only returns non-deleted input sets. ### Merge given Input Sets into a single Runtime Input YAML - [POST /pipeline/api/inputSets/merge](https://apidocs.harness.io/pipeline-input-set/mergeinputsets.md) ### Gets an Overlay Input Set by identifier - [GET /pipeline/api/inputSets/overlay/{inputSetIdentifier}](https://apidocs.harness.io/pipeline-input-set/getoverlayinputset.md) ### Update an Overlay Input Set for a pipeline - [PUT /pipeline/api/inputSets/overlay/{inputSetIdentifier}](https://apidocs.harness.io/pipeline-input-set/putoverlayinputset.md) ### Fetch Runtime Input Template - [POST /pipeline/api/inputSets/template](https://apidocs.harness.io/pipeline-input-set/runtimeinputtemplate.md): Returns Runtime Input Template for a Pipeline ### Update git-metadata in remote input-set - [PUT /pipeline/api/inputSets/{inputSetIdentifier}/update-git-metadata](https://apidocs.harness.io/pipeline-input-set/updateinputsetgitdetails.md): Update git-metadata in remote input-set and return the updated input-set ## Pipeline This contains pipeline APIs for files as provided as runtime input during pipeline execution ### Download file from GCS using filePath - [GET /pipeline/api/input-file/download-file](https://apidocs.harness.io/pipeline/downloadfileusingfilepath.md): Download file from GCS using filePath ### Returns a file uploaded or filtered based on the fileIdentifier provided for a given nodeExecutionId - [GET /pipeline/api/input-file/file/{planExecutionId}](https://apidocs.harness.io/pipeline/pipelinegetfile.md): Returns a file uploaded or filtered based on the fileIdentifier provided for a given nodeExecutionId ### Create/Update Pipeline Annotations - [POST /pipeline/api/pipelines/annotations](https://apidocs.harness.io/pipeline/createpipelineexecutionannotations.md): Creates or updates annotations for a pipeline execution. Called by lite-engine after step execution. ### Convert existing pipeline to DAG format - [POST /pipeline/api/pipelines/{pipelineIdentifier}/convert-to-dag](https://apidocs.harness.io/pipeline/convertpipelinetodag.md): Converts an existing sequential pipeline to DAG format by adding depends_on fields to stages ### Create a Pipeline - [POST /pipeline/api/pipelines/v2](https://apidocs.harness.io/pipeline/postpipelinev2.md): Creates a Pipeline ### Fetch a Pipeline - [GET /pipeline/api/pipelines/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/getpipeline.md): Returns a Pipeline by Identifier ### Delete a Pipeline - [DELETE /pipeline/api/pipelines/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/deletepipeline.md): Deletes a Pipeline by Identifier ### List Pipelines - [POST /pipeline/api/pipelines/list](https://apidocs.harness.io/pipeline/getpipelinelist.md): Returns List of Pipelines in the Given Project ### Fetch Pipeline Summary - [GET /pipeline/api/pipelines/summary/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/getpipelinesummary.md): Returns Pipeline Summary by Identifier ### Import and Create Pipeline from Git Repository - [POST /pipeline/api/pipelines/import](https://apidocs.harness.io/pipeline/importpipeline.md) ### Update git-metadata in remote pipeline Entity - [PUT /pipeline/api/pipelines/{pipelineIdentifier}/update-git-metadata](https://apidocs.harness.io/pipeline/updatepipelinegitdetails.md): Update git-metadata in remote pipeline and returns the identifier of updated pipeline ### Update a Pipeline - [PUT /pipeline/api/pipelines/v2/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/updatepipelinev2.md): Updates a Pipeline by Identifier ### Create a Pipeline (deprecated) - [POST /pipeline/api/pipelines](https://apidocs.harness.io/pipeline/postpipeline.md): Creates a Pipeline ### Update a Pipeline (deprecated) - [PUT /pipeline/api/pipelines/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/updatepipeline.md): Updates a Pipeline by Identifier ### Import and Create Pipeline from Git Repository (deprecated) - [POST /pipeline/api/pipelines/import/{pipelineIdentifier}](https://apidocs.harness.io/pipeline/importpipeline_1.md) ## Pipeline Execution Details This contains APIs for fetching Pipeline Execution Details ### Validate if Execution can be retried - [GET /pipeline/api/pipelines/execution/canRetry/{planExecutionId}](https://apidocs.harness.io/pipeline-execution-details/canretryexecution.md): Validates if an execution can be retried for a Given PlanExecution ID ### Fetch Full Annotation Content - [GET /pipeline/api/pipelines/execution/{planExecutionId}/annotations/{contextId}/content](https://apidocs.harness.io/pipeline-execution-details/getannotationfullcontent.md): Returns full annotation content for a specific context from GCS ### Fetch Execution Details - [GET /pipeline/api/pipelines/execution/v2/{planExecutionId}](https://apidocs.harness.io/pipeline-execution-details/getexecutiondetailv2.md): Returns the Pipeline Execution Details for a Given PlanExecution ID ### Fetch Execution Graph - [GET /pipeline/api/pipelines/execution/getExecutionGraph/{planExecutionId}](https://apidocs.harness.io/pipeline-execution-details/getexecutiongraph.md): Returns the Pipeline Execution Graph for a Given PlanExecution ID ### Fetch Execution SubGraph for a Given Retried StepGroup NodeExecution ID - [GET /pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId}](https://apidocs.harness.io/pipeline-execution-details/getexecutionsubgraphfornodeexecution.md): Returns the Pipeline Execution SubGraph for a Given Retried StepGroup NodeExecution ID ### Fetch Execution Url - [POST /pipeline/api/pipelines/execution/url](https://apidocs.harness.io/pipeline-execution-details/getexecutionurl.md): Returns the Pipeline Execution Url for a Given PlanExecution ID ### Get execution metadata of a pipeline execution - [GET /pipeline/api/pipelines/execution/{planExecutionId}/metadata](https://apidocs.harness.io/pipeline-execution-details/getexecutiondata.md) ### Get the Input Set YAML used for given Plan Execution - [GET /pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2](https://apidocs.harness.io/pipeline-execution-details/getinputsetyamlv2.md) ### Gets the policy evaluated used for given Plan Execution - [GET /pipeline/api/pipelines/execution/{planExecutionId}/policy-evaluation](https://apidocs.harness.io/pipeline-execution-details/getppolicyevaluation.md) ### List Execution Identifier - [POST /pipeline/api/pipelines/execution/executionSummary](https://apidocs.harness.io/pipeline-execution-details/getlistofexecutionidentifier.md): Returns a List of Pipeline Executions Identifier with Specific Filter ### List Executions - [POST /pipeline/api/pipelines/execution/summary](https://apidocs.harness.io/pipeline-execution-details/getlistofexecutions.md): Returns a List of Pipeline Executions with Specific Filter ### List Executions Outline - [POST /pipeline/api/pipelines/execution/summary/outline](https://apidocs.harness.io/pipeline-execution-details/getlistofexecutionsoutline.md): Returns a List of Pipeline Executions Outline given pipelineId or a list of executionIds ### Get Notes for a pipelineExecution - [GET /pipeline/api/pipelines/execution/{planExecutionId}/notes](https://apidocs.harness.io/pipeline-execution-details/getnotesforexecution.md) ### Updates Notes for a pipelineExecution - [PUT /pipeline/api/pipelines/execution/{planExecutionId}/notes](https://apidocs.harness.io/pipeline-execution-details/updatenotesforexecution.md) ### Fetch Pipeline Execution Annotations - [GET /pipeline/api/pipelines/execution/{planExecutionId}/annotations](https://apidocs.harness.io/pipeline-execution-details/getpipelineexecutionannotations.md): Returns annotations for a specific pipeline execution ### Get workflow graph for visualization - [GET /pipeline/api/pipelines/execution/{planExecutionId}/workflow-graph](https://apidocs.harness.io/pipeline-execution-details/getworkflowgraph.md): Returns the workflow graph for visualization ### Fetch Execution Details (deprecated) - [GET /pipeline/api/pipelines/execution/{planExecutionId}](https://apidocs.harness.io/pipeline-execution-details/getexecutiondetail.md): Returns the Pipeline Execution Details for a Given PlanExecution ID ## Pipeline Execute This contains APIs for Executing a Pipeline ### Retry History for a given execution - [GET /pipeline/api/pipeline/execute/retryHistory/{planExecutionId}](https://apidocs.harness.io/pipeline-execute/retryhistory.md) ### Execute an Interrupt - [PUT /pipeline/api/pipeline/execute/interrupt/{planExecutionId}](https://apidocs.harness.io/pipeline-execute/puthandleinterrupt.md): Executes an Interrupt on a Given Execution ### Marks the Manual Execution as fail or resume - [POST /pipeline/api/pipeline/execute/manual-execution/{nodeExecutionId}](https://apidocs.harness.io/pipeline-execute/markmanualexecution.md) ### Handles the interrupt for a given stage in a pipeline - [PUT /pipeline/api/pipeline/execute/interrupt/{planExecutionId}/{nodeExecutionId}](https://apidocs.harness.io/pipeline-execute/handlestageinterrupt.md) ### Retry a executed pipeline with inputSet pipeline yaml - [POST /pipeline/api/pipeline/execute/retry/{identifier}](https://apidocs.harness.io/pipeline-execute/retrypipeline.md) ### Retry a executed pipeline with Runtime Input YAML V2 - [POST /pipeline/api/pipeline/execute/retry/v2/{identifier}](https://apidocs.harness.io/pipeline-execute/retrypipelinev2.md): Retry a executed pipeline with Runtime Input YAML and Expression Values V2 ### Execute a Pipeline with Input Set References - [POST /pipeline/api/pipeline/execute/{identifier}/inputSetList](https://apidocs.harness.io/pipeline-execute/postpipelineexecutewithinputsetlist.md): Execute a Pipeline with Input Set References ### Execute a Pipeline with Runtime Input YAML - [POST /pipeline/api/pipeline/execute/{identifier}](https://apidocs.harness.io/pipeline-execute/postpipelineexecutewithinputsetyaml.md): Execute a Pipeline with Runtime Input YAML ### Execute given Stages of a Pipeline - [POST /pipeline/api/pipeline/execute/{identifier}/stages](https://apidocs.harness.io/pipeline-execute/postexecutestages.md) ## Pipeline Refresh This contains APIs related to validation of templates in pipeline yaml ### This recursively refresh and update template inputs in pipeline - [POST /pipeline/api/refresh-template/refresh-all](https://apidocs.harness.io/pipeline-refresh/refreshalltemplatesinputsinpipeline.md): This recursively refresh and update template inputs in pipeline ### Validates template inputs in a pipeline's YAML specification. - [GET /pipeline/api/refresh-template/validate-template-inputs](https://apidocs.harness.io/pipeline-refresh/validatetemplateinputs.md): Validates the template inputs in a pipeline's YAML specification. If the template inputs are invalid, the operation returns an error summary. ## Pipeline data retention This contains APIs related to retention of pipeline execution data ### Get retention period for pipeline executions - [GET /pipeline/api/pipelines/retention/{accountIdentifier}](https://apidocs.harness.io/pipeline-data-retention/getretentionperiodinmonths.md): Returns the retention period for pipeline executions based on accountId ## Triggers [Beta] This contains APIs for performing CRUD operations on Triggers. ### Create a Trigger - [POST /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers](https://apidocs.harness.io/triggers/create-trigger.md): Create a Trigger. ### Retrieve a Trigger - [GET /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}](https://apidocs.harness.io/triggers/get-trigger.md): Retrieve a Trigger. ### Update a Trigger - [PUT /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}](https://apidocs.harness.io/triggers/update-trigger.md): Updates a Trigger. ### Delete a Trigger - [DELETE /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger}](https://apidocs.harness.io/triggers/delete-trigger.md): Deletes a Trigger. ### Gets the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier. - [GET /pipeline/api/triggers](https://apidocs.harness.io/triggers/getlistfortarget.md) ### Creates Trigger for triggering target pipeline identifier. - [POST /pipeline/api/triggers](https://apidocs.harness.io/triggers/createtrigger.md) ### Creates Trigger with executor identity in request body (v2 API). - [POST /pipeline/api/triggers/v2](https://apidocs.harness.io/triggers/createtriggerv2.md) ### Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier. - [GET /pipeline/api/triggers/{triggerIdentifier}](https://apidocs.harness.io/triggers/gettrigger.md) ### Updates trigger for pipeline with target pipeline identifier. - [PUT /pipeline/api/triggers/{triggerIdentifier}](https://apidocs.harness.io/triggers/updatetrigger.md) ### Deletes Trigger by identifier. - [DELETE /pipeline/api/triggers/{triggerIdentifier}](https://apidocs.harness.io/triggers/deletetrigger.md) ### Get list of users and service accounts eligible to execute trigger - [GET /pipeline/api/triggers/eligible-executors](https://apidocs.harness.io/triggers/geteligibletriggerexecutors.md): Returns a list of users and service accounts who have permission to execute the specified pipeline. For normal users, returns only themselves. For admins, returns all eligible executors in the scope. ### Lists all Triggers - [GET /pipeline/api/triggers/catalog](https://apidocs.harness.io/triggers/gettriggercatalog.md): Lists all the Triggers for the given Account ID. ### Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier. - [GET /pipeline/api/triggers/{triggerIdentifier}/details](https://apidocs.harness.io/triggers/gettriggerdetails.md) ### Updates trigger with executor identity in request body (v2 API). - [PUT /pipeline/api/triggers/{triggerIdentifier}/v2](https://apidocs.harness.io/triggers/updatetriggerv2.md) ### Get event history for a trigger (deprecated) - [GET /pipeline/api/triggers/{triggerIdentifier}/eventHistory](https://apidocs.harness.io/triggers/triggereventhistory.md): Get event history for a trigger ## TriggersEvents This contains APIs related to Trigger Event History. ### Get all the polled response for a given trigger - [GET /pipeline/api/triggers/eventHistory/polledResponse/{triggerIdentifier}](https://apidocs.harness.io/triggersevents/polledresponsetriggeridentifier.md): Get all the polled response for a given trigger ### Get event history for a trigger - [GET /pipeline/api/triggers/eventHistory/{triggerIdentifier}](https://apidocs.harness.io/triggersevents/triggereventhistorynew.md): Get event history for a trigger ### Get event history for a trigger using filters. - [GET /pipeline/api/triggers/eventHistory/events](https://apidocs.harness.io/triggersevents/triggereventhistoryusingfilters.md): Get event history for a trigger using filters. ### Get Trigger history event correlation - [GET /pipeline/api/triggers/eventHistory/eventCorrelation/{eventCorrelationId}](https://apidocs.harness.io/triggersevents/triggerhistoryeventcorrelation.md): Get Trigger history event correlation ### Get Trigger history event correlation V2 - [GET /pipeline/api/triggers/eventHistory/v2/eventCorrelation/{eventCorrelationId}](https://apidocs.harness.io/triggersevents/triggerhistoryeventcorrelationv2.md): Get Trigger history event correlation V2 ### Get artifact and manifest trigger event history based on build source type - [GET /pipeline/api/triggers/eventHistory/artifact-manifest-info](https://apidocs.harness.io/triggersevents/triggereventhistorybuildsourcetype.md): Get artifact and manifest trigger event history based on build source type ## Webhook Triggers This contains APIs related to Webhook Triggers. ### Gets webhook event processing details for input eventId. - [GET /pipeline/api/webhook/triggerProcessingDetails](https://apidocs.harness.io/webhook-triggers/fetchwebhookdetails.md) ### Gets webhook event processing details for input eventId. - [GET /pipeline/api/webhook/triggerExecutionDetails/{eventId}](https://apidocs.harness.io/webhook-triggers/fetchwebhookexecutiondetails.md) ### Gets webhook event processing details for input eventId when the trigger is queued and has not triggered the pipeline yet. - [GET /pipeline/api/webhook/triggerExecutionDetailsV2/{eventId}](https://apidocs.harness.io/webhook-triggers/fetchwebhookexecutiondetailsv2.md) ### Handles event payload for webhook triggers. - [POST /pipeline/api/webhook/trigger](https://apidocs.harness.io/webhook-triggers/pipelineprocesswebhookevent.md) ### Handles event payload for custom webhook triggers. - [POST /pipeline/api/webhook/custom](https://apidocs.harness.io/webhook-triggers/processcustomwebhookevent.md) ### Handles event payload for custom webhook triggers. - [POST /pipeline/api/webhook/custom/v2](https://apidocs.harness.io/webhook-triggers/processcustomwebhookeventv2.md) ### Handles event payload for custom webhook triggers. - [POST /pipeline/api/webhook/custom/{webhookToken}/v3](https://apidocs.harness.io/webhook-triggers/processcustomwebhookeventv3.md) ## Webhook Event Handler Contains APIs corresponding to Webhook Triggers. ### Process event payload for webhook triggers. - [POST /ng/api/webhook](https://apidocs.harness.io/webhook-event-handler/processwebhookevent.md) ## Registries APIs to create, update, list registries ### Create Registry. - [POST /har/api/v1/registry](https://apidocs.harness.io/registries/createregistry.md): Create a Registry. ### Delete a Registry - [DELETE /har/api/v1/registry/{registry_ref}](https://apidocs.harness.io/registries/deleteregistry.md): Delete a Registry in the account for the given key ### Returns Registry Details - [GET /har/api/v1/registry/{registry_ref}](https://apidocs.harness.io/registries/getregistry.md): Returns Registry Details in the account for the given key ### Updates a Registry - [PUT /har/api/v1/registry/{registry_ref}](https://apidocs.harness.io/registries/modifyregistry.md): Updates a Registry in the account for the given key ### List Artifacts for Registry - [GET /har/api/v1/registry/{registry_ref}/artifacts](https://apidocs.harness.io/registries/getallartifactsbyregistry.md): Lists all the Artifacts for Registry ### Returns CLI Client Setup Details - [GET /har/api/v1/registry/{registry_ref}/client-setup-details](https://apidocs.harness.io/registries/getclientsetupdetails.md): Returns CLI Client Setup Details based on package type ## Artifacts APIs to get, list artifacts ### Redirect to Harness Artifact Page - [GET /har/api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect](https://apidocs.harness.io/artifacts/redirectharnessartifact.md): Redirect to Harness Artifact Page ### Delete Artifact - [DELETE /har/api/v1/registry/{registry_ref}/artifact/{artifact}](https://apidocs.harness.io/artifacts/deleteartifact.md): Delete Artifact. ### Update Artifact Labels - [PUT /har/api/v1/registry/{registry_ref}/artifact/{artifact}/labels](https://apidocs.harness.io/artifacts/updateartifactlabels.md): Update Artifact Labels. ### Get Artifact Stats - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/stats](https://apidocs.harness.io/artifacts/getartifactstats.md): Get Artifact Stats. ### Get Artifact Summary - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/summary](https://apidocs.harness.io/artifacts/getartifactsummary.md): Get Artifact Summary. ### List OCI Artifact tags - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/tags](https://apidocs.harness.io/artifacts/getociartifacttags.md): Lists OCI Artifact Tags. ### Delete an Artifact Version - [DELETE /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}](https://apidocs.harness.io/artifacts/deleteartifactversion.md): Delete Artifact Version. ### Create a bulk download request - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download](https://apidocs.harness.io/artifacts/createbulkdownloadrequestv1.md): Create a bulk download request ### Describe Artifact Deployments - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails](https://apidocs.harness.io/artifacts/getartifactdeployments.md): Get Artifact Deployments ### Describe Artifact Details - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details](https://apidocs.harness.io/artifacts/getartifactdetails.md): Get Artifact Details ### Get Artifact file - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name}](https://apidocs.harness.io/artifacts/getartifactfile.md): just validate existence of Artifact file ### Describe Artifact files - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files](https://apidocs.harness.io/artifacts/getartifactfiles.md): Get Artifact files ### Get Artifact Version Summary - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary](https://apidocs.harness.io/artifacts/getartifactversionsummary.md): Get Artifact Version Summary. ### List Artifact Versions - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/versions](https://apidocs.harness.io/artifacts/getallartifactversions.md): Lists all the Artifact Versions. ### List Artifact Labels - [GET /har/api/v1/registry/{registry_ref}/artifact/labels](https://apidocs.harness.io/artifacts/listartifactlabels.md): List Artifact Labels. ### Get Artifact Stats - [GET /har/api/v1/registry/{registry_ref}/artifact/stats](https://apidocs.harness.io/artifacts/getartifactstatsforregistry.md): Get Artifact Stats. ## Docker Artifacts APIs to get details of docker artifacts ### Describe Docker Artifact Detail - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/details](https://apidocs.harness.io/docker-artifacts/getdockerartifactdetails.md): Get Docker Artifact Details ### Describe Docker Artifact Integration Detail - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/integrationdetails](https://apidocs.harness.io/docker-artifacts/getdockerartifactintegrationdetails.md): Get Docker Artifact Integration Details ### Describe Docker Artifact Layers - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/layers](https://apidocs.harness.io/docker-artifacts/getdockerartifactlayers.md): Get Docker Artifact Layers ### Describe Docker Artifact Manifest - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifest](https://apidocs.harness.io/docker-artifacts/getdockerartifactmanifest.md): Get Docker Artifact Manifest ### Describe Docker Artifact Manifests - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/docker/manifests](https://apidocs.harness.io/docker-artifacts/getdockerartifactmanifests.md): Get Docker Artifact Manifests ## Helm Artifacts APIs to get details of helm artifacts ### Describe Helm Artifact Detail - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/details](https://apidocs.harness.io/helm-artifacts/gethelmartifactdetails.md): Get Helm Artifact Details ### Describe Helm Artifact Manifest - [GET /har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/helm/manifest](https://apidocs.harness.io/helm-artifacts/gethelmartifactmanifest.md): Get Helm Artifact Manifest ## quarantine ### deleteQuarantineFilePath - [DELETE /har/api/v1/registry/{registry_ref}/quarantine](https://apidocs.harness.io/quarantine/deletequarantinefilepath.md): delete Quarantine file path ### quarantineFilePath - [PUT /har/api/v1/registry/{registry_ref}/quarantine](https://apidocs.harness.io/quarantine/quarantinefilepath.md): quarantine file path ## Webhooks APIs to create, update, list webhooks ### ListWebhooks - [GET /har/api/v1/registry/{registry_ref}/webhooks](https://apidocs.harness.io/webhooks/listwebhooks.md): Returns List of Webhook Details ### CreateWebhook - [POST /har/api/v1/registry/{registry_ref}/webhooks](https://apidocs.harness.io/webhooks/createwebhook.md): Returns Webhook Details ### DeleteWebhook - [DELETE /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhooks/deletewebhook.md): Delete a Webhook ### GetWebhook - [GET /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhooks/getwebhook.md): Returns Webhook Details ### UpdateWebhook - [PUT /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhooks/updatewebhook.md): Returns Webhook Details ### ListWebhookExecutions - [GET /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions](https://apidocs.harness.io/webhooks/listwebhookexecutions.md): Returns Webhook Execution Details List ### GetWebhookExecution - [GET /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}](https://apidocs.harness.io/webhooks/getwebhookexecution.md): Returns Webhook Execution Details ### ReTriggerWebhookExecution - [GET /har/api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger](https://apidocs.harness.io/webhooks/retriggerwebhookexecution.md): Retrigger Webhook Execution ## Spaces ### Get artifact stats - [GET /har/api/v1/spaces/{space_ref}/artifact/stats](https://apidocs.harness.io/spaces/getartifactstatsforspace.md): Get artifact stats ### List artifacts - [GET /har/api/v1/spaces/{space_ref}/artifacts](https://apidocs.harness.io/spaces/getallartifacts.md): Lists all the artifacts ### Get storage details for given space - [GET /har/api/v1/spaces/{space_ref}/details](https://apidocs.harness.io/spaces/getstoragedetails.md): Get storage details for given space ### RegistrylistSpaceLabels - [GET /har/api/v1/spaces/{space_ref}/labels](https://apidocs.harness.io/spaces/registrylistspacelabels.md) ### RegistrydefineSpaceLabel - [POST /har/api/v1/spaces/{space_ref}/labels](https://apidocs.harness.io/spaces/registrydefinespacelabel.md) ### RegistrysaveSpaceLabel - [PUT /har/api/v1/spaces/{space_ref}/labels](https://apidocs.harness.io/spaces/registrysavespacelabel.md) ### RegistrydeleteSpaceLabel - [DELETE /har/api/v1/spaces/{space_ref}/labels/{key}](https://apidocs.harness.io/spaces/registrydeletespacelabel.md) ### findSpaceLabel - [GET /har/api/v1/spaces/{space_ref}/labels/{key}](https://apidocs.harness.io/spaces/findspacelabel.md) ### RegistryupdateSpaceLabel - [PATCH /har/api/v1/spaces/{space_ref}/labels/{key}](https://apidocs.harness.io/spaces/registryupdatespacelabel.md) ### RegistrylistSpaceLabelValues - [GET /har/api/v1/spaces/{space_ref}/labels/{key}/values](https://apidocs.harness.io/spaces/registrylistspacelabelvalues.md) ### RegistrydefineSpaceLabelValue - [POST /har/api/v1/spaces/{space_ref}/labels/{key}/values](https://apidocs.harness.io/spaces/registrydefinespacelabelvalue.md) ### RegistrydeleteSpaceLabelValue - [DELETE /har/api/v1/spaces/{space_ref}/labels/{key}/values/{value}](https://apidocs.harness.io/spaces/registrydeletespacelabelvalue.md) ### RegistryupdateSpaceLabelValue - [PATCH /har/api/v1/spaces/{space_ref}/labels/{key}/values/{value}](https://apidocs.harness.io/spaces/registryupdatespacelabelvalue.md) ### List registries - [GET /har/api/v1/spaces/{space_ref}/registries](https://apidocs.harness.io/spaces/getallregistries.md): Lists all the registries. ## Replication ### List replication rules - [GET /har/api/v1/replication/rules](https://apidocs.harness.io/replication/listreplicationrules.md): List all replication rules ### Create a replication rule - [POST /har/api/v1/replication/rules](https://apidocs.harness.io/replication/createreplicationrule.md): Create a replication rule ### Delete a replication rule - [DELETE /har/api/v1/replication/rules/{id}](https://apidocs.harness.io/replication/deletereplicationrule.md): Delete a replication rule ### Get a replication rule - [GET /har/api/v1/replication/rules/{id}](https://apidocs.harness.io/replication/getreplicationrule.md): Get a replication rule ### Update a replication rule - [PUT /har/api/v1/replication/rules/{id}](https://apidocs.harness.io/replication/updatereplicationrule.md): Update a replication rule ### List migration images - [GET /har/api/v1/replication/rules/{id}/migration/images](https://apidocs.harness.io/replication/listmigrationimages.md): List migration images given an id ### Get migration logs for an image - [GET /har/api/v1/replication/rules/{id}/migration/images/{image_id}/logs](https://apidocs.harness.io/replication/getmigrationlogsforimage.md) ### Start migration - [POST /har/api/v1/replication/rules/{id}/migration/start](https://apidocs.harness.io/replication/startmigration.md): Start migration given an id ### Stop migration - [POST /har/api/v1/replication/rules/{id}/migration/stop](https://apidocs.harness.io/replication/stopmigration.md): Stop migration given an id ## Registry V3 - Registries V3 registries endpoints ### List registries - [GET /har/api/v3/registries](https://apidocs.harness.io/registry-v3-registries/listregistriesv3.md): Lists registries. ### Delete a Registry - [DELETE /har/api/v3/registries/{id}](https://apidocs.harness.io/registry-v3-registries/deleteregistryv3.md): Delete a registry (soft or hard delete based on deleteType parameter) ### Get Registry Metadata - [GET /har/api/v3/registries/{id}/metadata](https://apidocs.harness.io/registry-v3-registries/getregistrymetadatav3.md): Retrieves all metadata for a registry. ### Upsert Registry Metadata - [POST /har/api/v3/registries/{id}/metadata](https://apidocs.harness.io/registry-v3-registries/upsertregistrymetadatav3.md): Creates or overwrites metadata for a registry. ### Replace Registry Metadata - [PUT /har/api/v3/registries/{id}/metadata](https://apidocs.harness.io/registry-v3-registries/saveregistrymetadatav3.md): Replaces all metadata for a registry. ### Migrate Generic Registry to Raw Registry - [POST /har/api/v3/registries/{id}/migrate](https://apidocs.harness.io/registry-v3-registries/migrateregistryv3.md): Migrate a generic registry to raw registry type. This will change the registry type from GENERIC to RAW and delete all images associated with the registry. ### Restore a Soft-Deleted Registry - [POST /har/api/v3/registries/{id}/restore](https://apidocs.harness.io/registry-v3-registries/restoreregistryv3.md): Restore a previously soft-deleted registry by ID ## Registry V3 - Packages V3 packages endpoints ### List Packages - [GET /har/api/v3/packages](https://apidocs.harness.io/registry-v3-packages/listpackagesv3.md): Lists Packages ### Delete a Package - [DELETE /har/api/v3/packages/{id}](https://apidocs.harness.io/registry-v3-packages/deletepackagev3.md): Delete a package/image ### Get Package Metadata - [GET /har/api/v3/packages/{id}/metadata](https://apidocs.harness.io/registry-v3-packages/getpackagemetadatav3.md): Retrieves all metadata for a package. ### Upsert Package Metadata - [POST /har/api/v3/packages/{id}/metadata](https://apidocs.harness.io/registry-v3-packages/upsertpackagemetadatav3.md): Creates or overwrites metadata for a package. ### Replace Package Metadata - [PUT /har/api/v3/packages/{id}/metadata](https://apidocs.harness.io/registry-v3-packages/savepackagemetadatav3.md): Replaces all metadata for a package. ### Restore a Soft-Deleted Package - [POST /har/api/v3/packages/{id}/restore](https://apidocs.harness.io/registry-v3-packages/restorepackagev3.md): Restore a previously soft-deleted package/image by ID ## Registry V3 - Versions V3 versions endpoints ### List versions of packages - [GET /har/api/v3/versions](https://apidocs.harness.io/registry-v3-versions/listversionsv3.md): Lists versions of packages ### Delete a Version - [DELETE /har/api/v3/versions/{id}](https://apidocs.harness.io/registry-v3-versions/deleteversionv3.md): Delete a version (soft or hard delete based on deleteType parameter) ### Get Version Metadata - [GET /har/api/v3/versions/{id}/metadata](https://apidocs.harness.io/registry-v3-versions/getversionmetadatav3.md): Retrieves all metadata for a version. ### Upsert Version Metadata - [POST /har/api/v3/versions/{id}/metadata](https://apidocs.harness.io/registry-v3-versions/upsertversionmetadatav3.md): Creates or overwrites metadata for a version. ### Replace Version Metadata - [PUT /har/api/v3/versions/{id}/metadata](https://apidocs.harness.io/registry-v3-versions/saveversionmetadatav3.md): Replaces all metadata for a version. ### Restore a Soft-Deleted Version - [POST /har/api/v3/versions/{id}/restore](https://apidocs.harness.io/registry-v3-versions/restoreversionv3.md): Restore a previously soft-deleted version by ID ### Add tags to version of package - [POST /har/api/v3/versions/{id}/tags](https://apidocs.harness.io/registry-v3-versions/addversiontagsv3.md): Add tags to version of package. Currently supported for only OCI package. ### Rebuild metadata for all versions in a registry - [POST /har/api/v3/versions/rebuild-metadata](https://apidocs.harness.io/registry-v3-versions/rebuildversionmetadatav3.md): Trigger metadata rebuild for all versions in a registry ## Registry V3 - Files V3 files endpoints ### Search Files - [GET /har/api/v3/files](https://apidocs.harness.io/registry-v3-files/listfilesv3.md): List files. ### Download file using file id - [GET /har/api/v3/files/{id}/content](https://apidocs.harness.io/registry-v3-files/getfilev3.md): Download file using id ### Get File Metadata - [GET /har/api/v3/files/{id}/metadata](https://apidocs.harness.io/registry-v3-files/getfilemetadatav3.md): Retrieves all metadata for a file. ### Upsert File Metadata - [POST /har/api/v3/files/{id}/metadata](https://apidocs.harness.io/registry-v3-files/upsertfilemetadatav3.md): Creates or overwrites metadata for a file. ### Replace File Metadata - [PUT /har/api/v3/files/{id}/metadata](https://apidocs.harness.io/registry-v3-files/savefilemetadatav3.md): Replaces all metadata for a file. ## Registry V3 - Metadata V3 metadata endpoints ### Delete Metadata - [DELETE /har/api/v3/metadata/{id}](https://apidocs.harness.io/registry-v3-metadata/deletemetadatav3.md): Delete metadata key-value pairs by ID of metadata ### Get Metadata Keys - [GET /har/api/v3/metadata/keys](https://apidocs.harness.io/registry-v3-metadata/getmetadatakeysv3.md): Retrieve a paginated list of all available metadata keys. ### Get Metadata Values - [GET /har/api/v3/metadata/values](https://apidocs.harness.io/registry-v3-metadata/getmetadatavaluesv3.md): Retrieve all possible values for a specific metadata key. ## Registry V3 - Firewall V3 firewall endpoints ### Add build info - [POST /har/api/v3/build-info](https://apidocs.harness.io/registry-v3-firewall/addbuildinfov3.md): Adds build info generated by CLI after package installation. ### List pipeline build info details - [GET /har/api/v3/build-info/pipeline/details](https://apidocs.harness.io/registry-v3-firewall/listpipelinebuildinfodetailsv3.md): Returns all pipeline build info details. ### Get the list of artifact scan result for a particular scope - [GET /har/api/v3/scans](https://apidocs.harness.io/registry-v3-firewall/getartifactscansv3.md): Get the list of artifact scan result for a particular scope ### Get the details of a artifact scan - [GET /har/api/v3/scans/{id}/details](https://apidocs.harness.io/registry-v3-firewall/getartifactscandetailsv3.md): Get the details of a artifact scan ### Initiate bulk scan evaluation - [POST /har/api/v3/scans/bulk-evaluate](https://apidocs.harness.io/registry-v3-firewall/initiatebulkscanevaluationv3.md): Triggers firewall policy evaluation for multiple artifacts ### Get bulk scan evaluation status - [GET /har/api/v3/scans/bulk-evaluate/{evaluation_id}](https://apidocs.harness.io/registry-v3-firewall/getbulkscanevaluationstatusv3.md): Returns the status of a bulk scan evaluation ### Re-evaluate artifact scan - [POST /har/api/v3/scans/evaluate](https://apidocs.harness.io/registry-v3-firewall/evaluateartifactscanv3.md): Re-evaluate artifact scan ### List firewall exceptions - [GET /har/api/v3/scans/exceptions](https://apidocs.harness.io/registry-v3-firewall/listfirewallexceptionsv3.md): List firewall exceptions with optional filters ### Create a firewall exception - [POST /har/api/v3/scans/exceptions](https://apidocs.harness.io/registry-v3-firewall/createfirewallexceptionv3.md): Create a firewall exception for an artifact ### Delete a firewall exception - [DELETE /har/api/v3/scans/exceptions/{id}](https://apidocs.harness.io/registry-v3-firewall/deletefirewallexceptionv3.md): Delete a firewall exception by ID ### Update a firewall exception - [PUT /har/api/v3/scans/exceptions/{id}](https://apidocs.harness.io/registry-v3-firewall/updatefirewallexceptionv3.md): Update a firewall exception. Only allowed when status is PENDING. ### Update status of a firewall exception - [PUT /har/api/v3/scans/exceptions/{id}/status](https://apidocs.harness.io/registry-v3-firewall/updatestatusfirewallexceptionv3.md): Update the status of a firewall exception (approve or reject) ### List versions for firewall exceptions - [GET /har/api/v3/scans/versions](https://apidocs.harness.io/registry-v3-firewall/listfirewallexceptionversionsv3.md): List versions for a specific package in a registry, for use when creating firewall exceptions ## Registry V3 - Transfer V3 transfer endpoints ### Create a bulk download request - [POST /har/api/v3/bulk-download](https://apidocs.harness.io/registry-v3-transfer/createbulkdownloadrequestv3.md): Create a bulk download request ### Get bulk download request status - [GET /har/api/v3/bulk-download/{id}](https://apidocs.harness.io/registry-v3-transfer/getbulkdownloadrequeststatusv3.md): Get bulk download request status ### Copy resources - [POST /har/api/v3/copy](https://apidocs.harness.io/registry-v3-transfer/copyresourcesv3.md): Copy resources ## Database Schema This contains APIs for performing CRUD operations on Database Schema Entity ### List Database Schemas for an Account across Projects with optional Project filtering - [GET /v1/dbops/dbschema](https://apidocs.harness.io/database-schema/v1listdatabaseschema.md): List database schemas for an account ### List database schemas - [GET /v1/orgs/{org}/projects/{project}/dbschema](https://apidocs.harness.io/database-schema/v1listprojdbschema.md): List database Schemas ### Create a database schema - [POST /v1/orgs/{org}/projects/{project}/dbschema](https://apidocs.harness.io/database-schema/v1createprojdbschema.md): Create a database schema ### Delete a database schema - [DELETE /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}](https://apidocs.harness.io/database-schema/v1deleteprojdbschema.md): Delete a database schema ### Get a database schema - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}](https://apidocs.harness.io/database-schema/v1getprojdbschema.md): Retrieves the specified database schema ### Update a database schema - [PUT /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}](https://apidocs.harness.io/database-schema/v1updateprojdbschema.md): Update a database schema ### Update a database instance - [PUT /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}](https://apidocs.harness.io/database-schema/v1updateprojdbschemainstance.md): Update a database instance ## Database Instance This contains APIs for performing CRUD operations on Database Instance Entity ### Get default authoring instance - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/default-authoring-instance](https://apidocs.harness.io/database-instance/v1getdefaultauthoringinstance.md): Returns the best instance for LLM change authoring. Selects the oldest instance with a metadata snapshot; falls back to the oldest instance overall if none have a snapshot. ### Create a database instance - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance](https://apidocs.harness.io/database-instance/v1createprojdbschemainstance.md): Create a database instance ### Delete a database instance - [DELETE /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}](https://apidocs.harness.io/database-instance/v1deleteprojdbschemainstance.md): Delete a database instance ### Get a database instance - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}](https://apidocs.harness.io/database-instance/v1getprojdbschemainstance.md): Retrieves the specified database instance ### List database instances - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instancelist](https://apidocs.harness.io/database-instance/v1listprojdbschemainstance.md): Retrieves the specified database instances of the database schema ## Deployed State This contains APIs for tracking changeSet deployment status ### Get Deployed State - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/deployedState](https://apidocs.harness.io/deployed-state/v1getdeployedstate.md): Status of changeset deployment as part of execution with comparison to earlier state. ## Execution Config This contains APIs for execution config for image tags ### Delete Execution config for DBOps - [DELETE /v1/dbops/execution-config](https://apidocs.harness.io/execution-config/v1deleteexecutionconfig.md): Delete the Execution config overrides for the customer ### Get Customer Execution Config overrides - [GET /v1/dbops/execution-config/get-customer-config](https://apidocs.harness.io/execution-config/v1getcustomerconfig.md) ### Get Default Execution Config - [GET /v1/dbops/execution-config/get-default-config](https://apidocs.harness.io/execution-config/v1getdefaultconfig.md): Get list of the latest Harness Dbops images and tags ### Reset execution Config for DBOPs image tags - [POST /v1/dbops/execution-config/reset-config](https://apidocs.harness.io/execution-config/v1resetexecutionconfig.md): To reset one or more images to their defaults with a list of the images to reset. ### Override execution Config for DBOPs image tags - [POST /v1/dbops/execution-config/update-config](https://apidocs.harness.io/execution-config/v1updateexecutionconfig.md): Override execution Config for DBOPs image tags ## Migration State This contains APIs for getting Migration State of Database Schema Entity ### Fetch SQL changesets of a instance - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/sql](https://apidocs.harness.io/migration-state/v1fetchdeployedchangesetsql.md): Fetch SQL changesets ### ChangeSet deployment yaml for an instance - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/yaml](https://apidocs.harness.io/migration-state/v1changesetyamlprojdbinstance.md) ### Flyway Migration state of an instance - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/flyway/migrationstate](https://apidocs.harness.io/migration-state/v1migrationstateflywayinstance.md): Flyway Migration state of an instance ### Migration state of a instance - [GET /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migrationstate](https://apidocs.harness.io/migration-state/v1migrationstateprojdbinstance.md): Migration state of a instance ### Migration state of a flyway schema - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/flyway/migrationstate](https://apidocs.harness.io/migration-state/v1migrationstateflywayschema.md): Migration state of a flyway schema ### Migration state of a schema - [POST /v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/migrationstate](https://apidocs.harness.io/migration-state/v1migrationstateprojdbschema.md): Migration state of a schema ## K8s Release Service Mapping [Beta] This contains APIs for Fetching Release details regarding a pod. ### List service and environment details using namespace and releasename - [GET /v1/kubernetes/releases/service-mapping](https://apidocs.harness.io/k8s-release-service-mapping/get-v1-releasedetails.md): Return details of service and environment mapped to pods namespace and release-name for a given account. ### List service and environment details using namespace and releasename - [POST /v1/kubernetes/releases/service-mapping](https://apidocs.harness.io/k8s-release-service-mapping/post-v1-releasedetails.md): Return details of service and environment mapped to pods namespace and release-name for a given account. ## CustomDeployment This contains APIs related to Custom Deployment ### Gets Custom Deployment Entity References - [POST /ng/api/customDeployment/get-references](https://apidocs.harness.io/customdeployment/getcustomdeploymententityreferences.md) ### Gets Custom Deployment Expression Variables - [POST /ng/api/customDeployment/expression-variables](https://apidocs.harness.io/customdeployment/getcustomdeploymentexpressionvariables.md) ### Gets Infra Variables from a Custom Deployment Template by identifier - [GET /ng/api/customDeployment/variables/{templateIdentifier}](https://apidocs.harness.io/customdeployment/getcustomdeploymentinfravariables.md) ### Return the updated yaml for infrastructure based on Deployment template - [POST /ng/api/customDeployment/get-updated-Yaml/{infraIdentifier}](https://apidocs.harness.io/customdeployment/getupdatedyamlforinfrastructure.md) ### This validates whether Infrastructure is valid or not - [GET /ng/api/customDeployment/validate-infrastructure/{infraIdentifier}](https://apidocs.harness.io/customdeployment/validateinfrastructurefordeploymenttemplate.md) ## Environments This contains APIs related to Environments ### Check for allowed-values in the Environments - [POST /ng/api/environmentsV2/check-allowed-values](https://apidocs.harness.io/environments/checkallowedvaluesinenvs.md) ### Gets Environment list for a project - [GET /ng/api/environmentsV2](https://apidocs.harness.io/environments/getenvironmentlist.md) ### Update an Environment by identifier - [PUT /ng/api/environmentsV2](https://apidocs.harness.io/environments/updateenvironmentv2.md) ### Create an Environment - [POST /ng/api/environmentsV2](https://apidocs.harness.io/environments/createenvironmentv2.md) ### Create Environments in batch with partial success support - [POST /ng/api/environmentsV2/batch](https://apidocs.harness.io/environments/createenvironmentsv2.md) ### Gets an Environment by identifier - [GET /ng/api/environmentsV2/{environmentIdentifier}](https://apidocs.harness.io/environments/getenvironmentv2.md) ### Delete an Environment by identifier - [DELETE /ng/api/environmentsV2/{environmentIdentifier}](https://apidocs.harness.io/environments/deleteenvironmentv2.md) ### Gets Service Overrides list - [GET /ng/api/environmentsV2/serviceOverrides](https://apidocs.harness.io/environments/getserviceoverrideslist.md) ### upsert a Service Override for an Environment - [POST /ng/api/environmentsV2/serviceOverrides](https://apidocs.harness.io/environments/upsertserviceoverride.md) ### Delete a ServiceOverride entity - [DELETE /ng/api/environmentsV2/serviceOverrides](https://apidocs.harness.io/environments/deleteserviceoverride.md) ### Import and Create Environment from Git Repository - [POST /ng/api/environmentsV2/import](https://apidocs.harness.io/environments/importenvironment.md) ### Gets Environment Access list - [GET /ng/api/environmentsV2/list/access](https://apidocs.harness.io/environments/getenvironmentaccesslist.md) ### Move environment YAML from inline to remote - [POST /ng/api/environmentsV2/move-config/{environmentIdentifier}](https://apidocs.harness.io/environments/moveenvironmentconfigs.md) ### Update git-metadata in remote environment Entity - [PUT /ng/api/environmentsV2/{environmentIdentifier}/update-git-metadata](https://apidocs.harness.io/environments/updateenvironmentgitdetails.md): Update git-metadata in remote environment and returns the identifier of updated environment ### Upsert an Environment by identifier - [PUT /ng/api/environmentsV2/upsert](https://apidocs.harness.io/environments/upsertenvironmentv2.md) ## EnvironmentGroup This contains APIs related to EnvironmentGroup. ### Create an Environment Group - [POST /ng/api/environmentGroup](https://apidocs.harness.io/environmentgroup/postenvironmentgroup.md) ### Gets an Environment Group by identifier - [GET /ng/api/environmentGroup/{envGroupIdentifier}](https://apidocs.harness.io/environmentgroup/getenvironmentgroup.md) ### Update an Environment Group by Identifier - [PUT /ng/api/environmentGroup/{envGroupIdentifier}](https://apidocs.harness.io/environmentgroup/updateenvironmentgroup.md) ### Delete en Environment Group by Identifier - [DELETE /ng/api/environmentGroup/{envGroupIdentifier}](https://apidocs.harness.io/environmentgroup/deleteenvironmentgroup.md) ### Gets Environment Group list - [POST /ng/api/environmentGroup/list](https://apidocs.harness.io/environmentgroup/getenvironmentgrouplist.md) ## Infrastructures This contains APIs related to Infrastructure Definitions ### Gets Infrastructure list - [GET /ng/api/infrastructures](https://apidocs.harness.io/infrastructures/getinfrastructurelist.md) ### Update an Infrastructure by identifier - [PUT /ng/api/infrastructures](https://apidocs.harness.io/infrastructures/updateinfrastructure.md) ### Create an Infrastructure in an Environment - [POST /ng/api/infrastructures](https://apidocs.harness.io/infrastructures/createinfrastructure.md) ### Gets an Infrastructure by identifier - [GET /ng/api/infrastructures/{infraIdentifier}](https://apidocs.harness.io/infrastructures/getinfrastructure.md) ### Delete an Infrastructure by identifier - [DELETE /ng/api/infrastructures/{infraIdentifier}](https://apidocs.harness.io/infrastructures/deleteinfrastructure.md) ### Import and Create Infrastructure from Git Repository - [POST /ng/api/infrastructures/import](https://apidocs.harness.io/infrastructures/importinfrastructure.md) ### Move infra YAML from inline to remote - [POST /ng/api/infrastructures/move-config/{infraIdentifier}](https://apidocs.harness.io/infrastructures/moveinfraconfigs.md) ### Update git-metadata in remote infrastructure Entity - [PUT /ng/api/infrastructures/{infraIdentifier}/update-git-metadata](https://apidocs.harness.io/infrastructures/updateinfrastructuregitdetails.md): Update git-metadata in remote infrastructure and returns the identifier of updated infrastructure ## Usage This contains APIs specific to CD license usage ### Download CD Usage CSV report - [GET /ng/api/license-usage-cd/v2/{usageType}/csv/download](https://apidocs.harness.io/usage/downloadcdusagecsvreport.md) ### Download CSV Active Services report - [GET /ng/api/usage/cd/active-services/csv/download](https://apidocs.harness.io/usage/downloadactiveservicecsvreport.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ng/api/usage/CD/serviceInstancesLicense](https://apidocs.harness.io/usage/getcdlicenseusageforserviceinstances.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ng/api/usage/CD/servicesLicense](https://apidocs.harness.io/usage/getcdlicenseusageforservices.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ng/api/usage/{module}](https://apidocs.harness.io/usage/getlicenseusage.md) ### Download CSV Active Services report - [GET /ccm/api/usage/cd/active-services/csv/download](https://apidocs.harness.io/usage/ccmdownloadactiveservicecsvreport.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ccm/api/usage/CD/serviceInstancesLicense](https://apidocs.harness.io/usage/ccmgetcdlicenseusageforserviceinstances.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ccm/api/usage/CD/servicesLicense](https://apidocs.harness.io/usage/ccmgetcdlicenseusageforservices.md) ### Gets License Usage By Module, Timestamp, and Account Identifier - [GET /ccm/api/usage/{module}](https://apidocs.harness.io/usage/ccmgetlicenseusage.md) ### Download CSV Active Monitored Services report - [GET /cv/api/usage/SRM/active-monitored-services/csv/download](https://apidocs.harness.io/usage/downloadactivemonitoredservicecsvreport.md) ### Download CSV Active Services Monitored report - [GET /cv/api/usage/SRM/active-services-monitored/csv/download](https://apidocs.harness.io/usage/downloadactiveservicemonitoredcsvreport.md) ### CvgetLicenseUsage - [GET /cv/api/usage/CV](https://apidocs.harness.io/usage/cvgetlicenseusage.md) ### getSRMLicenseUsage - [GET /cv/api/usage/SRM](https://apidocs.harness.io/usage/getsrmlicenseusage.md) ### Returns a List of active monitored services along with identifier,Active Monitored Services Count and other details - [POST /cv/api/usage/SRM/active-monitored-services](https://apidocs.harness.io/usage/listsrmactivemonitoredservices.md) ### Usage#ReportUsage - [GET /sto/api/usage](https://apidocs.harness.io/usage/usage_reportusage.md): Report usage ### Usage#UsageAllAccounts - [GET /sto/api/usage/all-accounts](https://apidocs.harness.io/usage/usage_usageallaccounts.md): Report usage for all accounts ## File Store This contains APIs related to File Store in Harness ### List Files and Folders metadata - [GET /ng/api/file-store](https://apidocs.harness.io/file-store/listfilesandfolders.md) ### Create Folder or File including content - [POST /ng/api/file-store](https://apidocs.harness.io/file-store/create.md) ### Creates File or Folder metadata via YAML - [POST /ng/api/file-store/yaml](https://apidocs.harness.io/file-store/createviayaml.md) ### Get the Folder or File metadata - [GET /ng/api/file-store/{identifier}](https://apidocs.harness.io/file-store/getfile.md) ### Update Folder or File including content - [PUT /ng/api/file-store/{identifier}](https://apidocs.harness.io/file-store/update.md) ### Delete File or Folder by identifier - [DELETE /ng/api/file-store/{identifier}](https://apidocs.harness.io/file-store/deletefile.md) ### Download File - [GET /ng/api/file-store/files/{identifier}/download](https://apidocs.harness.io/file-store/downloadfile.md) ### Get list of created by user details - [GET /ng/api/file-store/files/createdBy](https://apidocs.harness.io/file-store/getcreatedbylist.md) ### Get file content by file path - [POST /ng/api/file-store/files/content](https://apidocs.harness.io/file-store/getfilecontentusingscopedfilepathv2.md): Returns the content of a file in the Harness file store as a string. The request body must be a plain-text string containing the scoped file path (not JSON-encoded, do not wrap in quotes). For account scope, prefix with 'account:' (e.g., 'account:/my-file'). For org scope, prefix with 'org:' (e.g., 'org:/my-file'). For project scope, optionally prefix with 'project:' or just provide the path (e.g., '/my-file'). The path must start with '/'. Scope query parameters must also match: project scope requires accountIdentifier, orgIdentifier, and projectIdentifier; org scope requires accountIdentifier and orgIdentifier; account scope requires only accountIdentifier. ### Get list of entities where file is referenced by queried entity type - [GET /ng/api/file-store/{identifier}/referenced-by](https://apidocs.harness.io/file-store/getreferencedby.md) ### Get the list of supported entity types for files - [GET /ng/api/file-store/supported-entity-types](https://apidocs.harness.io/file-store/getentitytypes.md) ### Get filtered list of Files or Folders - [POST /ng/api/file-store/files/filter](https://apidocs.harness.io/file-store/listfileswithfilter.md) ### Get folder nodes at first level, not including sub-nodes - [POST /ng/api/file-store/folder](https://apidocs.harness.io/file-store/getfoldernodes.md) ### Update File or Folder metadata via YAML - [PUT /ng/api/file-store/yaml/{identifier}](https://apidocs.harness.io/file-store/updateviayaml.md): Updates the metadata of an existing file or folder using a YAML payload. This endpoint updates metadata (name, description, tags, etc.) only. ### Get file content of scopedFilePath (deprecated) - [GET /ng/api/file-store/files/{scopedFilePath}/content](https://apidocs.harness.io/file-store/getfilecontentusingscopedfilepath.md) ## Service Dashboard This contains APIs related to Service Dashboard ### Get pipeline execution count for a service with grouping support on artifact and deployment status - [GET /ng/api/dashboard/getPipelineExecutionCount](https://apidocs.harness.io/service-dashboard/pipelineexecutioncount.md) ## ServiceOverrides This contains APIs related to Service Overrides V2 ### Update an ServiceOverride Entity - [PUT /ng/api/serviceOverrides](https://apidocs.harness.io/serviceoverrides/updateserviceoverride.md) ### Create an ServiceOverride Entity - [POST /ng/api/serviceOverrides](https://apidocs.harness.io/serviceoverrides/createserviceoverride.md) ### Gets Service Overrides by Identifier - [GET /ng/api/serviceOverrides/{identifier}](https://apidocs.harness.io/serviceoverrides/getserviceoverrides.md): Retrieves a Service Override by its identifier. The identifier can be user-provided during creation, or if not provided, it is auto-generated based on the override type: ENV_GLOBAL_OVERRIDE = environmentRef, ENV_SERVICE_OVERRIDE = environmentRef_serviceRef, INFRA_GLOBAL_OVERRIDE = environmentRef_infraIdentifier, INFRA_SERVICE_OVERRIDE = environmentRef_serviceRef_infraIdentifier. Dots in refs are replaced with underscores. ### Delete a ServiceOverride entity - [DELETE /ng/api/serviceOverrides/{identifier}](https://apidocs.harness.io/serviceoverrides/deleteserviceoverride_1.md) ### Move ServiceOverride YAML from inline to remote or remote to inline - [POST /ng/api/serviceOverrides/move-config](https://apidocs.harness.io/serviceoverrides/serviceoverridemoveconfigs.md) ### Update git-metadata in remote ServiceOverride Entity - [PUT /ng/api/serviceOverrides/update-git-metadata](https://apidocs.harness.io/serviceoverrides/updateserviceoverridegitdetails.md): Update git-metadata in remote ServiceOverride and returns the identifier of updated ServiceOverride ## Rollback This contains APIs related to Post Prod Rollback of specific service ### Verification for rollback eligibility for service - [POST /ng/api/rollback/check](https://apidocs.harness.io/rollback/checkifinstancecanberolledback.md) ### Trigger the rollback for specific service - [POST /ng/api/rollback/trigger](https://apidocs.harness.io/rollback/triggerrollback.md) ### Trigger the rollback for specific service to an environment - [POST /ng/api/rollback/trigger/v2](https://apidocs.harness.io/rollback/triggerrollbackv2.md) ## tas This contains APIs related to tas ### Return the Tas organizations - [GET /ng/api/tas/organizations](https://apidocs.harness.io/tas/gettasorganizations.md) ### Return the Tas spaces - [GET /ng/api/tas/space](https://apidocs.harness.io/tas/gettasspaces.md) ### Return the Tas spaces - [GET /ng/api/tas/v2/space](https://apidocs.harness.io/tas/gettasspacesv2.md) ## Freeze CRUD This contains APIs related to Freeze CRUD ### Create a Freeze - [POST /ng/api/freeze](https://apidocs.harness.io/freeze-crud/createfreeze.md) ### Get a Freeze - [GET /ng/api/freeze/{freezeIdentifier}](https://apidocs.harness.io/freeze-crud/getfreeze.md) ### Updates a Freeze - [PUT /ng/api/freeze/{freezeIdentifier}](https://apidocs.harness.io/freeze-crud/updatefreeze.md) ### Delete a Freeze - [DELETE /ng/api/freeze/{freezeIdentifier}](https://apidocs.harness.io/freeze-crud/deletefreeze.md) ### Delete many Freezes - [POST /ng/api/freeze/delete](https://apidocs.harness.io/freeze-crud/deletemanyfreezes.md) ### Gets Freeze list - [POST /ng/api/freeze/list](https://apidocs.harness.io/freeze-crud/getfreezelist.md) ### Get list of freeze acted on a frozen execution - [GET /ng/api/freeze/getFrozenExecutionDetails](https://apidocs.harness.io/freeze-crud/getfrozenexecutiondetails.md) ### Get Global Freeze Yaml - [GET /ng/api/freeze/getGlobalFreeze](https://apidocs.harness.io/freeze-crud/getglobalfreeze.md) ### Create Global Freeze - [POST /ng/api/freeze/manageGlobalFreeze](https://apidocs.harness.io/freeze-crud/createglobalfreeze.md) ### Update the status of Freeze to active or inactive - [POST /ng/api/freeze/updateFreezeStatus](https://apidocs.harness.io/freeze-crud/updatefreezestatus.md) ## Account Services [Beta] This contains APIs for account-scoped services. ### Retrieve a service - [GET /v1/services/{service}](https://apidocs.harness.io/account-services/get-account-scoped-service.md): Retrieves the specified service ### Update service - [PUT /v1/services/{service}](https://apidocs.harness.io/account-services/update-account-scoped-service.md): Updates the specified service ### Delete a service - [DELETE /v1/services/{service}](https://apidocs.harness.io/account-services/delete-account-scoped-service.md): Deletes the requested service ### List services - [GET /v1/services](https://apidocs.harness.io/account-services/get-account-scoped-services.md): Returns a list of the services for which you have view permissions in the given project. ### Create a service - [POST /v1/services](https://apidocs.harness.io/account-services/create-account-scoped-service.md): Creates a service ### List primary manifests of a account scoped service - [GET /v1/services/{service}/primary-manifests](https://apidocs.harness.io/account-services/get-account-scoped-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in an account-scoped service. ### List primary manifests of a account scoped service - [POST /v1/services/{service}/primary-manifests](https://apidocs.harness.io/account-services/post-account-scoped-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in an account-scoped service. ## Organization Services [Beta] This contains APIs for organization-scoped services. ### Retrieve a service - [GET /v1/orgs/{org}/services/{service}](https://apidocs.harness.io/org-services/get-org-scoped-service.md): Retrieves the specified service ### Update Service - [PUT /v1/orgs/{org}/services/{service}](https://apidocs.harness.io/org-services/update-org-scoped-service.md): Updates the specified service ### Delete a service - [DELETE /v1/orgs/{org}/services/{service}](https://apidocs.harness.io/org-services/delete-org-scoped-service.md): Deletes the requested service ### List Services - [GET /v1/orgs/{org}/services](https://apidocs.harness.io/org-services/get-org-scoped-services.md): Returns a list of the services for which you have view permissions in the given project. ### Create a service - [POST /v1/orgs/{org}/services](https://apidocs.harness.io/org-services/create-org-scoped-service.md): Creates a service ### List primary manifests of a org scoped service - [GET /v1/orgs/{org}/services/{service}/primary-manifests](https://apidocs.harness.io/org-services/get-org-scoped-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in an org-scoped service. ### List primary manifests of a org scoped service - [POST /v1/orgs/{org}/services/{service}/primary-manifests](https://apidocs.harness.io/org-services/post-org-scoped-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in an org-scoped service. ## Project Services [Beta] This contains APIs for project-scoped services. ### Retrieve a service - [GET /v1/orgs/{org}/projects/{project}/services/{service}](https://apidocs.harness.io/project-services/get-service.md): Retrieves the specified service ### Update Service - [PUT /v1/orgs/{org}/projects/{project}/services/{service}](https://apidocs.harness.io/project-services/update-service.md): Updates the specified service ### Delete a Service - [DELETE /v1/orgs/{org}/projects/{project}/services/{service}](https://apidocs.harness.io/project-services/delete-service.md): Deletes the requested service. ### List Services - [GET /v1/orgs/{org}/projects/{project}/services](https://apidocs.harness.io/project-services/get-services.md): Returns a list of the services for which you have view permissions in the given project. ### Create a Service - [POST /v1/orgs/{org}/projects/{project}/services](https://apidocs.harness.io/project-services/create-service.md): Creates a service ### List primary manifests of a project scoped service - [GET /v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests](https://apidocs.harness.io/project-services/get-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in a project-scoped service. ### List primary manifests of a project scoped service - [POST /v1/orgs/{org}/projects/{project}/services/{service}/primary-manifests](https://apidocs.harness.io/project-services/post-primary-manifests.md): Returns a list of eligible primary manifests from all configured manifest in a project-scoped service. ## Services This contains APIs related to Services ### Check for allowed-values in the Services - [POST /ng/api/servicesV2/check-allowed-values](https://apidocs.harness.io/services/checkallowedvaluesinservices.md) ### Gets Service list - [GET /ng/api/servicesV2](https://apidocs.harness.io/services/getservicelist.md) ### Update a Service by identifier - [PUT /ng/api/servicesV2](https://apidocs.harness.io/services/updateservicev2.md) ### Create a Service - [POST /ng/api/servicesV2](https://apidocs.harness.io/services/createservicev2.md) ### Create Services - [POST /ng/api/servicesV2/batch](https://apidocs.harness.io/services/createservicesv2.md) ### Create Services with partial success support - returns both successful and failed services - [POST /ng/api/servicesV2/batch/partial](https://apidocs.harness.io/services/createservicespartialbatch.md) ### Gets a Service by identifier - [GET /ng/api/servicesV2/{serviceIdentifier}](https://apidocs.harness.io/services/getservicev2.md) ### Delete a Service by identifier - [DELETE /ng/api/servicesV2/{serviceIdentifier}](https://apidocs.harness.io/services/deleteservicev2.md) ### Retrieving the list of Kubernetes Command Options - [GET /ng/api/servicesV2/k8s/command-flags](https://apidocs.harness.io/services/k8scmdflags.md) ### Retrieving the list of Kustomize Command Flags - [GET /ng/api/servicesV2/kustomize/command-flags](https://apidocs.harness.io/services/kustomizecmdflags.md) ### Get Plugin Info at Service - [GET /ng/api/servicesV2/plugin-info](https://apidocs.harness.io/services/getplugininfo.md) ### Retrieving the list of actions available for service hooks - [GET /ng/api/servicesV2/hooks/actions](https://apidocs.harness.io/services/hookactions.md) ### Get Service YAML from Git Repository - [POST /ng/api/servicesV2/import](https://apidocs.harness.io/services/importservice.md) ### Gets Service Access list - [GET /ng/api/servicesV2/list/access](https://apidocs.harness.io/services/getserviceaccesslist.md) ### Move Service YAML from inline to remote - [POST /ng/api/servicesV2/move-config/{serviceIdentifier}](https://apidocs.harness.io/services/moveserviceconfigs.md) ### Update git-metadata in remote service Entity - [PUT /ng/api/servicesV2/{serviceIdentifier}/update-git-metadata](https://apidocs.harness.io/services/updateservicegitdetails.md): Update git-metadata in remote service and returns the identifier of updated service ### Upsert a Service by identifier - [PUT /ng/api/servicesV2/upsert](https://apidocs.harness.io/services/upsertservicev2.md) ## Account Rancher Infrastructure [Beta] This contains APIs for Rancher infra entities for account level. ### List rancher clusters using account level connector - [GET /v1/rancher/connectors/{connector}/clusters](https://apidocs.harness.io/account-rancher-infrastructure/list-account-scoped-rancher-clusters-using-connector.md): List rancher clusters using the given account level rancher connector ### List rancher clusters using account level env and infra def - [GET /v1/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters](https://apidocs.harness.io/account-rancher-infrastructure/list-account-scoped-rancher-clusters-using-env-and-infra.md): List rancher clusters using the given account level environment and infrastructure definition. ## Org Rancher Infrastructure [Beta] This contains APIs for Rancher infra entities for org level. ### List rancher clusters using org level connector - [GET /v1/orgs/{org}/rancher/connectors/{connector}/clusters](https://apidocs.harness.io/org-rancher-infrastructure/list-org-scoped-rancher-clusters-using-connector.md): List rancher clusters using the given org level rancher connector ### List rancher clusters using org level env and infra def - [GET /v1/orgs/{org}/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters](https://apidocs.harness.io/org-rancher-infrastructure/list-org-scoped-rancher-clusters-using-env-and-infra.md): List rancher clusters using the given org level environment and infrastructure definition. ## Project Rancher Infrastructure [Beta] This contains APIs for Rancher infra entities for project level. ### List rancher clusters using project level connector - [GET /v1/orgs/{org}/projects/{project}/rancher/connectors/{connector}/clusters](https://apidocs.harness.io/project-rancher-infrastructure/list-project-scoped-rancher-clusters-using-connector.md): List rancher clusters using the given project level rancher connector ### List rancher clusters using project level env and infra def - [GET /v1/orgs/{org}/projects/{project}/rancher/environments/{environment}/infrastructure-definitions/{infrastructure-definition}/clusters](https://apidocs.harness.io/project-rancher-infrastructure/list-project-scoped-rancher-clusters-using-env-and-infra.md): List rancher clusters using the given project level environment and infrastructure definition. ## Account Templates [Beta] This contains APIs for Account-scoped Templates. ### Create Template - [POST /v1/templates](https://apidocs.harness.io/account-template/create-templates-acc.md): Creates a Template in the Account scope. ### Get Templates List - [GET /v1/templates](https://apidocs.harness.io/account-template/get-templates-list-acc.md): Retrieves list of Template with meta-data at Account scope. ### Update Git details - [PUT /v1/templates/git-metadata/{template}](https://apidocs.harness.io/account-template/update-git-metadata-details.md): Update Git details for multiple version. ### Get Stable Template - [GET /v1/templates/{template}](https://apidocs.harness.io/account-template/get-template-stable-acc.md): Retrieves stable version of Template at Account scope. ### Retrieve a Template - [GET /v1/templates/{template}/versions/{version}](https://apidocs.harness.io/account-template/get-template-acc.md): Retrieves particular version of Template at Account scope. ### Update Template - [PUT /v1/templates/{template}/versions/{version}](https://apidocs.harness.io/account-template/update-template-acc.md): Updates particular version of Template at Account scope. ### Delete Template - [DELETE /v1/templates/{template}/versions/{version}](https://apidocs.harness.io/account-template/delete-template-acc.md): Deletes particular version of Template at Account scope. ### Update Stable Template - [PUT /v1/templates/{template}/versions/{version}/stable](https://apidocs.harness.io/account-template/update-template-stable-acc.md): Updates the stable version of Template at Account scope. ### Import Template - [POST /v1/templates/{template}/import](https://apidocs.harness.io/account-template/import-template-acc.md): Import template at account level ### Get inputs schema for account level templates - [GET /v1/templates/{template}/versions/{version}/inputs-schema](https://apidocs.harness.io/account-template/get-acc-templates-inputs-schema.md): get inputs schema for account level templates ## Organization Templates [Beta] This contains APIs for Organization-scoped Templates. ### Update Git details - [PUT /v1/orgs/{org}/templates/git-metadata/{template}](https://apidocs.harness.io/org-template/update-git-metadata-details-org.md): Update Git details for multiple version. ### Create Template - [POST /v1/orgs/{org}/templates](https://apidocs.harness.io/org-template/create-templates-org.md): Creates a Template in the Organization scope. ### Get Templates List - [GET /v1/orgs/{org}/templates](https://apidocs.harness.io/org-template/get-templates-list-org.md): Retrieves list of Template with meta-data at Organization scope. ### Get Stable Template - [GET /v1/orgs/{org}/templates/{template}](https://apidocs.harness.io/org-template/get-template-stable-org.md): Retrieves stable version of Template at Organization scope. ### Retrieve a Template - [GET /v1/orgs/{org}/templates/{template}/versions/{version}](https://apidocs.harness.io/org-template/get-template-org.md): Retrieves particular version of Template at Organization scope. ### Update Template - [PUT /v1/orgs/{org}/templates/{template}/versions/{version}](https://apidocs.harness.io/org-template/update-template-org.md): Updates particular version of Template at Organization scope. ### Delete Template - [DELETE /v1/orgs/{org}/templates/{template}/versions/{version}](https://apidocs.harness.io/org-template/delete-template-org.md): Deletes particular version of Template at Organization scope. ### Update Stable Template - [PUT /v1/orgs/{org}/templates/{template}/versions/{version}/stable](https://apidocs.harness.io/org-template/update-template-stable-org.md): Updates the stable version of Template at Organization scope. ### Import template - [POST /v1/orgs/{org}/templates/{template}/import](https://apidocs.harness.io/org-template/import-template-org.md): Import template at org level ### Get inputs schema for org level templates - [GET /v1/orgs/{org}/templates/{template}/versions/{version}/inputs-schema](https://apidocs.harness.io/org-template/get-org-templates-inputs-schema.md): get inputs schema for org level templates ## Project Templates [Beta] This contains APIs for Project-scoped Templates. ### Update Git details - [PUT /v1/orgs/{org}/projects/{project}/templates/git-metadata/{template}](https://apidocs.harness.io/project-template/update-git-metadata-details-project.md): Update Git details for multiple version. ### Create Template - [POST /v1/orgs/{org}/projects/{project}/templates](https://apidocs.harness.io/project-template/create-templates-project.md): Creates a Template in the Project scope. ### Get Templates List - [GET /v1/orgs/{org}/projects/{project}/templates](https://apidocs.harness.io/project-template/get-templates-list-project.md): Retrieves list of Template with meta-data at Project scope. ### Get Stable Template - [GET /v1/orgs/{org}/projects/{project}/templates/{template}](https://apidocs.harness.io/project-template/get-template-stable-project.md): Retrieves stable version of Template at Project scope. ### Retrieve a Template - [GET /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}](https://apidocs.harness.io/project-template/get-template-project.md): Retrieves particular version of Template at Project scope. ### Update Template - [PUT /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}](https://apidocs.harness.io/project-template/update-template-project.md): Updates particular version of Template at Project scope. ### Delete Template - [DELETE /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}](https://apidocs.harness.io/project-template/delete-template-project.md): Deletes particular version of Template at Project scope. ### Update Stable Template - [PUT /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}/stable](https://apidocs.harness.io/project-template/update-template-stable-project.md): Updates the stable version of Template at Project scope. ### Import Template - [POST /v1/orgs/{org}/projects/{project}/templates/{template}/import](https://apidocs.harness.io/project-template/import-template-project.md): Import template at a project level ### Get inputs schema for project level templates - [GET /v1/orgs/{org}/projects/{project}/templates/{template}/versions/{version}/inputs-schema](https://apidocs.harness.io/project-template/get-project-templates-inputs-schema.md): get inputs schema for project level templates ## Templates This contains a list of APIs specific to the Templates Validations and Refresh ### Get YAML with updated Template Inputs - [POST /template/api/refresh-template/refreshed-yaml](https://apidocs.harness.io/templates/getrefreshedyaml.md): Returns YAML with updated Template Inputs for a given YAML ### Validate Template Inputs in a YAML - [GET /template/api/refresh-template/validate-template-inputs](https://apidocs.harness.io/templates/templatevalidatetemplateinputs.md): Validates the Template Inputs in a pipeline's YAML specification. If the Template Inputs are invalid, the operation returns an error summary. ### Gets complete yaml with templateRefs resolved - [POST /template/api/templates/v2/applyTemplates](https://apidocs.harness.io/templates/getyamlwithtemplaterefsresolvedv2.md) ### Create a Template - [POST /template/api/templates](https://apidocs.harness.io/templates/createtemplate.md) ### Delete Template Version - [DELETE /template/api/templates/{templateIdentifier}/{versionLabel}](https://apidocs.harness.io/templates/deletetemplateversion.md) ### Get Template - [GET /template/api/templates/{templateIdentifier}](https://apidocs.harness.io/templates/gettemplate.md) ### Gets Template Input Set YAML - [GET /template/api/templates/templateInputs/{templateIdentifier}](https://apidocs.harness.io/templates/gettemplateinputsetyaml.md) ### Get custom labels per template version - [GET /template/api/templates/{templateIdentifier}/labels](https://apidocs.harness.io/templates/gettemplatelabelsmap.md): Per-version labels; optional version filter. ### Get Entities referring this template - [GET /template/api/templates/entitySetupUsage/{templateIdentifier}](https://apidocs.harness.io/templates/listtemplateusage.md) ### Gets all metadata of template list - [POST /template/api/templates/list-metadata](https://apidocs.harness.io/templates/gettemplatemetadatalist.md) ### Move Template YAML from inline to remote - [POST /template/api/templates/move-config/{templateIdentifier}](https://apidocs.harness.io/templates/movetemplateconfigs.md) ### Update Template Version - [PUT /template/api/templates/update/{templateIdentifier}/{versionLabel}](https://apidocs.harness.io/templates/updateexistingtemplateversion.md) ### Update git metadata details for a remote template - [POST /template/api/templates/update/git-metadata/{templateIdentifier}/{versionLabel}](https://apidocs.harness.io/templates/updategitdetails.md) ### Update Stable Template Version - [PUT /template/api/templates/updateStableTemplate/{templateIdentifier}/{versionLabel}](https://apidocs.harness.io/templates/updatestabletemplate.md) ### Upsert custom labels for one template version - [POST /template/api/templates/{templateIdentifier}/labels/upsert](https://apidocs.harness.io/templates/upsertlabelsfortemplate.md): Upsert labels for one version. Bad tokens in labelFailures; other errors as API errors. ## Agents ### AgentServiceForServer_List - [GET /gitops/api/v1/agents](https://apidocs.harness.io/agents/agentserviceforserver_list.md): List agents. ### AgentServiceForServer_Create - [POST /gitops/api/v1/agents](https://apidocs.harness.io/agents/agentserviceforserver_create.md): Create agent. ### AgentServiceForServer_ListNamespaces - [GET /gitops/api/v1/agents/ns](https://apidocs.harness.io/agents/agentserviceforserver_listnamespaces.md): Get agent namespaces. ### AgentServiceForServer_Search - [POST /gitops/api/v1/agents/search](https://apidocs.harness.io/agents/agentserviceforserver_search.md): Search agents. ### AgentServiceForServer_ListTags - [GET /gitops/api/v1/agents/tags](https://apidocs.harness.io/agents/agentserviceforserver_listtags.md): Get agent tags. ### AgentServiceForServer_ListVersions - [GET /gitops/api/v1/agents/versions](https://apidocs.harness.io/agents/agentserviceforserver_listversions.md): Get agent versions. ### Update agents. - [PUT /gitops/api/v1/agents/{agent.identifier}](https://apidocs.harness.io/agents/agentserviceforserver_update.md): This API can be used to update an agent's details in Harness. The following fields will be updated to the new values in the body - "tags", "metadata"(all nested fields in metadata will be replaced with new provided values including empty/nil values if they're sent), "description", "type". ### AgentServiceForServer_GetDeployYaml - [GET /gitops/api/v1/agents/{agentIdentifier}/deploy.yaml](https://apidocs.harness.io/agents/agentserviceforserver_getdeployyaml.md): GetDeployYaml returns deployment yamls for agents. ### AgentServiceForServer_PostDeployHelmChart - [POST /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/helm](https://apidocs.harness.io/agents/agentserviceforserver_postdeployhelmchart.md): PostDeployHelmChart returns the Helm Chart for deploying the agents. ### AgentServiceForServer_PostDeployYaml - [POST /gitops/api/v1/agents/{agentIdentifier}/deployment-spec/yaml](https://apidocs.harness.io/agents/agentserviceforserver_postdeployyaml.md): PostDeployYaml returns deployment yamls for agents. ### AgentServiceForServer_GetDeployHelmChart - [GET /gitops/api/v1/agents/{agentIdentifier}/helm-chart](https://apidocs.harness.io/agents/agentserviceforserver_getdeployhelmchart.md): GetDeployHelmChart returns the Helm Chart for deploying the agents. ### AgentServiceForServer_GetDeployOverrides - [GET /gitops/api/v1/agents/{agentIdentifier}/helm-overrides](https://apidocs.harness.io/agents/agentserviceforserver_getdeployoverrides.md): GetDeployOverrides returns the Helm Chart overrides for the agents. ### AgentServiceForServer_PostDeployOverrides - [POST /gitops/api/v1/agents/{agentIdentifier}/helm-overrides](https://apidocs.harness.io/agents/agentserviceforserver_postdeployoverrides.md): PostDeployOverrides returns the Helm Chart overrides for deploying the agents. ### AgentServiceForServer_GetOperatorYaml - [GET /gitops/api/v1/agents/{agentIdentifier}/operator/yaml](https://apidocs.harness.io/agents/agentserviceforserver_getoperatoryaml.md): GetOperatorYaml returns operator yaml for deploying the agents. ### AgentServiceForServer_PostOperatorYaml - [POST /gitops/api/v1/agents/{agentIdentifier}/operator/yaml](https://apidocs.harness.io/agents/agentserviceforserver_postoperatoryaml.md): PostOperatorYaml returns operator yaml for deploying the agents. ### AgentServiceForServer_SetPrimaryNode - [PATCH /gitops/api/v1/agents/{agentIdentifier}/primaryNode](https://apidocs.harness.io/agents/agentserviceforserver_setprimarynode.md): Set primary disaster recovery node. ### AgentServiceForServer_GetSyncAllowed - [GET /gitops/api/v1/agents/{agentIdentifier}/sync-allowed](https://apidocs.harness.io/agents/agentserviceforserver_getsyncallowed.md): GetSyncStatus returns the sync status of the agent. ### AgentServiceForServer_UpdateSyncAllowed - [PUT /gitops/api/v1/agents/{agentIdentifier}/sync-allowed](https://apidocs.harness.io/agents/agentserviceforserver_updatesyncallowed.md): UpdateSyncAllowed updates the sync status of the agent by creating deny sync windows for mapped app projects. ### AgentServiceForServer_Get - [GET /gitops/api/v1/agents/{identifier}](https://apidocs.harness.io/agents/agentserviceforserver_get.md): Get agents. ### AgentServiceForServer_Delete - [DELETE /gitops/api/v1/agents/{identifier}](https://apidocs.harness.io/agents/agentserviceforserver_delete.md): Delete agents. ### AgentServiceForServer_RegenerateCredentials - [POST /gitops/api/v1/agents/{identifier}/credentials](https://apidocs.harness.io/agents/agentserviceforserver_regeneratecredentials.md): Regenerate credentials for agents. ### AgentServiceForServer_Scale - [POST /gitops/api/v1/agents/{identifier}/scale](https://apidocs.harness.io/agents/agentserviceforserver_scale.md): Scale the Hosted agent. ### AgentServiceForServer_Unique - [GET /gitops/api/v1/agents/{identifier}/unique](https://apidocs.harness.io/agents/agentserviceforserver_unique.md): Unique returns unique agents. ### VersionUpgradeService_UpgradeAvailableV2 - [GET /gitops/api/v2/versions/agents/upgrade-available](https://apidocs.harness.io/agents/versionupgradeservice_upgradeavailablev2.md): Check for version updates. ## Application ### List applications - [POST /gitops/api/v1/applications](https://apidocs.harness.io/application/applicationservice_listapps.md): ListApps retrieves a list of applications. ## Applications ### List applications for a specific agent - [GET /gitops/api/v1/agents/{agentIdentifier}/applications](https://apidocs.harness.io/applications/agentapplicationservice_list.md): List returns a list of applications for a specific agent. ### Create an application - [POST /gitops/api/v1/agents/{agentIdentifier}/applications](https://apidocs.harness.io/applications/agentapplicationservice_create.md): Create creates a new application in the specified project. ### Get parent application - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/parent/{query.name}](https://apidocs.harness.io/applications/agentapplicationservice_parent.md): Parent returns a parent application (app of apps or appset) by child name ### Get ManagedResources - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.applicationName}/managed-resources](https://apidocs.harness.io/applications/agentapplicationservice_managedresources.md): ManagedResources returns list of managed resources. ### Get resource tree - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.applicationName}/resource-tree](https://apidocs.harness.io/applications/agentapplicationservice_resourcetree.md): ResourceTree returns resource tree. ### Get application - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}](https://apidocs.harness.io/applications/agentapplicationservice_get.md): Get returns an application by name. ### List resource events - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/events](https://apidocs.harness.io/applications/agentapplicationservice_listresourceevents.md): ListResourceEvents returns a list of event resources. ### PodLogs returns stream of log entries for the specified pod(s). - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/logs](https://apidocs.harness.io/applications/agentapplicationstreamservice_podlogs2.md): PodLogs returns stream of log entries for the specified pod(s). ### AgentApplicationStreamService_PodLogsBatch2 - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/logs/batch](https://apidocs.harness.io/applications/agentapplicationstreamservice_podlogsbatch2.md): PodLogsBatch returns stream of log entry in batches of upto 1000 entries for the specified pod(s). ### Get application manifest - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/manifests](https://apidocs.harness.io/applications/agentapplicationservice_getmanifests.md): GetManifests returns an application manifests. ### PodLogs returns stream of log entries for the specified pod(s). - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/pods/{query.podName}/logs](https://apidocs.harness.io/applications/agentapplicationstreamservice_podlogs.md): PodLogs returns stream of log entries for the specified pod(s). ### AgentApplicationStreamService_PodLogsBatch - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/pods/{query.podName}/logs/batch](https://apidocs.harness.io/applications/agentapplicationstreamservice_podlogsbatch.md): PodLogsBatch returns stream of log entry in batches of upto 1000 entries for the specified pod(s). ### Get revision metadata - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/revisions/{query.revision}/metadata](https://apidocs.harness.io/applications/agentapplicationservice_revisionmetadata.md): RevisionMetadata returns metadata for a specific revision of the application. ### Get sync windows of the application - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{query.name}/syncwindows](https://apidocs.harness.io/applications/agentapplicationservice_getapplicationsyncwindows.md): GetApplicationSyncWindows returns sync windows of the application. ### Update an application - [PUT /gitops/api/v1/agents/{agentIdentifier}/applications/{request.application.metadata.name}](https://apidocs.harness.io/applications/agentapplicationservice_update.md): Update updates an application. ### Delete an application - [DELETE /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}](https://apidocs.harness.io/applications/agentapplicationservice_delete.md): Delete deletes an application. ### Patch an application - [PATCH /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}](https://apidocs.harness.io/applications/agentapplicationservice_patch.md): Patch applies a patch to an application. ### Terminate operation - [DELETE /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/operation](https://apidocs.harness.io/applications/agentapplicationservice_terminateoperation.md): TerminateOperation terminates the currently running operation. ### Get an application resource - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource](https://apidocs.harness.io/applications/agentapplicationservice_getresource.md): GetResource returns single application resource. ### Delete resource - [DELETE /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource](https://apidocs.harness.io/applications/agentapplicationservice_deleteresource.md): DeleteResource deletes a single application resource. ### Patch an application resource - [POST /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource](https://apidocs.harness.io/applications/agentapplicationservice_patchresource.md): PatchResource patch single application resource. ### List resource actions - [GET /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource/actions](https://apidocs.harness.io/applications/agentapplicationservice_listresourceactions.md): ListResourceActions returns a list of resource actions. ### Run resource action - [POST /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/resource/actions](https://apidocs.harness.io/applications/agentapplicationservice_runresourceaction.md): RunResourceAction runs a resource action. ### Rollback syncs an application to its target state - [POST /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/rollback](https://apidocs.harness.io/applications/agentapplicationservice_rollback.md): Rollback syncs an application to its target state. Harness Event type (rollback). ### Update application spec - [PUT /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/spec](https://apidocs.harness.io/applications/agentapplicationservice_updatespec.md): UpdateSpec updates an application spec. ### Sync an application - [POST /gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/sync](https://apidocs.harness.io/applications/agentapplicationservice_sync.md): Sync syncs an application to its target state. Harness Event type (deploy) ### Watch returns stream of application change events - [GET /gitops/api/v1/agents/{agentIdentifier}/stream/applications](https://apidocs.harness.io/applications/agentapplicationstreamservice_watch.md): Watch returns stream of application change events. ### WatchResourceTree returns stream of application resource tree - [GET /gitops/api/v1/agents/{agentIdentifier}/stream/applications/{query.applicationName}/resource-tree](https://apidocs.harness.io/applications/agentapplicationstreamservice_watchresourcetree.md): WatchResourceTree returns stream of application resource tree. ### List attributes for applications - [GET /gitops/api/v1/applications/attributes](https://apidocs.harness.io/applications/applicationservice_listattributes.md): ListAttributes returns a list of attributes for applications ### Bulk refresh multiple applications - [POST /gitops/api/v1/applications/bulk/refresh](https://apidocs.harness.io/applications/applicationservice_bulkrefresh.md): BulkRefresh refreshes the status of multiple applications at once, optionally performing a hard refresh if refresh is set to hard. ### Bulk sync multiple applications - [POST /gitops/api/v1/applications/bulk/sync](https://apidocs.harness.io/applications/applicationservice_bulksync.md): BulkSync initiates sync for multiple applications to their target states. ### List namespaces for a specific query - [POST /gitops/api/v1/applications/ns](https://apidocs.harness.io/applications/applicationservice_listns.md): ListNs retrieves a list of namespaces for a specific query. ### List LegacyApplicationSets - [GET /gitops/api/v1/applications/sets](https://apidocs.harness.io/applications/applicationservice_listappsets.md): ListAppSets lists LegacyApplicationSets in the specified project ### List application sync status - [POST /gitops/api/v1/applications/sync](https://apidocs.harness.io/applications/applicationservice_listappsync.md): ListAppSync returns a list of application sync status ### Check if an application exists - [GET /gitops/api/v1/applications/{name}/exists](https://apidocs.harness.io/applications/applicationservice_exists.md): Exists checks whether an application with the given name exists. ## Certificates ### List certificates - [GET /gitops/api/v1/certificates](https://apidocs.harness.io/certificates/certificateservice_listcerts.md): ListCerts retrieves a list of certificates ## Clusters This contains APIs related to Gitops Clusters ### Get a Cluster linked to an environment by identifier - [GET /ng/api/gitops/clusters/{identifier}](https://apidocs.harness.io/clusters/getcluster.md) ### Unlink a cluster by identifier - [DELETE /ng/api/gitops/clusters/{identifier}](https://apidocs.harness.io/clusters/deletecluster.md): Unlink a cluster from an environment by identifier ### Gets cluster list - [GET /ng/api/gitops/clusters](https://apidocs.harness.io/clusters/getclusterlist.md): Gets a list of GitOps clusters linked to an environment ### Link a Cluster - [POST /ng/api/gitops/clusters](https://apidocs.harness.io/clusters/linkcluster.md): Link a GitOps cluster to an environment by identifier ### Link Clusters - [POST /ng/api/gitops/clusters/batch](https://apidocs.harness.io/clusters/linkclusters.md) ### Unlink Clusters - [POST /ng/api/gitops/clusters/batchunlink](https://apidocs.harness.io/clusters/unlinkclustersinbatch.md) ### Get a cluster managed by an agent by name - [GET /gitops/api/v1/agents/{agentIdentifier}/cluster_byname](https://apidocs.harness.io/clusters/agentclusterservice_getbyname.md): Get a cluster managed by agent using name ### Get a cluster managed by an agent by URL - [GET /gitops/api/v1/agents/{agentIdentifier}/cluster_byurl](https://apidocs.harness.io/clusters/agentclusterservice_getbyurl.md): Get a cluster managed by agent using URL ### List returns list of clusters - [GET /gitops/api/v1/agents/{agentIdentifier}/clusters](https://apidocs.harness.io/clusters/agentclusterservice_list.md): List clusters. ### Create creates a cluster - [POST /gitops/api/v1/agents/{agentIdentifier}/clusters](https://apidocs.harness.io/clusters/agentclusterservice_create.md): Create cluster. ### Get returns a cluster by identifier - [GET /gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}](https://apidocs.harness.io/clusters/agentclusterservice_get.md): Get cluster. ### Delete deletes a cluster - [DELETE /gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}](https://apidocs.harness.io/clusters/agentclusterservice_delete.md): Delete cluster. ### Update updates a cluster - [PUT /gitops/api/v1/agents/{agentIdentifier}/clusters/{identifier}](https://apidocs.harness.io/clusters/agentclusterservice_update.md): Update cluster. ### List all available repository certificates - [GET /gitops/api/v1/agents/{agentIdentifier}/gpgkeys](https://apidocs.harness.io/clusters/agentgpgkeyservice_list.md): List all available repository certificates. ### CreateHosted creates a harness hosted cluster - [POST /gitops/api/v1/agents/{agentIdentifier}/hosted/cluster](https://apidocs.harness.io/clusters/agentclusterservice_createhosted.md): Creates Harness hosted cluster. ### List clusters - [POST /gitops/api/v1/clusters](https://apidocs.harness.io/clusters/clusterservice_listclusters.md): ListClusters returns a list of clusters. ### Check if a cluster exists - [GET /gitops/api/v1/clusters/exists](https://apidocs.harness.io/clusters/clusterservice_exists.md): Exists checks whether a cluster with the given identifier exists. ## Dashboard Aggregates ### Get recent deployment statistics - [POST /gitops/api/v1/dashboard/activity](https://apidocs.harness.io/dashboard-aggregates/dashboardservice_recentdeployments.md): RecentDeployments returns aggregate statistics of recent deployments. ### List top 5 most deployed apps - [GET /gitops/api/v1/dashboard/topapps](https://apidocs.harness.io/dashboard-aggregates/dashboardservice_topapplicationphasestats.md): TopApplicationPhaseStats lists phase status counts for the top 5 most deployed applications. ## Dashboards ### Get recently created app, cluster, repo counts - [GET /gitops/api/v1/dashboard/counts](https://apidocs.harness.io/dashboards/dashboardservice_recentlycreatedcounts.md): RecentlyCreatedCounts lists the count of clusters, repositories, and applications created within a specified time period. ### Get dashboard overview - [GET /gitops/api/v1/dashboard/overview](https://apidocs.harness.io/dashboards/dashboardservice_getdashboardoverview.md): GetDashboardOverview provides an overview of the dashboard including key metrics. ## GnuPGP Keys ### Create one or more GPG public keys in the server's configuration - [POST /gitops/api/v1/agents/{agentIdentifier}/gpgkeys](https://apidocs.harness.io/gnupgp-keys/agentgpgkeyservice_create.md): Create one or more GPG public keys in the server's configuration. ### Get information about specified GPG public key from the server - [GET /gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}](https://apidocs.harness.io/gnupgp-keys/agentgpgkeyservice_get.md): Get information about specified GPG public key from the server. ### Delete specified GPG public key from the server's configuration - [DELETE /gitops/api/v1/agents/{agentIdentifier}/gpgkeys/{query.keyID}](https://apidocs.harness.io/gnupgp-keys/agentgpgkeyservice_delete.md): Delete specified GPG public key from the server's configuration. ## GPG Keys ### List all GPG keys - [GET /gitops/api/v1/gpgkeys](https://apidocs.harness.io/gpg-keys/gnupgkeyservice_listgpgkeys.md): ListGPGKeys retrieves all available GPG public keys. ## Hosts This contains APIs related to Hosts as defined in Harness ### Gets the list of hosts filtered by accountIdentifier and connectorIdentifier - [POST /ng/api/hosts/filter](https://apidocs.harness.io/hosts/filterhostsbyconnector.md) ### Validates hosts connectivity credentials - [POST /ng/api/hosts/validate](https://apidocs.harness.io/hosts/validatehosts_1.md) ## Project mappings ### Get Harness-Argo project mapping by agent - [GET /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_getappprojectmappinglistbyagent.md): GetAppProjectMappingListByAgent retrieves Harness-Argo project mappings list by agent. ### Create Harness-Argo project mapping - [POST /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_create.md): Create creates Harness-Argo project mappings. ### Update Harness-Argo project mapping - [PUT /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_update.md): Update updates Harness-Argo project mappings. ### Delete Harness-Arog project mapping - [DELETE /gitops/api/v1/agents/{agentIdentifier}/appprojectsmapping/{name}](https://apidocs.harness.io/project-mappings/appprojectmappingservice_delete.md): Delete deletes Harness-Argo project mapping. ### Get Harness-Argo project mappings - [GET /gitops/api/v1/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_getappprojectmappinglist.md): GetAppProjectMappingList retrieves Harness-Argo project mappings list. ### Create Harness-Argo project mapping V2 - [POST /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_createv2.md): CreateV2 creates Harness-Argo project mappings. ### Get Harness-Argo project mapping V2 - [GET /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}](https://apidocs.harness.io/project-mappings/appprojectmappingservice_getappprojectmappingv2.md): GetAppProjectMappingV2 retrieves Harness-Argo project mapping for the given identifier. ### Delete Harness-Argo project mapping - [DELETE /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}](https://apidocs.harness.io/project-mappings/appprojectmappingservice_deletev2.md): DeleteV2 deletes Harness-Argo project mappings. ### Update Harness-Argo project mappings V2 - [PUT /gitops/api/v2/agents/{agentIdentifier}/appprojectsmapping/{identifier}](https://apidocs.harness.io/project-mappings/appprojectmappingservice_updatev2.md): UpdateV2 updates Harness-Argo project mappings. ### Get Harness-Argo project mapping list by agent V2 - [GET /gitops/api/v2/agents/{agentIdentifier}/appprojectsmappings](https://apidocs.harness.io/project-mappings/appprojectmappingservice_getappprojectmappingslistbyagentv2.md): GetAppProjectMappingsListByAgentV2 retrieves Harness-Argo project mappings list by agent. ### Get Harness-Argo project mappings with pagination and search - [GET /gitops/api/v2/appprojectsmapping](https://apidocs.harness.io/project-mappings/appprojectmappingservice_listappprojectmappings.md): ListAppProjectMappings retrieves Harness-Argo project mappings list with pagination and search. ## Projects ### List returns list of Argo projects - [GET /gitops/api/v1/agents/{agentIdentifier}/projects](https://apidocs.harness.io/projects/agentprojectservice_list.md): Lists lists Argo projects. ### Create a new Argo project - [POST /gitops/api/v1/agents/{agentIdentifier}/projects](https://apidocs.harness.io/projects/agentprojectservice_create.md): Create a new Argo project ### Get returns an Argo project by name - [GET /gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}](https://apidocs.harness.io/projects/agentprojectservice_get.md): Get returns an Argo project by name. ### Delete deletes an Argo project - [DELETE /gitops/api/v1/agents/{agentIdentifier}/projects/{query.name}](https://apidocs.harness.io/projects/agentprojectservice_delete.md): Delete deletes an Argo project. ### Update updates an Argo project - [PUT /gitops/api/v1/agents/{agentIdentifier}/projects/{request.project.metadata.name}](https://apidocs.harness.io/projects/agentprojectservice_update.md): Update updates an Argo project. ## Reconciler ### List auto-create logs - [GET /gitops/api/v1/agents/{agentIdentifier}/autocreate-logs](https://apidocs.harness.io/reconciler/reconcilerservice_listautocreatelogs.md): Lists logs for auto-created resources (services, environments, cluster links). Supports filtering by import request ID, application set, or application name. ### Collect entity counts on cluster via agent - [POST /gitops/api/v1/agents/{agentIdentifier}/reconcile/counts](https://apidocs.harness.io/reconciler/reconcilerservice_collectcounts.md): Returns number of entities that exist in the cluster on the agent. Filter can be used to count only global entities (with empty project) and those specified by the filter. ### Import data from cluster via agent - [POST /gitops/api/v1/agents/{agentIdentifier}/reconcile/import](https://apidocs.harness.io/reconciler/reconcilerservice_importdata.md): Imports data from cluster via agent. There must be at least one project mapping in the database. Returns number of entities imported. ## Repositories ### ListRepositories gets a list of all configured repositories - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories](https://apidocs.harness.io/repositories/agentrepositoryservice_listrepositories.md): ListRepositories gets a list of all configured repositories. ### CreateRepository creates a new repository configuration - [POST /gitops/api/v1/agents/{agentIdentifier}/repositories](https://apidocs.harness.io/repositories/agentrepositoryservice_createrepository.md): CreateRepository creates a new repository configuration. ### Checks whether External Secrets Operator is installed - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/eso/check](https://apidocs.harness.io/repositories/agentrepositoryservice_checkexternalsecretsoperator.md): CheckExternalSecretsOperator Checks whether External Secrets Operator is installed or not ### Returns a list of ESO generators installed in agent namespace. - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/eso/generators](https://apidocs.harness.io/repositories/agentrepositoryservice_listesogenerators.md): Returns a list of ESO generators installed in agent namespace. ### Returns the Repository type of OCI repo - [POST /gitops/api/v1/agents/{agentIdentifier}/repositories/oci/type](https://apidocs.harness.io/repositories/agentrepositoryservice_checkocirepotype.md): CheckOCIRepoType Returns the Repository type of OCI repo ### ValidateAccess gets connection state for a repository - [POST /gitops/api/v1/agents/{agentIdentifier}/repositories/validate](https://apidocs.harness.io/repositories/agentrepositoryservice_validateaccess.md): ValidateAccess gets connection state for a repository. ### Get returns a repository or its credentials - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}](https://apidocs.harness.io/repositories/agentrepositoryservice_get.md): Get returns a repository or its credentials. ### DeleteRepository deletes a repository from the configuration - [DELETE /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}](https://apidocs.harness.io/repositories/agentrepositoryservice_deleterepository.md): DeleteRepository deletes a repository from the configuration. ### UpdateRepository updates a repository configuration - [PUT /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}](https://apidocs.harness.io/repositories/agentrepositoryservice_updaterepository.md): UpdateRepository updates a repository configuration. ### GetAppDetails returns application details by given path - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/appdetails](https://apidocs.harness.io/repositories/agentrepositoryservice_getappdetails.md): GetAppDetails returns application details by given path. ### ListApps returns list of apps in the repo - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/apps](https://apidocs.harness.io/repositories/agentrepositoryservice_listapps.md): ListApps returns list of apps in the repo. ### GetHelmCharts returns list of helm charts in the specified repository - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/helmcharts](https://apidocs.harness.io/repositories/agentrepositoryservice_gethelmcharts.md): GetHelmCharts returns list of helm charts in the specified repository. ### Returns a list of refs (e.g. branches and tags) in the repo - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories/{identifier}/refs](https://apidocs.harness.io/repositories/agentrepositoryservice_listrefs.md): Returns a list of refs (e.g. branches and tags) in the repo. ### GetAppDetailsByUrl returns application details by given path for repositories by URL - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/appdetails](https://apidocs.harness.io/repositories/agentrepositoryservice_getappdetailsbyurl.md): GetAppDetails returns application details by given path. ### ListAppsByUrl returns list of apps in the repo - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/apps](https://apidocs.harness.io/repositories/agentrepositoryservice_listappsbyurl.md): ListApps returns list of apps in the repo. ### GetHelmChartsByUrl returns list of helm charts in the repository by URL - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/helmcharts](https://apidocs.harness.io/repositories/agentrepositoryservice_gethelmchartsbyurl.md): GetHelmCharts returns list of helm charts in the specified repository. ### Returns a list of refs (e.g. branches and tags) in the repo by URL - [GET /gitops/api/v1/agents/{agentIdentifier}/repositories_byurl/refs](https://apidocs.harness.io/repositories/agentrepositoryservice_listrefsbyurl.md): Returns a list of refs (e.g. branches and tags) in the repo. ### Get a repository configured in gitops by URL from Harness - [GET /gitops/api/v1/agents/{agentIdentifier}/repository_byurl](https://apidocs.harness.io/repositories/agentrepositoryservice_getbyurl.md): Returns a repository by URL ### List Repositories by repository credential template - [GET /gitops/api/v1/repositories](https://apidocs.harness.io/repositories/repositoryservice_listrepositoriesbyrepositorycredentialtemplate.md): ListRepositoriesByRepositoryCredentialTemplate lists Repositories by repositories credential template ### List repositories - [POST /gitops/api/v1/repositories](https://apidocs.harness.io/repositories/repositoryservice_listrepositories.md): ListRepositories retrieves a list of all configured repositories. ### Check if a repository exists - [GET /gitops/api/v1/repositories/exists](https://apidocs.harness.io/repositories/repositoryservice_exists.md): Exists checks whether a repository with the given URL exists. ## Repository Certificates ### List all available repository certificates - [GET /gitops/api/v1/agents/{agentIdentifier}/certificates](https://apidocs.harness.io/repository-certificates/agentcertificateservice_list.md): List repository certificates. ### Delete the certificates that match the RepositoryCertificateQuery - [DELETE /gitops/api/v1/agents/{agentIdentifier}/certificates](https://apidocs.harness.io/repository-certificates/agentcertificateservice_delete.md): Delete repository certificates. ### Creates repository certificates on the server - [POST /gitops/api/v1/agents/{agentIdentifier}/certificates](https://apidocs.harness.io/repository-certificates/agentcertificateservice_create.md): Create repository certificates. ## Repository credentials ### Create a new repository credential - [POST /gitops/api/v1/agents/{agentIdentifier}/repocreds](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_createrepositorycredentials.md): CreateRepositoryCredentials creates a new repository credential. ### Get credentials for repository url - [POST /gitops/api/v1/agents/{agentIdentifier}/repocreds/get](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_getcredentialsforrepositoryurl.md): GetCredentialsForRepositoryUrl returns a repository credential given its url. ### Get repository credential by identifier - [GET /gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_getrepositorycredentials.md): GetRepositoryCredentials retrieves a repository credential given its identifier. ### Delete a repository credential - [DELETE /gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_deleterepositorycredentials.md): DeleteRepositoryCredentials deletes a specific repository credential. ### Update a repository credential - [PUT /gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_updaterepositorycredentials.md): UpdateRepositoryCredentials updates a specific repository credential. ### List repository credentials - [POST /gitops/api/v1/repocreds](https://apidocs.harness.io/repository-credentials/agentrepositorycredentialsservice_listrepositorycredentials.md): ListRepositoryCredentials retrieves a list of all repository credentials. ## ValidateHost This contains APIs related to SSH or WinRm host validation ### Validates hosts connectivity credentials (deprecated) - [POST /ng/api/host-validation](https://apidocs.harness.io/validatehost/validatehosts.md) ## Account GitX Webhooks This contains APIs for Account GitX Webhooks. ### Create a GitX webhook at Account level - [POST /v1/gitx-webhooks](https://apidocs.harness.io/gitx-webhooks/create-gitx-webhook.md): Create GitXWebhook at account level ### Lists all the GitX Webhooks at Account level - [GET /v1/gitx-webhooks](https://apidocs.harness.io/gitx-webhooks/list-gitx-webhooks.md): List GitX webhooks ### Fetch GitX Webhook at Account level - [GET /v1/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/gitx-webhooks/get-gitx-webhook.md): Fetch a gitx webhook ### Updates a GitX Webhook at Account level - [PUT /v1/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/gitx-webhooks/update-gitx-webhook.md): Update a Gitx webhook ### Deletes a GitX Webhook at Account level - [DELETE /v1/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/gitx-webhooks/delete-gitx-webhook.md): Deletes a gitx webhooks ### Lists all the GitX Webhooks events at Account level - [GET /v1/gitx-webhook-events](https://apidocs.harness.io/gitx-webhooks/list-gitx-webhook-events.md): List GitX webhook Events ## Org Gitx Webhooks ### Lists all the GitX Webhooks at Org level - [GET /v1/orgs/{org}/gitx-webhooks](https://apidocs.harness.io/org-gitx-webhooks/list-org-gitx-webhooks.md): List org level GitX webhooks ### Create Org Level GitX webhook - [POST /v1/orgs/{org}/gitx-webhooks](https://apidocs.harness.io/org-gitx-webhooks/create-org-gitx-webhook.md): Create GitXWebhook at org level ### Fetch GitX Webhook at org level - [GET /v1/orgs/{org}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/org-gitx-webhooks/get-org-gitx-webhook.md): Fetch a org level gitx webhook ### Updates a GitX Webhook at org level - [PUT /v1/orgs/{org}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/org-gitx-webhooks/update-org-gitx-webhook.md): Update a org level Gitx webhook ### Deletes a GitX Webhook at org level - [DELETE /v1/orgs/{org}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/org-gitx-webhooks/delete-org-gitx-webhook.md): Deletes a org level gitx webhooks ## Project Gitx Webhooks ### Lists all the GitX Webhooks at project level - [GET /v1/orgs/{org}/projects/{project}/gitx-webhooks](https://apidocs.harness.io/project-gitx-webhooks/list-project-gitx-webhook.md): List project level GitX webhooks ### Create Project level GitX webhook - [POST /v1/orgs/{org}/projects/{project}/gitx-webhooks](https://apidocs.harness.io/project-gitx-webhooks/create-project-gitx-webhook.md): Create GitXWebhook at project level ### Fetch GitX Webhook at project level - [GET /v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/project-gitx-webhooks/get-project-gitx-webhook.md): Fetch a project level gitx webhook ### Updates a GitX Webhook at project level - [PUT /v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/project-gitx-webhooks/update-project-gitx-webhook.md): Update a project level Gitx webhook ### Deletes a GitX Webhook at project level - [DELETE /v1/orgs/{org}/projects/{project}/gitx-webhooks/{gitx-webhook}](https://apidocs.harness.io/project-gitx-webhooks/delete-project-gitx-webhook.md): Deletes a project level gitx webhooks ## Anomalies Ignorelist Rule This contains APIs related to Anomalies Ignorelist Rule Management. ### Create a new anomalies ignorelist rule - [POST /ccm/api/anomalies/ignoreListRule](https://apidocs.harness.io/anomalies-ignorelist-rule/createnewanomaliesignorelistrule.md): Create a new anomalies ignorelist rule ### Get anomalies ignorelist rule - [GET /ccm/api/anomalies/ignoreListRule/{id}](https://apidocs.harness.io/anomalies-ignorelist-rule/getanomaliesignorelistrule.md): Get anomalies ignorelist rule ### Update anomalies ignorelist rule - [PUT /ccm/api/anomalies/ignoreListRule/{id}](https://apidocs.harness.io/anomalies-ignorelist-rule/updateanomaliesignorelistrule.md): Update anomalies ignorelist rule ### Delete anomalies ignorelist rule - [DELETE /ccm/api/anomalies/ignoreListRule/{id}](https://apidocs.harness.io/anomalies-ignorelist-rule/deleteanomaliesignorelistrule.md): Delete anomalies ignorelist rule ### Fetch Azure subscriptions (ID and name) for the given account - [GET /ccm/api/anomalies/ignoreListRule/filter-values/azure-subscriptions](https://apidocs.harness.io/anomalies-ignorelist-rule/listazuresubscriptions.md): Get Azure subscription IDs and names ### List anomalies ignorelist rule - [POST /ccm/api/anomalies/ignoreListRule/list](https://apidocs.harness.io/anomalies-ignorelist-rule/listanomaliesignorelistrule.md): List anomalies ignorelist rule ### Toggle anomalies ignorelist rule - [PUT /ccm/api/anomalies/ignoreListRule/{id}/toggle](https://apidocs.harness.io/anomalies-ignorelist-rule/toggleanomaliesignorelistrule.md): Toggle anomalies ignorelist rule ## Anomalies Get details about any anomalous spike in your cloud and AI costs ### List Anomalies - [POST /ccm/api/anomaly/summary](https://apidocs.harness.io/anomalies/getanomaliessummary.md): Fetch the result of anomaly query ### Returns the list of distinct values for all the specified Anomaly fields. - [POST /ccm/api/anomaly/filter-values](https://apidocs.harness.io/anomalies/anomalyfiltervalues.md): Returns the list of distinct values for all the specified Anomaly fields. ### List Anomalies - [POST /ccm/api/anomaly](https://apidocs.harness.io/anomalies/listanomalies.md): Fetch the list of anomalies reported according to the filters applied ### List ignore list anomalies - [POST /ccm/api/anomaly/listIgnoredAnomalies](https://apidocs.harness.io/anomalies/listignoredanomalies.md): Fetch the list of anomalies present in the ignore list according to the filters applied ### List Anomalies for Perspective - [POST /ccm/api/anomaly/perspective/{perspectiveId}](https://apidocs.harness.io/anomalies/listperspectiveanomalies.md): Fetch anomalies for perspective ### Report Anomaly feedback - [PUT /ccm/api/anomaly/feedback](https://apidocs.harness.io/anomalies/reportanomalyfeedback.md): Mark an anomaly as true/false anomaly ### Dismisses an Anomaly - [PUT /cf/admin/anomalies/{identifier}/dismiss](https://apidocs.harness.io/anomalies/dismissanomaly.md): Dismisses A CCM Anomaly, which essentially sets it as acknowledged in the database ### List Anomalies - [POST /ccm/api/anomaly/summary](https://apidocs.harness.io/anomalies/getanomaliessummary.md): Fetch the result of anomaly query ### Returns the list of distinct values for all the specified Anomaly fields. - [POST /ccm/api/anomaly/filter-values](https://apidocs.harness.io/anomalies/anomalyfiltervalues.md): Returns the list of distinct values for all the specified Anomaly fields. ### List Anomalies - [POST /ccm/api/anomaly](https://apidocs.harness.io/anomalies/listanomalies.md): Fetch the list of anomalies reported according to the filters applied ### List ignore list anomalies - [POST /ccm/api/anomaly/listIgnoredAnomalies](https://apidocs.harness.io/anomalies/listignoredanomalies.md): Fetch the list of anomalies present in the ignore list according to the filters applied ### List Anomalies for Perspective - [POST /ccm/api/anomaly/perspective/{perspectiveId}](https://apidocs.harness.io/anomalies/listperspectiveanomalies.md): Fetch anomalies for perspective ### Report Anomaly feedback - [PUT /ccm/api/anomaly/feedback](https://apidocs.harness.io/anomalies/reportanomalyfeedback.md): Mark an anomaly as true/false anomaly ### Dismisses an Anomaly - [PUT /cf/admin/anomalies/{identifier}/dismiss](https://apidocs.harness.io/anomalies/dismissanomaly.md): Dismisses A CCM Anomaly, which essentially sets it as acknowledged in the database ## BI Dashboards Get details of BI-dashboards specific to CACM ### List all the BI Dashboards for CACM - [GET /ccm/api/bi-dashboards](https://apidocs.harness.io/bi-dashboards/listbidashboards.md): List all the BI Dashboards. ## Budgets Manage Budgets in bulk ### Adjust Budget Amount in bulk - [POST /ccm/api/budgets/bulk/adjust-budget-amount](https://apidocs.harness.io/budgets/adjustbudgetamountoperation.md): Change the budget amount for the budgets in bulk ### Clone Budgets in bulk - [POST /ccm/api/budgets/bulk/clone](https://apidocs.harness.io/budgets/clonebudgetsbulkoperation.md): Clone budgets in bulk with customizable alert handling options ### Bulk create Cost Bucket Budgets - [POST /ccm/api/budgets/bulk/create-cost-bucket-budgets](https://apidocs.harness.io/budgets/createcostbucketbudgetsbulk.md): Create budgets for multiple cost buckets within a cost category ### Delete Budgets in bulk - [POST /ccm/api/budgets/bulk/delete](https://apidocs.harness.io/budgets/deletebudgetsbulkoperation.md): Delete budgets in bulk. ### Check bulk budget update job status - [GET /ccm/api/budgets/bulk/check-job-status](https://apidocs.harness.io/budgets/checkbulkbudgetjobstatus.md): Checks the current status (RUNNING, COMPLETED, FAILED) of a bulk budget update job by jobId. ### Manage Budget Alerts in bulk - [POST /ccm/api/budgets/bulk/manage-alerts](https://apidocs.harness.io/budgets/managebudgetalertsbulkoperation.md): Manage alerts for budgets in bulk (delete, add, add/remove recipients) ### Fetch Budget details - [GET /ccm/api/budgets/{id}](https://apidocs.harness.io/budgets/getbudget.md): Fetch details of a Budget for the given Budget ID. ### Update an existing budget - [PUT /ccm/api/budgets/{id}](https://apidocs.harness.io/budgets/updatebudget.md): Update an existing Budget for the given Budget ID. ### Clone a budget - [POST /ccm/api/budgets/{id}](https://apidocs.harness.io/budgets/clonebudget.md): Clone a Budget using the given Budget ID. ### Delete a budget - [DELETE /ccm/api/budgets/{id}](https://apidocs.harness.io/budgets/deletebudget.md): Delete a Budget for the given Budget ID. ### Return the list of filter values for the Budgets - [POST /ccm/api/budgets/filter-values](https://apidocs.harness.io/budgets/budgetfiltervalues.md): Returns the list of filter values for all the specified filters. ### Filter budgets with RBAC checks - [POST /ccm/api/budgets/v2/list](https://apidocs.harness.io/budgets/getaccessiblebudgetsummaries.md): Returns a list of budgets based on filter criteria with folder-based RBAC checks ### Fetch the cost details of a Budget - [GET /ccm/api/budgets/{id}/costDetails](https://apidocs.harness.io/budgets/getcostdetails.md): Fetch the cost details of a Budget for the given Budget ID. ### List all the Budgets associated with a Perspective - [GET /ccm/api/budgets/perspectiveBudgets](https://apidocs.harness.io/budgets/listbudgetsforperspective.md): List all the Budgets associated for the given Perspective ID. ### List all the Budgets - [GET /ccm/api/budgets](https://apidocs.harness.io/budgets/listbudgets.md): List all the Budgets. ### Create a Budget - [POST /ccm/api/budgets](https://apidocs.harness.io/budgets/createbudget.md): Create a Budget to set and receive alerts when your costs exceed (or are forecasted to exceed) your budget amount. ### List alert thresholds for a budget - [GET /ccm/api/budgets/subscribe/list](https://apidocs.harness.io/budgets/listbudgetalertthresholds.md): List all the alert thresholds that have been set for the given Budget ID. ### Move budgets to a folder - [POST /ccm/api/budgets/moveBudgets](https://apidocs.harness.io/budgets/movebudgets.md): Move budgets to a different folder, overriding perspective folder inheritance. ### Update alert thresholds for a budget - [POST /ccm/api/budgets/subscribe](https://apidocs.harness.io/budgets/updatebudgetalertthresholds.md): Update the alert thresholds for the given Budget ID with the provided list of alert thresholds. ## Budget Groups Manage Budget Groups and receive alerts when your costs exceed (or are forecasted to exceed) your configured budget group. ### Fetch Budget group details - [GET /ccm/api/budgetGroups/{id}](https://apidocs.harness.io/budget-groups/getbudgetgroup.md): Fetch details of a Budget group for the given Budget group ID. ### Update an existing budget group - [PUT /ccm/api/budgetGroups/{id}](https://apidocs.harness.io/budget-groups/updatebudgetgroup.md): Update an existing Budget group for the given Budget group ID. ### Delete a budget group - [DELETE /ccm/api/budgetGroups/{id}](https://apidocs.harness.io/budget-groups/deletebudgetgroup.md): Delete a Budget group for the given Budget group ID. ### Filter budget groups and return hierarchical structure - [POST /ccm/api/budgetGroups/v2/list](https://apidocs.harness.io/budget-groups/getaccessiblebudgetgroupsummaries.md): Returns a hierarchical list of budget groups based on the filter criteria. ### Get aggregated amount for given budget groups/budgets - [POST /ccm/api/budgetGroups/aggregatedAmount](https://apidocs.harness.io/budget-groups/getlastperiodcost.md): Returns list of value dataPoints specifying aggregated amount ### Get list of budget and budget group summaries - [GET /ccm/api/budgetGroups/summary](https://apidocs.harness.io/budget-groups/getbudgetandbudgetgroupslist.md): Returns list of budgetSummary ### List all the Budget groups - [GET /ccm/api/budgetGroups](https://apidocs.harness.io/budget-groups/listbudgetgroups.md): List all the Budget Groups for an account. ### Create a Budget Group - [POST /ccm/api/budgetGroups](https://apidocs.harness.io/budget-groups/createbudgetgroup.md): Create a Budget group to set and receive alerts when your costs exceed (or are forecasted to exceed) your budget group amount. ## Cost Categories Allows you to categorize based on business requirements and get a contextual view of your expenses. ### Fetch details of a Cost category - [GET /ccm/api/business-mapping/{id}](https://apidocs.harness.io/cost-categories/getbusinessmapping.md): Retrieve a specific Cost Category by its unique identifier. Returns the complete Cost Category configuration including all cost buckets, shared costs, and rule definitions. ### Delete a Cost category - [DELETE /ccm/api/business-mapping/{id}](https://apidocs.harness.io/cost-categories/deletebusinessmapping.md): Delete a Cost Category by its unique identifier. The deletion will fail if the Cost Category is currently used in any Perspectives. Returns a list of linked Perspectives if deletion is blocked. ### Get (cost-categories)/(cost buckets) for recommendation filter panel - [GET /ccm/api/business-mapping/filter-panel](https://apidocs.harness.io/cost-categories/getbusinessmappingforfilterpanel.md): Get (cost-categories)/(cost buckets) for recommendation filter panel ### Return details of all the Cost categories - [GET /ccm/api/business-mapping](https://apidocs.harness.io/cost-categories/getbusinessmappinglist.md): List all Cost Categories for your account with support for search, sorting, and pagination. Use this endpoint to browse and discover existing Cost Categories and their configurations. ### Update a Cost category - [PUT /ccm/api/business-mapping](https://apidocs.harness.io/cost-categories/updatebusinessmapping.md): Update an existing Cost Category configuration. Modify cost buckets, shared costs, rules, or rename the Cost Category. The update is identified by the UUID in the request body. ### Create a Cost Category - [POST /ccm/api/business-mapping](https://apidocs.harness.io/cost-categories/createbusinessmapping.md): Create a Cost Category to organize and allocate cloud and AI costs based on your business structure. Define custom rules and cost buckets to automatically categorize expenses by teams, projects, environments, or any business dimension. Cost Categories enable accurate cost allocation, chargeback, and financial reporting across your organization. ## Cloud Accounts APIs for listing cloud accounts across cloud providers. ### List cloud accounts by cloud provider - [GET /ccm/api/cloud-account](https://apidocs.harness.io/cloud-accounts/listcloudaccounts.md): List all cloud accounts for a given cloud provider ## K8S Connectors Metadata Health related metadata for your k8S clusters having cost access enabled. ### Get CACM K8S Metadata - [POST /ccm/api/ccmK8sMeta](https://apidocs.harness.io/k8s-connectors-metadata/ccmk8smeta.md): Get CACM K8S Metadata ## Notification Settings v2 Set notification channels to get cloud and AI cost anomaly alerts ### List notification settings - [GET /ccm/api/notificationSetting/v2](https://apidocs.harness.io/notification-settings-v2/listnotificationsettingsv2.md): List notification settings for the given account id. ### Update an existing notification setting - [PUT /ccm/api/notificationSetting/v2](https://apidocs.harness.io/notification-settings-v2/updatenotificationsettingv2.md): Update an existing notification setting for the given perspective id. ### Create a notification setting - [POST /ccm/api/notificationSetting/v2](https://apidocs.harness.io/notification-settings-v2/createnotificationsettingv2.md): Create a notification setting for a perspective to receive cloud and AI cost anomaly alerts. ### Delete notification settings - [DELETE /ccm/api/notificationSetting/v2](https://apidocs.harness.io/notification-settings-v2/deletenotificationsettingsv2.md): Delete notification settings for the given perspective id. ## Overview Get overview of CACM features. ### Fetch high level overview details about CACM feature. - [GET /ccm/api/overview](https://apidocs.harness.io/overview/getccmoverview.md): Fetch high level overview details about CACM feature. ### Get overview - [GET /v1/orgs/{org}/projects/{project}/dbschema/overview](https://apidocs.harness.io/overview/v1getdboverview.md): retrieves total dbSchemas, dbInstances and the latest 5 instances deployed ## Data Job Status Track and monitor the status of data ingestion and processing jobs across your cloud cost data pipeline. ### Get all job statuses - [GET /ccm/api/data-job-status/job-statuses](https://apidocs.harness.io/data-job-status/getalljobstatuses.md): Retrieve all available job status values from the JobStatus enum. ### Get distinct billing periods for a connector - [GET /ccm/api/data-job-status/history/billing-periods](https://apidocs.harness.io/data-job-status/getdistinctbillingperiods.md): Retrieve distinct billing periods for a connector and job kind in YYYY-MM format, sorted in descending order. ### Get distinct execution months for a connector - [GET /ccm/api/data-job-status/history/execution-months](https://apidocs.harness.io/data-job-status/getdistinctexecutionmonths.md): Retrieve distinct execution months for a connector and job kind in YYYY-MM format, sorted in descending order. ### Get distinct job kinds - [GET /ccm/api/data-job-status/job-kinds](https://apidocs.harness.io/data-job-status/getdistinctjobkinds.md): Retrieve distinct job kind values available for the account. ### Fetch data job history details - [GET /ccm/api/data-job-status/history](https://apidocs.harness.io/data-job-status/getdatajobhistorydetails.md): Retrieve the execution history details filtered by connector, job kind, billing period, and execution month. Returns all history records sorted by execution date in descending order. ### Fetch details of a data job with latest billing period - [GET /ccm/api/data-job-status/details/{jobId}](https://apidocs.harness.io/data-job-status/getdatajobdetails.md): Retrieve the details for a specific data job with the latest billing period. Returns the most recent execution attempt with detailed state transitions, timestamps, and execution metadata. Useful for debugging, auditing, and analyzing job performance. ### Fetch dashboard statistics for data jobs - [GET /ccm/api/data-job-status/overview](https://apidocs.harness.io/data-job-status/getdatajobsdashboard.md): Retrieve dashboard statistics for data jobs including active jobs count, jobs requiring attention, and completed jobs today with average duration. Provides a high-level overview of the data pipeline health and performance. ### List data jobs with filters - [POST /ccm/api/data-job-status/list](https://apidocs.harness.io/data-job-status/listdatajobs.md): Retrieve a paginated list of data jobs with optional filters including connector, job kind, status, and date range. ## Recommendation cost settings Get/set cost type preferences for recommendations ### Get recommendation cost settings - [GET /ccm/api/recommendation-cost-settings](https://apidocs.harness.io/recommendation-cost-settings/getrecommendationcostsettings.md): Get recommendation cost settings for an account ### Update recommendation cost settings - [PUT /ccm/api/recommendation-cost-settings](https://apidocs.harness.io/recommendation-cost-settings/updaterecommendationcostsettings.md): Update recommendation cost settings for an account ## Unit Metric Unit Metric resource. ### Get Unit Metric - [GET /ccm/api/unit-metric](https://apidocs.harness.io/unit-metric/getunitmetric.md): Get a Unit Metric by identifier with records for the specified time range. ### Update Unit Metric - [PUT /ccm/api/unit-metric](https://apidocs.harness.io/unit-metric/updateunitmetric.md): Update an existing Unit Metric. ### Create Unit Metric - [POST /ccm/api/unit-metric](https://apidocs.harness.io/unit-metric/createunitmetric.md): Create a Unit Metric. ### Delete Unit Metric Records within a specified time range. - [DELETE /ccm/api/unit-metric](https://apidocs.harness.io/unit-metric/deleteunitmetric.md): Delete Unit Metric Records within a specified time range. ### List All Unit Metrics - [GET /ccm/api/unit-metric/list](https://apidocs.harness.io/unit-metric/listallunitmetrics.md): Get all Unit Metrics for an account (metadata only, no records). ## Anomaly Comments APIs to manage anomaly comments ### List anomaly comments - [GET /ccm/api/anomaly/v2/comment](https://apidocs.harness.io/anomaly-comments/listanomalycomments.md): List comments for the given anomaly ### Save anomaly comment - [POST /ccm/api/anomaly/v2/comment](https://apidocs.harness.io/anomaly-comments/saveanomalycomment.md): Save comment for the given anomaly ## Cloud and AI cost anomaly details Get resource level insights into your cloud and AI cost anomalies ### Get anomaly cost time-series data - [GET /ccm/api/anomaly/v2/drill-down/cost/time-series](https://apidocs.harness.io/cloud-and-ai-cost-anomaly-details/getanomalycosttimeseriesdata.md): Get actual cost time-series data for given anomaly. ### Get anomaly details - [GET /ccm/api/anomaly/v2/drill-down](https://apidocs.harness.io/cloud-and-ai-cost-anomaly-details/getanomalydetails.md): Get details about the given cloud and AI cost anomaly ### Get anomaly resource cost time-series data - [GET /ccm/api/anomaly/v2/drill-down/resource/cost/time-series](https://apidocs.harness.io/cloud-and-ai-cost-anomaly-details/getanomalyresourcecosttimeseriesdata.md): Get actual cost time-series data for given resource. ### Get anomaly resource list - [GET /ccm/api/anomaly/v2/drill-down/list](https://apidocs.harness.io/cloud-and-ai-cost-anomaly-details/getanomalyresourcelist.md): Get details about the top contributing resources for the given cloud and AI cost anomaly. Returns either a list of resource details (AnomalyResourceDetails) when drill-down is successful, or a list of anomaly data (AnomalyData) when drill-down results are insufficient or empty. The response type depends on whether the drill-down query returns meaningful results and whether the drill-down cost impact is at least 50% of the total cost impact. ## Cloud and AI cost anomalies v2 Get details about any anomalies in your cloud and AI costs ### Get anomalies list - [POST /ccm/api/anomaly/v2/list](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/getanomalieslist.md): Get anomalies list ### Get anomaly metrics - [POST /ccm/api/anomaly/v2/metrics](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/getanomalymetrics.md): Get metrics for different types of anomalies ### Get anomaly metrics summary - [POST /ccm/api/anomaly/v2/summary](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/getanomalymetricssummary.md): Get summary of anomaly metrics ### Get anomaly metrics time-series - [POST /ccm/api/anomaly/v2/metrics/time-series](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/getanomalymetricstimeseries.md): Get metrics for different types of anomalies per day ### Get mean resolution time - [POST /ccm/api/anomaly/v2/mean-resolution-time](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/getmeanresolutiontime.md): Get mean resolution time ### Update feedback for given anomaly - [PUT /ccm/api/anomaly/v2/update/feedback](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/updateanomalyfeedback.md): Update feedback for given anomaly ### Update status for given anomaly - [PUT /ccm/api/anomaly/v2/update/status](https://apidocs.harness.io/cloud-and-ai-cost-anomalies-v2/updateanomalystatus.md): Update status for given anomaly ## Cost Details Fetch cloud and AI cost data for cost analysis ### Returns an overview of the cost - [POST /ccm/api/costdetails/overview](https://apidocs.harness.io/cost-details/costdetailoverview.md): Returns total cost, cost trend, and the time period based on the specified query parameters. ### Returns cluster data in a tabular format - [POST /ccm/api/costdetails/clusterData](https://apidocs.harness.io/cost-details/clusterdata.md): Returns cluster data based on the specified query parameters. ### Returns cost details in a tabular format - [POST /ccm/api/costdetails/tabularformat](https://apidocs.harness.io/cost-details/costdetailtabular.md): Returns cost details in a tabular format based on the specified query parameters. ### Returns cost details in a time series format - [POST /ccm/api/costdetails/timeseriesformat](https://apidocs.harness.io/cost-details/costdetailttimeseries.md): Returns cost details in a time series format based on the specified query parameters. ## External Data Provider This contains APIs related to External Data Provider Support for CACM ### Add a new external data file metadata - [POST /ccm/api/externaldata/filesinfo](https://apidocs.harness.io/external-data-provider/addnewexternaldatafilemetadata.md): Add a new external data file metadata ### Create External Data Provider - [POST /ccm/api/externaldata/provider](https://apidocs.harness.io/external-data-provider/createexternaldataprovider.md): Create External Data Provider ### Trigger data ingestion - [POST /ccm/api/externaldata/dataingestion](https://apidocs.harness.io/external-data-provider/triggerdataingestion.md): Trigger data ingestion ### Delete a provider - [DELETE /ccm/api/externaldata/provider/{providerId}](https://apidocs.harness.io/external-data-provider/ccmdeleteprovider.md): Delete a external data provider given a idD. ### Update file metadata - [PUT /ccm/api/externaldata/filesinfo/{fileId}](https://apidocs.harness.io/external-data-provider/updatefilemetadata.md): Update file metadata ### Delete data file and related metadata - [DELETE /ccm/api/externaldata/filesinfo/{fileId}](https://apidocs.harness.io/external-data-provider/deletedatafileandmetadata.md): Delete data file and related metadata given an id. ### Get a signed url - [GET /ccm/api/externaldata/signedurl](https://apidocs.harness.io/external-data-provider/getsignedurl.md): Get a signed url to upload external cost data. ### get all external data providers - [POST /ccm/api/externaldata/provider/list](https://apidocs.harness.io/external-data-provider/get%20providers.md): get providers ### get all files info for list of providers - [POST /ccm/api/externaldata/provider/filesinfo](https://apidocs.harness.io/external-data-provider/listprovidersfileinfo.md): listProvidersFileInfo ## AiEngine This contains APIs related to Generative AI Support for Governance ### Get supported prompt resources - [GET /ccm/api/governance/promptResources](https://apidocs.harness.io/aiengine/getpromptresources.md): Get supported prompt resources for a given cloud provider ### Get sample prompt governance rules - [GET /ccm/api/governance/promptRules](https://apidocs.harness.io/aiengine/getpromptrules.md): Get sample prompt rules for given cloud provider and resource type ## CACM governance cost settings Get/set cost type settings for CACM governance ### Get governance cost settings - [GET /ccm/api/governance/cost-settings](https://apidocs.harness.io/cacm-governance-cost-settings/getgovernancecostsettings.md): Get governance cost settings for an account ### Update governance cost settings - [PUT /ccm/api/governance/cost-settings](https://apidocs.harness.io/cacm-governance-cost-settings/updategovernancecostsettings.md): Update governance cost settings for an account ## Governance Enforcement Recommendation APIs This contains APIs related to CACM Governance Enforcement Recommendations ### Accept governance rule enforcement recommendations for given enforcement recommendation ids. - [PUT /ccm/api/governance/enforcementRecommendation/accept](https://apidocs.harness.io/governance-enforcement-recommendation-apis/acceptenforcementrecommendations.md): Accept governance rule enforcement recommendations. ### Dismiss governance rule enforcement recommendations for given enforcement recommendation ids. - [PUT /ccm/api/governance/enforcementRecommendation/dismiss](https://apidocs.harness.io/governance-enforcement-recommendation-apis/dismissenforcementrecommendations.md): Dismiss governance rule enforcement recommendations. ### Get governance rule enforcement recommendation details for given enforcement recommendation id. - [GET /ccm/api/governance/enforcementRecommendation/details](https://apidocs.harness.io/governance-enforcement-recommendation-apis/enforcementrecommendationdetails.md): Get governance rule enforcement recommendation details. ### List governance rule enforcement recommendations for given accountId. - [POST /ccm/api/governance/enforcementRecommendation/list](https://apidocs.harness.io/governance-enforcement-recommendation-apis/listruleenforcementrecommendations.md): List governance rule enforcement recommendations. ### Update a governance rule enforcement recommendation. - [PUT /ccm/api/governance/enforcementRecommendation/update](https://apidocs.harness.io/governance-enforcement-recommendation-apis/updateenforcementrecommendation.md): Update a governance rule enforcement recommendation. ### List governance rule enforcement recommendations for given accountId. (deprecated) - [GET /ccm/api/governance/enforcementRecommendation/list](https://apidocs.harness.io/governance-enforcement-recommendation-apis/ruleenforcementrecommendations.md): List governance rule enforcement recommendations. ## Governance Alert This contains APIs related to Governance Alert Management ### Clone a governance alert rule with the given id - [POST /ccm/api/governance/alert/clone](https://apidocs.harness.io/governance-alert/clonegovernancealertrule.md): Clone a governance alert rule with the given id ### Update a existing governance alert rule - [PUT /ccm/api/governance/alert](https://apidocs.harness.io/governance-alert/updategovernancealertrule.md): Update a existing governance alert rule ### Create a new governance alert rule - [POST /ccm/api/governance/alert](https://apidocs.harness.io/governance-alert/createnewgovernancealertrule.md): Create a new governance alert rule ### Delete a governance alert rule with the given id - [DELETE /ccm/api/governance/alert/{id}](https://apidocs.harness.io/governance-alert/deletegovernancealertrule.md): Delete a governance alert rule with the given id ### List all governance alert rule(s) - [GET /ccm/api/governance/alert/list](https://apidocs.harness.io/governance-alert/governancealertrules.md): List all governance alert rule(s) ### List all governance supported resource types - [GET /ccm/api/governance/alert/resourceTypes](https://apidocs.harness.io/governance-alert/governanceresourcetypes.md): List all governance supported resource types ### Toggle a governance alert rule with the given id - [PUT /ccm/api/governance/alert/toggle](https://apidocs.harness.io/governance-alert/togglegovernancealertrule.md): Toggle a governance alert rule with the given id ## Governance Overview This contains APIs related to CACM Governance Overview Page ### Return day wise total evaluations grouped by evaluation status. - [POST /ccm/api/governance/overview/dayWiseTotalEvaluations](https://apidocs.harness.io/governance-overview/daywisetotalevaluations.md) ### Return total number of new enforcement recommendations. - [GET /ccm/api/governance/overview/totalNewEnforcementRecommendations](https://apidocs.harness.io/governance-overview/totalnewenforcementrecommendations.md) ### Return total number of active enforcements. - [GET /ccm/api/governance/overview/totalActiveEnforcements](https://apidocs.harness.io/governance-overview/totalactiveenforcements.md) ### Return total number of evaluations. - [GET /ccm/api/governance/overview/totalEvaluations](https://apidocs.harness.io/governance-overview/totalevaluations.md) ### Return total realised Savings. - [POST /ccm/api/governance/overview/totalRealisedSavingsV2](https://apidocs.harness.io/governance-overview/totalrealisedsavingsv2.md) ### Return total realised Savings grouped by cloud provider/resource type. - [GET /ccm/api/governance/overview/totalRealisedSavingsGrouped](https://apidocs.harness.io/governance-overview/totalrealisedsavingsgrouped.md) ## Governance Recommendation APIs This contains APIs related to CACM Governance Recommendations ### Return governance rule recommendation health summary. - [GET /ccm/api/governance/recommendationHealth](https://apidocs.harness.io/governance-recommendation-apis/recommendationhealth.md) ### Governance recommendation details - [GET /ccm/api/governance/recommendation/{recommendationId}](https://apidocs.harness.io/governance-recommendation-apis/getrulerecommendation.md) ### Return list of governance rule recommendation health summary. - [POST /ccm/api/governance/recommendationHealth/list](https://apidocs.harness.io/governance-recommendation-apis/listgovernancerecommendationhealth.md) ## RuleEnforcement This contains APIs related to Rule Enforcement ### Update a Rule enforcement - [PUT /ccm/api/governance/enforcement](https://apidocs.harness.io/ruleenforcement/updateenforcement.md): Update a Rule enforcement ### Add a new rule Enforcement - [POST /ccm/api/governance/enforcement](https://apidocs.harness.io/ruleenforcement/addruleenforcement.md) ### Delete a rule enforcement - [DELETE /ccm/api/governance/enforcement/{enforcementID}](https://apidocs.harness.io/ruleenforcement/deleteruleenforcement.md): Delete a Rule enforcement for the given a ID. ### Fetch Rule Enforcements for given RuleIds/RuleSetIds - [POST /ccm/api/governance/enforcement/count](https://apidocs.harness.io/ruleenforcement/getruleenforcementcount.md): Fetch Rule Enforcements for given RuleIds/RuleSetIds ### Get Rule Enforcement details for given Enforcement Id - [GET /ccm/api/governance/enforcement/details](https://apidocs.harness.io/ruleenforcement/enforcementdetails.md): Get Rule Enforcement details ### Get Rule Enforcement savings for given Enforcement Id - [POST /ccm/api/governance/enforcement/savings](https://apidocs.harness.io/ruleenforcement/enforcementsavings.md): Get Rule Enforcement savings ### Fetch Rule Enforcements for account with filters - [POST /ccm/api/governance/enforcement/list](https://apidocs.harness.io/ruleenforcement/listruleenforcements.md): Fetch Rule Enforcements for account with filters ### Enable/Disable a Rule Enforcement for given Enforcement Id - [PUT /ccm/api/governance/enforcement/toggle](https://apidocs.harness.io/ruleenforcement/toggleenforcement.md): Toggle a Rule Enforcement ### Fetch Rule Enforcements for account (deprecated) - [GET /ccm/api/governance/enforcement/list](https://apidocs.harness.io/ruleenforcement/getruleenforcement.md): Fetch Rule Enforcement ## Rule Executions This contains APIs related to Rule Executions ### Export evaluations data - [POST /ccm/api/governance/execution/export](https://apidocs.harness.io/rule-executions/exportevaluations.md): Export evaluations data ### Fetch RuleExecutions for account - [POST /ccm/api/governance/execution/list](https://apidocs.harness.io/rule-executions/getruleexecutions.md): Fetch RuleExecutions ### Rule Execution Filter Values - [GET /ccm/api/governance/execution/filter-value](https://apidocs.harness.io/rule-executions/getruleexecutionsfiltervalues.md): Rule Execution Filter Values ### Get rule execution - [GET /ccm/api/governance/execution/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecution.md) ### Resources/logs for a rule execution - [GET /ccm/api/governance/execution/details/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutiondetails.md) ### Find last execution given rules list - [POST /ccm/api/governance/execution/ruleLastExecution](https://apidocs.harness.io/rule-executions/getrulelastexecution.md): Find last execution given rules list ### Refresh cost for a rule execution - [GET /ccm/api/governance/execution/refreshCost/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/refreshcostforruleexecution.md) ### Rule Execution Tag Filter Values - [POST /ccm/api/governance/execution/filter-value/tags](https://apidocs.harness.io/rule-executions/getruleexecutiontagfiltervalues.md): Rule Execution Tag Filter Values ### Return actioned resources for a rule execution (deprecated) - [GET /ccm/api/governance/actionedResources/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutionactionedresources.md) ### Return resource for a rule execution (deprecated) - [GET /ccm/api/governance/granularStatus/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutiongranularstatus.md) ### Return logs for a rule execution (deprecated) - [GET /ccm/api/governance/logs/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutionlogs.md) ### Return governance rule yaml for a rule execution (deprecated) - [GET /ccm/api/governance/ruleYaml/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutionruleyaml.md) ### Return resources for a rule execution (deprecated) - [GET /ccm/api/governance/status/{ruleExecutionId}](https://apidocs.harness.io/rule-executions/getruleexecutionstatus.md) ## Rule This contains APIs related to Governance Rule Management ### Clone a rule - [POST /ccm/api/governance/ruleClone](https://apidocs.harness.io/rule/clonerule.md): Clone a Rule with the given ID. ### Update a Rule - [PUT /ccm/api/governance/rule](https://apidocs.harness.io/rule/updaterule.md): Update a Rule ### Add a rule - [POST /ccm/api/governance/rule](https://apidocs.harness.io/rule/createnewrule.md): Create a new governance rule. ### Get a governance rule - [GET /ccm/api/governance/rule/{ruleID}](https://apidocs.harness.io/rule/getgovernancerule.md): Get a governance rule with the given ID. ### Delete a rule - [DELETE /ccm/api/governance/rule/{ruleID}](https://apidocs.harness.io/rule/deleterule.md): Delete a Rule with the given ID. ### Enqueue jobs for evaluation. - [POST /ccm/api/governance/enqueue](https://apidocs.harness.io/rule/enqueuegovernancejob.md): Enqueue jobs for evaluation. ### Simple Request to enqueue rule for execution - [POST /ccm/api/governance/enqueueAdhocV2](https://apidocs.harness.io/rule/simpleenqueueadhocgovernancerule.md): Simple Request to enqueue rule for execution ### List resources for which cost co-relation is supported. - [GET /ccm/api/governance/rule/costCoRelationSupportedResources](https://apidocs.harness.io/rule/costcorelationsupportedresources.md): List resources for which cost co-relation is supported. ### Custodian Schema - [GET /ccm/api/governance/ruleSchema](https://apidocs.harness.io/rule/governanceruleschema.md): Get custodian schema for governance rule validation ### Fetch potential rules that can be enabled for recommendation for account - [GET /ccm/api/governance/rule/potentialRulesForRecommendation](https://apidocs.harness.io/rule/getpotentialrulesforrecommendation.md): Fetch potential rules that can be enabled for recommendation for account ### Fetch rules for account - [POST /ccm/api/governance/rule/list](https://apidocs.harness.io/rule/getpolicies.md): Fetch rules ### Governance Targets - [GET /ccm/api/governance/governanceTargetList](https://apidocs.harness.io/rule/governancetargetlist.md): Get targets with governance enabled and valid permission ### List of Regions for Aws/Azure - [GET /ccm/api/governance/regions](https://apidocs.harness.io/rule/regions.md): List Aws/Azure Regions for filtering resources. ### Enable/Disable a custom Rule to be considered for recommendation - [PUT /ccm/api/governance/rule/toggleForRecommendation](https://apidocs.harness.io/rule/toggleforrecommendation.md): Toggle a Rule for Recommendation ### Validate Governance Rule - [POST /ccm/api/governance/ruleValidate](https://apidocs.harness.io/rule/validategovernancerule.md): Validate governance rule for syntactical errors. ## Rule Sets Rule sets serve as logical bindings on top of individual rules that help you organize and manage rules. ### Update a Rule set - [PUT /ccm/api/governance/ruleSet](https://apidocs.harness.io/rule-sets/updateruleset.md): Update a Rule set ### Add a rule Set - [POST /ccm/api/governance/ruleSet](https://apidocs.harness.io/rule-sets/addruleset.md) ### Delete a rule set - [DELETE /ccm/api/governance/ruleSet/{ruleSetId}](https://apidocs.harness.io/rule-sets/deleteruleset.md): Delete a Rule set for the given a ID. ### Fetch rule sets for account - [POST /ccm/api/governance/ruleSet/list](https://apidocs.harness.io/rule-sets/listrulesets.md): List all rule sets ## Perspectives Folders Group your Perspectives using Folders in ways that are more meaningful to your business needs. ### Create a Perspective folder - [POST /ccm/api/perspectiveFolders/create](https://apidocs.harness.io/perspectives-folders/createperspectivefolder.md): Create a Perspective Folder. ### Delete a folder - [DELETE /ccm/api/perspectiveFolders/{folderId}](https://apidocs.harness.io/perspectives-folders/deletefolder.md): Delete a Folder for the given Folder ID. ### Fetch folders for an account - [GET /ccm/api/perspectiveFolders](https://apidocs.harness.io/perspectives-folders/getfolders.md): Fetch folders given an accountId ### Update a folder - [PUT /ccm/api/perspectiveFolders](https://apidocs.harness.io/perspectives-folders/updatefolder.md): Update a folder ### Return details of all the Perspectives - [GET /ccm/api/perspectiveFolders/{folderId}/perspectives](https://apidocs.harness.io/perspectives-folders/getallfolderperspectives.md): Return details of all the Perspectives for the given account ID and folder ### Move a Perspective - [POST /ccm/api/perspectiveFolders/movePerspectives](https://apidocs.harness.io/perspectives-folders/moveperspectives.md): Move a perspective from a folder to another. ## Perspective Reports Manage cost reports created on Perspectives. ### Fetch details of a cost Report - [GET /ccm/api/perspectiveReport/{accountIdentifier}](https://apidocs.harness.io/perspective-reports/getreportsetting.md): Fetch cost Report details for the given Report ID or a Perspective ID. ### Update a cost Perspective Report - [PUT /ccm/api/perspectiveReport/{accountIdentifier}](https://apidocs.harness.io/perspective-reports/updatereportsetting.md): Update cost Perspective Reports. ### Create a schedule for a Report - [POST /ccm/api/perspectiveReport/{accountIdentifier}](https://apidocs.harness.io/perspective-reports/createreportsetting.md): Create a report schedule for the given Report ID or a Perspective ID. ### Delete cost Perspective report - [DELETE /ccm/api/perspectiveReport/{accountIdentifier}](https://apidocs.harness.io/perspective-reports/deletereportsetting.md): Delete cost Perspective Report for the given Report ID or a Perspective ID. ### Fetch cost Report details accessible to a user - [POST /ccm/api/perspectiveReport/getAllReports](https://apidocs.harness.io/perspective-reports/getallreports.md): Fetch cost Report details accessible to a user. ### Send mail based on reportId - [POST /ccm/api/perspectiveReport/sendMail](https://apidocs.harness.io/perspective-reports/sendmail.md): Send mail based on reportId. ## Perspectives Group your resources using Perspectives in ways that are more meaningful to your business needs. ### Fetch details of a Perspective - [GET /ccm/api/perspective](https://apidocs.harness.io/perspectives/getperspective.md): Fetch details of a Perspective for the given Perspective ID. ### Update a Perspective - [PUT /ccm/api/perspective](https://apidocs.harness.io/perspectives/updateperspective.md): Update a Perspective. It accepts a CEView object and upserts it using the uuid mentioned in the definition. ### Create a Perspective - [POST /ccm/api/perspective](https://apidocs.harness.io/perspectives/createperspective.md): Create a Perspective. You can set the clone parameter as true to clone a Perspective. ### Delete a Perspective - [DELETE /ccm/api/perspective](https://apidocs.harness.io/perspectives/deleteperspective.md): Delete a Perspective for the given Perspective ID. ### Return details of all the Perspectives - [GET /ccm/api/perspective/getAllPerspectives](https://apidocs.harness.io/perspectives/getallperspectives.md): Return details of all the Perspectives for the given account ID. ### Get the last period cost for a Perspective - [GET /ccm/api/perspective/lastPeriodCost](https://apidocs.harness.io/perspectives/getlastperiodcost_1.md): Get last period cost for a Perspective ### Get the last twelve month cost for a Perspective - [GET /ccm/api/perspective/lastYearMonthlyCost](https://apidocs.harness.io/perspectives/getlastyearmonthlycost.md): Get last twelve month cost for a Perspective ## Cost Category Jira Project Mapping Cost Category Jira Project Mapping CRUD APIs. ### Bulk sync cost category jira project mappings - [PUT /ccm/api/recommendation/cost-category/jira-mapping/bulk](https://apidocs.harness.io/cost-category-jira-project-mapping/bulksynccostcategoryjiramappings.md): Bulk sync cost category jira project mappings. This syncs the database to match the provided list by creating new mappings, updating existing ones, and deleting mappings not in the list. ### List all cost category jira project mapping - [GET /ccm/api/recommendation/cost-category/jira-mapping](https://apidocs.harness.io/cost-category-jira-project-mapping/listcostcategoryjiramapping.md): List all cost category jira project mapping ### Create cost category jira project mapping - [POST /ccm/api/recommendation/cost-category/jira-mapping](https://apidocs.harness.io/cost-category-jira-project-mapping/createcostcategoryjiramapping.md): Create cost category jira project mapping ### Get cost category jira project preference by ID - [GET /ccm/api/recommendation/cost-category/jira-mapping/{mappingId}](https://apidocs.harness.io/cost-category-jira-project-mapping/getcostcategoryjiramapping.md): Get cost category jira project preference by ID ### Update cost category jira project mapping - [PUT /ccm/api/recommendation/cost-category/jira-mapping/{mappingId}](https://apidocs.harness.io/cost-category-jira-project-mapping/updatecostcategoryjiramapping.md): Update cost category jira project mapping ### Delete cost category jira project mapping - [DELETE /ccm/api/recommendation/cost-category/jira-mapping/{mappingId}](https://apidocs.harness.io/cost-category-jira-project-mapping/deletecostcategoryjiramapping.md): Delete cost category jira project mapping ## Recommendations Details Recommendations details for workloads and node pools. ### Return Azure VM Recommendation - [GET /ccm/api/recommendation/details/azure-vm](https://apidocs.harness.io/recommendations-details/azurevmrecommendationdetail.md): Returns Azure VM Recommendation details for the given Recommendation identifier. ### Return EC2 Recommendation - [GET /ccm/api/recommendation/details/ec2-instance](https://apidocs.harness.io/recommendations-details/ec2recommendationdetail.md): Returns EC2 or AWS Passthrough V2 Recommendation details for the given Recommendation identifier. ### Return ECS Recommendation - [GET /ccm/api/recommendation/details/ecs-service](https://apidocs.harness.io/recommendations-details/ecsrecommendationdetail.md): Returns ECS Recommendation details for the given Recommendation identifier. ### Return node pool Recommendation - [GET /ccm/api/recommendation/details/node-pool](https://apidocs.harness.io/recommendations-details/noderecommendationdetail.md): Returns node pool Recommendation details for the given identifier. ### Return workload Recommendation - [GET /ccm/api/recommendation/details/workload](https://apidocs.harness.io/recommendations-details/workloadrecommendationdetail.md): Returns workload Recommendation details for the given Recommendation identifier. ## Recommendations Recommendations for workloads and node pools. ### Returns Applied Recommendations statistics grouped by Resource type with total savings - [POST /ccm/api/recommendation/overview/stats/applied](https://apidocs.harness.io/recommendations/appliedrecommendationresourcestats.md): Returns the Applied Recommendations statistics grouped by resource type with total savings. ### Return void - [POST /ccm/api/recommendation/overview/change-inference-status](https://apidocs.harness.io/recommendations/changeinferencestate.md): Mark recommendation as inferred verified/rejected ### Return void - [POST /ccm/api/recommendation/overview/change-state](https://apidocs.harness.io/recommendations/changerecommendationstate.md): Mark recommendation as applied/open ### Return the number of Recommendations - [POST /ccm/api/recommendation/overview/count](https://apidocs.harness.io/recommendations/recommendationscount.md): Returns the total number of Recommendations based on the specified filters. ### Return the list of filter values for the Recommendations - [POST /ccm/api/recommendation/overview/filter-values](https://apidocs.harness.io/recommendations/recommendationfiltervalues.md): Returns the list of filter values for all the specified filters. ### Return list of supported recommendation filters - [GET /ccm/api/recommendation/overview/supported-filters](https://apidocs.harness.io/recommendations/getsupportedrecommendationfilters.md): Returns the list of supported filter field IDs for recommendations. ### Return the list of Recommendations - [POST /ccm/api/recommendation/overview/list](https://apidocs.harness.io/recommendations/listrecommendations.md): Returns the list of Recommendations for the specified filters. ### Return boolean - [PUT /ccm/api/recommendation/overview/override-savings](https://apidocs.harness.io/recommendations/overriderecommendationsavings.md): Override savings for recommendation ### Return time series statistics for realized savings with date information - [POST /ccm/api/recommendation/overview/realized-savings](https://apidocs.harness.io/recommendations/realizedsavingstimeseries.md): Returns the time series statistics for realized savings from applied recommendations. ### Return Recommendations statistics Grouped on Resource Type - [POST /ccm/api/recommendation/overview/resource-type/stats](https://apidocs.harness.io/recommendations/recommendationresourcetypestats.md): Returns the Recommendations statistics for the specified filters Grouped on Resource Type. ### Return Recommendations statistics - [POST /ccm/api/recommendation/overview/stats](https://apidocs.harness.io/recommendations/recommendationstats.md): Returns the Recommendations statistics for the specified filters. ### Return Recommendations for Terraform Resources - [POST /ccm/api/recommendation/overview/terraform-resources](https://apidocs.harness.io/recommendations/terraformresourcerecommendations.md): Returns the Recommendations for Terraform-managed resources based on cloud-native identifiers (ARNs, FQNs, GRNs). ## Recommendation Jira Recommendation CRUD apis for jira. ### Create jira for recommendation - [POST /ccm/api/recommendation/jira/create](https://apidocs.harness.io/recommendation-jira/createrecommendationjira.md): Create jira for recommendation ### Get all Jira field mappings - [GET /ccm/api/recommendation/jira/field-mapping](https://apidocs.harness.io/recommendation-jira/getjirafieldmappings.md): Get all Jira field mappings for account ### Replace Jira field mappings for a field type - [POST /ccm/api/recommendation/jira/field-mapping](https://apidocs.harness.io/recommendation-jira/upsertjirafieldmapping.md): Replaces all Jira field mappings for the given fieldType (savings or variance) with the provided set ### Delete Jira field mapping - [DELETE /ccm/api/recommendation/jira/field-mapping](https://apidocs.harness.io/recommendation-jira/deletejirafieldmapping.md): Delete Jira field mapping for a project, optionally for a specific issue type ### Delete Jira from recommendations - [POST /ccm/api/recommendation/jira/delete](https://apidocs.harness.io/recommendation-jira/deletejirafromrecommendations.md): Delete Jira details from recommendations ### Get all jira statuses - [GET /ccm/api/recommendation/jira/statuses](https://apidocs.harness.io/recommendation-jira/getjirastatuses.md): Get all jira statuses ### Get common Jira fields across projects and issue types - [POST /ccm/api/recommendation/jira/common-fields](https://apidocs.harness.io/recommendation-jira/getcommonjirafields.md): Get intersection of fields across multiple projects and issue types ### Get common Jira issue types across projects - [POST /ccm/api/recommendation/jira/common-issue-types](https://apidocs.harness.io/recommendation-jira/getcommonjiraissuetypes.md): Get intersection of issue types across multiple Jira projects ### Get mapped jira projects for given recommendation - [GET /ccm/api/recommendation/jira/mapped-projects](https://apidocs.harness.io/recommendation-jira/getmappedprojects.md): Get mapped jira projects for given recommendation ### Get all jira resolution codes - [GET /ccm/api/recommendation/jira/resolution-code](https://apidocs.harness.io/recommendation-jira/getresolutioncodes.md): Get all jira resolution codes ## Recommendation Preferences Recommendation apis for recommendations preferences. ### Update a cloud account override - [PUT /ccm/api/recommendation/preference/cloud-account-override/{uuid}](https://apidocs.harness.io/recommendation-preferences/updatecloudaccountoverride.md): Update the cloud accounts for an existing override identified by its ID ### Delete a cloud account override - [DELETE /ccm/api/recommendation/preference/cloud-account-override/{uuid}](https://apidocs.harness.io/recommendation-preferences/deletecloudaccountoverride.md): Delete a cloud account level preset override by its ID ### Get applied preferences for given account - [GET /ccm/api/recommendation/preference](https://apidocs.harness.io/recommendation-preferences/getrecommendationpreferences.md): Get applied preferences for given account ### Update preference - [PUT /ccm/api/recommendation/preference](https://apidocs.harness.io/recommendation-preferences/updatepreset.md): update preferences for your recommendations ### Get cloud account override overview - [GET /ccm/api/recommendation/preference/cloud-account-override/overview](https://apidocs.harness.io/recommendation-preferences/getcloudaccountoverrideoverview.md): Get an overview of cloud provider recommendation preferences with default presets and override counts per resource type ### List cloud account overrides by resource type - [GET /ccm/api/recommendation/preference/cloud-account-override](https://apidocs.harness.io/recommendation-preferences/listcloudaccountoverridesbyresourcetype.md): List all cloud account level preset overrides for a given resource type ### Create a cloud account override - [POST /ccm/api/recommendation/preference/cloud-account-override](https://apidocs.harness.io/recommendation-preferences/createcloudaccountoverride.md): Create a cloud account level preset override for recommendations. If an override already exists for the same resource type and preset, the cloud accounts will be merged into the existing record. ## Recommendation Presets Recommendation apis for recommendations presets. ### Update an existing preset - [PUT /ccm/api/recommendation/preset/{id}](https://apidocs.harness.io/recommendation-presets/updatepreset_1.md): Update an existing Recommendation Preset for the given Preset ID. ### Delete a preset - [DELETE /ccm/api/recommendation/preset/{id}](https://apidocs.harness.io/recommendation-presets/deletepreset.md): Delete a Recommendation preset for the given preset ID. ### Get all presets for given account - [GET /ccm/api/recommendation/preset](https://apidocs.harness.io/recommendation-presets/getrecommendationpresets.md): Get all presets for given account ### Create a Preset - [POST /ccm/api/recommendation/preset](https://apidocs.harness.io/recommendation-presets/createpreset.md): Create a Preset to set preferences for your recommendations ## Recommendation Servicenow Recommendation CRUD apis for servicenow. ### Create servicenow ticket for recommendation - [POST /ccm/api/recommendation/servicenow/create](https://apidocs.harness.io/recommendation-servicenow/createrecommendationservicenowticket.md): Create Servicenow ticket for recommendation ### getServiceNowServiceRequestFields - [GET /ccm/api/recommendation/servicenow/serviceRequestFields](https://apidocs.harness.io/recommendation-servicenow/getservicenowservicerequestfields.md) ## Recommendation Tags Recommendation apis for recommendations tags. ### Get tags for given recommendation - [GET /ccm/api/recommendation/tags](https://apidocs.harness.io/recommendation-tags/getrecommendationtags.md): Get tags key value pairs for given recommendation ### Get tag (keys)/(values for a particular tag key) for recommendation filter panel - [GET /ccm/api/recommendation/tags/filter-panel](https://apidocs.harness.io/recommendation-tags/gettagsforfilterpanel.md): Get tag (keys)/(values for a particular tag key) for recommendation filter panel ## Recommendation Ignore List Recommendation CRUD apis for recommendations ignore list. ### Add resources to recommendations ignore list - [POST /ccm/api/recommendation/ignore-list/add](https://apidocs.harness.io/recommendation-ignore-list/addrecommendationsignorelist.md): Add resources to recommendations ignore list ### Get resources in recommendations ignore list - [GET /ccm/api/recommendation/ignore-list](https://apidocs.harness.io/recommendation-ignore-list/getrecommendationsignorelist.md): Get resources in recommendations ignore list ### Remove resources from recommendations ignore list - [POST /ccm/api/recommendation/ignore-list/remove](https://apidocs.harness.io/recommendation-ignore-list/removerecommendationsignorelist.md): Remove resources from recommendations ignore list ## AutoStopping Rules This contains APIs to create and manage AutoStopping Rules for your cloud resources. ### List AutoStopping Rules - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules](https://apidocs.harness.io/autostopping-rules/listautostoppingrules.md): Retrieves a list of all AutoStopping Rules configured in your account. AutoStopping Rules help optimize cloud costs by automatically stopping idle resources and starting them on-demand when accessed. ### Create an AutoStopping Rule - [POST /gateway/lw/api/accounts/{account_id}/autostopping/rules](https://apidocs.harness.io/autostopping-rules/updateautostoppingrule.md): Creates a new AutoStopping Rule to automatically manage cloud resources and reduce costs. The rule monitors resource activity and automatically stops resources during idle periods, then restarts them when traffic is detected. You can configure idle time thresholds, access methods (HTTP/HTTPS, SSH, RDP), custom domains, and schedules. ### Return AutoStopping Rule details - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}](https://apidocs.harness.io/autostopping-rules/autostoppingruledetails.md): Retrieves details of a specific AutoStopping Rule including its configuration, associated resources, idle time settings, etc. ### Delete an AutoStopping Rule - [DELETE /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}](https://apidocs.harness.io/autostopping-rules/deleteautostoppingrule.md): Permanently deletes an AutoStopping Rule from your account. ⚠️ CAUTION: This action is irreversible. Once deleted, the rule configuration cannot be recovered. Resources that were managed by this rule will no longer be automatically stopped, which may result in increased cloud costs. ### Return health status of an AutoStopping Rule - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/health](https://apidocs.harness.io/autostopping-rules/healthofautostoppingrule.md): Retrieves the current health and operational status of an AutoStopping Rule. ### Return savings details for an AutoStopping Rule - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/savings](https://apidocs.harness.io/autostopping-rules/savingsfromautostoppingrule.md): Retrieves detailed cost savings data for a specific AutoStopping Rule grouped by day over the specified time period. ### List all the resources for an AutoStopping Rule - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/resources](https://apidocs.harness.io/autostopping-rules/allautostoppingresources.md): Lists all the resources for an AutoStopping Rule for the given identifier. ### Return diagnostics result of an AutoStopping Rule - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/diagnostics](https://apidocs.harness.io/autostopping-rules/getautostoppingdiagnostics.md): Retrieves diagnostic information for an AutoStopping Rule to help troubleshoot issues. ### Warm up an AutoStopping Rule - [POST /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/warmup](https://apidocs.harness.io/autostopping-rules/warmupautostoppingrule.md): Manually starts (warms up) the resources managed by an AutoStopping Rule, bringing them online immediately. ### Cool down an AutoStopping Rule - [POST /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown](https://apidocs.harness.io/autostopping-rules/cooldownautostoppingrule.md): Manually stops (cools down) the resources managed by an AutoStopping Rule, shutting them down immediately to save costs. ### Return metadata of cool down of an AutoStopping Rule - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/cooldown_meta](https://apidocs.harness.io/autostopping-rules/getautostoppingcooldownmeta.md): Retrieves metadata about the cooldown configuration and status of an AutoStopping Rule. ### Return cumulative savings for all the AutoStopping Rules - [GET /gateway/lw/api/accounts/{account_id}/autostopping/rules/savings/cumulative](https://apidocs.harness.io/autostopping-rules/cumulativeautostoppingsavings.md): Retrieves the total cumulative cost savings achieved across all AutoStopping Rules in the account. ### Disable/Enable an Autostopping Rule - [PUT /gateway/lw/api/accounts/{account_id}/autostopping/rules/{rule_id}/toggle_state](https://apidocs.harness.io/autostopping-rules/toggleautostoppingrule.md): Enables or disables an AutoStopping Rule. When disabled, the rule will not automatically stop resources during idle periods. ## AutoStopping Rules V2 This contains Autostopping v2 APIs that support the usage of Autostopping Proxy for managing cloud resources. ### Create an AutoStopping Rule - [POST /gateway/lw/api/accounts/{account_id}/autostopping/v2/rules](https://apidocs.harness.io/autostopping-rules-v2/createautostoppingrulev2.md): Creates a new AutoStopping Rule using the V2 API format with enhanced proxy support. ### Return AutoStopping Rule details in V2 format - [GET /gateway/lw/api/accounts/{account_id}/autostopping/v2/rules/{rule_id}](https://apidocs.harness.io/autostopping-rules-v2/getautostoppingrulev2.md): Retrieves details of an AutoStopping Rule in V2 format with enhanced proxy configuration details. ### Update an existing AutoStopping Rule - [PUT /gateway/lw/api/accounts/{account_id}/autostopping/v2/rules/{rule_id}](https://apidocs.harness.io/autostopping-rules-v2/updateautostoppingrulev2.md): Updates an existing AutoStopping Rule configuration using the V2 API format. ## AutoStopping Load Balancers This contains APIs to create and manage load balancers used for AutoStopping. ### Return all the load balancers - [GET /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers](https://apidocs.harness.io/autostopping-load-balancers/listloadbalancers.md): Retrieves a list of all AutoStopping load balancers configured in your account. Load balancers act as proxy entry points that route traffic to your AutoStopping Rules. ### Update a load balancer - [PUT /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers](https://apidocs.harness.io/autostopping-load-balancers/editloadbalancer.md): Updates the configuration of an existing AutoStopping load balancer. ### Create a load balancer - [POST /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers](https://apidocs.harness.io/autostopping-load-balancers/createloadbalancer.md): Creates a new AutoStopping load balancer to act as a proxy entry point for routing traffic to AutoStopping Rules. ### Delete load balancers and the associated resources - [DELETE /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers](https://apidocs.harness.io/autostopping-load-balancers/deleteloadbalancer.md): Permanently deletes one or more AutoStopping load balancers and their associated resources. ⚠️ CAUTION: This action is irreversible. Once deleted, the load balancer configuration cannot be recovered. Any AutoStopping Rules using this load balancer will lose their access point and may become inaccessible. ### Return details of a load balancer - [GET /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}](https://apidocs.harness.io/autostopping-load-balancers/describeloadbalancer.md): Retrieves detailed configuration and status information for a specific AutoStopping load balancer. ### Return all the AutoStopping Rules in a load balancer - [GET /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/rules](https://apidocs.harness.io/autostopping-load-balancers/accesspointrules.md): Retrieves a list of all AutoStopping Rules that are configured to route traffic through a specific load balancer. ### Return last activity details of a load balancer - [GET /gateway/lw/api/accounts/{account_id}/autostopping/loadbalancers/{lb_id}/last_active_at](https://apidocs.harness.io/autostopping-load-balancers/loadbalanceractivity.md): Retrieves the timestamp of the most recent activity (traffic) through the load balancer. ## AutoStopping Fixed Schedules This contains APIs to manage fixed schedules for the AutoStopping Rules. ### Return all the AutoStopping Rule fixed schedules - [GET /gateway/lw/api/accounts/{account_id}/schedules](https://apidocs.harness.io/autostopping-fixed-schedules/listautostoppingschedules.md): Retrieves all fixed schedules configured for an AutoStopping Rule. Fixed schedules define specific times when resources should be automatically started or stopped. ### Create a fixed schedule for an AutoStopping Rule - [POST /gateway/lw/api/accounts/{account_id}/schedules](https://apidocs.harness.io/autostopping-fixed-schedules/createautostoppingschedules.md): Creates a new fixed schedule for an AutoStopping Rule to automatically start or stop resources at specific times. ### Delete a fixed schedule for AutoStopping Rule - [DELETE /gateway/lw/api/accounts/{account_id}/schedules/{schedule_id}](https://apidocs.harness.io/autostopping-fixed-schedules/deleteautostoppingschedule.md): Permanently deletes a fixed schedule from an AutoStopping Rule. The rule will no longer start or stop resources based on this schedule. ## AutoStopping Alerts This contains APIs to create and manage alerts for AutoStopping events and notifications. ### Create Alert - [POST /gateway/lw/api/accounts/{account_id}/alerts](https://apidocs.harness.io/autostopping-alerts/createalert.md): Creates a new alert configuration for AutoStopping events. Alerts can notify users via email or Slack when specific events occur, such as warmup failures, cooldown failures, or rule lifecycle changes. ### Update Alert - [PUT /gateway/lw/api/accounts/{account_id}/alerts](https://apidocs.harness.io/autostopping-alerts/updatealert.md): Updates an existing alert configuration. The alert ID must be provided in the request body. ### List Alerts - [POST /gateway/lw/api/accounts/{account_id}/alerts/list](https://apidocs.harness.io/autostopping-alerts/listalerts.md): Retrieves a paginated list of alerts matching the specified search criteria. Supports filtering by entity type, entity IDs, enabled status, events, and name search. ### Get Alert - [GET /gateway/lw/api/accounts/{account_id}/alerts/{alert_id}](https://apidocs.harness.io/autostopping-alerts/getalert.md): Retrieves the details of a specific alert by its ID. ### Delete Alert - [DELETE /gateway/lw/api/accounts/{account_id}/alerts/{alert_id}](https://apidocs.harness.io/autostopping-alerts/deletealert.md): Deletes an alert by its ID. This is a soft delete operation. ## Commitment Orchestrator Events APIs This contains APIs to fetch commitment orchestrator events data. ### List event logs - [POST /gateway/lw/api/accounts/{account_id}/v1/events/chart](https://apidocs.harness.io/commitment-orchestrator-events-apis/eventschart.md): Obtains list of events and the count of their occurences grouped by date ### List auto-renewal events - [POST /gateway/lw/api/accounts/{account_id}/v1/events/renewal_events](https://apidocs.harness.io/commitment-orchestrator-events-apis/renewalevents.md): Returns auto-renewal activities (upcoming and completed) for the account, filtered by date range and optional cloud account, regions, and AWS service. Used to annotate charts such as Compute Coverage when savings or coverage dip around RI/SP renewals. If start_date and end_date are omitted, the server defaults to the last 30 days (UTC). ### RI recommendation cooldown schedule - [GET /gateway/lw/api/accounts/{account_id}/v1/events/ri_recommendation_schedule](https://apidocs.harness.io/commitment-orchestrator-events-apis/rirecommendationschedule.md): Returns the configured minimum interval between RI recommendation engine runs and when the next run becomes eligible, based on the latest completed approval transaction for the account and service. ## API Keys APIs to create and manage Feature Flag SDK API Keys ### Returns API Keys for an Environment - [GET /cf/admin/apikey](https://apidocs.harness.io/api-keys/getallapikeys.md): Returns all the API Keys for an Environment ### Creates an API key for the given Environment - [POST /cf/admin/apikey](https://apidocs.harness.io/api-keys/addapikey.md): Creates an API key for the given Environment ### Deletes an API Key - [DELETE /cf/admin/apikey/{identifier}](https://apidocs.harness.io/api-keys/deleteapikey.md): Deletes an API key for the given identifier ### Returns API keys - [GET /cf/admin/apikey/{identifier}](https://apidocs.harness.io/api-keys/getapikey.md): Returns all the API Keys for the given identifier ### Updates an API Key - [PUT /cf/admin/apikey/{identifier}](https://apidocs.harness.io/api-keys/updateapikey.md): Updates an API key for the given identifier ## Feature Flags APIs to create and manage Feature Flags ### Returns all Feature Flags for the project - [GET /cf/admin/features](https://apidocs.harness.io/feature-flags/getallfeatures.md): Returns all the Feature Flag details for the given project ### Creates a Feature Flag - [POST /cf/admin/features](https://apidocs.harness.io/feature-flags/createfeatureflag.md): Creates a Feature Flag in the Project ### Delete a Feature Flag - [DELETE /cf/admin/features/{identifier}](https://apidocs.harness.io/feature-flags/deletefeatureflag.md): Delete Feature Flag for the given identifier and account ID ### Returns a Feature Flag - [GET /cf/admin/features/{identifier}](https://apidocs.harness.io/feature-flags/getfeatureflag.md): Returns details such as Variation name, identifier etc for the given Feature Flag ### Updates a Feature Flag - [PATCH /cf/admin/features/{identifier}](https://apidocs.harness.io/feature-flags/patchfeature.md): This operation is used to modify a Feature Flag. The request body can include one or more instructions that can modify flag attributes such as the state (off|on), the variations that are returned and serving rules. For example if you want to turn a flag off you can use this opeartion and send the setFeatureFlagState { "kind": "setFeatureFlagState", "parameters": { "state": "off" } } ### Updates a Feature Flag - [PUT /cf/admin/features/{identifier}](https://apidocs.harness.io/feature-flags/putfeatureflag.md): Updates a Feature Flag in the Project ### Return a list of dependant flags - [GET /cf/admin/features/{identifier}/dependants](https://apidocs.harness.io/feature-flags/getdependentfeatures.md): Given identifier return list all the flags which depend on it. ### Restore a Feature Flag - [POST /cf/admin/features/{identifier}/restore](https://apidocs.harness.io/feature-flags/restorefeatureflag.md): Restore Feature Flag for the given identifier and account ID ## Targets APIs to create and manage Feature Flag Targets ### Returns all Targets - [GET /cf/admin/targets](https://apidocs.harness.io/targets/getalltargets.md): Returns all the Targets for the given Account ID ### Creates a Target - [POST /cf/admin/targets](https://apidocs.harness.io/targets/createtarget.md): Create Targets for the given identifier ### Add Target details - [POST /cf/admin/targets/upload](https://apidocs.harness.io/targets/uploadtargets.md): Add targets by uploading a CSV file ### Deletes a Target - [DELETE /cf/admin/targets/{identifier}](https://apidocs.harness.io/targets/deletetarget.md): Deletes a Target for the given identifier ### Returns details of a Target - [GET /cf/admin/targets/{identifier}](https://apidocs.harness.io/targets/gettarget.md): Returns details of a Target for the given identifier ### Updates a Target - [PATCH /cf/admin/targets/{identifier}](https://apidocs.harness.io/targets/patchtarget.md): Updates a Target for the given identifier ### Modifies a Target - [PUT /cf/admin/targets/{identifier}](https://apidocs.harness.io/targets/modifytarget.md): Modifies a Target for the given account identifier ### Returns Target Groups for the given Target - [GET /cf/admin/targets/{identifier}/segments](https://apidocs.harness.io/targets/gettargetsegments.md): Returns the Target Groups that the specified Target belongs to. ## Target Groups APIs to create and manage Feature Flag Target Groups ### Returns all Target Groups - [GET /cf/admin/segments](https://apidocs.harness.io/target-groups/getallsegments.md): Returns Target Group details for the given account ### Creates a Target Group - [POST /cf/admin/segments](https://apidocs.harness.io/target-groups/createsegment.md): Creates a Target Group in the given Project ### Deletes a Target Group - [DELETE /cf/admin/segments/{identifier}](https://apidocs.harness.io/target-groups/deletesegment.md): Deletes a Target Group for the given ID ### Returns Target Group details for the given identifier - [GET /cf/admin/segments/{identifier}](https://apidocs.harness.io/target-groups/getsegment.md): Returns Target Group details for the given ID ### Updates a Target Group - [PATCH /cf/admin/segments/{identifier}](https://apidocs.harness.io/target-groups/patchsegment.md): Updates a Target Group for the given identifier ### Returns Feature Flags that are available to be added to the given Target Group - [GET /cf/admin/segments/{identifier}/available_flags](https://apidocs.harness.io/target-groups/getavailableflagsforsegment.md): Returns the list of Feature Flags that the Target Group can be added to. This list will exclude any Feature Flag that the Target Group is already part of. ### Returns Feature Flags in a Target Group - [GET /cf/admin/segments/{identifier}/flags](https://apidocs.harness.io/target-groups/getsegmentflags.md): Returns the details of a Feature Flag in a Target Group for the given identifier ## Environment Perspectives APIs to create and manage Feature Flag Environment perspectives ### Delete a Perspective - Environment link. - [DELETE /cf/admin/environments/perspectives](https://apidocs.harness.io/environment-perspectives/deleteperspective.md): Deletes a perspective from an environment. An Environment can only have one Perspective ### Upsert a Perspective to an Environment. - [PUT /cf/admin/environments/perspectives](https://apidocs.harness.io/environment-perspectives/upsertperspective.md): Adds a perspective to an environment, or updates an existing. An Environment can only have one Perspective ## Proxy APIs used by the ff-proxy ### Returns all Proxy keys in an account - [GET /cf/admin/proxy/keys](https://apidocs.harness.io/proxy/getproxykeys.md): Returns all the Proxy keys in an account ### Creates a Proxy Key in the account & org - [POST /cf/admin/proxy/keys](https://apidocs.harness.io/proxy/createproxykey.md): Creates a Proxy Key in the account & org ### Deletes a ProxyKey - [DELETE /cf/admin/proxy/keys/{identifier}](https://apidocs.harness.io/proxy/deleteproxykey.md): Deletes a ProxyKey ### Returns a ProxyKey - [GET /cf/admin/proxy/keys/{identifier}](https://apidocs.harness.io/proxy/getproxykey.md): Returns a ProxyKey ### Updates a Proxy Key in the account & org - [PATCH /cf/admin/proxy/keys/{identifier}](https://apidocs.harness.io/proxy/patchproxykey.md): This operation is used to modify which environments a ProxyKey has access to. The request body can include one or more instructions that can assign or unassign environmnets to the ProxyKey ## Tags APIs to create and manage Feature Flag Tags ### Returns all Tags - [GET /cf/admin/tags](https://apidocs.harness.io/tags/getalltags.md): Returns all the Tags for the given Account ID ### Creates a Tag - [POST /cf/admin/tags](https://apidocs.harness.io/tags/createtag.md): Create Tags for the given identifier ### Delete a Tag - [DELETE /cf/admin/tags/{identifier}](https://apidocs.harness.io/tags/deletetag.md): Delete Tag for the given identifier and account ID ### Returns a Tag - [GET /cf/admin/tags/{identifier}](https://apidocs.harness.io/tags/gettag.md): Returns details such as identifier,Associated Feature Flag etc for the given Tag ## Monitored Services This contains APIs related to CRUD operations of Monitored Services ### createDefaultMonitoredService - [POST /cv/api/monitored-service/create-default](https://apidocs.harness.io/monitored-services/createdefaultmonitoredservice.md) ### Get monitored service data - [GET /cv/api/monitored-service/{identifier}](https://apidocs.harness.io/monitored-services/getmonitoredservice.md) ### Updates monitored service data - [PUT /cv/api/monitored-service/{identifier}](https://apidocs.harness.io/monitored-services/updatemonitoredservice.md) ### Delete monitored service data - [DELETE /cv/api/monitored-service/{identifier}](https://apidocs.harness.io/monitored-services/deletemonitoredservice.md) ### delete template reference from monitored service - [PUT /cv/api/monitored-service/{identifier}/detach-template](https://apidocs.harness.io/monitored-services/detachmonitoredservicefromtemplate.md) ### getAllMonitoredServicesWithHealthSources - [GET /cv/api/monitored-service/all/time-series-health-sources](https://apidocs.harness.io/monitored-services/getallmonitoredserviceswithhealthsources.md) ### CvgetAnomaliesSummary - [GET /cv/api/monitored-service/{identifier}/anomaliesCount](https://apidocs.harness.io/monitored-services/cvgetanomaliessummary.md) ### getCountOfServices - [GET /cv/api/monitored-service/count-of-services](https://apidocs.harness.io/monitored-services/getcountofservices.md) ### getEnvironments - [GET /cv/api/monitored-service/environments](https://apidocs.harness.io/monitored-services/getenvironments.md) ### getHealthSources - [GET /cv/api/monitored-service/health-sources](https://apidocs.harness.io/monitored-services/gethealthsources.md) ### getHealthSourcesForMonitoredServiceIdentifier - [GET /cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources](https://apidocs.harness.io/monitored-services/gethealthsourcesformonitoredserviceidentifier.md) ### getList - [GET /cv/api/monitored-service/list](https://apidocs.harness.io/monitored-services/getlist.md) ### getListV2 - [GET /cv/api/monitored-service/platform/list](https://apidocs.harness.io/monitored-services/getlistv2.md) ### getMSSecondaryEvents - [GET /cv/api/monitored-service/{identifier}/secondary-events](https://apidocs.harness.io/monitored-services/getmssecondaryevents.md) ### getMSSecondaryEventsDetails - [GET /cv/api/monitored-service/secondary-events-details](https://apidocs.harness.io/monitored-services/getmssecondaryeventsdetails.md) ### getMonitoredServiceChangeDetails - [GET /cv/api/monitored-service/{monitoredServiceIdentifier}/change-details](https://apidocs.harness.io/monitored-services/getmonitoredservicechangedetails.md) ### getMonitoredServiceDetails - [GET /cv/api/monitored-service/{monitoredServiceIdentifier}/service-details](https://apidocs.harness.io/monitored-services/getmonitoredservicedetails.md) ### getMonitoredServiceFromServiceAndEnvironment - [GET /cv/api/monitored-service/service-environment](https://apidocs.harness.io/monitored-services/getmonitoredservicefromserviceandenvironment.md) ### getMonitoredServiceLogs - [GET /cv/api/monitored-service/{monitoredServiceIdentifier}/logs](https://apidocs.harness.io/monitored-services/getmonitoredservicelogs.md) ### fetch reconciliation status for template referenced monitored services - [GET /cv/api/monitored-service/reconciliation-status](https://apidocs.harness.io/monitored-services/getmonitoredservicereconciliationstatuses.md) ### get monitored service resolved template inputs - [GET /cv/api/monitored-service/{identifier}/resolved-template-inputs](https://apidocs.harness.io/monitored-services/getmonitoredserviceresolvedtemplateinputs.md) ### getMonitoredServiceScore - [GET /cv/api/monitored-service/{identifier}/scores](https://apidocs.harness.io/monitored-services/getmonitoredservicescore.md) ### Get notification rules for MonitoredService - [GET /cv/api/monitored-service/{identifier}/notification-rules](https://apidocs.harness.io/monitored-services/getnotificationrulesformonitoredservice.md) ### getOverAllHealthScore - [GET /cv/api/monitored-service/{identifier}/overall-health-score](https://apidocs.harness.io/monitored-services/getoverallhealthscore.md) ### getServices - [GET /cv/api/monitored-service/services](https://apidocs.harness.io/monitored-services/getservices.md) ### getSloMetrics - [GET /cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics](https://apidocs.harness.io/monitored-services/getslometrics.md) ### check if a template referenced monitored service(s) require reconciliation - [GET /cv/api/monitored-service/reconciliation-required](https://apidocs.harness.io/monitored-services/isreconciliationrequiredformonitoredservices.md) ### list - [GET /cv/api/monitored-service](https://apidocs.harness.io/monitored-services/list.md) ### Saves monitored service data - [POST /cv/api/monitored-service](https://apidocs.harness.io/monitored-services/savemonitoredservice.md) ### Saves monitored service from template input - [POST /cv/api/monitored-service/template-input](https://apidocs.harness.io/monitored-services/savemonitoredservicefromtemplateinput.md) ### saveMonitoredServiceFromYaml - [POST /cv/api/monitored-service/yaml](https://apidocs.harness.io/monitored-services/savemonitoredservicefromyaml.md) ### setHealthMonitoringFlag - [PUT /cv/api/monitored-service/{identifier}/health-monitoring-flag](https://apidocs.harness.io/monitored-services/sethealthmonitoringflag.md) ### Update monitored service from yaml or template - [PUT /cv/api/monitored-service/{identifier}/template-input](https://apidocs.harness.io/monitored-services/updatemonitoredservicefromtemplateinput.md) ### updateMonitoredServiceFromYaml - [PUT /cv/api/monitored-service/{identifier}/yaml](https://apidocs.harness.io/monitored-services/updatemonitoredservicefromyaml.md) ### yamlTemplate - [GET /cv/api/monitored-service/yaml-template](https://apidocs.harness.io/monitored-services/yamltemplate.md) ### getMonitoredServiceDetails_1 (deprecated) - [GET /cv/api/monitored-service/service-details](https://apidocs.harness.io/monitored-services/getmonitoredservicedetails_1.md) ## SLOs dashboard This contains APIs related to SLOs dashboard ### getSLOAssociatedEnvironmentIdentifiers - [GET /cv/api/slo-dashboard/environment-identifiers](https://apidocs.harness.io/slos-dashboard/getsloassociatedenvironmentidentifiers.md) ### getSLOAssociatedMonitoredServices - [GET /cv/api/slo-dashboard/monitored-services](https://apidocs.harness.io/slos-dashboard/getsloassociatedmonitoredservices.md) ### getSecondaryEventDetails - [GET /cv/api/slo-dashboard/secondary-events-details](https://apidocs.harness.io/slos-dashboard/getsecondaryeventdetails.md) ### getSecondaryEvents - [GET /cv/api/slo-dashboard/secondary-events/{identifier}](https://apidocs.harness.io/slos-dashboard/getsecondaryevents.md) ### Get all SLOs count by risk - [GET /cv/api/slo-dashboard/risk-count](https://apidocs.harness.io/slos-dashboard/getservicelevelobjectivesriskcount.md) ### Get SLO consumption breakdown - [GET /cv/api/slo-dashboard/widget/{identifier}/consumption](https://apidocs.harness.io/slos-dashboard/getsloconsumptionbreakdownview.md) ### Get SLO dashboard details - [GET /cv/api/slo-dashboard/widget/{identifier}](https://apidocs.harness.io/slos-dashboard/getslodetails.md) ### Get SLO list view - [GET /cv/api/slo-dashboard/widgets/list](https://apidocs.harness.io/slos-dashboard/getslohealthlistview.md) ### Get SLO list view - [POST /cv/api/slo-dashboard/widgets/list](https://apidocs.harness.io/slos-dashboard/getslohealthlistviewv2.md) ## NG SLOs This contains APIs related to CRUD operations of SLOs (simple & composite) ### Get SLO data - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}](https://apidocs.harness.io/ng-slos/getservicelevelobjectiveng.md) ### Update SLO data - [PUT /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}](https://apidocs.harness.io/ng-slos/updateslodatang.md) ### Delete SLO data - [DELETE /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/identifier/{identifier}](https://apidocs.harness.io/ng-slos/deleteslodatang.md) ### Get onBoarding graph for composite slo - [POST /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/composite-slo/onboarding-graph](https://apidocs.harness.io/ng-slos/getonboardinggraphng.md) ### Get SLO list view - [POST /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2/status-list](https://apidocs.harness.io/ng-slos/getslohealthlistviewng.md) ### Get all SLOs - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2](https://apidocs.harness.io/ng-slos/getservicelevelobjectivesng.md) ### Saves SLO data - [POST /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/slo/v2](https://apidocs.harness.io/ng-slos/saveslodatang.md) ## SLOs This contains APIs related to CRUD operations of SLOs ### Get Error budget reset history - [GET /cv/api/slo/{identifier}/errorBudgetResetHistory](https://apidocs.harness.io/slos/geterrorbudgetresethistory.md) ### Get notification rules for SLO - [GET /cv/api/slo/{identifier}/notification-rules](https://apidocs.harness.io/slos/getnotificationrulesforslo.md) ### Get SLO logs - [GET /cv/api/slo/{identifier}/logs](https://apidocs.harness.io/slos/getservicelevelobjectivelogs.md) ### Reset Error budget history - [POST /cv/api/slo/{identifier}/resetErrorBudget](https://apidocs.harness.io/slos/reseterrorbudget.md) ### Get Metric Graph For SLO - [GET /cv/api/v1/orgs/{org}/projects/{project}/metric-graph/{slo-identifier}](https://apidocs.harness.io/slos/getmetricgraphforslo.md): Get Underlying Metrics Graph for SLO ### List SLOs - [GET /cv/api/v1/orgs/{org}/projects/{project}/slo](https://apidocs.harness.io/slos/listslo.md): Returns a list of Service Level Objectives ## ServiceLevelObjective ### Get Metric Graph For SLO - [GET /cv/api/v1/orgs/{org}/projects/{project}/metric-graph/{slo-identifier}](https://apidocs.harness.io/slos/getmetricgraphforslo.md): Get Underlying Metrics Graph for SLO ### List SLOs - [GET /cv/api/v1/orgs/{org}/projects/{project}/slo](https://apidocs.harness.io/slos/listslo.md): Returns a list of Service Level Objectives ## Downtime This contains APIs related to CRUD operations of Downtime ### getDowntime - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}](https://apidocs.harness.io/downtime/getdowntime.md) ### updateDowntimeData - [PUT /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}](https://apidocs.harness.io/downtime/updatedowntimedata.md) ### deleteDowntimeData - [DELETE /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}](https://apidocs.harness.io/downtime/deletedowntimedata.md) ### getAssociatedMonitoredServices - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services/{identifier}](https://apidocs.harness.io/downtime/getassociatedmonitoredservices.md) ### getDowntimeAssociatedMonitoredServices - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services](https://apidocs.harness.io/downtime/getdowntimeassociatedmonitoredservices.md) ### getHistory - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/history](https://apidocs.harness.io/downtime/gethistory.md) ### listDowntimes - [GET /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/list](https://apidocs.harness.io/downtime/listdowntimes.md) ### saveDowntime - [POST /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime](https://apidocs.harness.io/downtime/savedowntime.md) ### updateDowntimeEnabled - [PUT /cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/flag/{identifier}](https://apidocs.harness.io/downtime/updatedowntimeenabled.md) ## Srm Notification This contains APIs related to CRUD operations of srm notifications ### getNotificationRuleData - [GET /cv/api/notification-rule/{identifier}](https://apidocs.harness.io/srm-notification/getnotificationruledata.md) ### updateNotificationRuleData - [PUT /cv/api/notification-rule/{identifier}](https://apidocs.harness.io/srm-notification/updatenotificationruledata.md) ### deleteNotificationRuleData - [DELETE /cv/api/notification-rule/{identifier}](https://apidocs.harness.io/srm-notification/deletenotificationruledata.md) ### getNotificationRuleData_1 - [GET /cv/api/notification-rule](https://apidocs.harness.io/srm-notification/getnotificationruledata_1.md) ### saveNotificationRuleData - [POST /cv/api/notification-rule](https://apidocs.harness.io/srm-notification/savenotificationruledata.md) ## Entities APIs for managing catalog Entities which represent the core components of your system. Entities can represent services, APIs, user groups, resources, and more. These endpoints allow you to create, retrieve, update, delete, and query entities across different scopes. ### Create an Entity - [POST /v1/entities](https://apidocs.harness.io/entities/create-entity.md): Creates a new Entity in the specified scope (Account, Organization, or Project). Entities are the core components of the catalog system and can represent various resources such as services, APIs, user groups, and more. Each entity has a specific kind and type that defines its purpose in the system. ### Get Entities - [GET /v1/entities](https://apidocs.harness.io/entities/get-entities.md): Retrieves a paginated list of Entities based on the provided filters. This endpoint supports comprehensive filtering options to help you find specific entities across different scopes, kinds, and other properties. The response includes pagination metadata and counts for owned and favorite entities. When a search returns no matching entities, the API returns a 200 status code with an empty data array. This is the expected behavior for this list API. Note that 400 status codes are only returned when a specific entity is requested and not found (e.g., in the Get Entity Details endpoint). ### Get entities by refs - [POST /v1/entities/by-refs](https://apidocs.harness.io/entities/get-entities-by-refs.md): Fetches entities matching the entity references specified in the request body, in conjunction with other provided filters. ### Import an Entity from Git - [POST /v1/entities/import](https://apidocs.harness.io/entities/import-entity.md): Imports a new Entity from Git in the specified scope (Account, Organization, or Project). ### Get Entities Groups - [GET /v1/entities/groups](https://apidocs.harness.io/entities/get-entities-groups.md): Retrieves entities organized in hierarchical groups based on account, organization, and project. This endpoint is useful for displaying entities in a structured UI view where entities need to be presented in their organizational context. The response contains both grouped and ungrouped entities at each level. ### Move an Entity - [POST /v1/entities/move/{scope}/{kind}/{identifier}](https://apidocs.harness.io/entities/move-entity.md): Move an existing Inline entity to Remote. ### Update GitMetadata for Remote Entities - [PUT /v1/entities/git-metadata/{scope}/{kind}/{identifier}](https://apidocs.harness.io/entities/update-git-metadata.md): Update GitMetadata for Remote Entities ### Convert Entity Format - [POST /v1/entities/convert/{option}](https://apidocs.harness.io/entities/convert-entity.md): Converts entity YAML between Backstage and Harness formats. This is useful when migrating entities between systems or when standardizing entity definitions across different platforms. The conversion preserves all semantic information while adapting to the target format conventions. ### Update an Entity - [PUT /v1/entities/{scope}/{kind}/{identifier}](https://apidocs.harness.io/entities/update-entity.md): Updates an existing Entity identified by its scope, kind, and identifier. All fields in the entity definition will be replaced with the new values provided in the request. This operation is idempotent and will create the entity if it doesn't already exist. ### Delete an Entity - [DELETE /v1/entities/{scope}/{kind}/{identifier}](https://apidocs.harness.io/entities/delete-entity.md): Permanently removes an Entity identified by its scope, kind, and identifier from the system. This operation cannot be undone, so use it with caution. Any references to the deleted entity from other entities will become invalid. ### Get Entity Details - [GET /v1/entities/{scope}/{kind}/{identifier}](https://apidocs.harness.io/entities/get-entity.md): Retrieves the complete details of an Entity identified by its scope, kind, and identifier, including its YAML definition, metadata, and relationships with other entities. This endpoint provides the most comprehensive view of a specific entity. ### Get Entity Kinds - [GET /v1/entities/kinds](https://apidocs.harness.io/entities/get-entities-kinds.md): Returns a list of all supported Entity Kinds along with their display names, descriptions, and counts. This is useful for populating filter dropdowns in UIs and for understanding what kinds of entities are available in the system. ### Get Entity Filter Options - [GET /v1/entities/filters](https://apidocs.harness.io/entities/get-entities-filters.md): Returns the available filter options that can be used when querying entities. This helps in building dynamic filter UIs for entity exploration and discovery. The response includes filter names and their possible values based on the current entities in the system. ### Get Entities Filters By Query - [POST /v1/entities/filters](https://apidocs.harness.io/entities/get-entities-filters-by-query.md): Returns the available filter options that can be used when querying entities based on the provided query.This helps in building dynamic filter UIs for entity exploration and discovery.The response includes filter names and their possible values based on the current entities in the system. ### Get Entity JSON Schema - [GET /v1/entities/json-schema](https://apidocs.harness.io/entities/get-json-schema.md): Returns the JSON Schema for validating Entity definitions. This is useful for client-side validation before submitting entity creation or update requests. The schema can be filtered by entity kind to get specific validation rules. ## Catalog Custom Properties Catalog Custom Properties ### Ingest catalog custom properties - [POST /v1/catalog/custom-properties](https://apidocs.harness.io/catalogcustomproperties/ingest-catalog-custom-properties.md): Ingest catalog custom properties ### Delete catalog custom properties - [DELETE /v1/catalog/custom-properties](https://apidocs.harness.io/catalogcustomproperties/delete-catalog-custom-properties.md): Delete catalog custom properties ### Get catalog custom properties for given entity - [GET /v1/catalog/custom-properties/entity](https://apidocs.harness.io/catalogcustomproperties/get-catalog-custom-properties-by-entity.md): Get catalog custom properties for given entity ### Ingest catalog custom properties for given entity - [POST /v1/catalog/custom-properties/entity](https://apidocs.harness.io/catalogcustomproperties/ingest-catalog-custom-properties-by-entity.md): Ingest catalog custom properties for given entity ### Delete catalog custom properties for given entity - [DELETE /v1/catalog/custom-properties/entity](https://apidocs.harness.io/catalogcustomproperties/delete-catalog-custom-properties-by-entity.md): Delete catalog custom properties for given entity ### Get entities for given custom property - [GET /v1/catalog/custom-properties/property](https://apidocs.harness.io/catalogcustomproperties/get-entities-by-catalog-custom-property.md): Get entities for given custom property ### Ingest entities for given custom property - [POST /v1/catalog/custom-properties/property](https://apidocs.harness.io/catalogcustomproperties/ingest-entities-by-catalog-custom-property.md): Ingest entities for given custom property ### Delete entities for given custom property - [DELETE /v1/catalog/custom-properties/property](https://apidocs.harness.io/catalogcustomproperties/delete-entities-by-catalog-custom-property.md): Delete entities for given custom property ## Scores Information Scores Information ### Get Score Summary for Scorecards - [GET /v1/scores/summary](https://apidocs.harness.io/scores/get-all-scorecard-summary.md) ### Get Scores for Scorecards - [GET /v1/scores](https://apidocs.harness.io/scores/get-scorecards-scores-overview.md) ### Get Aggregated Scores for Catalog entities - [POST /v1/scores/aggregate](https://apidocs.harness.io/scores/get-aggregated-scores.md) ### Get Data for check status for graph - [GET /v1/scores/graph](https://apidocs.harness.io/scores/get-scorecards-graphs-score-summary.md) ### Trigger recalibration of scores for a scorecard - [POST /v1/scores/recalibrate](https://apidocs.harness.io/scores/scorecard-recalibrate.md): API for Recalibrating the score for scorecard of entity ### Get score recalibration status - [GET /v1/scores/recalibrate/status](https://apidocs.harness.io/scores/get-scores-recalibrate-status.md): Get status of score computation request ## DataSource Information DataSource Information ### Get Datasources Present In Account - [GET /v1/data-sources](https://apidocs.harness.io/datasource/get-all-datasources-for-account.md): API for getting all the datasources present in account. ### Get DataPoints present in DataSources for an account - [GET /v1/data-sources/{data-source}/datapoints](https://apidocs.harness.io/datasource/get-data-points-for-data-source.md): Get DataPoints Present in DataSources ### Get Data Sources and Data Points Map for Account - [GET /v1/data-sources/data-points/map](https://apidocs.harness.io/datasource/get-data-sources-data-points-map.md): API for getting the map of data sources and data points for account ## Kubernetes DataPoints Information Kubernetes DataPoints Information ### Get data points data for kubernetes data source - [POST /v1/data-sources/kubernetes/data-point/values](https://apidocs.harness.io/kubernetesdatapoints/get-k8s-data-point-values.md) ## IDP App Configurations IDP App Configurations ### Toggle Plugin - [POST /v1/plugin-toggle/{plugin-id}](https://apidocs.harness.io/appconfig/toggle-plugin-for-account.md): Toggle Backstage Plugin ### Save Or Update Plugin Config - [POST /v1/app-config](https://apidocs.harness.io/appconfig/save-or-update-plugin-app-config.md): Save or Update Plugin Config ## Plugin Information Plugin Information ### List Available Plugins - [GET /v1/plugins-info](https://apidocs.harness.io/plugininfo/get-plugins.md): Get all plugins available ### Save custom plugin info - [POST /v1/plugins-info](https://apidocs.harness.io/plugininfo/save-custom-plugins-info.md) ### Get Plugin - [GET /v1/plugins-info/{plugin-id}](https://apidocs.harness.io/plugininfo/get-plugins-info-plugin-id.md): Get plugin details for given pluginId ### Update custom plugin info - [PUT /v1/plugins-info/{plugin-id}](https://apidocs.harness.io/plugininfo/update-custom-plugins-info.md) ### Delete custom plugin info - [DELETE /v1/plugins-info/{plugin-id}](https://apidocs.harness.io/plugininfo/delete-custom-plugin-info.md) ### List Available Backstage Plugins - [GET /v1/backstage-plugins-info](https://apidocs.harness.io/plugininfo/get-backstage-plugins.md): Get all backstage plugins available ### Request for a Plugin - [POST /v1/plugin/request](https://apidocs.harness.io/plugininfo/post-plugin-request.md): Request for a Plugin ### Get all plugin requests for an account - [GET /v1/plugin/request](https://apidocs.harness.io/plugininfo/get-plugin-request.md): Get all plugin requests for an account ## Layout Proxy Layout Proxy ### List Layouts - [GET /v1/layout](https://apidocs.harness.io/layoutproxy/get-all-layouts.md): Get all layouts ### Create layout - [POST /v1/layout](https://apidocs.harness.io/layoutproxy/create-layout.md): Create layout ### Delete layout - [DELETE /v1/layout](https://apidocs.harness.io/layoutproxy/delete-layout.md): Delete layout ### Get layout - [GET /v1/layout/{layout-identifier}](https://apidocs.harness.io/layoutproxy/get-layout.md): Get Layout ### Get Layout Health - [GET /v1/layout/health](https://apidocs.harness.io/layoutproxy/get-layout-health.md): Get Layout Health ### Ingest plugin layout - [POST /v1/layout/ingest](https://apidocs.harness.io/layoutproxy/layout-ingest.md): Ingest plugin layout ## Kinds This contains APIs for Kinds. ### Create a Kind - [POST /v1/kinds](https://apidocs.harness.io/kinds/create-kind.md): Create a Kind. ### Get Kinds - [GET /v1/kinds](https://apidocs.harness.io/kinds/get-kinds.md): Get Kinds. ### Update a Kind - [PUT /v1/kinds/{identifier}](https://apidocs.harness.io/kinds/update-kind.md): Update a Kind. ### Delete a Kind - [DELETE /v1/kinds/{identifier}](https://apidocs.harness.io/kinds/delete-kind.md): Delete a Kind. ### Get Kind - [GET /v1/kinds/{identifier}](https://apidocs.harness.io/kinds/get-kind.md): Get Kind. ### Get Kind Schema - [GET /v1/kinds/schema](https://apidocs.harness.io/kinds/get-kind-schema.md): Get Kind Schema. ### Validate kind schema - [POST /v1/kinds/schema/validate](https://apidocs.harness.io/kinds/kind-schema-validate.md): Validate kind schema. ## LayoutsV3 This contains APIs for LayoutsV3. ### Get Layouts V3 - [GET /v3/layout](https://apidocs.harness.io/layoutsv3/get-layouts-v3.md): Get Layouts V3. ### Create layout V3 - [POST /v3/layout](https://apidocs.harness.io/layoutsv3/create-layout-v3.md): Create layout V3. ### Delete layout V3 - [DELETE /v3/layout](https://apidocs.harness.io/layoutsv3/delete-layout-v3.md): Delete layout V3. ### Get layout V3 - [GET /v3/layout/{layout-identifier}](https://apidocs.harness.io/layoutsv3/get-layout-v3.md): Get Layout V3. ### Get Layout Health V3 - [GET /v3/layout/health](https://apidocs.harness.io/layoutsv3/get-layout-health-v3.md): Get Layout Health V3. ### Ingest layout V3 - [POST /v3/layout/ingest](https://apidocs.harness.io/layoutsv3/layout-ingest-v3.md): Ingest layout V3. ## LayoutsV4 This contains APIs for LayoutsV4. ### Get Layouts V4 - [GET /v4/layout](https://apidocs.harness.io/layoutsv4/get-layouts-v4.md): Get Layouts V4. ## Environment The environment service for working with Environment-type infrastructures ### Create Compile And Execute Environment - [POST /v1/idp-environments](https://apidocs.harness.io/environment/create-compile-and-execute-environment.md): Create environment in catalog, compiles it and then finally execute it. ### Update Compile And Execute Environment - [PUT /v1/idp-environments/{environment-id}](https://apidocs.harness.io/environment/update-compile-and-execute-environment.md): Update environment in catalog, compiles it and then finally execute it. ### Delete Environment - [DELETE /v1/idp-environments/{environment-id}](https://apidocs.harness.io/environment/delete-environment1.md): Delete any environment that is no longer active ### Compile Environment - [POST /api/environments/compile](https://apidocs.harness.io/environment/environment_compile.md): Endpoint for compiling an environment and a target state to a valid infrastructure ### Schemas Environment - [GET /api/environments/schemas](https://apidocs.harness.io/environment/environment_schemas.md): Endpoint for retrieving the environment and environment blueprint schemas ## Infrastructure The infrastructure service for working with infrastructures ### List Infrastructure - [GET /api/infrastructures](https://apidocs.harness.io/infrastructure/infrastructure_list.md): Endpoint for listing all infrastructures. ### Abort Infrastructure - [POST /api/infrastructures/{executionID}/abort](https://apidocs.harness.io/infrastructure/infrastructure_abort.md): Endpoint for aborting an infrastructure execution. ### Delete Infrastructure - [DELETE /api/infrastructures/{id}](https://apidocs.harness.io/infrastructure/infrastructure_delete.md): Endpoint for deleting a specific infrastructure. ### Get Infrastructure - [GET /api/infrastructures/{id}](https://apidocs.harness.io/infrastructure/infrastructure_get.md): Endpoint for retrieving a specific infrastructure. ### ListExecutions Infrastructure - [GET /api/infrastructures/{id}/executions](https://apidocs.harness.io/infrastructure/infrastructure_listexecutions.md): Endpoint for listing executions for a specific infrastructure. ### ListSpecs Infrastructure - [GET /api/infrastructures/{id}/specs](https://apidocs.harness.io/infrastructure/infrastructure_listspecs.md): Endpoint for listing specs for a specific infrastructure. ### ApprovePipelineExecution Infrastructure - [POST /api/infrastructures/approve](https://apidocs.harness.io/infrastructure/infrastructure_approvepipelineexecution.md): Endpoint for approving a pipeline approval step. ### Execute Infrastructure - [POST /api/infrastructures/execute](https://apidocs.harness.io/infrastructure/infrastructure_execute.md): Endpoint for executing an infrastructure, with the options of either dryrunning this process, or forcing it. ### GetExecution Infrastructure - [GET /api/infrastructures/executions/{id}](https://apidocs.harness.io/infrastructure/infrastructure_getexecution.md): Endpoint for retrieving a specific execution for a specific infrastructure. ## Instance The instance service for working with instances ### List Instance - [GET /api/instances](https://apidocs.harness.io/instance/instance_list.md): Endpoint for listing instances, with the option of filtering for a specific infrastructure. ### Get Instance - [GET /api/instances/{id}](https://apidocs.harness.io/instance/instance_get.md): Endpoint for retrieving a specific instance. ### ForceState Instance - [POST /api/instances/{instanceID}/force-state](https://apidocs.harness.io/instance/instance_forcestate.md): Endpoint for forcing a specific instance to a specific state. ### ListEvents Instance - [GET /api/instances/events](https://apidocs.harness.io/instance/instance_listevents.md): Endpoint for listing events for a specific instance. ### GetEvent Instance - [GET /api/instances/events/{id}](https://apidocs.harness.io/instance/instance_getevent.md): Endpoint for retrieving a specific instance event. ## aida AIDA API's for Harness OPA ### aida#accept - [POST /pm/api/v1/aida/accept](https://apidocs.harness.io/aida/aida_accept.md): Record explicit AI acceptance from UI ### aida#analyze - [POST /pm/api/v1/aida/analyze](https://apidocs.harness.io/aida/aida_analyze.md): Describe Policy On Basis of rego ### aida#generate - [POST /pm/api/v1/aida/generate](https://apidocs.harness.io/aida/aida_generate.md): Generate Policy On Basis of free Text ## dashboards ### Download data within a Dashboard - [GET /dashboard/api/dashboards/{dashboard_id}/download](https://apidocs.harness.io/dashboards/get_dashboard_data.md): Download the data of all tiles within a Dashboard. ### get_dashboard_elements - [GET /dashboard/dashboards/{dashboard_id}/elements](https://apidocs.harness.io/dashboards/get_dashboard_elements.md): Get all elements within a dashboard by ID. ### get_dashboard_filters - [GET /dashboard/dashboards/{dashboard_id}/filters](https://apidocs.harness.io/dashboards/get_dashboard_filters.md): Get all filters within a dashboard by ID. ### clone_dashboard - [POST /dashboard/clone](https://apidocs.harness.io/dashboards/clone_dashboard.md): Clone a dashboard. ### get_dashboard - [GET /dashboard/dashboards/{dashboard_id}](https://apidocs.harness.io/dashboards/get_dashboard.md): Get all details of a dashboard by ID. ### update_dashboard - [PATCH /dashboard/](https://apidocs.harness.io/dashboards/update_dashboard.md): Update a dashboards name, tags or folder. ### delete_dashboard - [DELETE /dashboard/remove](https://apidocs.harness.io/dashboards/delete_dashboard.md): Delete a dashboard. ### update_dashboard_filter - [PATCH /dashboard/dashboards/{dashboard_id}/filters/{filter_id}](https://apidocs.harness.io/dashboards/update_dashboard_filter.md): Update a specific filter within a dashboard by ID. ### Download a Dashboard CSV - [GET /dashboard/download/dashboards/{dashboard_id}/csv](https://apidocs.harness.io/dashboards/get_dashboard_download_csv.md): Download a Dashboard in CSV format. ### Download a Dashboard PDF - [GET /dashboard/download/dashboards/{dashboard_id}/pdf](https://apidocs.harness.io/dashboards/get_dashboard_download_pdf.md): Download a Dashboard in PDF format. ### Runs a schedule delivery once that is then immediately sent via email to recipients - [POST /dashboard/schedules/run_once](https://apidocs.harness.io/dashboards/schedules_run_once.md): Run a schedule delivery once ## downloads ### get_download_task_status - [GET /dashboard/download/tasks/{task_id}](https://apidocs.harness.io/downloads/get_download_task_status.md): Get the current status of a download task ### create_dashboard_element_download_task - [POST /dashboard/download/dashboards/{dashboard_id}/dashboard_elements/{dashboard_element_id}](https://apidocs.harness.io/downloads/create_dashboard_element_download_task.md): Creates an asynchronous download task for a specific element within a dashboard. ### get_dashboard_element_download_task_results - [GET /dashboard/download/dashboards/{dashboard_id}/dashboard_elements/{dashboard_element_id}](https://apidocs.harness.io/downloads/get_dashboard_element_download_task_results.md): Get the results of a download task for a specific element within a dashboard. ## folders ### create_folder - [POST /dashboard/folders](https://apidocs.harness.io/folders/create_folder.md): Create a new folder. ### get_folder - [GET /dashboard/folders/{folder_id}](https://apidocs.harness.io/folders/get_folder.md): Get a folder by ID. ### update_folder - [PATCH /dashboard/folders/{folder_id}](https://apidocs.harness.io/folders/update_folder.md): Update a folder's name. ### delete_folder - [DELETE /dashboard/folders/{folder_id}](https://apidocs.harness.io/folders/delete_folder.md): Delete a folder along with any dashboards it contains. ## dashboard Aggregate summary of policies, policy sets and evaluations for display on the dashboard ### dashboard#metrics - [GET /pm/api/v1/dashboard](https://apidocs.harness.io/dashboard/dashboard_metrics.md): Get metrics about policies, policy sets and evaluations ## examples Example rego policies and corresponding input ### examples#list - [GET /pm/api/v1/examples](https://apidocs.harness.io/examples/examples_list.md): list examples ## policies Create, edit and delete Governance policies written in rego ### policies#list - [GET /pm/api/v1/policies](https://apidocs.harness.io/policies/policies_list.md): List all policies ### policies#create - [POST /pm/api/v1/policies](https://apidocs.harness.io/policies/policies_create.md): Create a policy ### policies#move_policy - [POST /pm/api/v1/policies/move-policy/{identifier}](https://apidocs.harness.io/policies/policies_move_policy.md): Move an inline policy's configuration to remote (Git) ### policies#delete - [DELETE /pm/api/v1/policies/{identifier}](https://apidocs.harness.io/policies/policies_delete.md): Delete a policy by identifier. Returns 409 Conflict if the policy is referenced by policy sets (unless force=true). ### policies#find - [GET /pm/api/v1/policies/{identifier}](https://apidocs.harness.io/policies/policies_find.md): Find a policy by identifier ### policies#update - [PATCH /pm/api/v1/policies/{identifier}](https://apidocs.harness.io/policies/policies_update.md): Update a policy by identifier ### policies#list_policy_sets - [GET /pm/api/v1/policies/{identifier}/policysets](https://apidocs.harness.io/policies/policies_list_policy_sets.md): List all policy sets that reference a specific policy ## evaluate Perform evaluations ### evaluate#evaluate - [POST /pm/api/v1/evaluate](https://apidocs.harness.io/evaluate/evaluate_evaluate.md): Evaluate arbitrary rego ## evaluations Access evaluation results ### evaluations#list - [GET /pm/api/v1/evaluations](https://apidocs.harness.io/evaluations/evaluations_list.md): List evaluations ### evaluations#getYaml - [GET /pm/api/v1/evaluations/getYaml](https://apidocs.harness.io/evaluations/evaluations_getyaml.md): Get entity yaml ### Get signed URL for evaluation payload - [GET /pm/api/v1/evaluations/payload-signed-url/{evaluation_id}](https://apidocs.harness.io/evaluations/evaluations_get-payload-signed-url.md): Get signed URL for evaluation payload stored in GCS ### evaluations#find - [GET /pm/api/v1/evaluations/{id}](https://apidocs.harness.io/evaluations/evaluations_find.md): Find an evaluation by ID ## policysets Create, edit and delete Governance policy sets ### policysets#list - [GET /pm/api/v1/policysets](https://apidocs.harness.io/policysets/policysets_list.md): List all policy sets ### policysets#create - [POST /pm/api/v1/policysets](https://apidocs.harness.io/policysets/policysets_create.md): Create a policy set ### List all policy sets hierarchically - [GET /pm/api/v1/policysets/all](https://apidocs.harness.io/policysets/policysets_listall.md): List all policy sets hierarchically (includes policy sets from account, org, and project levels) ### policysets#delete - [DELETE /pm/api/v1/policysets/{identifier}](https://apidocs.harness.io/policysets/policysets_delete.md): Delete a policy set by identifier ### policysets#find - [GET /pm/api/v1/policysets/{identifier}](https://apidocs.harness.io/policysets/policysets_find.md): Find a policy set by identifier ### policysets#update - [PATCH /pm/api/v1/policysets/{identifier}](https://apidocs.harness.io/policysets/policysets_update.md): Update a policy set by identifier ## system System version and health ### system#health - [GET /pm/api/v1/system/health](https://apidocs.harness.io/system/system_health.md): Check service health ### system#version - [GET /pm/api/v1/system/version](https://apidocs.harness.io/system/system_version.md): Check service version ### health system - [GET /iacm/api/health](https://apidocs.harness.io/system/iacmsystem_health.md): Check server health ### latest-plugin-version system - [POST /iacm/api/latest-plugin-version](https://apidocs.harness.io/system/system_latest-plugin-version.md): Get the latest plugin version ### get-provisioner-config system - [GET /iacm/api/provisioners/{provisioner}/config](https://apidocs.harness.io/system/system_get-provisioner-config.md): Get provisioner configuration with supported versions and settings. ### list-supported-provisioner-versions system - [GET /iacm/api/provisioners/supported/{provisioner}](https://apidocs.harness.io/system/system_list-supported-provisioner-versions.md): List supported provisioner versions. ### version system - [GET /iacm/api/version](https://apidocs.harness.io/system/iacmsystem_version.md): Get server version ## repository ### List repositories - [GET /code/api/v1/repos](https://apidocs.harness.io/repository/listrepos.md) ### Create repository - [POST /code/api/v1/repos](https://apidocs.harness.io/repository/createrepository.md) ### Soft delete repository - [DELETE /code/api/v1/repos/{repo_identifier}](https://apidocs.harness.io/repository/deleterepository.md) ### Get repository - [GET /code/api/v1/repos/{repo_identifier}](https://apidocs.harness.io/repository/getrepository.md) ### Update repository - [PATCH /code/api/v1/repos/{repo_identifier}](https://apidocs.harness.io/repository/updaterepository.md) ### List repository activities - [GET /code/api/v1/repos/{repo_identifier}/activities](https://apidocs.harness.io/repository/listrepoactivities.md) ### Download repo in archived format - [GET /code/api/v1/repos/{repo_identifier}/archive/{git_ref}.{format}](https://apidocs.harness.io/repository/archive.md) ### Get git blame - [GET /code/api/v1/repos/{repo_identifier}/blame/{path}](https://apidocs.harness.io/repository/getblame.md) ### List branches - [GET /code/api/v1/repos/{repo_identifier}/branches](https://apidocs.harness.io/repository/listbranches.md) ### Create branch - [POST /code/api/v1/repos/{repo_identifier}/branches](https://apidocs.harness.io/repository/createbranch.md) ### Delete branch - [DELETE /code/api/v1/repos/{repo_identifier}/branches/{branch_name}](https://apidocs.harness.io/repository/deletebranch.md) ### Get branch - [GET /code/api/v1/repos/{repo_identifier}/branches/{branch_name}](https://apidocs.harness.io/repository/getbranch.md) ### Validate code owners file - [GET /code/api/v1/repos/{repo_identifier}/codeowners/validate](https://apidocs.harness.io/repository/codeownersvalidate.md) ### List commits - [GET /code/api/v1/repos/{repo_identifier}/commits](https://apidocs.harness.io/repository/listcommits.md) ### Commit files - [POST /code/api/v1/repos/{repo_identifier}/commits](https://apidocs.harness.io/repository/commitfiles.md) ### Get commit - [GET /code/api/v1/repos/{repo_identifier}/commits/{commit_sha}](https://apidocs.harness.io/repository/getcommit.md) ### Get raw git diff of a commit - [GET /code/api/v1/repos/{repo_identifier}/commits/{commit_sha}/diff](https://apidocs.harness.io/repository/getcommitdiff.md) ### Get commit divergence - [POST /code/api/v1/repos/{repo_identifier}/commits/calculate-divergence](https://apidocs.harness.io/repository/calculatecommitdivergence.md) ### Get content of a file - [GET /code/api/v1/repos/{repo_identifier}/content/{path}](https://apidocs.harness.io/repository/getcontent.md) ### Update default branch - [POST /code/api/v1/repos/{repo_identifier}/default-branch](https://apidocs.harness.io/repository/updatedefaultbranch.md) ### Get diff stats - [GET /code/api/v1/repos/{repo_identifier}/diff-stats/{range}](https://apidocs.harness.io/repository/diffstats.md) ### Get raw diff - [GET /code/api/v1/repos/{repo_identifier}/diff/{range}](https://apidocs.harness.io/repository/rawdiff.md) ### Get raw diff - [POST /code/api/v1/repos/{repo_identifier}/diff/{range}](https://apidocs.harness.io/repository/rawdiffpost.md) ### forkCreate - [POST /code/api/v1/repos/{repo_identifier}/fork](https://apidocs.harness.io/repository/forkcreate.md) ### forkSyncBranch - [POST /code/api/v1/repos/{repo_identifier}/fork-sync](https://apidocs.harness.io/repository/forksyncbranch.md) ### Get repository language statistics - [GET /code/api/v1/repos/{repo_identifier}/languages](https://apidocs.harness.io/repository/getrepolanguages.md) ### getLinkedSource - [GET /code/api/v1/repos/{repo_identifier}/linked/source](https://apidocs.harness.io/repository/getlinkedsource.md) ### linkedSync - [POST /code/api/v1/repos/{repo_identifier}/linked/sync](https://apidocs.harness.io/repository/linkedsync.md) ### Check mergeability - [POST /code/api/v1/repos/{repo_identifier}/merge-check/{range}](https://apidocs.harness.io/repository/mergecheck.md) ### Creates a merge commit on the head branch with changes from the base - [POST /code/api/v1/repos/{repo_identifier}/merge-commit](https://apidocs.harness.io/repository/mergecommit.md) ### Get commit details - [POST /code/api/v1/repos/{repo_identifier}/path-details](https://apidocs.harness.io/repository/pathdetails.md) ### List all paths - [GET /code/api/v1/repos/{repo_identifier}/paths](https://apidocs.harness.io/repository/listpaths.md) ### Purge repository - [POST /code/api/v1/repos/{repo_identifier}/purge](https://apidocs.harness.io/repository/purgerepository.md) ### Get raw file content - [GET /code/api/v1/repos/{repo_identifier}/raw/{path}](https://apidocs.harness.io/repository/getraw.md) ### Rebase a branch relative to another branch or a commit - [POST /code/api/v1/repos/{repo_identifier}/rebase](https://apidocs.harness.io/repository/rebasebranch.md) ### Restore repository - [POST /code/api/v1/repos/{repo_identifier}/restore](https://apidocs.harness.io/repository/restorerepository.md) ### Get general settings - [GET /code/api/v1/repos/{repo_identifier}/settings/general](https://apidocs.harness.io/repository/findgeneralsettings.md) ### Update general settings - [PATCH /code/api/v1/repos/{repo_identifier}/settings/general](https://apidocs.harness.io/repository/updategeneralsettings.md) ### Get security settings - [GET /code/api/v1/repos/{repo_identifier}/settings/security](https://apidocs.harness.io/repository/findsecuritysettings.md) ### Update security settings - [PATCH /code/api/v1/repos/{repo_identifier}/settings/security](https://apidocs.harness.io/repository/updatesecuritysettings.md) ### Squashes commits in a branch relative to another branch or a commit - [POST /code/api/v1/repos/{repo_identifier}/squash](https://apidocs.harness.io/repository/squashbranch.md) ### Get repository summary - [GET /code/api/v1/repos/{repo_identifier}/summary](https://apidocs.harness.io/repository/summary.md) ### List tags - [GET /code/api/v1/repos/{repo_identifier}/tags](https://apidocs.harness.io/repository/listtags.md) ### Create tag - [POST /code/api/v1/repos/{repo_identifier}/tags](https://apidocs.harness.io/repository/createtag.md) ### Delete tag - [DELETE /code/api/v1/repos/{repo_identifier}/tags/{tag_name}](https://apidocs.harness.io/repository/deletetag.md) ### Import repository - [POST /code/api/v1/repos/import](https://apidocs.harness.io/repository/importrepository.md) ### linkedCreate - [POST /code/api/v1/repos/link](https://apidocs.harness.io/repository/linkedcreate.md) ## status_checks ### List recent status check for acc, org or proj - [GET /code/api/v1/checks/recent](https://apidocs.harness.io/status_checks/liststatuscheckrecentspace.md) ### List status check results - [GET /code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}](https://apidocs.harness.io/status_checks/liststatuscheckresults.md) ### Report status check results - [PUT /code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}](https://apidocs.harness.io/status_checks/reportstatuscheckresults.md) ### List recent status check - [GET /code/api/v1/repos/{repo_identifier}/checks/recent](https://apidocs.harness.io/status_checks/liststatuscheckrecent.md) ## pullreq ### List pull requests in account/org/project - [GET /code/api/v1/pullreq](https://apidocs.harness.io/pullreq/listpullreqspace.md) ### Count pull requests in account/org/project - [GET /code/api/v1/pullreq/count](https://apidocs.harness.io/pullreq/countpullreqspace.md) ### List pull requests - [GET /code/api/v1/repos/{repo_identifier}/pullreq](https://apidocs.harness.io/pullreq/listpullreq.md) ### Create pull request - [POST /code/api/v1/repos/{repo_identifier}/pullreq](https://apidocs.harness.io/pullreq/createpullreq.md) ### Get pull request - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}](https://apidocs.harness.io/pullreq/getpullreq.md) ### Update pull request - [PATCH /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}](https://apidocs.harness.io/pullreq/updatepullreq.md) ### List activities - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/activities](https://apidocs.harness.io/pullreq/listpullreqactivities.md) ### Disable the auto-merge option for the pull request. - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge](https://apidocs.harness.io/pullreq/prautomergedisable.md) ### Get the auto-merge option for the pull request. - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge](https://apidocs.harness.io/pullreq/prautomergeget.md) ### Enable the auto-merge option for the pull request. - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/automerge](https://apidocs.harness.io/pullreq/prautomergeenable.md) ### Restore source branch - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/branch](https://apidocs.harness.io/pullreq/restorepullreqsourcebranch.md) ### Get status checks - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/checks](https://apidocs.harness.io/pullreq/checkspullreq.md) ### Get code owners - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/codeowners](https://apidocs.harness.io/pullreq/codeownerspullreq.md) ### Create new pull request comment - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments](https://apidocs.harness.io/pullreq/commentcreatepullreq.md) ### Delete pull request comment - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}](https://apidocs.harness.io/pullreq/commentdeletepullreq.md) ### Update pull request comment - [PATCH /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}](https://apidocs.harness.io/pullreq/commentupdatepullreq.md) ### Update status of pull request comment - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/{pullreq_comment_id}/status](https://apidocs.harness.io/pullreq/commentstatuspullreq.md) ### Apply pull request code comment suggestions - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/comments/apply-suggestions](https://apidocs.harness.io/pullreq/commentapplysuggestions.md) ### List commits - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/commits](https://apidocs.harness.io/pullreq/listpullreqcommits.md) ### Get file changes - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff](https://apidocs.harness.io/pullreq/diffpullreq.md) ### Get file changes - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/diff](https://apidocs.harness.io/pullreq/diffpullreqpost.md) ### List viewed files - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views](https://apidocs.harness.io/pullreq/fileviewlistpullreq.md) ### Mark file as viewed - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views](https://apidocs.harness.io/pullreq/fileviewaddpullreq.md) ### Remove file view - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/file-views/{file_path}](https://apidocs.harness.io/pullreq/fileviewdeletepullreq.md) ### Merge - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/merge](https://apidocs.harness.io/pullreq/mergepullreqop.md) ### Remove the pull request from the merge queue. - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue](https://apidocs.harness.io/pullreq/prmergequeueremove.md) ### Get the pull request's merge-queue details. - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue](https://apidocs.harness.io/pullreq/prmergequeueget.md) ### Place the pull request to the target branch's merge queue. - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue](https://apidocs.harness.io/pullreq/prmergequeueenable.md) ### Reorder the merge queue so that this PR is at the head of the queue. - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/mergequeue/prioritize](https://apidocs.harness.io/pullreq/prmergequeueprioritize.md) ### Get metadata - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/metadata](https://apidocs.harness.io/pullreq/pullreqmetadata.md) ### Revert of a merged pull request - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/revert](https://apidocs.harness.io/pullreq/revertpullreqop.md) ### List reviewers - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers](https://apidocs.harness.io/pullreq/reviewerlistpullreq.md) ### Add reviewer - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers](https://apidocs.harness.io/pullreq/revieweraddpullreq.md) ### Remove reviewer - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/{pullreq_reviewer_id}](https://apidocs.harness.io/pullreq/reviewerdeletepullreq.md) ### reviewerCombinedListPullReq - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/combined](https://apidocs.harness.io/pullreq/reviewercombinedlistpullreq.md) ### userGroupReviewerAddPullReq - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/usergroups](https://apidocs.harness.io/pullreq/usergrouprevieweraddpullreq.md) ### userGroupReviewerDeletePullReq - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviewers/usergroups/{user_group_id}](https://apidocs.harness.io/pullreq/usergroupreviewerdeletepullreq.md) ### Submit review - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/reviews](https://apidocs.harness.io/pullreq/reviewsubmitpullreq.md) ### Update state of pull request - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/state](https://apidocs.harness.io/pullreq/statepullreq.md) ### List suggested labels - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels](https://apidocs.harness.io/pullreq/listsuggestedlabels.md) ### Remove suggested label - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/{label_id}](https://apidocs.harness.io/pullreq/removesuggestedlabel.md) ### Apply suggested label - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/{label_id}/apply](https://apidocs.harness.io/pullreq/applysuggestedlabel.md) ### Create label suggestions - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/labels/batch](https://apidocs.harness.io/pullreq/suggestlabelsbatch.md) ### List suggested reviewers - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers](https://apidocs.harness.io/pullreq/listsuggestedreviewers.md) ### Remove suggested reviewer - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/{principal_id}](https://apidocs.harness.io/pullreq/removesuggestedreviewer.md) ### Apply suggested reviewer - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/{principal_id}/apply](https://apidocs.harness.io/pullreq/applysuggestedreviewer.md) ### Create reviewer suggestions - [POST /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/suggestions/reviewers/batch](https://apidocs.harness.io/pullreq/suggestreviewersbatch.md) ### prCandidates - [GET /code/api/v1/repos/{repo_identifier}/pullreq/candidates](https://apidocs.harness.io/pullreq/prcandidates.md) ## upload ### Repo artifact upload - [POST /code/api/v1/repos/{repo_identifier}/uploads](https://apidocs.harness.io/upload/repoartifactupload.md) ### Repo artifact download - [GET /code/api/v1/repos/{repo_identifier}/uploads/{file_ref}](https://apidocs.harness.io/upload/repoartifactdownload.md) ## webhook ### List repo webhooks - [GET /code/api/v1/repos/{repo_identifier}/webhooks](https://apidocs.harness.io/webhook/listrepowebhooks.md) ### Create repo webhook - [POST /code/api/v1/repos/{repo_identifier}/webhooks](https://apidocs.harness.io/webhook/createrepowebhook.md) ### Delete repo webhook - [DELETE /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/deleterepowebhook.md) ### Get repo webhook - [GET /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/getrepowebhook.md) ### Update repo webhook - [PATCH /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/updaterepowebhook.md) ### List repo webhook executions - [GET /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions](https://apidocs.harness.io/webhook/listrepowebhookexecutions.md) ### Get repo webhook execution - [GET /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}](https://apidocs.harness.io/webhook/getrepowebhookexecution.md) ### Retrigger repo webhook execution - [POST /code/api/v1/repos/{repo_identifier}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger](https://apidocs.harness.io/webhook/retriggerrepowebhookexecution.md) ### List acc, org or proj webhooks - [GET /code/api/v1/webhooks](https://apidocs.harness.io/webhook/listspacewebhooks.md) ### Create acc, org or proj webhook - [POST /code/api/v1/webhooks](https://apidocs.harness.io/webhook/createspacewebhook.md) ### Delete acc, org or proj webhook - [DELETE /code/api/v1/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/deletespacewebhook.md) ### Get acc, org or proj webhook - [GET /code/api/v1/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/getspacewebhook.md) ### Update acc, org or proj webhook - [PATCH /code/api/v1/webhooks/{webhook_identifier}](https://apidocs.harness.io/webhook/updatespacewebhook.md) ### List acc, org or proj webhook executions - [GET /code/api/v1/webhooks/{webhook_identifier}/executions](https://apidocs.harness.io/webhook/listspacewebhookexecutions.md) ### Get acc, org or proj webhook execution - [GET /code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}](https://apidocs.harness.io/webhook/getspacewebhookexecution.md) ### Retrigger acc, org or proj webhook execution - [POST /code/api/v1/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger](https://apidocs.harness.io/webhook/retriggerspacewebhookexecution.md) ## resource ### List available gitignore names - [GET /code/api/v1/resources/gitignore](https://apidocs.harness.io/resource/listgitignore.md) ### List available license names - [GET /code/api/v1/resources/license](https://apidocs.harness.io/resource/listlicenses.md) ## rules ### List repo protection rules - [GET /code/api/v1/repos/{repo_identifier}/rules](https://apidocs.harness.io/rules/reporulelist.md) ### Add repo protection rule - [POST /code/api/v1/repos/{repo_identifier}/rules](https://apidocs.harness.io/rules/reporuleadd.md) ### Delete repo protection rule - [DELETE /code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}](https://apidocs.harness.io/rules/reporuledelete.md) ### Get repo protection rule - [GET /code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}](https://apidocs.harness.io/rules/reporuleget.md) ### Update repo protection rule - [PATCH /code/api/v1/repos/{repo_identifier}/rules/{rule_identifier}](https://apidocs.harness.io/rules/reporuleupdate.md) ### List acc/org/proj protection rules - [GET /code/api/v1/rules](https://apidocs.harness.io/rules/spacerulelist.md) ### Add acc/org/proj protection rule - [POST /code/api/v1/rules](https://apidocs.harness.io/rules/spaceruleadd.md) ### Delete acc/org/proj protection rule - [DELETE /code/api/v1/rules/{rule_identifier}](https://apidocs.harness.io/rules/spaceruledelete.md) ### Get acc/org/proj protection rule - [GET /code/api/v1/rules/{rule_identifier}](https://apidocs.harness.io/rules/spaceruleget.md) ### Update acc/org/proj protection rule - [PATCH /code/api/v1/rules/{rule_identifier}](https://apidocs.harness.io/rules/spaceruleupdate.md) ## labels ### List labels at account, org or project level - [GET /code/api/v1/labels](https://apidocs.harness.io/labels/listspacelabels.md) ### Create label at account, org or project level - [POST /code/api/v1/labels](https://apidocs.harness.io/labels/definespacelabel.md) ### Save label and values at account, org or project level - [PUT /code/api/v1/labels](https://apidocs.harness.io/labels/savespacelabel.md) ### Delete label at account, org or project level - [DELETE /code/api/v1/labels/{key}](https://apidocs.harness.io/labels/deletespacelabel.md) ### Update label at account, org or project level - [PATCH /code/api/v1/labels/{key}](https://apidocs.harness.io/labels/updatespacelabel.md) ### List label values at account, org or project level - [GET /code/api/v1/labels/{key}/values](https://apidocs.harness.io/labels/listspacelabelvalues.md) ### Create label value at account, org or project level - [POST /code/api/v1/labels/{key}/values](https://apidocs.harness.io/labels/definespacelabelvalue.md) ### Delete label value at account, org or project level - [DELETE /code/api/v1/labels/{key}/values/{value}](https://apidocs.harness.io/labels/deletespacelabelvalue.md) ### Update label value at account, org or project level - [PATCH /code/api/v1/labels/{key}/values/{value}](https://apidocs.harness.io/labels/updatespacelabelvalue.md) ### List labels at repo level - [GET /code/api/v1/repos/{repo_identifier}/labels](https://apidocs.harness.io/labels/listrepolabels.md) ### Create label at repo level - [POST /code/api/v1/repos/{repo_identifier}/labels](https://apidocs.harness.io/labels/definerepolabel.md) ### Save label and values at repo level - [PUT /code/api/v1/repos/{repo_identifier}/labels](https://apidocs.harness.io/labels/saverepolabel.md) ### Delete label at repo level - [DELETE /code/api/v1/repos/{repo_identifier}/labels/{key}](https://apidocs.harness.io/labels/deleterepolabel.md) ### Update label at repo level - [PATCH /code/api/v1/repos/{repo_identifier}/labels/{key}](https://apidocs.harness.io/labels/updaterepolabel.md) ### List label values at repo level - [GET /code/api/v1/repos/{repo_identifier}/labels/{key}/values](https://apidocs.harness.io/labels/listrepolabelvalues.md) ### Create label value at repo level - [POST /code/api/v1/repos/{repo_identifier}/labels/{key}/values](https://apidocs.harness.io/labels/definerepolabelvalue.md) ### Delete label value at repo level - [DELETE /code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}](https://apidocs.harness.io/labels/deleterepolabelvalue.md) ### Update label value at repo level - [PATCH /code/api/v1/repos/{repo_identifier}/labels/{key}/values/{value}](https://apidocs.harness.io/labels/updaterepolabelvalue.md) ### List labels assigned to pull request - [GET /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels](https://apidocs.harness.io/labels/listpullreqlabels.md) ### Assign label to pull request - [PUT /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels](https://apidocs.harness.io/labels/assignlabel.md) ### Unassign label from pull request - [DELETE /code/api/v1/repos/{repo_identifier}/pullreq/{pullreq_number}/labels/{label_id}](https://apidocs.harness.io/labels/unassignlabel.md) ## usage Usage service handles licencing ### Show usage - [PUT /iacm/api/enforcement/client/usage/{metric}](https://apidocs.harness.io/usage/usage_getusage.md): Retrieve a single usage ### Show licence - [GET /iacm/api/usage/check-licence](https://apidocs.harness.io/usage/usage_checklicence.md): Check whether the account is currently licenced ## approvals Approval service handles the approval API to approve or reject pipeline executions ### List approvals - [GET /iacm/api/orgs/{org}/projects/{project}/approvals](https://apidocs.harness.io/approvals/approvals_list-approvals.md): List all the approvals ### Create approval - [POST /iacm/api/orgs/{org}/projects/{project}/approvals](https://apidocs.harness.io/approvals/approvals_create-approval.md): Create an approval resource ### Show approval - [GET /iacm/api/orgs/{org}/projects/{project}/approvals/{id}](https://apidocs.harness.io/approvals/approvals_show-approval.md): Retrieve a single approval ### Update approval - [PUT /iacm/api/orgs/{org}/projects/{project}/approvals/{id}](https://apidocs.harness.io/approvals/approvals_update-approval.md): Update a single approval ## costs Costs Service handles the API related with the costs attached to workspaces. This API is read only as all the cost are generated in the plugin side ### List costs - [GET /iacm/api/orgs/{org}/projects/{project}/costs](https://apidocs.harness.io/costs/costs_list-costs.md): List the monthly cost per each workspace ### List costs per workspace - [GET /iacm/api/orgs/{org}/projects/{project}/costs/{workspace}](https://apidocs.harness.io/costs/costs_list-costs-per-workspace.md): List the cost of the workspace and correlate it with the executions ## executions Executions Service handles the API for workflow executions. At this time it is a read-only API with no ability to directly create or edit executions. Instead these are triggered from the Workspaces Service. ### List executions - [GET /iacm/api/orgs/{org}/projects/{project}/executions](https://apidocs.harness.io/executions/executions_list-executions.md): List all executions. ### Create execution - [POST /iacm/api/orgs/{org}/projects/{project}/executions](https://apidocs.harness.io/executions/executions_create-execution.md): Create a new execution. ### Show execution - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}](https://apidocs.harness.io/executions/executions_show-execution.md): Show an individual execution. ### Update execution - [POST /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}/audit-event](https://apidocs.harness.io/executions/executions_modify-execution.md): Modify an individual execution by adding audit data. ### List cost changes - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes](https://apidocs.harness.io/executions/executions_list-cost-changes.md): List cost changes from the latest plan and last applied state for the current execution. ### List cost changes for all stages - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages](https://apidocs.harness.io/executions/executions_list-cost-changes-all-stages.md): List cost changes for all stages from the latest plan and last applied state for the current execution. ### List cost changes for all stages by modules - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages-by-modules](https://apidocs.harness.io/executions/executions_list-cost-changes-all-stages-by-modules.md): List cost changes per module (stack path) for all stages for the current execution. ### Get dependency graph - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/dependency-graph](https://apidocs.harness.io/executions/executions_get-dependency-graph.md): Get dependency graph for an execution ### List resource changes - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes](https://apidocs.harness.io/executions/executions_list-resource-changes.md): List resource changes from the latest plan and state for this execution. ### List resource changes for all stages - [GET /iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes-all-stages](https://apidocs.harness.io/executions/executions_list-resource-changes-all-stages.md): List resource changes for all stages from the latest plan and state for this execution. ## module-registry The module-registry service is a private registry for Terraform/Opentofu modules ### List modules - [GET /iacm/api/modules](https://apidocs.harness.io/module-registry/module-registry_list_modules-by-account.md): List all modules from the module registry ### Create module - [POST /iacm/api/modules](https://apidocs.harness.io/module-registry/module-registry_create-module.md): Create a new module in the module registry ### Delete module - [DELETE /iacm/api/modules/{id}](https://apidocs.harness.io/module-registry/module-registry_delete-module.md): Delete a module from the module registry ### List module by id - [GET /iacm/api/modules/{id}](https://apidocs.harness.io/module-registry/module-registry_list-modules-by-id.md): List a module from the module registry by ID ### Update module - [PUT /iacm/api/modules/{id}](https://apidocs.harness.io/module-registry/module-registry_update-module.md): Update a module in the module registry ### Delete module lifecycle rule - [DELETE /iacm/api/modules/{id}/lifecycle](https://apidocs.harness.io/module-registry/module-registry_delete-module-lifecycle.md): Delete the lifecycle rule and all overrides for a module; all versions revert to supported ### Get module lifecycle rule - [GET /iacm/api/modules/{id}/lifecycle](https://apidocs.harness.io/module-registry/module-registry_get-module-lifecycle.md): Get the lifecycle rule for a module ### Upsert module lifecycle rule - [PUT /iacm/api/modules/{id}/lifecycle](https://apidocs.harness.io/module-registry/module-registry_put-module-lifecycle.md): Create or replace the lifecycle rule for a module, atomically replacing all overrides ### Get module version lifecycle status - [GET /iacm/api/modules/{id}/lifecycle/versions/{version}](https://apidocs.harness.io/module-registry/module-registry_get-module-lifecycle-version-status.md): Compute the lifecycle tier and enforcement action for a specific module version ### Create testing pipeline - [POST /iacm/api/modules/{id}/pipeline](https://apidocs.harness.io/module-registry/module-registry_create-testing-pipelines.md): Create a new testing pipeline for a given module ### Sync module metadata - [POST /iacm/api/modules/{id}/sync](https://apidocs.harness.io/module-registry/module-registry_sync-module-metadata.md): Sync the module metadata from the module registry ### List module tags - [GET /iacm/api/modules/{id}/tags](https://apidocs.harness.io/module-registry/module-registry_list-module-tags-by-id.md): List the module tags from the module registry ### Disable testing - [DELETE /iacm/api/modules/{id}/testing](https://apidocs.harness.io/module-registry/module-registry_disable-testing.md): Disable testing for a module ### Enable testing - [POST /iacm/api/modules/{id}/testing](https://apidocs.harness.io/module-registry/module-registry_enable-testing.md): Enable testing for a module ### Update module testing - [PUT /iacm/api/modules/{id}/testing](https://apidocs.harness.io/module-registry/module-registry_update-module-testing.md): Update module testing metadata ### Delete module version - [DELETE /iacm/api/modules/{id}/versions/{version}](https://apidocs.harness.io/module-registry/module-registry_delete-module-versions.md): Delete a specific version from a module in the module registry ### List module example files - [GET /iacm/api/modules/{module_id}/examples/{example_path}](https://apidocs.harness.io/module-registry/module-registry_list-module-example-files.md): List the files for a specific example directory of a module version ### Get module example file - [GET /iacm/api/modules/{module_id}/examples/{example_path}/{filename}](https://apidocs.harness.io/module-registry/module-registry_get-module-example-file.md): Download a single file from a specific example directory of a module version ### List module metadata - [GET /iacm/api/modules/{module_id}/metadata](https://apidocs.harness.io/module-registry/module-registry_list-metadata-by-module.md): List the module metadata from the module registry ### List module readme - [GET /iacm/api/modules/{module_id}/readme](https://apidocs.harness.io/module-registry/module-registry_list-readme-by-id.md): List the module readme from the module registry ### Send an event related with a module execution - [POST /iacm/api/modules/{moduleId}/events](https://apidocs.harness.io/module-registry/module-registry_send-module-event.md): Send an event related with a module execution ### List executions for a specific module - [GET /iacm/api/modules/{moduleId}/executions](https://apidocs.harness.io/module-registry/module-registry_list-module-executions-id.md): List all module executions for a module. ### Create a new module execution - [POST /iacm/api/modules/{moduleId}/executions](https://apidocs.harness.io/module-registry/module-registry_create-module-execution.md): Create a new module execution. ### Create module example - [POST /iacm/api/modules/{name}/{system}/{version}/examples/{example_path}](https://apidocs.harness.io/module-registry/module-registry_post-module-example.md): Endpoint to upload README and Terraform source files for a single example directory of a module version ### Create module data - [POST /iacm/api/modules/{name}/{system}/{version}/metadata](https://apidocs.harness.io/module-registry/module-registry_module-parsed-data.md): Create a new module in the module registry ### Create module readme - [POST /iacm/api/modules/{name}/{system}/{version}/readme](https://apidocs.harness.io/module-registry/module-registry_post-module-readme.md): Endpoint to push the Readme for a given module ### Upload module artifact files - [POST /iacm/api/modules/{name}/{system}/{version}/upload](https://apidocs.harness.io/module-registry/module-registry_post-module-artifact.md): Upload module artifact to the module registry ### Create module tags - [POST /iacm/api/modules/{name}/{system}/tags](https://apidocs.harness.io/module-registry/module-registry_post-module-tags.md): List all tags for a given module ### List connectors - [GET /iacm/api/modules/connectors](https://apidocs.harness.io/module-registry/module-registry_list-connectors.md): List all connectors from the module registry for a specific account ### Batch check module lifecycle status - [POST /iacm/api/modules/lifecycle/batch-check](https://apidocs.harness.io/module-registry/module-registry_batch-check-module-lifecycle.md): Batch-check lifecycle status for a list of modules resolved during terraform init; only violations are returned ### Create onboarding pipeline - [POST /iacm/api/modules/pipeline/onboarding](https://apidocs.harness.io/module-registry/module-registry_create-onboarding-pipeline.md): Create a new onboarding pipeline for module registry ### Download module - [GET /iacm/registry/account/{namespace}/{name}/{system}/{version}/download](https://apidocs.harness.io/module-registry/module-registry_download.md): Download a module given a specific version ### Download module file tarball - [GET /iacm/registry/account/{namespace}/{name}/{system}/{version}/download/file](https://apidocs.harness.io/module-registry/module-registry_getmodule.md): Download a module given a specific version ### List module versions - [GET /iacm/registry/account/{namespace}/{name}/{system}/versions](https://apidocs.harness.io/module-registry/module-registry_list-versions.md): list-module-versions returns an array of versions for a given module ## workspaces Workspaces Service handles the API for managing workspaces and triggering workflows against them. ### List all workspace tags - [GET /iacm/api/orgs/{org}/projects/{project}/tags](https://apidocs.harness.io/workspaces/workspaces_list-all-workspace-tags.md): List all tags ### Show workspace metrics - [GET /iacm/api/orgs/{org}/projects/{project}/workspace-metrics](https://apidocs.harness.io/workspaces/workspaces_show-workspace-metrics.md): Show metrics for workspaces ### List workspaces - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces](https://apidocs.harness.io/workspaces/workspaces_list-workspaces.md): List all workspaces. ### Create workspace - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces](https://apidocs.harness.io/workspaces/workspaces_create-workspace.md): Create a new workspace. ### Destroy workspace - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}](https://apidocs.harness.io/workspaces/workspaces_destroy-workspace.md): Deletes the given workspace. ### Show workspace - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}](https://apidocs.harness.io/workspaces/workspaces_show-workspace.md): Show an individual workspace. ### Update workspace - [PUT /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}](https://apidocs.harness.io/workspaces/workspaces_update-workspace.md): Updates the given workspace with new info. ### Force unlock workspace - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/actions/force-unlock](https://apidocs.harness.io/workspaces/workspaces_force-unlock-workspace.md): Force unlock a workspace. ### List modules - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/modules](https://apidocs.harness.io/workspaces/workspaces_list-workspace-modules.md): List modules associated with this workspace. ### List resources - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources](https://apidocs.harness.io/workspaces/workspaces_list-resources.md): List resources associated with this workspace. ### List resources using selectors - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{identifier}/resources/search](https://apidocs.harness.io/workspaces/workspaces_search-resources.md): List resources for a workspace using selectors. ### Clone workspace - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/clone](https://apidocs.harness.io/workspaces/workspaces_clone-workspace.md): Clone the given workspace with new name. ### List data - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data](https://apidocs.harness.io/workspaces/workspaces_list-data.md): List all stored data for a workspace. ### Create data - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data](https://apidocs.harness.io/workspaces/workspaces_create-data.md): Store binary data generated by the provisioner, such as plans and state files. ### Show data - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}](https://apidocs.harness.io/workspaces/workspaces_show-data.md): Get binary data generated by the provisioner, such as plans and state files. ### Evaluate data - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/data/{id}/evaluate-policy](https://apidocs.harness.io/workspaces/workspaces_evaluate-data.md): Evaluate policy against previously stored data, such as plans and state files. ### Upload dependency graph data - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/dependency-graph](https://apidocs.harness.io/workspaces/workspaces_upload-dependency-graph.md): Upload dependency graph for an existing plan file. ### Disable drift automation for a workspace - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config](https://apidocs.harness.io/workspaces/workspaces_delete-drift-config.md): Removes drift scheduling and related configuration for the workspace. ### Get drift automation status for a workspace - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config](https://apidocs.harness.io/workspaces/workspaces_get-drift-config.md): Returns whether drift automation is enabled and related metadata. ### Enable drift automation for a workspace - [PUT /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/drift-config](https://apidocs.harness.io/workspaces/workspaces_update-drift-config.md): Configures drift detection pipeline and schedule for the workspace. ### Disable ephemeral TTL for a workspace - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config](https://apidocs.harness.io/workspaces/workspaces_delete-ephemeral-config.md): Removes ephemeral scheduling and related configuration for the workspace. ### Get ephemeral TTL status for a workspace - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config](https://apidocs.harness.io/workspaces/workspaces_get-ephemeral-config.md): Returns whether ephemeral TTL is enabled and related metadata. ### Enable ephemeral TTL for a workspace - [PUT /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/ephemeral-config](https://apidocs.harness.io/workspaces/workspaces_update-ephemeral-config.md): Configures time-to-live settings to automatically destroy infrastructure and optionally delete the workspace. ### Send event - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/events](https://apidocs.harness.io/workspaces/workspaces_send-event.md): Store binary data generated by the provisioner, such as plans and state files. ### List pipelines - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/pipelines](https://apidocs.harness.io/workspaces/workspaces_list-pipelines.md): List the pipelines where the workspace is been used ### Create remote execution - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions](https://apidocs.harness.io/workspaces/workspaces_create-remote-execution.md): Create a remote execution for a workspace. ### Show remote execution - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}](https://apidocs.harness.io/workspaces/workspaces_find-remote-execution.md): Find remote execution ### Download remote execution - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/download](https://apidocs.harness.io/workspaces/workspaces_download-remote-execution.md): Download the source code for the remote plan. ### execute-remote-execution workspaces - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/execute](https://apidocs.harness.io/workspaces/workspaces_execute-remote-execution.md): Execute the remote execution ### Upload remote execution source - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remote-executions/{id}/upload](https://apidocs.harness.io/workspaces/workspaces_upload-remote-execution.md): Upload the source code for the remote execution. ### List workspace resource types - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types](https://apidocs.harness.io/workspaces/workspaces_list-workspace-resource-types.md): Retrieves the resource types used by workspaces ### Map of resource types and their attributes - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types-and-attributes](https://apidocs.harness.io/workspaces/workspaces_list-workspace-resource-types-and-attributes.md): Retrieves the resource type attributes used by workspaces and attributes ### List workspace resource type attributes - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resource-types/{resource_type}/attributes](https://apidocs.harness.io/workspaces/workspaces_list-workspace-resource-type-attributes.md): Retrieves the resource type attributes used by workspaces ### Delete resources - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources](https://apidocs.harness.io/workspaces/workspaces_delete-resources.md): Deletes destroyed resources for a workspace. ### Update resources - [PATCH /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources](https://apidocs.harness.io/workspaces/workspaces_update-resources.md): Updates resources for a workspace. ### Delete stale resources - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/resources/stale](https://apidocs.harness.io/workspaces/workspaces_delete-stale-resources.md): Deletes stale resources for a workspace that don't belong to the current session. ### Upload risk assessment data - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment](https://apidocs.harness.io/workspaces/workspaces_upload-risk-assessment.md): Upload per-resource risk data and overall risk summary for an existing plan file. ### List provisioners ratio - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/provisioners-ratio](https://apidocs.harness.io/workspaces/workspaces_list-provisioners-ratio.md): Retrieves the ratio of provisioners used by workspaces ### List workspaces associated with a template ID - [GET /iacm/api/workspace/templates/{template_id}](https://apidocs.harness.io/workspaces/workspaces_list-associated-workspaces.md): Get all workspaces associated with a specific template ID ## settings Settings service handles all API endpoints related to configuration settings ### Find general settings of the account, organization, or project. - [GET /code/api/v1/settings/general](https://apidocs.harness.io/settings/findspacegeneralsettings.md) ### Update general settings of the account, organization, or project. - [PATCH /code/api/v1/settings/general](https://apidocs.harness.io/settings/updatespacegeneralsettings.md) ### Delete default pipeline - [DELETE /iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines](https://apidocs.harness.io/settings/settings_delete-default-pipeline.md): Delete the association between a default pipeline and a provisioner operation ### List default pipelines - [GET /iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines](https://apidocs.harness.io/settings/settings_list-default-pipelines.md): List all associations between provisioner operations and default pipelines ### Upsert default pipeline - [PUT /iacm/api/orgs/{org}/projects/{project}/settings/default-pipelines](https://apidocs.harness.io/settings/settings_upsert-default-pipeline.md): Associate a default pipeline with a provisioner operation ### Check push data - [GET /iacm/api/orgs/{org}/projects/{project}/settings/disabled](https://apidocs.harness.io/settings/settings_check-push-data.md): Check if the plan/state should be sent to the server ### Disable drift automation for all workspaces in a project - [DELETE /iacm/api/orgs/{org}/projects/{project}/settings/drift-config](https://apidocs.harness.io/settings/settings_disable-project-drift.md): Enqueues a background job that removes drift triggers for every workspace in the project. ### Enable drift automation for all workspaces in a project - [PUT /iacm/api/orgs/{org}/projects/{project}/settings/drift-config](https://apidocs.harness.io/settings/settings_enable-project-drift.md): Enqueues a background job that creates drift triggers for every workspace in the project. ### Disable ephemeral TTL for all workspaces in a project - [DELETE /iacm/api/orgs/{org}/projects/{project}/settings/ephemeral-config](https://apidocs.harness.io/settings/settings_disable-ephemeral-workspaces-in-project.md): Enqueues a background job that removes ephemeral schedules for every workspace in the project. ### Enable ephemeral TTL for all workspaces in a project - [PUT /iacm/api/orgs/{org}/projects/{project}/settings/ephemeral-config](https://apidocs.harness.io/settings/settings_enable-ephemeral-workspaces-in-project.md): Enqueues a background job that configures ephemeral destroy/delete schedules for every workspace in the project. ## tf-standard-backend HTTP standard backend for Terraform ### Show terraform state - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend](https://apidocs.harness.io/tf-standard-backend/tf-standard-backend_pull-terraform-state.md) ### Create terraform state - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend](https://apidocs.harness.io/tf-standard-backend/tf-standard-backend_push-terraform-state.md) ### Unlock workspace - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock](https://apidocs.harness.io/tf-standard-backend/tf-standard-backend_unlock-workspace.md) ### Lock workspace - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/terraform-backend/lock](https://apidocs.harness.io/tf-standard-backend/tf-standard-backend_lock-workspace.md) ## variables Variables Service handles the API for managing workspace variables. ### List workspace variables - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables](https://apidocs.harness.io/variables/variables_list-variables.md): List all workspace variables. ### Create workspace variable - [POST /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables](https://apidocs.harness.io/variables/variables_create-variable.md): Creates a new workspace variable ### Destroy workspace variable - [DELETE /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}](https://apidocs.harness.io/variables/variables_destroy-variable.md): Deletes the given workspace variable. ### Show workspace variable - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}](https://apidocs.harness.io/variables/variables_show-variable.md): Show an individual workspace variable. ### Update workspace variable - [PUT /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/{kind}/{key}](https://apidocs.harness.io/variables/variables_update-variable.md): Updates the given workspace variable with new info. ### Get variables, provider connectors, and variable files - [GET /iacm/api/orgs/{org}/projects/{project}/workspaces/{workspace}/variables/merged](https://apidocs.harness.io/variables/variables_get-variables-and-providers.md): Returns all terraform/environment variables, provider connectors, and variable files for a workspace ## Exemptions Access and modify Exemptions to Security Issues ### Exemptions#ListExemptions - [GET /sto/api/v2/exemptions](https://apidocs.harness.io/exemptions/exemptions_listexemptions.md): List a collection of Exemptions ### Exemptions#CreateExemption - [POST /sto/api/v2/exemptions](https://apidocs.harness.io/exemptions/exemptions_createexemption.md): Create a new Exemption ### Exemptions#DeleteExemption - [DELETE /sto/api/v2/exemptions/{id}](https://apidocs.harness.io/exemptions/exemptions_deleteexemption.md): Delete an existing Exemption ### Exemptions#FindExemptionById - [GET /sto/api/v2/exemptions/{id}](https://apidocs.harness.io/exemptions/exemptions_findexemptionbyid.md): Find Exemption by ID ### Exemptions#UpdateExemption - [PUT /sto/api/v2/exemptions/{id}](https://apidocs.harness.io/exemptions/exemptions_updateexemption.md): Update an existing Exemption ### Exemptions#ApproveExemption - [PUT /sto/api/v2/exemptions/{id}/{action}](https://apidocs.harness.io/exemptions/exemptions_approveexemption.md): Approve/reject an existing Exemption ### Exemptions#PromoteExemption - [PUT /sto/api/v2/exemptions/{id}/promote](https://apidocs.harness.io/exemptions/exemptions_promoteexemption.md): Promote an existing Exemption to a higher scope ### Bulk create exemptions - [POST /sto/api/v2/exemptions/bulk](https://apidocs.harness.io/exemptions/exemptions_bulkcreateexemptions.md): Create multiple Exemptions in bulk. Each item is processed independently — failures are collected and returned alongside successes. ### Get exemption for issue - [GET /sto/api/v2/exemptions/issue/{issueId}](https://apidocs.harness.io/exemptions/exemptions_getexemptionforissue.md): Get the highest-priority exemption for an issue across all scopes (account, org, project) ## Issues Access and modify Security Issues ### Issues#ListIssues - [GET /sto/api/v2/issues](https://apidocs.harness.io/issues/issues_listissues.md): List a collection of Security Issues ### Issues#CreateIssue - [POST /sto/api/v2/issues](https://apidocs.harness.io/issues/issues_createissue.md): Create a new Security Issue ### Issues#DeleteIssue - [DELETE /sto/api/v2/issues/{id}](https://apidocs.harness.io/issues/issues_deleteissue.md): Delete an existing Security Issue ### Issues#FindIssueById - [GET /sto/api/v2/issues/{id}](https://apidocs.harness.io/issues/issues_findissuebyid.md): Find Security Issue by ID ### Issues#UpdateIssue - [PUT /sto/api/v2/issues/{id}](https://apidocs.harness.io/issues/issues_updateissue.md): Update an existing Security Issue ### Issues#IssuesAugmentRemediation - [POST /sto/api/v2/issues/{id}/augment-remediation](https://apidocs.harness.io/issues/issues_issuesaugmentremediation.md): Use AI to augment the remediation steps for this Security Issue ## Scans Access and modify Security Test Scans ### Scans#ListScans - [GET /sto/api/v2/scans](https://apidocs.harness.io/scans/scans_listscans.md): List a collection of Security Test Scans ### Scans#CreateScan - [POST /sto/api/v2/scans](https://apidocs.harness.io/scans/scans_createscan.md): Create a new Security Test Scan ### Scans#DeleteScan - [DELETE /sto/api/v2/scans/{id}](https://apidocs.harness.io/scans/scans_deletescan.md): Delete an existing Security Test Scan ### Scans#FindScanById - [GET /sto/api/v2/scans/{id}](https://apidocs.harness.io/scans/scans_findscanbyid.md): Find Security Test Scan by ID ### Scans#UpdateScan - [PUT /sto/api/v2/scans/{id}](https://apidocs.harness.io/scans/scans_updatescan.md): Update an existing Security Test Scan ### Scans#ScanIssue - [GET /sto/api/v2/scans/{id}/issue/{issueId}](https://apidocs.harness.io/scans/scans_scanissue.md): Returns a scan specific issue ### Scans#ScanIssueOccurrences - [GET /sto/api/v2/scans/{id}/issue/{issueId}/occurrences](https://apidocs.harness.io/scans/scans_scanissueoccurrences.md): Returns occurrences for a scan specific issue ### Scans#ScanIssues - [GET /sto/api/v2/scans/{id}/issues](https://apidocs.harness.io/scans/scans_scanissues.md): List Issues by Scan ID ### Scans#ScanIssueCounts - [GET /sto/api/v2/scans/{id}/issues/counts](https://apidocs.harness.io/scans/scans_scanissuecounts.md): Returns counts of active Security Issues for a Security Test Scan ## Products Access Scan Tool information ### Products#ListProducts - [GET /sto/api/v2/products](https://apidocs.harness.io/products/products_listproducts.md): List a collection of Scan Tools ### Products#FindProductById - [GET /sto/api/v2/products/{id}](https://apidocs.harness.io/products/products_findproductbyid.md): Find Scan Tool by ID ## Test Targets Access and modify Scan Targets ### Targets#ListTargets - [GET /sto/api/v2/targets](https://apidocs.harness.io/test-targets/targets_listtargets.md): List a collection of Test Targets ### Targets#CreateTarget - [POST /sto/api/v2/targets](https://apidocs.harness.io/test-targets/targets_createtarget.md): Create a new Test Target ### Targets#DeleteTarget - [DELETE /sto/api/v2/targets/{id}](https://apidocs.harness.io/test-targets/targets_deletetarget.md): Delete an existing Test Target ### Targets#FindTargetById - [GET /sto/api/v2/targets/{id}](https://apidocs.harness.io/test-targets/targets_findtargetbyid.md): Find Test Target by ID ### Targets#PatchTarget - [PATCH /sto/api/v2/targets/{id}](https://apidocs.harness.io/test-targets/targets_patchtarget.md): Update only certain fields on an existing Test Target ### Targets#UpdateTarget - [PUT /sto/api/v2/targets/{id}](https://apidocs.harness.io/test-targets/targets_updatetarget.md): Update an existing Test Target ## Target Variants Access and modify Scan Target Variants ### Target Variants#ListTargetVariants - [GET /sto/api/v2/targets/{targetId}/variants](https://apidocs.harness.io/target-variants/target%20variants_listtargetvariants.md): List a collection of Scan Target Variants ### Target Variants#CreateTargetVariant - [POST /sto/api/v2/targets/{targetId}/variants](https://apidocs.harness.io/target-variants/target%20variants_createtargetvariant.md): Create a new Scan Target Variant ### Target Variants#DeleteTargetVariant - [DELETE /sto/api/v2/targets/{targetId}/variants/{id}](https://apidocs.harness.io/target-variants/target%20variants_deletetargetvariant.md): Delete an existing Scan Target Variant ### Target Variants#FindTargetVariantById - [GET /sto/api/v2/targets/{targetId}/variants/{id}](https://apidocs.harness.io/target-variants/target%20variants_findtargetvariantbyid.md): Find Scan Target Variant by ID ### Target Variants#UpdateTargetVariant - [PUT /sto/api/v2/targets/{targetId}/variants/{id}](https://apidocs.harness.io/target-variants/target%20variants_updatetargetvariant.md): Update an existing Scan Target Variant ## Collection categories This contains APIs specific to the Collection categories ### List all Collection categories - [POST /v1/org/workspaces/units/list](https://apidocs.harness.io/collection-categories/categories_listcategories.md): Retrieve a list of collection categories ### Create a new Collection category - [POST /v1/org/categories](https://apidocs.harness.io/collection-categories/categories_createcategory.md): Create a new collection category ### Delete multiple Collection categories - [DELETE /v1/org/categories](https://apidocs.harness.io/collection-categories/categories_deletecategories.md): Delete multiple collection categories in a single request ### Update an existing Collection category - [PUT /v1/org/categories/{id}](https://apidocs.harness.io/collection-categories/categories_updatecategory.md): Use this API endpoint to update an existing collection category ### Delete a specific Collection category - [DELETE /v1/org/categories/{id}](https://apidocs.harness.io/collection-categories/categories_deletecategory.md): Delete an existing collection category ## Collections This contains APIs specific to Collections ### Retrieve a list of collections - [POST /v1/org/units/list](https://apidocs.harness.io/collections/collections_listcollections.md): This API endpoint allows you to retrieve a list of collections. The endpoint is paginated. ### Create a new collection - [POST /v1/org/units](https://apidocs.harness.io/collections/collections_createcollection.md): This API endpoint allows you to create a new collection. ### Edit an existing collection - [PUT /v1/org/units](https://apidocs.harness.io/collections/collections_editcollection.md): This API endpoint allows you to edit an existing collection. ### Delete an existing collection - [DELETE /v1/org/units](https://apidocs.harness.io/collections/collections_deletecollection.md): This API endpoint allows you to delete an existing collection. ## Contributors This contains APIs specific to the Contributors ### Retrieve the list of active versions - [GET /v1/org/users/versions](https://apidocs.harness.io/contributors/contributors_getactiveversions.md): This API endpoint retrieves the list of active versions. ### Retrieve the Ccontributor data schema - [GET /v1/org/users/schema](https://apidocs.harness.io/contributors/contributors_getschema.md): This API endpoint retrieves the schema used by the contributors, including any custom fields. ### Retrieve the list of current active licensed contributors - [POST /v1/org/users/list](https://apidocs.harness.io/contributors/users_listactiveusers.md): This API endpoint retrieves the list of current active licensed contributors. ### Update existing contributors - [PUT /v1/org/users](https://apidocs.harness.io/contributors/contributors_updatecontributors.md): This API endpoint is used to update existing contributors (users) in the system. ### Retrieve SEI contributors list - [POST /v1/sei_contributor/list](https://apidocs.harness.io/contributors/seicontributors_listcontributors.md): This API endpoint retrieves the list of licensed users for the given organization. ## DORA This contains APIs specific to the DORA reports ### Retrieve lead time data - [POST /v1/dora/lead-time](https://apidocs.harness.io/dora/dora_getleadtime.md): This endpoint is paginated and retrieves lead time data. ### Retrieve deployment frequency data - [POST /v1/dora/deployment_frequency](https://apidocs.harness.io/dora/dora_getdeploymentfrequency.md): This endpoint is paginated and retrieves deployment frequency data. ### Retrieve change failure rate data - [POST /v1/dora/change_failure_rate](https://apidocs.harness.io/dora/dora_getchangefailurerate.md): This endpoint is paginated and retrieves change failure rate data. ### Retrieve Mean Time to Restore (MTTR) data - [POST /v1/dora/mean-time](https://apidocs.harness.io/dora/dora_getmeantimetorestore.md): This endpoint retrieves Mean Time to Restore (MTTR) data for DORA metrics. ## Git Branches Contains APIs related to Git Sync Branch ### Sync the content of new Git Branch into harness with Git Sync Config Id - [POST /ng/api/git-sync-branch/sync](https://apidocs.harness.io/git-branches/syncgitbranch.md) ### Lists branches with their status(Synced, Unsynced) by Git Sync Config Id for the given scope - [GET /ng/api/git-sync-branch/listBranchesWithStatus](https://apidocs.harness.io/git-branches/getlistofbrancheswithstatus.md) ## Git Full Sync Contains APIs related to Git Full Sync ### Fetch Configuration for Git Full Sync for the provided scope - [GET /ng/api/git-full-sync/config](https://apidocs.harness.io/git-full-sync/getgitfullsyncconfig.md) ### Update Configuration for Git Full Sync for the provided scope - [PUT /ng/api/git-full-sync/config](https://apidocs.harness.io/git-full-sync/updategitfullsyncconfig.md) ### Create Configuration for Git Full Sync for the provided scope - [POST /ng/api/git-full-sync/config](https://apidocs.harness.io/git-full-sync/creategitfullsyncconfig.md) ### List files in full sync along with their status - [POST /ng/api/git-full-sync/files](https://apidocs.harness.io/git-full-sync/listfullsyncfiles.md) ### Trigger Full Sync - [POST /ng/api/git-full-sync](https://apidocs.harness.io/git-full-sync/triggerfullsync.md) ## Git Sync Settings Contains APIs related to Git Sync Settings ### Get Git Sync Setting for the given scope - [GET /ng/api/git-sync-settings](https://apidocs.harness.io/git-sync-settings/getgitsyncsettings.md) ### This updates the existing Git Sync settings within the scope. Only changing Connectivity Mode is allowed - [PUT /ng/api/git-sync-settings](https://apidocs.harness.io/git-sync-settings/updategitsyncsetting.md) ### Creates Git Sync Setting in a scope - [POST /ng/api/git-sync-settings](https://apidocs.harness.io/git-sync-settings/creategitsyncsetting.md) ## Git Sync Contains APIs for CRUD on Git Sync ### Lists Git Sync Config for the given scope - [GET /ng/api/git-sync](https://apidocs.harness.io/git-sync/getgitsyncconfiglist.md) ### Update existing Git Sync Config by Identifier - [PUT /ng/api/git-sync](https://apidocs.harness.io/git-sync/updategitsyncconfig.md) ### Creates Git Sync Config in given scope - [POST /ng/api/git-sync](https://apidocs.harness.io/git-sync/creategitsyncconfig.md) ### Check whether Git Sync is enabled for given scope or not - [GET /ng/api/git-sync/git-sync-enabled](https://apidocs.harness.io/git-sync/isgitsyncenabled.md) ### Update existing Git Sync Config default root folder by Identifier - [PUT /ng/api/git-sync/{identifier}/folder/{folderIdentifier}/default](https://apidocs.harness.io/git-sync/updatedefaultfolder.md) ## Git Sync Errors Contains APIs related to Git Sync Errors ### Get Errors Count for the given scope, Repo and Branch - [GET /ng/api/git-sync-errors/count](https://apidocs.harness.io/git-sync-errors/getgitsyncerrorscount.md) ### Lists Git to Harness Errors by file or connectivity errors for the given scope, Repo and Branch - [GET /ng/api/git-sync-errors](https://apidocs.harness.io/git-sync-errors/listgitsyncerrors.md) ### Lists Git to Harness Errors for the given Commit Id - [GET /ng/api/git-sync-errors/commits/{commitId}](https://apidocs.harness.io/git-sync-errors/listgittoharnesserrorforcommit.md) ### Lists Git to Harness Errors grouped by Commits for the given scope, Repo and Branch - [GET /ng/api/git-sync-errors/aggregate](https://apidocs.harness.io/git-sync-errors/listgittoharnesserrorsgroupedbycommits.md) ## integration ### Get Integration ID by GitHub Organization URL - [GET /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/integration-summary](https://apidocs.harness.io/integration/getintegration.md): Fetch the RSPM integration ID based on account, organization, project, and GitHub organization URL ### List Integrations - [GET /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration](https://apidocs.harness.io/integration/listintegrations.md) ### Create Integration - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration](https://apidocs.harness.io/integration/createintegration.md) ### Get all repos from github app - [GET /v1/orgs/{org}/projects/{project}/integration/{integration}/fetch-repos](https://apidocs.harness.io/integration/fetchreposinintegration.md) ### Get configured repos in the integration - [GET /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos](https://apidocs.harness.io/integration/getintegrationrepos.md) ### Configure repos in your integration - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos](https://apidocs.harness.io/integration/configurerepos.md) ### Add repos in your integration - [PATCH /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos](https://apidocs.harness.io/integration/addrepos.md) ### Delete Integration - [DELETE /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}](https://apidocs.harness.io/integration/deleteintegration.md) ### Get Harness Pipeline Integration - [GET /v1/orgs/{org}/projects/{project}/integration/harness-pipeline](https://apidocs.harness.io/integration/getharnesspipelineintegration.md): Get Harness Pipeline Integration ## PipelineInfraConfig ### Save SPM Pipeline Infra Configs - [POST /gateway/ssca-manager/v1/ssca-config/pipeline-infra](https://apidocs.harness.io/pipelineinfraconfig/savepipelineinfraconfig.md) ### Configure your scan frequency - [POST /v1/ssca-config/integrations](https://apidocs.harness.io/pipelineinfraconfig/saveintegrationconfig.md) ## SBOM ### Download SBOM for an artifact - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-download](https://apidocs.harness.io/sbom/downloadsbomforartifact.md): Download SBOM for an artifact ### Download SBOM score for an artifact - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-score](https://apidocs.harness.io/sbom/getsbomscoreforartifact.md): Download SBOM score for an artifact ## Integration Step Config ### Integration step config for Account - [POST /gateway/ssca-manager/v1/ssca-config/integration-step](https://apidocs.harness.io/integration-step-config/setintegrationstepconfig.md) ### Integration step config for Project - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/ssca-config/integration-step](https://apidocs.harness.io/integration-step-config/setintegrationstepconfigfororgproject.md) ### Integration step config for Org - [POST /gateway/ssca-manager/v1/orgs/{org}/ssca-config/integration-step](https://apidocs.harness.io/integration-step-config/setintegrationstepconfigfororg.md) ## Delete Step Config ### Delete step config at Org - [DELETE /gateway/ssca-manager/v1/org/{org}/ssca-config/{config-id}](https://apidocs.harness.io/delete-step-config/deleteconfigbyorg.md) ### Delete step config at Account - [DELETE /gatway/ssca-manager/v1/ssca-config/{config-id}](https://apidocs.harness.io/delete-step-config/deleteconfigbyaccount.md) ### Delete step config by Project - [DELETE /gateway/ssca-manager/v1/org/{org}/project/{project}/ssca-config/{config-id}](https://apidocs.harness.io/delete-step-config/deleteconfigbyid.md): Delete Config By ID ## Delete Repositories ### Delete Repositories from Integration - [DELETE /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/integration/{integration}/repos](https://apidocs.harness.io/delete-repositories/deleterepos.md) ### Delete Repositories from Repo Listing Page - [DELETE /gateway/ssca-manager/v1/repository](https://apidocs.harness.io/delete-repositories/deleterepositories.md) ## Pipeline Store Config ### Save SPM Pipeline Remote Configs - [POST /gateway/ssca-manager/v1/orgs/{org}/projects/{project}/ssca-config/pipeline-store](https://apidocs.harness.io/pipeline-store-config/savepipelineremoteconfig.md) ## Evidence Vault [Beta] ### Upload attestation - [POST /gateway/ssca-manager/v2/orgs/{org}/projects/{project}/attestations/upload/{orchestration}](https://apidocs.harness.io/evidence-vault-beta/uploadattestation.md) ### Download attestation by digest(gitoidSha256 or payload digest) - [GET /gateway/ssca-manager/v2/orgs/{org}/projects/{project}/attestations/download/{digest}](https://apidocs.harness.io/evidence-vault-beta/downloadattestation.md) ### GraphQL query endpoint for attestations - [POST /gateway/ssca-manager/v2/orgs/{org}/projects/{project}/attestations/query](https://apidocs.harness.io/evidence-vault-beta/queryattestationsgraphql.md) ## Release Groups [Beta] ### Create New Release Group - [POST /rmg/api/releaseGroup](https://apidocs.harness.io/release-groups/post-releasegroup.md): Create a new Release Group. ### Delete Release Group by ID - [DELETE /rmg/api/releaseGroup/{releaseGroupId}](https://apidocs.harness.io/release-groups/delete-releasegroup.md): Delete a specific Release Group by its ID. ### Update Release Group - [PUT /rmg/api/releaseGroup/{releaseGroupId}](https://apidocs.harness.io/release-groups/put-releasegroup.md) ### Get Release Group by ID - [GET /rmg/api/releaseGroup/{releaseGroupId}](https://apidocs.harness.io/release-groups/get-releasegroup.md): Retrieve details of a specific Release Group. ### Partially Update Release Group - [PATCH /rmg/api/releaseGroup/{releaseGroupId}](https://apidocs.harness.io/release-groups/patch-releasegroup.md): Partially update a release group without recreating releases. Currently supports updating autoExecuteOnSchedule field. ### Fetch List of Release Group - [GET /rmg/api/releaseGroup/summary](https://apidocs.harness.io/release-groups/get-releasegroup-summary.md) ### Get Component Details for a given releaseGroupId - [GET /rmg/api/releaseGroup/{releaseGroupId}/components](https://apidocs.harness.io/release-groups/get-releasegroup-releasegroupid-components.md) ### Fetch Release Conflicts - [GET /rmg/api/releaseGroup/{releaseGroupId}/conflicts](https://apidocs.harness.io/release-groups/getreleaseconflicts.md): Fetch a paginated list of release conflicts for a release group with optional status filtering ## Releases [Beta] ### Create Ad Hoc Release - [POST /rmg/api/release/adhoc](https://apidocs.harness.io/releases/postreleaseadhoc.md): Create an ad hoc release with a linked orchestration process, bypassing the standard release group cadence. ### Fetch Release Summary - [POST /rmg/api/release/summary](https://apidocs.harness.io/releases/postreleasesummary.md): Fetch a list of releases based on the specified time ranges, optional filters, and search query. ### Fetch Release Information - [GET /rmg/api/release/{releaseId}](https://apidocs.harness.io/releases/get-release.md): Gets the release information for a given release ### Update a single release - [PUT /rmg/api/release/{releaseId}](https://apidocs.harness.io/releases/put-release-releaseid.md) ### Fetch Release Activities - [GET /rmg/api/release/{releaseId}/activities](https://apidocs.harness.io/releases/getreleaseactivities.md): Fetch a list of activities based on the startTime, endTime and release Id. ### Fetch Release Activities Day Wise - [GET /rmg/api/release/calendar/{releaseId}/activities](https://apidocs.harness.io/releases/getreleasedayactivities.md): Fetch a list of activities based on the startTime, endTime and release Id for a day view ### Fetch approvals activity for a release - [GET /rmg/api/release/{releaseId}/approvals](https://apidocs.harness.io/releases/get-release-releaseid-approvals.md) ### Environment Dashbaord for a release - [GET /rmg/api/release/{releaseId}/environmentDashboard](https://apidocs.harness.io/releases/get-release-releaseid-environmentdashboard.md): Gets the environment dashboard for the given release ### Fetch the list of environments for release - [GET /rmg/api/release/{releaseId}/environments](https://apidocs.harness.io/releases/get-release-releaseid-environments.md): Api to fetch the list of environments for release ### Execute Action on Release - [POST /rmg/api/release/{releaseId}/action](https://apidocs.harness.io/releases/postreleaseaction.md): Executes an action on a release (e.g., abort) ### Trigger Subprocess from Task - [POST /rmg/api/release/{releaseId}/subprocess/trigger](https://apidocs.harness.io/releases/postreleasesubprocesstrigger.md): Triggers a subprocess release from a task within the specified release ### Fetch Release Tasks - [GET /rmg/api/release/{releaseId}/tasks](https://apidocs.harness.io/releases/getreleasetasks.md): Fetch a paginated list of tasks from Manual Activities for a release with cursor-based pagination and optional status filtering. ## Orchestration Processes [Beta] ### Create Orchestration Process - [POST /rmg/api/orchestration/process](https://apidocs.harness.io/orchestration-processes/post-orchestrationprocess.md): Create a new orchestration process ### Fetch List of Orchestration Processes - [GET /rmg/api/orchestration/process/summary](https://apidocs.harness.io/orchestration-processes/get-orchestrationprocess-summary.md) ### Get Orchestration Process - [GET /rmg/api/orchestration/process/{identifier}](https://apidocs.harness.io/orchestration-processes/get-orchestrationprocess.md): Get orchestration process by identifier ### Update Orchestration Process - [PUT /rmg/api/orchestration/process/{identifier}](https://apidocs.harness.io/orchestration-processes/put-orchestration-process.md): Update an orchestration process with the provided YAML configuration ### Delete Orchestration Process - [DELETE /rmg/api/orchestration/process/{identifier}](https://apidocs.harness.io/orchestration-processes/delete-orchestration-process.md): Delete an orchestration process by identifier ### Create Orchestration Process Input - [POST /rmg/api/orchestration/process/{identifier}/input](https://apidocs.harness.io/orchestration-processes/post-orchestrationprocessinput.md): Create a new orchestration process input with the provided YAML configuration ### Get Orchestration Process Input - [GET /rmg/api/orchestration/process/{processIdentifier}/input/{identifier}](https://apidocs.harness.io/orchestration-processes/get-orchestration-process-input.md): Get an orchestration process input by process identifier and input identifier ### Update Orchestration Process Input - [PUT /rmg/api/orchestration/process/{processIdentifier}/input/{identifier}](https://apidocs.harness.io/orchestration-processes/put-orchestration-process-input.md): Update an orchestration process input with the provided YAML configuration ### Delete Orchestration Process Input - [DELETE /rmg/api/orchestration/process/{processIdentifier}/input/{identifier}](https://apidocs.harness.io/orchestration-processes/delete-orchestration-process-input.md): Delete an orchestration process input by process identifier and input identifier ### Fetch List of Orchestration Process Inputs - [GET /rmg/api/orchestration/process/{processIdentifier}/input/summary](https://apidocs.harness.io/orchestration-processes/get-orchestration-process-input-summary.md): Retrieve a paginated list of orchestration process inputs for a specific process ### Fetch List of Attached Release Groups for Orchestration Process - [POST /rmg/api/orchestration/process/{identifier}/attachedReleaseGroups](https://apidocs.harness.io/orchestration-processes/post-orchestrationprocess-attachedreleasegroups.md): Retrieve a paginated list of release groups attached to orchestration processes with optional filtering ## Orchestration Activities [Beta] ### Create Orchestration Activity - [POST /rmg/api/orchestration/activity](https://apidocs.harness.io/orchestration-activities/post-orchestrationactivity.md): Create a new orchestration activity ### Fetch List of Orchestration Activities - [GET /rmg/api/orchestration/activity/summary](https://apidocs.harness.io/orchestration-activities/get-orchestration-activity-summary.md): Retrieve a paginated list of orchestration activities ### Get Orchestration Activity - [GET /rmg/api/orchestration/activity/{identifier}](https://apidocs.harness.io/orchestration-activities/get-orchestrationactivity.md): Get orchestration activity by identifier ### Update Orchestration Activity - [PUT /rmg/api/orchestration/activity/{identifier}](https://apidocs.harness.io/orchestration-activities/put-orchestration-activity.md): Update an orchestration activity with the provided YAML configuration ### Delete Orchestration Activity - [DELETE /rmg/api/orchestration/activity/{identifier}](https://apidocs.harness.io/orchestration-activities/delete-orchestration-activity.md): Delete an orchestration activity by identifier ### Get Activity Inputs by Activity Ref - [GET /rmg/api/orchestration/activity/{activityRef}/inputs](https://apidocs.harness.io/orchestration-activities/get-orchestration-activity-inputs.md): Retrieve input definitions and values for a specific activity within a process input configuration ### Handle On-Hold Activity Action - [POST /rmg/api/orchestration/activity/{activityExecutionId}/onhold/action](https://apidocs.harness.io/orchestration-activities/postonholdactivityaction.md): Process actions (retry/ignore) for activities in ON_HOLD state ### List Orchestration Activities by Process Identifier - [GET /rmg/api/orchestration/activity/processIdentifier/{identifier}](https://apidocs.harness.io/orchestration-activities/get-orchestration-activities-by-process-identifier.md): Retrieve a paginated list of orchestration activities for a specific process identifier ### Get Orchestration Activities by activity refs - [POST /rmg/api/orchestration/activity/list](https://apidocs.harness.io/orchestration-activities/get-orchestration-activities-by-acitivity-refs.md): Get orchestration activities for specific activity refs ## Orchestration Executions [Beta] ### Start Release Execution - [POST /rmg/api/orchestration/execution/startRelease/{id}](https://apidocs.harness.io/orchestration-executions/startreleaseexecution.md): Start a new release execution for the given identifier ### Get Phases by Release ID - [GET /rmg/api/orchestration/execution/{releaseId}/phases](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-phases.md): Retrieve all phases for a specific release. Returns phase details including their YAML configurations. ### Get Activities by Release and Phase ID - [GET /rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activities](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-activities.md): Retrieve all activities for a specific release and phase execution. If no activities exist in the database, it will fetch them from the phase YAML configuration. ### Get Orchestration Execution Tasks by Activity - [GET /rmg/api/orchestration/execution/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/tasks](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-tasks.md): Retrieve all orchestration execution tasks for a specific activity in a release phase ### Get Activity Retry History By Identifiers - [GET /rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/retry-history](https://apidocs.harness.io/orchestration-executions/get-activity-retry-history-by-identifiers.md): Retrieve the retry history for a specific activity by release ID, phase identifier, and activity identifier ### Get Activity Execution Inputs - [GET /rmg/api/orchestration/execution/activity/{activityId}/input](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-activity-inputs.md): Retrieve input values for a specific activity execution ### Get Activity Execution Detail - [GET /rmg/api/orchestration/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-activity.md): Retrieve detailed information about an activity execution including phase info, yaml, and pipeline/subprocess execution details. If activityExecutionId is provided, filters by it directly. Otherwise, filters by releaseId, phaseIdentifier, activityIdentifier, and retryIndex (defaults to 0 if not provided). ### Get Phase Execution Outputs - [GET /rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/output](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-phase-outputs.md): Retrieve output values for a specific phase execution ### Get Activity Execution Outputs - [GET /rmg/api/orchestration/execution/release/{releaseId}/phase/{phaseIdentifier}/activity/{activityIdentifier}/output](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-activity-outputs.md): Retrieve output values for a specific activity execution ### Submit Activity Execution Outputs - [POST /rmg/api/orchestration/execution/activity/{activityId}/output](https://apidocs.harness.io/orchestration-executions/post-activity-execution-output.md): Submit outputs for a manual activity execution that is waiting for outputs ### Create Task Comment - [POST /rmg/api/orchestration/execution/task/{taskExecutionId}/comment](https://apidocs.harness.io/orchestration-executions/createtaskcomment.md): Create a new comment for a specific execution task ### Update Task Comment - [PUT /rmg/api/orchestration/execution/task/comment/{commentId}](https://apidocs.harness.io/orchestration-executions/updatetaskcomment.md): Update an existing task comment ### Delete Task Comment - [DELETE /rmg/api/orchestration/execution/task/comment/{commentId}](https://apidocs.harness.io/orchestration-executions/deletetaskcomment.md): Delete a specific task comment ### Get Task Comments Summary - [GET /rmg/api/orchestration/execution/task/{taskExecutionId}/comment/summary](https://apidocs.harness.io/orchestration-executions/gettaskcommentssummary.md): Retrieve a cursor based paginated list of comments for a specific execution task ### Update Execution Task Status - [PUT /rmg/api/orchestration/execution/task/{taskExecutionId}/status](https://apidocs.harness.io/orchestration-executions/updateexecutiontaskstatus.md): Update the status of a specific execution task ### Update Execution Task Metadata - [PUT /rmg/api/orchestration/execution/task/{taskExecutionId}/metadata](https://apidocs.harness.io/orchestration-executions/updateexecutiontaskmetadata.md): Update the metadata (name and description) of a specific execution task ### Get Events by Entity Type and Entity ID - [GET /rmg/api/orchestration/{entityType}/events/{entityId}](https://apidocs.harness.io/orchestration-executions/geteventsbyentitytypeandid.md): Retrieve a cursor-based paginated list of events for a specific entity type and entity ID, sorted by created_at in descending order ### Get Paginated Activities by Release ID - [GET /rmg/api/release/{releaseId}/execution/activities](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-activities-paginated.md): Retrieve a paginated list of orchestration execution activities for a specific release with optional filters. Sortable fields: start_ts, startTs, end_ts, endTs, last_updated_at, lastUpdatedAt, created_at, createdAt, name, identifier, status, type. Sort format: sort=field_name&sort=direction where direction is asc or desc. Examples: sort=start_ts&sort=desc or sort=endTs&sort=asc. ### Get Latest Release Input by Release ID - [GET /rmg/api/orchestration/execution/releaseInput/{releaseId}](https://apidocs.harness.io/orchestration-executions/get-orchestration-execution-release-input.md): Retrieve the latest release input for a specific release ID ## Conflicts [Beta] ### Update Release Conflict - [PUT /rmg/api/conflicts/{executionId}](https://apidocs.harness.io/conflicts/updatereleaseconflict.md): Update release ID and type for a release conflict ## Freeze [Beta] ### Get Freeze List by Timestamp - [GET /rmg/api/freeze/list](https://apidocs.harness.io/freeze/rmgetfreezelist.md): Retrieve a paginated list of freeze information for all active freezes that overlap with the specified time range (startTime to endTime). ### Get Freeze Details by Identifiers - [GET /rmg/api/freeze/details/{freeze_identifier}](https://apidocs.harness.io/freeze/getfreezedetails.md): Retrieve detailed freeze information including entity extraction for a specific freeze. ## Reports [Beta] ### Generate Report for Release - [POST /rmg/api/release/{releaseId}/report/generate](https://apidocs.harness.io/reports/postreleasereportgenerate.md): Generate a CSV report for a specific release within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report. ### Generate Report for Release Group - [POST /rmg/api/releaseGroup/{releaseGroupId}/report/generate](https://apidocs.harness.io/reports/postreleasegroupreportgenerate.md): Generate a CSV report for all releases in a release group within a time period. The report generation is asynchronous and returns a report job ID that can be used to track status and download the report. ### Get Report Status - [GET /rmg/api/release/report/{reportId}/status](https://apidocs.harness.io/reports/getreportstatus.md): Get the status of a report generation job. Returns the current status, timestamps, and error information if the job failed. ### Download Report - [GET /rmg/api/release/report/{reportId}/download](https://apidocs.harness.io/reports/getreportdownload.md): Download the generated CSV report. The report must be in COMPLETED status. Returns the CSV file as a binary download. ## Uploads [Beta] ### Generate presigned upload URL - [POST /rmg/api/v1/uploads/presign](https://apidocs.harness.io/uploads/presignupload.md): Generate a presigned GCS URL for uploading an image or video file. Returns both the upload URL (for PUT) and the serve URL (for retrieval). ### Serve uploaded file - [GET /rmg/api/v1/uploads/{accountId}/{releaseId}/{filename}](https://apidocs.harness.io/uploads/serveupload.md): Serve an uploaded file via a 307 redirect to a signed GCS URL. Performs post-upload size verification and deletes oversized objects. ## Actions ### List actions with filtering options - [GET /gateway/chaos/manager/api/rest/actions](https://apidocs.harness.io/actions/listactions.md): Retrieve a list of actions based on various filters like name, tags, date range, and infrastructure type, with pagination support. ### Create a new action - [POST /gateway/chaos/manager/api/rest/actions](https://apidocs.harness.io/actions/createaction.md): Create a new action ### Import a new action - [POST /gateway/chaos/manager/api/rest/actions/import](https://apidocs.harness.io/actions/importaction.md): Import a new action ### Get an action manifest - [GET /gateway/chaos/manager/api/rest/actions/manifest/{identity}](https://apidocs.harness.io/actions/getactionmanifest.md): Retrieve Action manifest of a specific action by its ID ### Get an action - [GET /gateway/chaos/manager/api/rest/actions/{identity}](https://apidocs.harness.io/actions/getaction.md): Retrieve details of a specific action by its ID ### Update an action - [PUT /gateway/chaos/manager/api/rest/actions/{identity}](https://apidocs.harness.io/actions/updateaction.md): Update an action with the specified configuration ### Delete an action - [DELETE /gateway/chaos/manager/api/rest/actions/{identity}](https://apidocs.harness.io/actions/deleteaction.md): Delete an action with a provided identifier ### List action metadata - [POST /gateway/chaos/manager/api/v3/actions/list-metadata](https://apidocs.harness.io/actions/listactionmetadata.md): List action metadata ## Action Templates ### List all the action templates in a hub - [GET /gateway/chaos/manager/api/rest/templates/actions](https://apidocs.harness.io/action-templates/listactiontemplate.md): List all the action templates in a hub based on tag ### Create the action templates in a hub - [POST /gateway/chaos/manager/api/rest/templates/actions](https://apidocs.harness.io/action-templates/createactiontemplate.md): Create action templates in a hub based on tag ### Get the action template in a hub - [GET /gateway/chaos/manager/api/rest/templates/actions/{identity}](https://apidocs.harness.io/action-templates/getactiontemplate.md): Get the action template in a hub based on action ref ### Update the action templates in a hub - [PUT /gateway/chaos/manager/api/rest/templates/actions/{identity}](https://apidocs.harness.io/action-templates/updateactiontemplate.md): Update an existing action template in a hub with new configuration ### Delete action template - [DELETE /gateway/chaos/manager/api/rest/templates/actions/{identity}](https://apidocs.harness.io/action-templates/deleteactiontemplate.md) ### Get the difference between 2 revisions of action template - [GET /gateway/chaos/manager/api/rest/templates/actions/{identity}/compare](https://apidocs.harness.io/action-templates/getactiontemplaterevisiondifference.md): Get the difference between 2 revisions of action template in a hub ### List all the revision of an action template in a hub - [GET /gateway/chaos/manager/api/rest/templates/actions/{identity}/revisions](https://apidocs.harness.io/action-templates/listactiontemplaterevisions.md): List all the revision of a fault template in a hub ### Get the list of inputs in an action template - [GET /gateway/chaos/manager/api/rest/templates/actions/{identity}/variables](https://apidocs.harness.io/action-templates/listvariablesinactiontemplate.md): Get the list of inputs in a fault template based on revision ## Chaos Components ### Get chaos component variables - [GET /gateway/chaos/manager/api/v3/integrations/get-chaos-component-variable](https://apidocs.harness.io/chaos-components/getchaoscomponentvariable.md): Get chaos component variables (faults, probes, actions) ### Run chaos component - [POST /gateway/chaos/manager/api/v3/integrations/run-chaos-component](https://apidocs.harness.io/chaos-components/runchaoscomponent.md): Run chaos component (faults, probes, actions) ## Chaos Hubs ### List chaos hubs - [GET /gateway/chaos/manager/api/rest/hubs](https://apidocs.harness.io/chaos-hubs/listchaoshub.md): List chaos hubs based on given filters ### Create chaos hub - [POST /gateway/chaos/manager/api/rest/hubs](https://apidocs.harness.io/chaos-hubs/createchaoshub.md): Create chaos hub ### Get chaos hub - [GET /gateway/chaos/manager/api/rest/hubs/{hubIdentity}](https://apidocs.harness.io/chaos-hubs/getchaoshub.md): Get chaos hub based on given filters ### Update chaos hub - [PUT /gateway/chaos/manager/api/rest/hubs/{hubIdentity}](https://apidocs.harness.io/chaos-hubs/updatechaoshub.md): Update chaos hub ### Delete a chaos hub in a scope - [DELETE /gateway/chaos/manager/api/rest/hubs/{hubIdentity}](https://apidocs.harness.io/chaos-hubs/deletehub.md): Delete a chaos hub in a scope ### List hub metadata - [POST /gateway/chaos/manager/api/v3/hubs/list-metadata](https://apidocs.harness.io/chaos-hubs/listhubmetadata.md): List hub metadata ## ChaosGuard Conditions ### Get security governance conditions template - [POST /gateway/chaos/manager/api/rest/genai/sgp/generate](https://apidocs.harness.io/chaosguard-conditions/getsgptemplatebygenai.md): Get security governance conditions template ### List chaos guard conditions - [GET /gateway/chaos/manager/api/v3/chaosguard-conditions](https://apidocs.harness.io/chaosguard-conditions/listcondition.md): List chaos guard conditions ### Create a chaos guard condition - [POST /gateway/chaos/manager/api/v3/chaosguard-conditions](https://apidocs.harness.io/chaosguard-conditions/createcondition.md): Create a chaos guard condition ### Get a chaos guard condition by id - [GET /gateway/chaos/manager/api/v3/chaosguard-conditions/{identity}](https://apidocs.harness.io/chaosguard-conditions/getcondition.md): Get a chaos guard condition by id ### Update a chaos guard condition - [PUT /gateway/chaos/manager/api/v3/chaosguard-conditions/{identity}](https://apidocs.harness.io/chaosguard-conditions/updatecondition.md): Update a chaos guard condition ### Delete a chaos guard condition - [DELETE /gateway/chaos/manager/api/v3/chaosguard-conditions/{identity}](https://apidocs.harness.io/chaosguard-conditions/deletecondition.md): Delete a chaos guard condition ## ChaosGuard Rules ### List chaos guard rules - [GET /gateway/chaos/manager/api/v3/chaosguard-rules](https://apidocs.harness.io/chaosguard-rules/listrule.md): List chaos guard rules ### Create a chaos guard rule - [POST /gateway/chaos/manager/api/v3/chaosguard-rules](https://apidocs.harness.io/chaosguard-rules/createrule.md): Create a chaos guard rule ### Get a chaos guard rule by id - [GET /gateway/chaos/manager/api/v3/chaosguard-rules/{identity}](https://apidocs.harness.io/chaosguard-rules/getrule.md): Get a chaos guard rule by id ### Update a chaos guard rule - [PUT /gateway/chaos/manager/api/v3/chaosguard-rules/{identity}](https://apidocs.harness.io/chaosguard-rules/updaterule1.md): Update a chaos guard rule ### Delete a chaos guard rule - [DELETE /gateway/chaos/manager/api/v3/chaosguard-rules/{identity}](https://apidocs.harness.io/chaosguard-rules/deleterule1.md): Delete a chaos guard rule ### Enable or disable a chaos guard rule - [PUT /gateway/chaos/manager/api/v3/chaosguard-rules/{identity}/enable](https://apidocs.harness.io/chaosguard-rules/enablerule.md): Enable or disable a chaos guard rule ## DR Tests ### List all DR tests - [GET /gateway/chaos/manager/api/v3/dr-tests](https://apidocs.harness.io/dr-tests/listdrtests.md): List all DR tests (DRTest stages) from pipelines ### Create a DR Test pipeline - [POST /gateway/chaos/manager/api/v3/dr-tests](https://apidocs.harness.io/dr-tests/createdrtest.md): Create a DR Test pipeline for disaster recovery testing ## Experiments ### Generate and return kubernetesV1 chaos experiment run report - [GET /gateway/chaos/manager/api/rest/chaos-experiment-run/report/{experimentRunId}/{notifyId}](https://apidocs.harness.io/experiments/getchaosexperimentrunreport.md): Generate and return kubernetesV1 chaos experiment run report ### Get chaos experiment run overview stats - [GET /gateway/chaos/manager/api/rest/overview/experiment-stats](https://apidocs.harness.io/experiments/getexperimentrunsoverviewstats.md): Get resource usage ### Delete given experiments - [POST /gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimentdelete](https://apidocs.harness.io/experiments/bulkexperimentdelete.md): Delete given experiments ### Add tags in given experiments - [POST /gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimenttagsadd](https://apidocs.harness.io/experiments/bulkexperimenttagadd.md): Add tags in given experiments ### Get a chaos pipeline step execution - [GET /gateway/chaos/manager/api/rest/v2/chaos-pipeline/step/{experimentId}/{experimentRunId}/{stepName}](https://apidocs.harness.io/experiments/getchaospipelinestepdetails.md): Get a chaos pipeline step execution ### Get a chaos pipeline execution - [GET /gateway/chaos/manager/api/rest/v2/chaos-pipeline/{experimentId}](https://apidocs.harness.io/experiments/getchaospipelineexecution.md): Get a chaos pipeline execution ### List chaos v2 experiments - [GET /gateway/chaos/manager/api/rest/v2/experiment](https://apidocs.harness.io/experiments/listchaosv2experiment.md): List chaos v2 experiments ### Save a chaos v2 experiment - [POST /gateway/chaos/manager/api/rest/v2/experiment](https://apidocs.harness.io/experiments/savechaosv2experiment.md): Save a chaos v2 experiment ### Download experiment runs as CSV - [POST /gateway/chaos/manager/api/rest/v2/experiment-runs/csv](https://apidocs.harness.io/experiments/getexperimentrunscsv.md): Download experiment runs as CSV (no request body; only path + query params) ### Create pipeline to run experiments in bulk - [POST /gateway/chaos/manager/api/rest/v2/experiment/bulk/run](https://apidocs.harness.io/experiments/createchaosexperimentpipeline.md): Create pipeline to run experiments in bulk ### Update a chaos v2 cron experiment - [POST /gateway/chaos/manager/api/rest/v2/experiment/cron](https://apidocs.harness.io/experiments/updatechaosv2cronexperiment.md): Update a chaos v2 cron experiment ### Delete a chaos v2 experiment - [DELETE /gateway/chaos/manager/api/rest/v2/experiment/{experimentId}](https://apidocs.harness.io/experiments/deletechaosv2experiment.md): Delete a chaos v2 experiment ### Stop a chaos v2 experiment - [POST /gateway/chaos/manager/api/rest/v2/experiment/{experimentId}/stop](https://apidocs.harness.io/experiments/stopchaosv2experiment.md): Stop a chaos v2 experiment ### List experiments - [POST /gateway/chaos/manager/api/rest/v2/experiments](https://apidocs.harness.io/experiments/listexperiments.md): List experiments with filtering, sorting and pagination ### Get a chaos v2 experiment timeline run - [GET /gateway/chaos/manager/api/rest/v2/experiments/timeline/run/{experimentId}](https://apidocs.harness.io/experiments/getexperimentruntimelineview.md): Get a chaos v2 experiment timeline run ### Get a chaos v2 experiment - [GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}](https://apidocs.harness.io/experiments/getchaosv2experiment.md): Get a chaos v2 experiment ### Get the list of input sets in an experiment - [GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets](https://apidocs.harness.io/experiments/listinputset1.md): Get the list of input sets in an experiment ### Create an input set - [POST /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets](https://apidocs.harness.io/experiments/createinputset.md): Create an input set ### Get the input set in an experiment - [GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}](https://apidocs.harness.io/experiments/getinputset1.md): Get the input set in an experiment ### Update an input set - [PUT /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}](https://apidocs.harness.io/experiments/updateinputset.md): Update an input set ### Delete an input set - [DELETE /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId}](https://apidocs.harness.io/experiments/deleteinputset1.md): Delete an input set ### Get a chaos v2 experiment run - [GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run](https://apidocs.harness.io/experiments/getchaosv2experimentrun.md): Get a chaos v2 experiment run ### Run a chaos v2 experiment - [POST /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run](https://apidocs.harness.io/experiments/runchaosv2experiment.md): Run a chaos v2 experiment ### Get a chaos v2 experiment - [GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/variables](https://apidocs.harness.io/experiments/getchaosv2experimentvariables.md): Get a chaos v2 experiment ### Update a resource note - [PATCH /gateway/chaos/manager/api/rest/v2/note](https://apidocs.harness.io/experiments/updatenote.md): Update a resource note ### Get a chaos resource Note - [GET /gateway/chaos/manager/api/rest/v2/notes](https://apidocs.harness.io/experiments/getnote.md): Get a chaos resource Note ### Add a resource note - [POST /gateway/chaos/manager/api/rest/v2/notes](https://apidocs.harness.io/experiments/addnote.md): Add a resource note ### List the experiment runs for a pipeline execution - [POST /gateway/chaos/manager/api/rest/v2/pipeline/experiment/runs](https://apidocs.harness.io/experiments/getchaosexperimentrunsforpipeline.md): List the experiment runs for a pipeline execution ### Verify the chaos stage in pipeline run - [GET /gateway/chaos/manager/api/rest/v2/pipeline/verify/runs](https://apidocs.harness.io/experiments/verifychaosstageinpipelinerun.md): Verify the chaos stage in pipeline run ### List chaos experiments with active infrastructures in minimal format for notification service - [GET /gateway/chaos/manager/api/v1/notification-experiments](https://apidocs.harness.io/experiments/listexperimentswithactiveinfrasminimalnotification.md): List all experiments with active infrastructures in minimal format for notification service ### Generate and return beta1 chaos experiment run report - [GET /gateway/chaos/manager/api/v3/chaos-experiment-run/report/{experimentId}/{chaosExperimentRunId}](https://apidocs.harness.io/experiments/getchaosexperimentrunreportpdf.md): Generate and return beta1 chaos experiment run report ### List experiment metadata - [POST /gateway/chaos/manager/api/v3/experiments/list-metadata](https://apidocs.harness.io/experiments/listexperimentmetadata.md): List experiment metadata ### Get experiment or template inputs - [GET /gateway/chaos/manager/api/v3/integrations/get-experiment-or-template-variable](https://apidocs.harness.io/experiments/getexperimentortemplatevariable.md): Get experiment or template inputs ### List experiment or template metadata - [GET /gateway/chaos/manager/api/v3/integrations/list-experiment-or-template](https://apidocs.harness.io/experiments/listexperimentortemplate.md): List experiment or template metadata ## Experiment Templates ### List all the experiment templates in a hub - [GET /gateway/chaos/manager/api/rest/experimenttemplates](https://apidocs.harness.io/experiment-templates/listexperimenttemplate.md): List all the experiment templates in a hub based on tag ### Create experiment templates in a hub - [POST /gateway/chaos/manager/api/rest/experimenttemplates](https://apidocs.harness.io/experiment-templates/createexperimenttemplate.md): Create experiment templates in a hub based on tag ### List all the experiment templates in a hub - [GET /gateway/chaos/manager/api/rest/experimenttemplates/{identity}](https://apidocs.harness.io/experiment-templates/getexperimenttemplate.md): List all the experiment templates in a hub based on tag ### Update the experiment templates in a hub - [PUT /gateway/chaos/manager/api/rest/experimenttemplates/{identity}](https://apidocs.harness.io/experiment-templates/updateexperimenttemplate.md): Update the experiment templates in a hub based on tag ### Delete the experiment templates in a hub - [DELETE /gateway/chaos/manager/api/rest/experimenttemplates/{identity}](https://apidocs.harness.io/experiment-templates/deleteexperimenttemplate.md): Delete the experiment templates in a hub based on tag ### Get the difference between 2 revisions of an experiment template - [GET /gateway/chaos/manager/api/rest/experimenttemplates/{identity}/compare](https://apidocs.harness.io/experiment-templates/compareexperimenttemplaterevisions.md): Get the difference between 2 revisions of an experiment template in a hub ### Create experiment from an experiment template - [POST /gateway/chaos/manager/api/rest/experimenttemplates/{identity}/launch](https://apidocs.harness.io/experiment-templates/createexperimentfromtemplate.md): Create experiment from an experiment template ### List all the revision of an experiment template in a hub - [GET /gateway/chaos/manager/api/rest/experimenttemplates/{identity}/revisions](https://apidocs.harness.io/experiment-templates/getexperimenttemplaterevisions.md): List all the revision of an experiment template in a hub ### Get the list of inputs in an experiment template - [GET /gateway/chaos/manager/api/rest/experimenttemplates/{identity}/variables](https://apidocs.harness.io/experiment-templates/getexperimenttemplatevariables.md): Get the list of inputs in an experiment template based on revision ### Get experiment template yaml - [GET /gateway/chaos/manager/api/rest/experimenttemplates/{identity}/yaml](https://apidocs.harness.io/experiment-templates/getexperimenttemplateyaml.md): Get experiment template yaml based on revision ## Faults ### List faults in a project - [GET /gateway/chaos/manager/api/rest/faults](https://apidocs.harness.io/faults/listfaultv2.md): List faults in a project ### Create fault - [POST /gateway/chaos/manager/api/rest/faults](https://apidocs.harness.io/faults/createfault.md): Create fault ### Get fault from project - [GET /gateway/chaos/manager/api/rest/faults/{identity}](https://apidocs.harness.io/faults/getfault.md): Get fault from project ### List experiment runs of a fault in a project - [GET /gateway/chaos/manager/api/rest/faults/{identity}/experimentruns](https://apidocs.harness.io/faults/listexperimentrunsoffault.md): List experiment runs of a fault in a project ### Get the list of inputs in a fault - [GET /gateway/chaos/manager/api/rest/faults/{identity}/variables](https://apidocs.harness.io/faults/getfaultvariables.md): Get the list of inputs in a fault ### Get the yaml of a fault - [GET /gateway/chaos/manager/api/rest/faults/{identity}/yaml](https://apidocs.harness.io/faults/getfaultyaml.md): Get the yaml of a fault ### List faults in a chaos hub - [GET /gateway/chaos/manager/api/rest/hubs/faults](https://apidocs.harness.io/faults/listfault.md): List faults in a chaos hub based on given filters ### List fault metadata - [POST /gateway/chaos/manager/api/v3/faults/list-metadata](https://apidocs.harness.io/faults/listfaultmetadata.md): List fault metadata ## Fault Templates ### Update the fault templates in a hub - [PUT /gateway/chaos/manager/api/rest/faults/{identity}](https://apidocs.harness.io/fault-templates/updatefault.md): Update the fault templates in a hub based on tag ### Delete the fault templates in a hub - [DELETE /gateway/chaos/manager/api/rest/faults/{identity}](https://apidocs.harness.io/fault-templates/deletefault.md): Delete the fault templates in a hub based on tag ### List all the fault templates in a hub - [GET /gateway/chaos/manager/api/rest/faulttemplates](https://apidocs.harness.io/fault-templates/listfaulttemplate.md): List all the fault templates in a hub based on tag ### Create fault templates in a hub - [POST /gateway/chaos/manager/api/rest/faulttemplates](https://apidocs.harness.io/fault-templates/createfaulttemplate.md): Create fault templates in a hub based on tag ### List all the fault templates in a hub - [GET /gateway/chaos/manager/api/rest/faulttemplates/{identity}](https://apidocs.harness.io/fault-templates/getfaulttemplate.md): List all the fault templates in a hub based on tag ### Update the fault templates in a hub - [PUT /gateway/chaos/manager/api/rest/faulttemplates/{identity}](https://apidocs.harness.io/fault-templates/updatefaulttemplate.md): Update the fault templates in a hub based on tag ### Delete the fault templates in a hub - [DELETE /gateway/chaos/manager/api/rest/faulttemplates/{identity}](https://apidocs.harness.io/fault-templates/deletefaulttemplate.md): Delete the fault templates in a hub based on tag ### Get the difference between 2 revisions of a fault template - [GET /gateway/chaos/manager/api/rest/faulttemplates/{identity}/compare](https://apidocs.harness.io/fault-templates/comparefaulttemplaterevisions.md): Get the difference between 2 revisions of a fault template in a hub ### List all the revision of a fault template in a hub - [GET /gateway/chaos/manager/api/rest/faulttemplates/{identity}/revisions](https://apidocs.harness.io/fault-templates/getfaulttemplaterevisions.md): List all the revision of a fault template in a hub ### Get the list of inputs in a fault template - [GET /gateway/chaos/manager/api/rest/faulttemplates/{identity}/variables](https://apidocs.harness.io/fault-templates/getfaulttemplatevariables.md): Get the list of inputs in a fault template based on revision ### Get a fault template yaml - [GET /gateway/chaos/manager/api/rest/faulttemplates/{identity}/yaml](https://apidocs.harness.io/fault-templates/getfaulttemplateyaml.md): Get a fault template yaml based on revision ## Chaos Infrastructure ### Get image registry - [GET /gateway/chaos/manager/api/rest/imageRegistry](https://apidocs.harness.io/chaos-infrastructure/getimageregistry.md): Get image registry ### Register a new legacy kubernetes chaos infra - [POST /gateway/chaos/manager/api/rest/kubernetes/infra](https://apidocs.harness.io/chaos-infrastructure/registerlegacykubernetesinfra.md): Register a new legacy kubernetes chaos infra ### Get legacy kubernetes helm infra command - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/helm-command/{id}](https://apidocs.harness.io/chaos-infrastructure/getlegacykuberneteshelminfracommand.md): Test legacy kubernetes helm infra command ### Get legacy kubernetes chaos infrastructure manifest - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/manifest/{id}](https://apidocs.harness.io/chaos-infrastructure/getlegacykuberneteschaosinframanifest.md): Get legacy kubernetes chaos infrastructure manifest ### Get legacy kubernetes chaos infra stats - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/stats](https://apidocs.harness.io/chaos-infrastructure/getlegacykuberneteschaosinfrastats.md): Get legacy kubernetes chaos infra stats ### Upgrade legacy kubernetes chaos infrastructure - [POST /gateway/chaos/manager/api/rest/kubernetes/infra/upgrade/{id}](https://apidocs.harness.io/chaos-infrastructure/upgradelegacykuberneteschaosinfra.md): Upgrade legacy kubernetes chaos infrastructure ### Get legacy kubernetes chaos infrastructure version details - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/version](https://apidocs.harness.io/chaos-infrastructure/getlegacykuberneteschaosinfraversiondetails.md): Get legacy kubernetes chaos infrastructure version details ### Get legacy kubernetes chaos infrastructure details - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/getlegacykuberneteschaosinfradetails.md): Get legacy kubernetes chaos infrastructure details ### Update legacy kubernetes chaos infras - [PUT /gateway/chaos/manager/api/rest/kubernetes/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/updatelegacykuberneteschaosinfra.md): Update legacy kubernetes chaos infras ### Delete a legacy kubernetes chaos infra - [DELETE /gateway/chaos/manager/api/rest/kubernetes/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/deletelegacykuberneteschaosinfra.md): Delete a legacy kubernetes chaos infra ### Test legacy kubernetes chaos infrastructure connection - [GET /gateway/chaos/manager/api/rest/kubernetes/infra/health/{id}](https://apidocs.harness.io/chaos-infrastructure/testlegacykuberneteschaosinfraconnection.md): Test legacy kubernetes chaos infrastructure connection ### List legacy kubernetes chaos infras - [POST /gateway/chaos/manager/api/rest/kubernetes/infras](https://apidocs.harness.io/chaos-infrastructure/listlegacykuberneteschaosinfra.md): List legacy kubernetes chaos infras ### Register a new machine chaos infra - [POST /gateway/chaos/manager/api/rest/machine/infra](https://apidocs.harness.io/chaos-infrastructure/registermachineinfra.md): Register a new machine chaos infra ### Get machine chaos infrastructure version details - [GET /gateway/chaos/manager/api/rest/machine/infra/version](https://apidocs.harness.io/chaos-infrastructure/getmachinechaosinfraversiondetails.md): Get machine chaos infrastructure version details ### Get machine chaos infrastructure details - [GET /gateway/chaos/manager/api/rest/machine/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/getmachinechaosinfradetails.md): Get machine chaos infrastructure details ### Update the machine chaos infra - [PUT /gateway/chaos/manager/api/rest/machine/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/updatemachineinfra.md): Update the machine chaos infra ### Delete a machine chaos infra - [DELETE /gateway/chaos/manager/api/rest/machine/infra/{id}](https://apidocs.harness.io/chaos-infrastructure/deletemachinechaosinfra.md): Delete a machine chaos infra ### List machine chaos infras - [POST /gateway/chaos/manager/api/rest/machine/infras](https://apidocs.harness.io/chaos-infrastructure/listmachinechaosinfra.md): List machine chaos infras ### Get resource usage - [GET /gateway/chaos/manager/api/rest/usage](https://apidocs.harness.io/chaos-infrastructure/getresourceusage.md): Get resource usage ### List harness infras - [GET /gateway/chaos/manager/api/rest/v2/harness-infrastructures](https://apidocs.harness.io/chaos-infrastructure/listharnessinfra.md): List harness infras ### Update a v2 infra - [PUT /gateway/chaos/manager/api/rest/v2/infrastructure](https://apidocs.harness.io/chaos-infrastructure/updateinfrav2.md): Update a v2 infra ### Register a new v2 infra - [POST /gateway/chaos/manager/api/rest/v2/infrastructure](https://apidocs.harness.io/chaos-infrastructure/registerinfrav2.md): Register a new v2 infra ### Preview v2 infra Yaml - [POST /gateway/chaos/manager/api/rest/v2/infrastructure/yaml](https://apidocs.harness.io/chaos-infrastructure/getv2infrastructureyaml.md): Preview v2 infra Yaml ### Delete a v2 infra - [DELETE /gateway/chaos/manager/api/rest/v2/infrastructure/{environmentIdentifier}/{identity}](https://apidocs.harness.io/chaos-infrastructure/deleteinfrav2.md): Delete a new v2 infra ### Get v2 infra details - [GET /gateway/chaos/manager/api/rest/v2/infrastructure/{identity}](https://apidocs.harness.io/chaos-infrastructure/getinfrav2.md): Get v2 infra details ### Get Connector For Infra - [GET /gateway/chaos/manager/api/rest/v2/infrastructure/{identity}/connector](https://apidocs.harness.io/chaos-infrastructure/getconnectorforinfra.md): Get Connector For Infra ### List v2 infras - [POST /gateway/chaos/manager/api/rest/v2/infrastructures](https://apidocs.harness.io/chaos-infrastructure/listinfrav2.md): List v2 infras ### List v2 infras - [POST /gateway/chaos/manager/api/rest/v2/infrastructures/chaos-enabled](https://apidocs.harness.io/chaos-infrastructure/listchaosenabledinfrav2.md): List v2 infras ### List all applications for a given infra - [GET /gateway/chaos/manager/api/rest/v2/infrastructures/{infrastructureIdentity}/applications](https://apidocs.harness.io/chaos-infrastructure/listapplication.md): List all applications for a given infra ### List instrumented functions for given application - [GET /gateway/chaos/manager/api/rest/v2/infrastructures/{infrastructureIdentity}/applications/{applicationIdentity}/functions](https://apidocs.harness.io/chaos-infrastructure/listfunction.md): List instrumented functions for given application ### Get a v2 infra token - [GET /gateway/chaos/manager/api/rest/v2/infrastructures/{infrastructureIdentity}/token](https://apidocs.harness.io/chaos-infrastructure/getinfratoken.md): Get a v2 infra token ### Update emissary endpoint - [POST /gateway/chaos/manager/api/rest/v2/infrastructures/{infrastructureIdentity}/updateemissary](https://apidocs.harness.io/chaos-infrastructure/updateemissary.md): Update emissary endpoint ## Health ### Health check - [GET /gateway/chaos/manager/api/v3/health](https://apidocs.harness.io/health/healthcheckv3.md): Health check ### Get experiment helper image version - [GET /gateway/chaos/manager/api/experimentHelperImageVersion](https://apidocs.harness.io/health/getexperimenthelperimageversion.md): Get experiment helper image version ## Network Maps ### List target network maps with chaos context - [POST /gateway/chaos/manager/api/rest/v2/applicationmaps](https://apidocs.harness.io/network-maps/listtargetnetworkmaps.md): List target network maps with chaos context ### Get target network map with chaos context - [GET /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}](https://apidocs.harness.io/network-maps/gettargetnetworkmap.md): Get target network map with chaos context ### Delete application network map with chaos context - [DELETE /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}](https://apidocs.harness.io/network-maps/deletetargetnetworkmap.md): Delete application network map with chaos context ### Can retry or not chaos experiment creation for the given target network map - [GET /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}/canretry](https://apidocs.harness.io/network-maps/canretryexperimentcreation.md): Can retry or not chaos experiment creation for the given target network map ### Retry chaos experiment creation for the given target network map - [POST /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}/retry](https://apidocs.harness.io/network-maps/retryexperimentcreation.md): Retry chaos experiment creation for the given target network map ### List target discovered service with chaos context - [GET /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}/targetservices](https://apidocs.harness.io/network-maps/listservice.md): Get target discovered service with chaos context ### Get target discovered service with chaos context - [GET /gateway/chaos/manager/api/rest/v2/applicationmaps/{applicationmapid}/targetservices/{targetserviceid}](https://apidocs.harness.io/network-maps/getserviceresponse.md): Get target discovered service with chaos context ## Onboarding ### List pipeline onboarding - [GET /gateway/chaos/manager/api/rest/pipeline-onboarding](https://apidocs.harness.io/onboarding/listpipelineonboarding.md): List pipeline onboarding ### Onboard a pipeline to chaos - [POST /gateway/chaos/manager/api/rest/pipeline-onboarding](https://apidocs.harness.io/onboarding/pipelineonboardchaos.md): Onboard a pipeline to chaos ### Delete pipeline onboarding entry - [DELETE /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}](https://apidocs.harness.io/onboarding/deletepipelineonboarding.md): Delete pipeline onboarding entry ### Check if a pipeline can be onboarded or not - [GET /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/can-onboard-chaos](https://apidocs.harness.io/onboarding/pipelinecanonboardchaos.md): Check if a pipeline can be onboarded or not ### Check chaos onboarding status for the pipeline - [GET /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/status](https://apidocs.harness.io/onboarding/pipelineonboardchaosstatus.md): Check chaos onboarding status for the pipeline ### Get V2 Onboarding - [GET /gateway/chaos/manager/api/rest/v2/onboarding](https://apidocs.harness.io/onboarding/listv2onboarding.md): Get V2 Onboarding ### Create V2 Onboarding - [POST /gateway/chaos/manager/api/rest/v2/onboarding](https://apidocs.harness.io/onboarding/createv2onboarding.md): Create V2 Onboarding ### Confirm discovery step in manual onboarding - [POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-discovery/{onboardingid}](https://apidocs.harness.io/onboarding/onboardingconfirmdiscovery.md): Confirm discovery step in manual onboarding ### Confirm experiment creation step in manual onboarding - [POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-creation/{onboardingid}](https://apidocs.harness.io/onboarding/onboardingconfirmexperimentcreation.md): Confirm experiment creation step in manual onboarding ### Confirm experiment run step in manual onboarding - [POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-run/{onboardingid}](https://apidocs.harness.io/onboarding/onboardingconfirmexperimentrun.md): Confirm experiment run step in manual onboarding ### Confirm network map creation step in manual onboarding - [POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-networkmap/{onboardingid}](https://apidocs.harness.io/onboarding/onboardingconfirmnetworkmap.md): Confirm network map creation step in manual onboarding ### Get V2 Onboarding - [GET /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}](https://apidocs.harness.io/onboarding/getv2onboarding.md): Get V2 Onboarding ### Get V2 Onboarding experiments - [GET /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/experiments](https://apidocs.harness.io/onboarding/getonboardingexperiments.md): Get V2 Onboarding experiments ### Stop V2 Onboarding experiments - [POST /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/stop](https://apidocs.harness.io/onboarding/stoponboardingexperiments.md): Stop V2 Onboarding experiments ## Probes ### List probes with filtering options - [GET /gateway/chaos/manager/api/rest/v2/probes](https://apidocs.harness.io/probes/listprobes.md): Retrieve a list of probes based on various filters like name, tags, date range, and infrastructure type, with pagination support. ### Create a new probe - [POST /gateway/chaos/manager/api/rest/v2/probes](https://apidocs.harness.io/probes/createprobe.md): Create a new probe ### Get probes in experiment - [POST /gateway/chaos/manager/api/rest/v2/probes/experiment-run](https://apidocs.harness.io/probes/getprobesinexperiment.md): Get probes in experiment ### Import a new probe - [POST /gateway/chaos/manager/api/rest/v2/probes/import](https://apidocs.harness.io/probes/importprobe.md): Import a new probe ### Get a probe - [GET /gateway/chaos/manager/api/rest/v2/probes/manifest/{probeId}](https://apidocs.harness.io/probes/getprobemanifest.md): Retrieve probe manifest of a specific probe by its ID ### Get a probe - [GET /gateway/chaos/manager/api/rest/v2/probes/{probeId}](https://apidocs.harness.io/probes/getprobe.md): Retrieve details of a specific probe by its ID ### Update a probe - [PUT /gateway/chaos/manager/api/rest/v2/probes/{probeId}](https://apidocs.harness.io/probes/updateprobe.md): Update a probe with the specified configuration ### Delete a probe - [DELETE /gateway/chaos/manager/api/rest/v2/probes/{probeId}](https://apidocs.harness.io/probes/deleteprobe.md): Delete a probe with a provided identifier ### Enable and disable probes across experiments - [POST /gateway/chaos/manager/api/rest/v2/probes/enable/{probeId}](https://apidocs.harness.io/probes/enableprobe.md): Enable and disable probes across experiments ### Verify a probe - [POST /gateway/chaos/manager/api/rest/v2/probes/verify/{probeId}](https://apidocs.harness.io/probes/verifyprobe.md): Verify a probe ### List probe metadata - [POST /gateway/chaos/manager/api/v3/probes/list-metadata](https://apidocs.harness.io/probes/listprobemetadata.md): List probe metadata ## Probe Templates ### List all the probe templates in a hub - [GET /gateway/chaos/manager/api/rest/templates/probes](https://apidocs.harness.io/probe-templates/listprobetemplate.md): List all the probe templates in a hub based on tag ### Create the probe templates in a hub - [POST /gateway/chaos/manager/api/rest/templates/probes](https://apidocs.harness.io/probe-templates/createprobetemplate.md): Create probe templates in a hub based on tag ### Get the probe template in a hub - [GET /gateway/chaos/manager/api/rest/templates/probes/{identity}](https://apidocs.harness.io/probe-templates/getprobetemplate.md): Get the probe template in a hub based on probe ref ### Update the probe templates in a hub - [PUT /gateway/chaos/manager/api/rest/templates/probes/{identity}](https://apidocs.harness.io/probe-templates/updateprobetemplate.md): Update an existing probe template in a hub with new configuration ### Delete probe template - [DELETE /gateway/chaos/manager/api/rest/templates/probes/{identity}](https://apidocs.harness.io/probe-templates/deleteprobetemplate.md) ### Get the list of inputs in a probe template - [GET /gateway/chaos/manager/api/rest/templates/probes/{identity}/variables](https://apidocs.harness.io/probe-templates/listvariablesinprobetemplate.md): Get the list of inputs in a probe template based on revision ## Chaos Recommendations ### Get recommendation details - [GET /gateway/chaos/manager/api/rest/recommendations](https://apidocs.harness.io/chaos-recommendations/getrecommendation.md): Get recommendation details based on the recommendation id ### List recommendations - [POST /gateway/chaos/manager/api/rest/recommendations](https://apidocs.harness.io/chaos-recommendations/listrecommendations1.md): List recommendations based on the filters ### Delete recommendation - [DELETE /gateway/chaos/manager/api/rest/recommendations](https://apidocs.harness.io/chaos-recommendations/deleterecommendation.md): Delete recommendation based on the recommendation id ### Create new experiment - [POST /gateway/chaos/manager/api/rest/recommendations/action/create](https://apidocs.harness.io/chaos-recommendations/createrecommendation.md): Create new experiment based on the recommendation ### Add recommended experiment to pipeline - [POST /gateway/chaos/manager/api/rest/recommendations/action/pipeline](https://apidocs.harness.io/chaos-recommendations/pipelineaddexperimentrecommendation.md): Add recommended experiment to pipeline ### Run the recommended experiment - [POST /gateway/chaos/manager/api/rest/recommendations/action/run](https://apidocs.harness.io/chaos-recommendations/runrecommendation.md): Run the recommended experiment ### Update the recommendation status - [PUT /gateway/chaos/manager/api/rest/recommendations/status](https://apidocs.harness.io/chaos-recommendations/updaterecommendationstatus.md): Update the recommendation status ### Bulk update the recommendation status - [POST /gateway/chaos/manager/api/rest/recommendations/status](https://apidocs.harness.io/chaos-recommendations/bulkupdaterecommendationstatus.md): Bulk update the recommendation status ## Risks ### Generate experimentation activity report - [GET /gateway/chaos/manager/api/rest/service/experimentation/report/{accountID}](https://apidocs.harness.io/risks/getexperimentationactivityreport.md): Generate experimentation activity report for account in a given timeframe ### Get the overall service usage stats by type related to requested account - [GET /gateway/chaos/manager/api/rest/service/overall/stats/{accountID}](https://apidocs.harness.io/risks/getoverallserviceusagestats.md): Get overall service usage stats by type for account ### Generate service usage report - [GET /gateway/chaos/manager/api/rest/service/report/{accountID}](https://apidocs.harness.io/risks/getserviceusagereport.md): Generate service usage report for account in a given timeframe ### Get the service usage stats related to requested account grouped by day or month - [GET /gateway/chaos/manager/api/rest/service/stats/{accountID}](https://apidocs.harness.io/risks/getaccountserviceusagestats.md): Get service usage stats for account ### Get service usage details for account in the requested time frame - [GET /gateway/chaos/manager/api/rest/service/{accountID}](https://apidocs.harness.io/risks/getaccountservicedetails.md): Get service details for account ### List risks - [GET /gateway/chaos/manager/api/v3/risks](https://apidocs.harness.io/risks/listrisks.md): List risks ### Create a risk - [POST /gateway/chaos/manager/api/v3/risks](https://apidocs.harness.io/risks/createrisk.md): Create a risk ### Get a risk by identity - [GET /gateway/chaos/manager/api/v3/risks/{identity}](https://apidocs.harness.io/risks/getrisk.md): Get a risk by identity ### Update a risk - [PUT /gateway/chaos/manager/api/v3/risks/{identity}](https://apidocs.harness.io/risks/updaterisk.md): Update a risk ### Delete a risk - [DELETE /gateway/chaos/manager/api/v3/risks/{identity}](https://apidocs.harness.io/risks/deleterisk.md): Delete a risk ### List probe executions - [GET /gateway/chaos/manager/api/v3/risks/{identity}/active-risks](https://apidocs.harness.io/risks/listprobeexecutions.md): List probe executions for a given risk identity