Harness Risks API
The Risks API from Harness — 8 operation(s) for risks.
Operations 11
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
The Risks API from Harness — 8 operation(s) for risks.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/harness:harness-risks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Harness Risks API
version: '1.0'
description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
contact:
name: API Support
email: contact@harness.io
url: https://harness.io/
x-logo:
url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
altText: Harness
termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
description: Harness host URL
- url: https://{vanity}
description: Vanity URL
variables:
vanity:
default: app.harness.io
security:
- x-api-key: []
tags:
- name: Risks
paths:
/gateway/chaos/manager/api/rest/service/experimentation/report/{accountID}:
get:
description: Generate experimentation activity report for account in a given timeframe
summary: Generate experimentation activity report
operationId: getExperimentationActivityReport
parameters:
- description: ID of the account
name: accountID
in: path
required: true
schema:
type: string
- description: start time in unix format in milliseconds
name: startTime
in: query
required: true
schema:
type: integer
- description: end time in unix format in milliseconds
name: endTime
in: query
required: true
schema:
type: integer
- description: true for cumulative stats
name: cumulate
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: array
items:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/shared.Error'
'500':
description: Internal Server Error
tags:
- Risks
/gateway/chaos/manager/api/rest/service/overall/stats/{accountID}:
get:
description: Get overall service usage stats by type for account
summary: Get the overall service usage stats by type related to requested account
operationId: getOverallServiceUsageStats
parameters:
- description: ID of the account
name: accountID
in: path
required: true
schema:
type: string
- description: start time in unix format in milliseconds
name: startTime
in: query
required: true
schema:
type: integer
- description: end time in unix format in milliseconds
name: endTime
in: query
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/chaosserviceusage.OverallServiceUsageStats'
'400':
description: Bad Request
'404':
description: Not Found
'500':
description: Internal Server Error
tags:
- Risks
/gateway/chaos/manager/api/rest/service/report/{accountID}:
get:
description: Generate service usage report for account in a given timeframe
summary: Generate service usage report
operationId: getServiceUsageReport
parameters:
- description: ID of the account
name: accountID
in: path
required: true
schema:
type: string
- description: start time in unix format in milliseconds
name: startTime
in: query
required: true
schema:
type: integer
- description: end time in unix format in milliseconds
name: endTime
in: query
required: true
schema:
type: integer
- description: true for cumulative stats
name: cumulate
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: array
items:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/shared.Error'
'500':
description: Internal Server Error
tags:
- Risks
/gateway/chaos/manager/api/rest/service/stats/{accountID}:
get:
description: Get service usage stats for account
summary: Get the service usage stats related to requested account grouped by day or month
operationId: getAccountServiceUsageStats
parameters:
- description: ID of the account
name: accountID
in: path
required: true
schema:
type: string
- description: group by period (day/month)
name: groupBy
in: query
required: true
schema:
type: string
- description: start time in unix format in milliseconds
name: startTime
in: query
required: true
schema:
type: integer
- description: end time in unix format in milliseconds
name: endTime
in: query
required: true
schema:
type: integer
- description: true for cumulative stats
name: cumulative
in: query
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/chaosserviceusage.UsageStats'
'400':
description: Bad Request
'404':
description: Not Found
'500':
description: Internal Server Error
tags:
- Risks
/gateway/chaos/manager/api/rest/service/{accountID}:
get:
description: Get service details for account
summary: Get service usage details for account in the requested time frame
operationId: getAccountServiceDetails
parameters:
- description: ID of the account
name: accountID
in: path
required: true
schema:
type: string
- description: page number
name: page
in: query
required: true
schema:
type: integer
default: 0
- description: limit per page
name: limit
in: query
required: true
schema:
type: integer
default: 10
- description: start time in unix format in milliseconds
name: startTime
in: query
required: true
schema:
type: integer
- description: end time in unix format in milliseconds
name: endTime
in: query
required: true
schema:
type: integer
- description: search based on service name
name: service
in: query
schema:
type: string
- description: search based on service type
name: serviceType
in: query
schema:
type: string
- description: sort the response in ascending order
name: sortAscending
in: query
schema:
type: boolean
default: false
- description: 'sort the response w.r.t field: faultsRan, experiments, experimentsRan'
name: sortField
in: query
schema:
type: string
enum:
- experimentsRan
- experiments
- faultsRan
default: faultsRan
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/chaosserviceusage.ServiceDataResponse'
'400':
description: Bad Request
'404':
description: Not Found
'500':
description: Internal Server Error
tags:
- Risks
/gateway/chaos/manager/api/v3/risks:
get:
tags:
- Risks
summary: List risks
operationId: listRisks
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- name: category
in: query
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- name: includeAllScope
in: query
schema:
type: boolean
- x-enum-varnames:
- InfrastructureTypeKubernetes
- InfrastructureTypeKubernetesV2
- InfrastructureTypeWindows
- InfrastructureTypeLinux
- InfrastructureTypeCloudFoundry
- InfrastructureTypeContainer
name: infrastructure
in: query
schema:
type: string
enum:
- Kubernetes
- KubernetesV2
- Windows
- Linux
- CloudFoundry
- Container
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 15
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
default: 0
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
- name: resourceIdentifiers
in: query
style: form
explode: false
schema:
type: array
items:
type: string
- description: name that you want to search
name: search
in: query
schema:
type: string
- description: if sort order ascending or not
name: sortAscending
in: query
schema:
type: boolean
- description: field name that you want to sort
name: sortField
in: query
schema:
type: string
enum:
- name
- lastUpdated
- experimentName
- name: tags
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.ListRiskResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
post:
tags:
- Risks
summary: Create a risk
operationId: createRisk
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/risks.CreateRequest'
description: create risk request
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.Risk'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
/gateway/chaos/manager/api/v3/risks/{identity}:
get:
tags:
- Risks
summary: Get a risk by identity
operationId: getRisk
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
- description: The identifier for the risk
name: identity
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.RiskResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
put:
tags:
- Risks
summary: Update a risk
operationId: updateRisk
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
- description: The identifier for the risk
name: identity
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/risks.UpdateRequest'
description: update risk request
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.Risk'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
delete:
tags:
- Risks
summary: Delete a risk
operationId: deleteRisk
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
- description: The identifier for the risk
name: identity
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.DeleteResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
/gateway/chaos/manager/api/v3/risks/{identity}/active-risks:
get:
description: List probe executions for a given risk identity
tags:
- Risks
summary: List probe executions
operationId: listProbeExecutions
parameters:
- description: account id to access the resource
name: accountIdentifier
in: query
required: true
schema:
type: string
- description: correlation id is used to debug micro svc communication
name: correlationID
in: query
schema:
type: string
- name: endTime
in: query
schema:
type: integer
- name: includeAllScope
in: query
schema:
type: boolean
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
default: 15
- description: organization id to access the resource
name: organizationIdentifier
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
default: 0
- description: project id to access the resource
name: projectIdentifier
in: query
schema:
type: string
- description: name that you want to search
name: search
in: query
schema:
type: string
- description: if sort order ascending or not
name: sortAscending
in: query
schema:
type: boolean
- description: field name that you want to sort
name: sortField
in: query
schema:
type: string
enum:
- name
- lastUpdated
- experimentName
- name: startTime
in: query
schema:
type: integer
- x-enum-varnames:
- ActiveRiskCounterTypePassedProbes
- ActiveRiskCounterTypeFailedProbes
name: status
in: query
schema:
type: string
enum:
- Passed
- Failed
- name: tags
in: query
schema:
type: string
- description: risk identity
name: identity
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/risks.ListExecutionResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/api.RestError'
components:
schemas:
risks.Risk:
type: object
required:
- accountID
- name
properties:
accountID:
type: string
activeRisk:
$ref: '#/components/schemas/risks.ActiveRiskCounter'
category:
type: string
description:
type: string
identity:
type: string
isDefault:
type: boolean
lastDetectedAt:
description: 'PassiveRiskCounter PassiveRiskCounter `bson:"passiveRisk" json:"passiveRisk"` //TODO: To be added later'
type: integer
name:
type: string
orgID:
type: string
projectID:
type: string
supportedInfra:
type: array
items:
$ref: '#/components/schemas/risks.Infrastructure'
tags:
type: array
items:
type: string
chaosserviceusage.OverallServiceUsageStats:
type: object
properties:
accountID:
type: string
licenseServiceMapping:
$ref: '#/components/schemas/chaosserviceusage.StatsByType'
serviceStats:
$ref: '#/components/schemas/chaosserviceusage.StatsByType'
totalUsage:
type: number
risks.ExecutionType:
type: string
enum:
- CHAOS_EXECUTION
- DR_EXECUTION
x-enum-varnames:
- ExecutionTypeChaosExecutionNode
- ExecutionTypeDRComponentNode
risks.ListExecutionResponse:
type: object
properties:
correlationID:
type: string
data:
type: array
items:
$ref: '#/components/schemas/risks.ActiveExecutionResponse'
pagination:
$ref: '#/components/schemas/shared.PaginationResponse'
risks.CreateRequest:
type: object
properties:
category:
type: string
description:
type: string
identity:
type: string
isDefault:
type: boolean
name:
type: string
supportedInfra:
type: array
items:
$ref: '#/components/schemas/risks.Infrastructure'
tags:
type: array
items:
type: string
chaosserviceusage.StatsByType:
type: object
properties:
Cloud Resources:
type: number
Container Services:
type: number
Kubernetes:
type: number
Linux:
type: number
Others:
type: number
Serverless:
type: number
Windows:
type: number
risks.ActiveRiskCounter:
type: object
properties:
failedProbes:
type: integer
passedProbes:
type: integer
risks.Infrastructure:
type: string
enum:
- Kubernetes
- KubernetesV2
- Windows
- Linux
- CloudFoundry
- Container
x-enum-varnames:
- InfrastructureTypeKubernetes
- InfrastructureTypeKubernetesV2
- InfrastructureTypeWindows
- InfrastructureTypeLinux
- InfrastructureTypeCloudFoundry
- InfrastructureTypeContainer
chaosserviceusage.PeriodicStats:
type: object
properties:
experimentStatsByType:
$ref: '#/components/schemas/chaosserviceusage.StatsByType'
serviceStatsByType:
$ref: '#/components/schemas/chaosserviceusage.StatsByType'
timestamp:
type: integer
totalConsumption:
type: number
totalExperimentRunsConsumption:
type: number
risks.UpdateRequest:
type: object
properties:
category:
type: string
description:
type: string
identity:
type: string
isDefault:
type: boolean
name:
type: string
supportedInfra:
type: array
items:
type: string
tags:
type: array
items:
type: string
execution.ChaosStepStatus:
type: string
enum:
- Queued
- Error
- Completed_With_Probe_Failure
- Completed_With_Probe_Absent
- Pending
- Running
- Stopped
- Completed
- Failed
- Passed
- Skipped
- Interrupted
x-enum-varnames:
- Queued
- Error
- CompletedWithProbeFailure
- CompletedWithProbeAbsent
- Pending
- Running
- Stopped
- Completed
- Failed
- Passed
- Skipped
- Interrupted
chaosserviceusage.ServiceType:
type: string
enum:
- Kubernetes
- Linux
- Windows
- Serverless
- ContainerServices
- CloudResources
- Others
x-enum-varnames:
- ServiceTypeKubernetes
- ServiceTypeLinux
- ServiceTypeWindows
- ServiceTypeServerless
- ServiceTypeContainerServices
- ServiceTypeCloudResources
- ServiceTypeOthers
risks.ActiveExecutionResponse:
type: object
properties:
duration:
type: string
executedBy:
$ref: '#/components/schemas/hcesdk.UserDetails'
executionID:
type: integer
executionType:
$ref: '#/components/schemas/risks.ExecutionType'
lastUpdatedAt:
type: integer
name:
type: string
parentIdentity:
type: string
probeID:
type: string
probeName:
type: string
runID:
type: string
startedAt:
type: integer
status:
$ref: '#/components/schemas/execution.ChaosStepStatus'
shared.PaginationResponse:
type: object
properties:
index:
type: integer
limit:
type: integer
totalItems:
type: integer
totalPages:
type: integer
api.RestError:
type: object
properties:
code:
$ref: '#/components/schemas/api.ResponseErrorCode'
description:
type: string
message:
type: string
hcesdk.UserDetails:
type: object
properties:
email:
type: string
userID:
type: string
username:
type: string
chaosserviceusage.ServiceData:
type: object
properties:
experimentRuns:
type: integer
experiments:
type: integer
faultsRan:
type: integer
infraStructure:
type: string
infraType:
$ref: '#/components/schemas/chaosserviceusage.InfrastructureType'
licenseUtilisation:
type: number
namespace:
type: string
orgID:
type: string
projectID:
type: string
resource:
type: string
service:
type: string
serviceID:
type: string
subType:
type: string
type:
$ref: '#/components/schemas/chaosserviceusage.ServiceType'
risks.RiskResponse:
type: object
required:
- accountID
- name
properties:
accountID:
type: string
activeRisk:
$ref: '#/components/schemas/risks.ActiveRiskCounter'
category:
type: string
createdBy:
$ref: '#/components/schemas/hcesdk.UserDetails'
description:
type: string
identity:
type: string
isDefault:
type: boolean
lastDetectedAt:
description: 'PassiveRiskCounter PassiveRiskCounter `bson:"passiveRisk" json:"passiveRisk"` //TODO: To be added later'
type: integer
name:
type: string
orgID:
type: string
projectID:
type: string
supportedInfra:
type: array
items:
$ref: '#/components/schemas/risks.Infrastructure'
tags:
type: array
items:
type: string
updatedBy:
$ref: '#/components/schemas/hcesdk.UserDetails'
shared.Error:
type: object
properties:
code:
type: integer
correlationID:
type: string
message:
type: string
risks.ListRiskResponse:
type: object
properties:
correlationID:
type: string
data:
type: array
items:
$ref: '#/components/schemas/risks.RiskResponse'
pagination:
$ref: '#/components/schemas/shared.PaginationResponse'
risks.DeleteResponse:
type: object
properties:
correlationID:
type: string
success:
type: boolean
chaosserviceusage.InfrastructureType:
type: string
enum:
- Kubernetes
- KubernetesV2
- Windows
- Linux
x-enum-varnames:
- InfrastructureTypeKubernetes
- InfrastructureTypeKubernetesV2
- InfrastructureTypeWindows
- InfrastructureTypeLinux
chaosserviceusage.ServiceDataResponse:
type: object
properties:
serviceData:
type: array
items:
$ref: '#/components/schemas/chaosserviceusage.ServiceData'
serviceTypes:
type: array
items:
type: string
total:
type: integer
api.ResponseErrorCode:
type: string
enum:
- PIPELINE_NOT_FOUND
x-enum-varnames:
- PipelineNotFound
chaosserviceusage.UsageStats:
type: object
properties:
accountID:
type: string
periodicStats:
type: array
items:
$ref: '#/components/schemas/chaosserviceusage.PeriodicStats'
securitySchemes:
x-api-key:
name: x-api-key
type: apiKey
in: header
description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
x-stoplight:
id: oc91t4vrfnjyi
x-tagGroups:
- name: Organizations
tags:
- Organization
- name: Projects
tags:
- Org Project
- Project
- name: Secrets
tags:
- Account Secret
- Org Secret
- Project Secret
- Secrets
- name: Connectors
tags:
- Account Connector
- Org Connector
- Project Connector
- Connectors
- GoogleSecretManagerConnector
- name: Roles
tags:
- Account Roles
- Organization Roles
- Project Roles
- Roles
- name: Resource Groups
tags:
- Account Resource Groups
- Organization Resource Groups
- Project Resource Groups
- Filter Resource Groups
- Harness Resource Group
- Zendesk
- name: Role Assignments
tags:
- Account Role Assignments
- Org Role Assignments
- Project Role Assignments
- Role Assignments
- name: Platform
tags:
- Access Control List
- Account Banner
- Account Banner
- Account Licensed Modules
- Account License Type
- Account Webhooks
- AccountSetting
- Accounts
- Analyze Account Access Policy
- Analyze Organization Access Policy
- Analyze Project Access Policy
- ApiKey
- Audit
- AuditFilters
- Authentication Settings
- Canny
- Devops Essentials License Data By Account
- EULA
- Filter
- Harness Resource Type
- Invite
- IP Allowlist
- Nextgen Ldap
- Notification Channels
- Notification Rules
- OIDC
- Oidc-Access-Token
- Oidc-ID-Token
- Org Webhooks
- Permissions
- Project Webhooks
- Secret Managers
- Service Account
- Setting
- SMTP
- Source Code Manager
- Token
- User
- User Group
- Variables
- name: Delegate
tags:
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://artifacts.apis.io/harness/openapi/harness-risks-api-openapi.yml