Endpoints in all versions of the REST API

TrueSight Network Automation REST API – AboutService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

about

{{status subtle="false" colour="Blue" title="GET"/}}

 /about
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

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


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /about/login_information
Click here to expand...


Responses

Code

Description

Schema

200

successful operation

token

{{status subtle="false" colour="Blue" title="GET"/}}

 /token
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

integer

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /token
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

grant_type

formData

The type of login being performed


string*
Enum: [
  "password"
]

username

formData

The username of who is logging in


string*

password

formData

The password of who is logging in


string*

interactiveUser

query

Whether or not the user logging in is using a browser-based interactive user interface (and is a person rather than a program); when false, authorization of subsequent requests must be done by providing an Authorization header with a bearer token; the response to this session creation request will contain the token; when true, authorization of subsequent requests must be done by providing a session cookie; the response to this session creation request will contain the cookie


boolean

Responses

Code

Description

Schema

400

Bad request: Required username is missing, or password has expired


401

Unauthorized: Failed to provide a suitable Authorization header, user account is locked or disabled, input grant type is incorrect, or input credentials are incorrect


403

Forbidden: Not allowed to access web services


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Red" title="DELETE"/}}

 /token
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /token/password_update
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

grant_type

formData

The type of login being performed


string*
Enum: [
  "password"
]

username

formData

The username of who is logging in


string*

currentPassword

formData

The current password of who is logging in


string*

newPassword

formData

The new password of who is logging in


string*

interactiveUser

query

Whether or not the user logging in is using a browser-based interactive user interface (and is a person rather than a program); when false, authorization of subsequent requests must be done by providing an Authorization header with a bearer token; the response to this session creation request will contain the token; when true, authorization of subsequent requests must be done by providing a session cookie; the response to this session creation request will contain the cookie


boolean

Responses

Code

Description

Schema

400

Bad request: Required username is missing, or old password has expired, or input new password is invalid or has already been used, or the system is using external authentication (and thus does not maintain passwords)


401

Unauthorized: Failed to provide a suitable Authorization header, user account is locked or disabled, input grant type is incorrect, or input credentials are incorrect.


403

Forbidden: Not allowed to access web services


500

Internal server error: Unexpected exception occurred


Object Definitions

Object

Schema

LoginInformation


Click here to expand...


{
    loginHtmlTagHeader: string
    The loginHtmlTagHeader property from the global.properties file which can be used by a browser-based client to present the custom header on a login page
 
    loginHtmlTagFooter: string
    The loginHtmlTagFooter property from the global.properties file which can be used by a browser-based client to present the custom footer on a login page
}

ProductInformation


Click here to expand...


{
    productName: string
    Localized name of the product
 
    component: string
    Component of the product (not used)
 
    fullVersion: string
    Full version of the product which includes build, upgrader, and hotfix version
 
    version: string
    Version of the product
 
    apiVersions: [
      List of supported API versions
 
      string
    ]
 
    siteName: string
    The name of the site, as defined in the system parameters
 
    siteDescription: string
    An optional description about the site, as defined in the system parameters
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*