Downtime

This contains APIs related to CRUD operations of Downtime

getDowntime

Securityx-api-key

Request

path Parameters

identifier required	string Identifier for the Entity.
accountIdentifier 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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

updateDowntimeData

Securityx-api-key

Request

path Parameters

identifier required	string Identifier for the Entity.
accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

Request Body schema: application/json
required

Details of the Downtime to be updated

orgIdentifier required	string
projectIdentifier required	string
identifier required	string
name required	string
description	string
	object
category required	string Enum: "ScheduledMaintenance" "Deployment" "Other"
scope	string Enum: "Project" "Entity"
required	object (DowntimeSpecDTO)
required	object (EntitiesRule)
enabled	boolean

Responses

400

Bad Request

500

Internal Server Error

put/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"orgIdentifier": "string",
"projectIdentifier": "string",
"identifier": "string",
"name": "string",
"description": "string",
"tags": {"property1": "string",
"property2": "string"
},
"category": "ScheduledMaintenance",
"scope": "Project",
"spec": {"type": "Onetime",
"spec": {"timezone": "string",
"startTime": 0,
"startDateTime": "string",
"type": "string"
}
},
"entitiesRule": {"affectedEntity": {"serviceName": "string",
"envName": "string",
"monitoredServiceIdentifier": "string"
},
"type": "All"
},
"enabled": true
}

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

deleteDowntimeData

Securityx-api-key

Request

path Parameters

identifier required	string Identifier for the Entity.
accountIdentifier 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

delete/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

getAssociatedMonitoredServices

Securityx-api-key

Request

path Parameters

identifier required	string Identifier for the Entity.
accountIdentifier 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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services/{identifier}

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

getDowntimeAssociatedMonitoredServices

Securityx-api-key

Request

path Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

query Parameters

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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

getHistory

Securityx-api-key

Request

path Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

query Parameters

pageNumber	integer <int32> Default: 0 Page Index of the results to fetch.Default Value: 0
pageSize	integer <int32> Default: 10 Results per page
monitoredServiceIdentifier	string For filtering on the basis of monitored services' identifiers
filter	string For filtering on the basis of name

Responses

400

Bad Request

500

Internal Server Error

get/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/history

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

listDowntimes

Securityx-api-key

Request

path Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

query Parameters

pageNumber	integer <int32> Default: 0 Page Index of the results to fetch.Default Value: 0
pageSize	integer <int32> Default: 10 Results per page
monitoredServiceIdentifier	string For filtering on the basis of monitored services' identifiers
filter	string For filtering on the basis of name

Responses

400

Bad Request

500

Internal Server Error

get/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/list

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

saveDowntime

Securityx-api-key

Request

path Parameters

accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

Request Body schema: application/json
required

Details of the Downtime to be saved

orgIdentifier required	string
projectIdentifier required	string
identifier required	string
name required	string
description	string
	object
category required	string Enum: "ScheduledMaintenance" "Deployment" "Other"
scope	string Enum: "Project" "Entity"
required	object (DowntimeSpecDTO)
required	object (EntitiesRule)
enabled	boolean

Responses

400

Bad Request

500

Internal Server Error

post/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime

Request samples

Payload
curl
Java
Go

application/json

{"orgIdentifier": "string",
"projectIdentifier": "string",
"identifier": "string",
"name": "string",
"description": "string",
"tags": {"property1": "string",
"property2": "string"
},
"category": "ScheduledMaintenance",
"scope": "Project",
"spec": {"type": "Onetime",
"spec": {"timezone": "string",
"startTime": 0,
"startDateTime": "string",
"type": "string"
}
},
"entitiesRule": {"affectedEntity": {"serviceName": "string",
"envName": "string",
"monitoredServiceIdentifier": "string"
},
"type": "All"
},
"enabled": true
}

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

updateDowntimeEnabled

Securityx-api-key

Request

path Parameters

identifier required	string Identifier for the Entity.
accountIdentifier required	string Account Identifier for the Entity.
orgIdentifier required	string Organization Identifier for the Entity.
projectIdentifier required	string Project Identifier for the Entity.

query Parameters

enable

required

boolean

Responses

400

Bad Request

500

Internal Server Error

put/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/flag/{identifier}

Request samples

curl
Java
Go

Response samples

{"status": "SUCCESS",
"code": "DEFAULT_ERROR_CODE",
"message": "string",
"correlationId": "string",
"errors": [{"fieldId": "string",
"error": "string"
}
]
}

➔ Next to Srm Notification

Downtime

getDowntime

path Parameters

updateDowntimeData

path Parameters

Request Body schema: application/jsonrequired

deleteDowntimeData

path Parameters

getAssociatedMonitoredServices

path Parameters

getDowntimeAssociatedMonitoredServices

path Parameters

query Parameters

getHistory

path Parameters

query Parameters

listDowntimes

path Parameters

query Parameters

saveDowntime

path Parameters

Request Body schema: application/jsonrequired

updateDowntimeEnabled

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required