Monitored Services

This contains APIs related to CRUD operations of Monitored Services

createDefaultMonitoredService

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

environmentIdentifier
required
string
serviceIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

post/cv/api/monitored-service/create-default
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get monitored service data

Securityx-api-key
Request
path Parameters
identifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Get monitored service data

get/cv/api/monitored-service/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates monitored service data

Securityx-api-key
Request
path Parameters
identifier
required
string

Identifier for the Entity.

query Parameters
accountId
required
string

Account Identifier for the Entity.

Request Body schema: */*
required
orgIdentifier
required
string
projectIdentifier
required
string
identifier
required
string
name
required
string
type
required
string
Enum: "Application" "Infrastructure"
description
string
serviceRef
required
string
environmentRef
string
environmentRefList
Array of strings
object
object (Sources)
Array of objects (ServiceDependencyDTO) unique
Array of objects (NotificationRuleRefDTO)
object (TemplateDTO)
enabled
boolean
Responses
400

Bad Request

500

Internal Server Error

default

Updates monitored service data

put/cv/api/monitored-service/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete monitored service data

Securityx-api-key
Request
path Parameters
identifier
required
string

Identifier for the Entity.

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

Delete monitored service data

delete/cv/api/monitored-service/{identifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

delete template reference from monitored service

Securityx-api-key
Request
path Parameters
identifier
required
string

Identifier for the Entity.

query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

default

delete template reference from monitored service

put/cv/api/monitored-service/{identifier}/detach-template
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getAllMonitoredServicesWithHealthSources

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/all/time-series-health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

CvgetAnomaliesSummary

Securityx-api-key
Request
path Parameters
identifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{identifier}/anomaliesCount
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getCountOfServices

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

environmentIdentifier
string
filter
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/count-of-services
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getEnvironments

Securityx-api-key
Request
query Parameters
accountId
required
string
orgIdentifier
required
string
projectIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/environments
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getHealthSources

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getHealthSourcesForMonitoredServiceIdentifier

Securityx-api-key
Request
path Parameters
monitoredServiceIdentifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getList

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

environmentIdentifier
string
environmentIdentifiers
Array of strings
offset
required
integer <int32>
pageSize
required
integer <int32>
filter
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/list
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getListV2

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

environmentIdentifiers
Array of strings
offset
required
integer <int32>
pageSize
required
integer <int32>
filter
string
monitoredServiceType
string
Enum: "Application" "Infrastructure"
hideNotConfiguredServices
boolean
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/platform/list
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMSSecondaryEvents

Securityx-api-key
Request
path Parameters
identifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

startTime
required
integer <int64>
endTime
required
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{identifier}/secondary-events
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMSSecondaryEventsDetails

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

secondaryEventType
required
string
Enum: "Downtime" "DataCollectionFailure" "Annotation" "ErrorBudgetReset" "SrmAnalysisImpact"
identifiers
required
Array of strings [ 1 .. 2147483647 ] items
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/secondary-events-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceChangeDetails

Securityx-api-key
Request
path Parameters
monitoredServiceIdentifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

sloIdentifiers
Array of strings
startTime
integer <int64>
endTime
integer <int64>
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{monitoredServiceIdentifier}/change-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceDetails

Securityx-api-key
Request
path Parameters
monitoredServiceIdentifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{monitoredServiceIdentifier}/service-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceDetails_1Deprecated

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/service-details
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceFromServiceAndEnvironment

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

serviceIdentifier
required
string
environmentIdentifier
required
string
Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/service-environment
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

getMonitoredServiceLogs

Securityx-api-key
Request
path Parameters
monitoredServiceIdentifier
required
string
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

logType
required
string
Enum: "ApiCallLog" "ExecutionLog"
errorLogsOnly
boolean
startTime
required
integer <int64>
endTime
required
integer <int64>
healthSources
Array of strings
pageNumber
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32>
Default: 10

Results per page

Responses
400

Bad Request

500

Internal Server Error

get/cv/api/monitored-service/{monitoredServiceIdentifier}/logs
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

fetch reconciliation status for template referenced monitored services

Securityx-api-key
Request
query Parameters
accountId
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.