Endpoints in the REST API all versions

BMC Network Automation REST API – All Versions

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...
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 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*

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header

 

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

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

Click here to expand...

{
    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

Click here to expand...

{
    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
}

 

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