dashboard

Get deployment health

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/deploymentHealth
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/deploymentHealth?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get list of buildId and instances

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
envId
required
string
buildIds
required
Array of strings
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getInstancesByServiceEnvAndBuilds
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getInstancesByServiceEnvAndBuilds?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string&envId=string&buildIds=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get active service instance count breakdown by env type

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
Array of strings
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getInstanceCountDetailsByService
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getInstanceCountDetailsByService?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get instance count history

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getInstanceCountHistory
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getInstanceCountHistory?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get deployments by serviceId

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getDeploymentsByServiceId
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getDeploymentsByServiceId?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get service header info

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getServiceHeaderInfo
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getServiceHeaderInfo?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get service deployment

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
serviceId
string
bucketSizeInDays
integer <int64>
Default: 1
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/serviceDeployments
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/serviceDeployments?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0&serviceId=string&bucketSizeInDays=1' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get service deployments info

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
serviceId
string
bucketSizeInDays
integer <int64>
Default: 1
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/serviceDeploymentsInfo
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/serviceDeploymentsInfo?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0&serviceId=string&bucketSizeInDays=1' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get deployment execution

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/deploymentExecution
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/deploymentExecution?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get deployments

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
top
integer <int64>
Default: 20
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getDeployments
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getDeployments?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&top=20' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get list of unique environment and build ids with instance count

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getEnvBuildInstanceCountByService
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getEnvBuildInstanceCountByService?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get service details list

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/serviceDetails
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/serviceDetails?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get service growth trend

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
timeGroupByType
required
string
Enum: "HOUR" "DAY" "WEEK"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getServicesGrowthTrend
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getServicesGrowthTrend?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0&timeGroupByType=HOUR' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get active service instance summary

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
timestamp
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getActiveServiceInstanceSummary
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getActiveServiceInstanceSummary?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string&timestamp=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get instance growth trend

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
serviceId
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getInstanceGrowthTrend
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getInstanceGrowthTrend?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&serviceId=string&startTime=0&endTime=0' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Get workloads

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
environmentType
string
Enum: "PreProduction" "Production"
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/ng/api/dashboard/getWorkloads
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/ng/api/dashboard/getWorkloads?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&startTime=0&endTime=0&environmentType=PreProduction' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}