Read
GET v1/master_key
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsString |
| active | NsBoolean |
GET v1/master_key/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsString |
| active | NsBoolean |
GET v1/master_key/id
Query parameters
| Parameter | Type |
|---|---|
| fields | NsCommaSeparatedList |
Description
Read master key status.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier of the master key. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsString | string | Name of the master key. The only allowed value is "default". Plain string. | |
| active | NsBoolean | boolean | Whether the master key is active or not. Possible values: 'true', 'false'. |
JSON Response