v4.0 Realms API
TrueSight Network Automation REST API – RealmService
The base URL for the API is:
realms
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/realms
Click here to expand...
Description
Retrieves realms, matching any filter criteria, with the returned result being abbreviated or partially-detailed realms
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
query | Filter for realms matching this name, asterisk wildcards allowed | string | ||
filter.action | query | Filter for realms where the user is allowed to perform this action, by action GUID | string | |
orderBy | query | Sort by the specified attribute (name, deviceCount, groupCount, or a listable realm dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" | string |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of realms to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access realms | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/realms
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
body | body | Complete attributes of the new realm | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
201 | Created: New realm successfully added | |
400 | Bad request: Input realm DTO is missing or new realm is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new realm | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/realms/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the realm of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access realms | |
404 | Not found: No single matching accessible realm found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/realms/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the realm to be modified | string * | |
body | body | Complete new attribute values for the realm; anything left out will be considered to be null and will be nulled out in the realm; any required fallback or hardware inventory purge criteria or dynamic fields missing or null in the input will revert to default values | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input realm DTO is missing or modified realm is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the realm | |
404 | Not found: No single matching accessible realm found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/realms/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the realm to be deleted | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | string |
400 | Bad request: Realm is currently in use, or it is the only realm and cannot be deleted | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the realm | |
404 | Not found: No single matching accessible realm found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Yellow" title="PATCH"/}}
/v4.0/realms/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
|---|---|---|---|---|
nameOrKey | path | Name or database key of the realm to be modified | string * | |
body | body | New attribute values for the realm, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
|---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified realm is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the realm | |
404 | Not found: No single matching accessible realm found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
|---|---|
AbbreviatedRealmDTO | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
PurgeCriteriaDTO | Click here to expand...{ |
RealmDTO | Click here to expand...{ |