TrueSight Network Automation REST API – Version 3.0
The base URL for the API is:
https://serverName:portNumber/bca-networks/api
See the following topics for the endpoints in REST API version 3.0:
For a few services, endpoints are included as supporting components. See the following topic for the same.
supporting components
{{status colour="Blue" title="GET"/}}
/v3.0/device_adapters
Click here to expand...
| | | | |
|---|
| | Filter for device adapters matching this type | | string
Enum: [
"configurationTrail",
"customAction",
"deviceType",
"externalScriptAction",
"vendor"
] |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Forbidden: Not allowed to access device adapters | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/device_adapters/{nameOrKeyOrGuid}
Click here to expand...
| | | | |
|---|
| | Name or database key or GUID of the one device adapter of interest | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Forbidden: Not allowed to access device adapters | |
| Not found: No single matching device adapter found | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/models
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/models/{nameOrKey}
Click here to expand...
| | | | |
|---|
| | Name or database key of the model of interest | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Not found: No single matching model found | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/os_images
Click here to expand...
| | | | |
|---|
| | Filter for OS images matching this name, asterisk wildcards allowed | | |
| | Filter for OS images matching this filename, asterisk wildcards allowed | | |
| | 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 token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Forbidden: Not allowed to access the OS image library | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/os_images/{nameOrKey}
Click here to expand...
| | | | |
|---|
| | Name or database key of the OS image of interest | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Forbidden: Not allowed to access the OS image library | |
| Not found: No single matching OS image found | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/time_period_types
Click here to expand...
| | | | |
|---|
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Internal server error: Unexpected exception occurred | |
{{status colour="Blue" title="GET"/}}
/v3.0/time_period_types/{idOrUrlKey}
Click here to expand...
| | | | |
|---|
| | ID or urlKey of the time period type of interest | | |
| | Authorization token formatted as 'Bearer [token]' | | |
| | |
|---|
| | |
| Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
| Not found: No single matching time period type found | |
| Internal server error: Unexpected exception occurred | |
Object Definitions
| |
|---|
DeviceAdapterDTO |
Click here to expand...
{
id: string
The adapter's unique database key
name: string
The adapter's display name
annotation: string
Annotation with reasons for modification
enabledFlag: boolean
Whether or not this adapter is enabled
guid: string
The adapter's GUID
lastModifiedTimestamp: date-time
When this adapter was last modified
Example: 2017-01-31T13:45:00.000+0000
lastModifiedUserName: string
The name of the user who last modified this adapter
requiresMergeFlag: boolean
Whether or not the adapter requires a manual three-way merge, caused by a software upgrade
stateId: integer
Whether an adapter is currently in the new, modified, or baseline state
stateName: string
The meaning of the numeric stateId
typeId: integer
The type of device adapter
typeName: string
The meaning of the numeric typeId
} |
DynamicFieldValueDTO |
Click here to expand...
{
id: string
The database key of the dynamic field whose value this is (read-only)
name: string
The name of the dynamic field (read-only)
values: [
The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
string
]
dynamicFieldDetailsLink: string
Link to get more detailed information about the dynamic field (read-only)
} |
ModelDTO |
Click here to expand...
{
id: string
The model's unique database key
name: string
The model name, unique within a vendor
vendorGuid: string
The GUID of the vendor associated with this model
vendorName: string
The name of the vendor associated with this model
} |
OsFileDTO |
Click here to expand...
{
imageTypeName: string
What type of binary file this is, when a device supports multi-file images
name: string
The name of the file
sizeBytes: integer
The size of the file in bytes
messageDigest: string
The MD5 checksum or digest
} |
OsImageDTO |
Click here to expand...
{
id: string
The OS image's unique database key
name: string
The OS image's display name; null/empty when this image has not been verified as having run on a device
deviceTypeGuid: string
Which device type this OS image applies to
deviceTypeName: string
The name of the device type
vendorGuid: string
Which vendor owns the associated device type
vendorName: string
The name of the vendor
forbidDeploymentFlag: boolean
Whether or not this OS image is allowed to be deployed
annotation: string
Notes, comments, description, explanation
memoryFootprintBytes: integer
Bytes of memory this image consumes; a zero indicates this value is not used by the device
activationKey: string
License key to activate features in the binary image on the device
files: [
The binary files; null/empty when no image snapshot has been taken from a device running this image, or user has not supplied any files
#OsFileDTO
]
modelNames: [
The models where this image can be deployed
string
]
dynamicFields: [
The dynamic fields
#DynamicFieldValueDTO
]
} |
TimePeriodTypeDTO |
Click here to expand...
{
id: integer
Unique identifier of this time period type
name: string
The time period type's display name
futureOrientedFlag: boolean
Whether or not this time period type is future-oriented (refers to dates/times in the future, such as tomorrow or next week)
hourOrientedFlag: boolean
Whether or not this time period type is hour-oriented (refers to a span of a certain number of hours, such as last 2 hours or last 24 hours)
preDefinedFlag: boolean
Whether or not the time period type is pre-defined; when true, the time period is a known or fixed range (such as last week or this month); when false, the time period includes dynamically selected or computed dates or times (such as before or since trusted)
sortOrder: integer
Where this time period type appears among the other time period types
urlKey: string
Unique identifier for this time period type for use in an external URL
} |