Supporting Components API
TrueSight Network Automation REST API – Listing Service
The base URL for the API is:
https://serverName:portNumber/bca-networks/api
GET /v3.0/device_adapters
GET /v3.0/device_adapters
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
filter.type | query | Filter for device adapters matching this type |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access device adapters | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/device_adapters/{nameOrKeyOrGuid
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKeyOrGuid | path | Name or database key or GUID of the one device adapter of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access device adapters | |
404 | Not found: No single matching device adapter found | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/models
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/models/{nameOrKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the model of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
404 | Not found: No single matching model found | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/os_images
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
query | Filter for OS images matching this name, asterisk wildcards allowed |
| ||
filter.filename | query | Filter for OS images matching this filename, asterisk wildcards allowed |
| |
filter.onlyDeployable | query | Filter for OS images that can be deployed; when true, returns only OS images whose 'Forbid Deployment of This Image' setting is unchecked; when false or when this filter is absent, no filtering is done |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access the OS image library | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/os_images/{nameOrKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the OS image of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access the OS image library | |
404 | Not found: No single matching OS image found | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/time_period_types
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/time_period_types/{idOrUrlKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
idOrUrlKey | path | ID or urlKey of the time period type of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
404 | Not found: No single matching time period type found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
DeviceAdapterDTO | Information about a device adapter
|
DynamicFieldValueDTO | A dynamic field value
|
ModelDTO | Information about a model, as discovered while accessing devices
|
OsFileDTO | Information about an operating system binary file
|
OsImageDTO | Information about an operating system image
|
TimePeriodTypeDTO | Information about a time period type
|
Comments
Log in or register to comment.