Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

Endpoints in the REST API all versions

This topic was edited by a BMC Contributor and has not been approved.  More information.

BMC Network Automation REST API – All Versions

The base URL for the API is:

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

about

GET /about
 Reports product and API version information
Responses

Code

Description

Schema

200

successful operation

ProductInformation


token

GET /token
 Reports the session idle timeout, in milliseconds, thus resetting the session's timeout and keeping the session alive
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 the specified user is not logged in

500

Internal server error: Unexpected exception occurred

POST /token
 Logs in a user, to verify access is allowed to the system and to identify which resources can be used subsequently
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*

Responses

Code

Description

Schema

200

successful operation

SessionInformation

401

Unauthorized: Failed to provide a suitable Authorization header

403

Forbidden: Not allowed to access web services

500

Internal server error: Unexpected exception occurred

DELETE /token
 Logs out a logged-in REST API user
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'

string*

Responses

Code

Description

Schema

200

successful operation

string

401

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

500

Internal server error: Unexpected exception occurred


Object Definitions

Object

Schema

ProductInformation

 Information about the product

{
    productName: string
    Localized name of the product
 
    component: string
    Component of the product (not used)
 
    version: string
    Version of the product
 
    apiVersions: [
      List of supported API versions
 
      string
    ]
}

SessionInformation

 Information about the logged-in user session

{
    access_token: string
    The identifying user token
 
    expires_in: integer
    How long the token/session can sit idle, in milliseconds
 
    token_type: string
    OAuth2 token type, which is always 'Bearer' in our case
}

Was this page helpful? Yes No Submitting... Thank you

Comments