Logo
Admin API API Documentation

CBR API

Number of APIs: 4


1. Create CBR

POST {{URL_ORIGIN}}/api/cbrs

This API allows to create a new CBR.

ID will be returned in the response, this ID is the unique identifier of the CBR and should be used when sending update commands.

Note: this ID can be retrieved via Get CBRs API.

Create CBR - Error Codes

Code Message
1 System is unavailable
100 Missing or invalid parameter: [FieldName]
101 [FieldName] not found
102 name already exists
105 Priority [value] already exists
10001 Permission denied



2. Get CBRs

GET {{URL_ORIGIN}}/api/cbrs

This API allows to get CBRs details.



3. Get CBR

GET {{URL_ORIGIN}}/api/cbrs/:id

This API allows to get a single CBR details.



4. Update CBR

PUT {{URL_ORIGIN}}/api/cbrs/31

This API allows to update existing CBR.

Update CBR - Error Codes

All validations in create CBR

Code Message
101 [FieldName] not found
10001 Permission denied



ENDPOINTS