Harness

Usage

This contains APIs specific to CD license usage

Download CD Usage CSV report

Securityx-api-key
Request
path Parameters
usageType
required
string
Enum: "ServiceDeployment" "Gitops" "PipelineExecution"
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

timestamp
integer <int64>
Default: 0
Responses
400

Bad Request

500

Internal server error

default

Download CSV Active Services report

get/ng/api/license-usage-cd/v2/{usageType}/csv/download
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Download CSV Active Services report
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
timestamp
integer <int64> 
 Default:  0
 
Responses 
400
Bad Request


500
Internal server error


default
Download CSV Active Services report


get/ng/api/usage/cd/active-services/csv/download
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ng/api/usage/CD/serviceInstancesLicense
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ng/api/usage/CD/servicesLicense
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
path Parameters
module
required
string
A Harness platform module.


 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
CDLicenseType
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ng/api/usage/{module}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Download CSV Active Services report
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
timestamp
integer <int64> 
 Default:  0
 
Responses 
400
Bad Request


500
Internal server error


default
Download CSV Active Services report


get/ccm/api/usage/cd/active-services/csv/download
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ccm/api/usage/CD/serviceInstancesLicense
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ccm/api/usage/CD/servicesLicense
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Gets License Usage By Module, Timestamp, and Account Identifier
Securityx-api-key 
Request 
path Parameters
module
required
string
A Harness platform module.


 
query Parameters
accountIdentifier
string
Account id to get the license usage.


 
timestamp
integer <int64> 
 
CDLicenseType
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns a license usage object


get/ccm/api/usage/{module}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Download CSV Active Monitored Services report
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
timestamp
integer <int64> 
 Default:  0
 
Responses 
default
Download CSV Active Monitored Services report


get/cv/api/usage/SRM/active-monitored-services/csv/download
Request samples 
Download CSV Active Services Monitored report
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
timestamp
integer <int64> 
 Default:  0
 
Responses 
default
Download CSV Active Services Monitored report


get/cv/api/usage/SRM/active-services-monitored/csv/download
Request samples 
CvgetLicenseUsage
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
 
timestamp
integer <int64> 
 
Responses 
default
default response


get/cv/api/usage/CV
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}
getSRMLicenseUsage
Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
 
timestamp
integer <int64> 
 
Responses 
default
default response


get/cv/api/usage/SRM
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}
Returns a List of active monitored services along with identifier,Active Monitored Services Count and other details
Securityx-api-key 
Request 
query Parameters
accountIdentifier
string
Account Identifier for the Entity.


 
page
integer <int32> 
 Default:  0
Page Index of the results to fetch.Default Value: 0


 
size
integer <int32>   <= 50 
 Default:  20
Results per page


 
sort
Array of strings
Sort criteria for the elements.


 
timestamp
integer <int64> 
 Default:  0
 
Request Body schema: */*
Details of the Active Services Monitored Filter


orgIdentifier
string
Organization identifier of the Entity.


 
projectIdentifier
string
Project identifier of the Entity.


 
serviceIdentifier
string
Service identifier of the Entity.


 
Responses 
default
Returns a list of active monitored services


post/cv/api/usage/SRM/active-monitored-services
Request samples 
Response samples 
application/json
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}
➔ Next to File Store