Search
Describe Cyber policy
Endpoint URL
HTTP Method
GET
Path Parameterscidr_id (string, required):
A unique identifier representing the cyber policy or customer view. This ID is used to retrieve detailed view information.
Request Headers
Content-Type: application/json
Authorization: Bearer <your_access_token>
Request Example
Success Response (200 OK)
This response provides detailed view information for a cyber policy, including policy details, region settings, instances, dates, disaster recovery events, and pricing.
{
"cidrId": "rFVrfliRmYgD",
"policyName": "Demo test",
"policyStatus": "ACTIVE",
"operatingState": "IDLE",
"cspAccountName": "personal AWS",
"primaryCspRegionAz": {
"regionCode": "us-east-1",
"regionType": "PRIMARY",
"availabilityZoneId": "use1-az1"
},
"failOverCspRegionAz": {
"regionCode": "us-west-2",
"regionType": "FAILOVER",
"availabilityZoneId": "usw2-az1"
},
"policyInstances": [
{
"instanceType": "m7g.large",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 2,
"memory": 8,
"qty": 1
},
{
"instanceType": "m7g.2xlarge",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 8,
"memory": 32,
"qty": 2
}
],
"startDate": "2025-02-21",
"termYears": 1,
"endDate": "2026-02-20",
"createdDate": "2025-02-07T16:40:22.416773",
"drEvents": [
{
"initiationTime": "2025-02-07T16:41:23.364751Z",
"terminationTime": "2025-02-07T17:35:01.790109Z",
"cidrAvailabilityStartTime": "2025-02-07T16:45:03.907891Z",
"cidrAvailabilityEndTime": "2025-02-07T17:35:01.790109Z",
"timeUsage": "49 minutes 57 seconds"
}
],
"pricing": {
"ourPrice": 1415.33568,
"cspProviderPrice": 6433.344,
"savings": 5018.00832,
"savingsPercentage"
{
"cidrId": "rFVrfliRmYgD",
"policyName": "Demo test",
"policyStatus": "ACTIVE",
"operatingState": "IDLE",
"cspAccountName": "personal AWS",
"primaryCspRegionAz": {
"regionCode": "us-east-1",
"regionType": "PRIMARY",
"availabilityZoneId": "use1-az1"
},
"failOverCspRegionAz": {
"regionCode": "us-west-2",
"regionType": "FAILOVER",
"availabilityZoneId": "usw2-az1"
},
"policyInstances": [
{
"instanceType": "m7g.large",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 2,
"memory": 8,
"qty": 1
},
{
"instanceType": "m7g.2xlarge",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 8,
"memory": 32,
"qty": 2
}
],
"startDate": "2025-02-21",
"termYears": 1,
"endDate": "2026-02-20",
"createdDate": "2025-02-07T16:40:22.416773",
"drEvents": [
{
"initiationTime": "2025-02-07T16:41:23.364751Z",
"terminationTime": "2025-02-07T17:35:01.790109Z",
"cidrAvailabilityStartTime": "2025-02-07T16:45:03.907891Z",
"cidrAvailabilityEndTime": "2025-02-07T17:35:01.790109Z",
"timeUsage": "49 minutes 57 seconds"
}
],
"pricing": {
"ourPrice": 1415.33568,
"cspProviderPrice": 6433.344,
"savings": 5018.00832,
"savingsPercentage"
{
"cidrId": "rFVrfliRmYgD",
"policyName": "Demo test",
"policyStatus": "ACTIVE",
"operatingState": "IDLE",
"cspAccountName": "personal AWS",
"primaryCspRegionAz": {
"regionCode": "us-east-1",
"regionType": "PRIMARY",
"availabilityZoneId": "use1-az1"
},
"failOverCspRegionAz": {
"regionCode": "us-west-2",
"regionType": "FAILOVER",
"availabilityZoneId": "usw2-az1"
},
"policyInstances": [
{
"instanceType": "m7g.large",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 2,
"memory": 8,
"qty": 1
},
{
"instanceType": "m7g.2xlarge",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 8,
"memory": 32,
"qty": 2
}
],
"startDate": "2025-02-21",
"termYears": 1,
"endDate": "2026-02-20",
"createdDate": "2025-02-07T16:40:22.416773",
"drEvents": [
{
"initiationTime": "2025-02-07T16:41:23.364751Z",
"terminationTime": "2025-02-07T17:35:01.790109Z",
"cidrAvailabilityStartTime": "2025-02-07T16:45:03.907891Z",
"cidrAvailabilityEndTime": "2025-02-07T17:35:01.790109Z",
"timeUsage": "49 minutes 57 seconds"
}
],
"pricing": {
"ourPrice": 1415.33568,
"cspProviderPrice": 6433.344,
"savings": 5018.00832,
"savingsPercentage"
{
"cidrId": "rFVrfliRmYgD",
"policyName": "Demo test",
"policyStatus": "ACTIVE",
"operatingState": "IDLE",
"cspAccountName": "personal AWS",
"primaryCspRegionAz": {
"regionCode": "us-east-1",
"regionType": "PRIMARY",
"availabilityZoneId": "use1-az1"
},
"failOverCspRegionAz": {
"regionCode": "us-west-2",
"regionType": "FAILOVER",
"availabilityZoneId": "usw2-az1"
},
"policyInstances": [
{
"instanceType": "m7g.large",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 2,
"memory": 8,
"qty": 1
},
{
"instanceType": "m7g.2xlarge",
"platformCode": "Linux/UNIX",
"tenancyCode": "SHARED",
"vcpu": 8,
"memory": 32,
"qty": 2
}
],
"startDate": "2025-02-21",
"termYears": 1,
"endDate": "2026-02-20",
"createdDate": "2025-02-07T16:40:22.416773",
"drEvents": [
{
"initiationTime": "2025-02-07T16:41:23.364751Z",
"terminationTime": "2025-02-07T17:35:01.790109Z",
"cidrAvailabilityStartTime": "2025-02-07T16:45:03.907891Z",
"cidrAvailabilityEndTime": "2025-02-07T17:35:01.790109Z",
"timeUsage": "49 minutes 57 seconds"
}
],
"pricing": {
"ourPrice": 1415.33568,
"cspProviderPrice": 6433.344,
"savings": 5018.00832,
"savingsPercentage"
Error Responses
Not Found (404 Not Found)
This error indicates that the specified cidr_id does not correspond to any existing cyber policy view
{
"error": {
"code": "404",
"message": "Not Found",
"details": {
"timestamp": "2025-03-04T17:15:55",
"description": "Cidr rFVrfliRmYgD1 not found"
{
"error": {
"code": "404",
"message": "Not Found",
"details": {
"timestamp": "2025-03-04T17:15:55",
"description": "Cidr rFVrfliRmYgD1 not found"
{
"error": {
"code": "404",
"message": "Not Found",
"details": {
"timestamp": "2025-03-04T17:15:55",
"description": "Cidr rFVrfliRmYgD1 not found"
{
"error": {
"code": "404",
"message": "Not Found",
"details": {
"timestamp": "2025-03-04T17:15:55",
"description": "Cidr rFVrfliRmYgD1 not found"
Unauthorized (401 Unauthorized)
{
"error": {
"code": "401",
"message": "Unauthorized",
"details": {
"timestamp": "2025-03-04T17:01:01",
"description": "Unable to process access token"
{
"error": {
"code": "401",
"message": "Unauthorized",
"details": {
"timestamp": "2025-03-04T17:01:01",
"description": "Unable to process access token"
{
"error": {
"code": "401",
"message": "Unauthorized",
"details": {
"timestamp": "2025-03-04T17:01:01",
"description": "Unable to process access token"
{
"error": {
"code": "401",
"message": "Unauthorized",
"details": {
"timestamp": "2025-03-04T17:01:01",
"description": "Unable to process access token"
Internal Server Error (500 Internal Server Error)
{
"error": {
"code": "500",
"message": "Internal Server Error",
"details": {
"timestamp": "2025-03-04T17:17:08",
"description": "Unexpected error. Our team is working on it"
{
"error": {
"code": "500",
"message": "Internal Server Error",
"details": {
"timestamp": "2025-03-04T17:17:08",
"description": "Unexpected error. Our team is working on it"
{
"error": {
"code": "500",
"message": "Internal Server Error",
"details": {
"timestamp": "2025-03-04T17:17:08",
"description": "Unexpected error. Our team is working on it"
{
"error": {
"code": "500",
"message": "Internal Server Error",
"details": {
"timestamp": "2025-03-04T17:17:08",
"description": "Unexpected error. Our team is working on it"
Backed by
