API status check

Get V2 API status

This call returns status information about the V2 API. It returns:

•whether the V2 API is available (implied by the presence of a return)

•the API version number

•the version and build number of the VSP

Required Role

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role
Any admin role

HTTP method

GET

Request URI

api/v2/ping

Request parameters

None.

Response fields

Field	Description
results	Container for the results
apiVersion	Version of the API.
vspVersion	Version and build number of the Core.

Sample request and response

Request

curl -X GET -H "Authorization: Basic bWlhZG1pbjpNaTRtYW4xMQ==" https://[core]/api/v2/ping

Response

{

    "results": {

        "apiVersion": 2,

        "vspVersion": "VSP 8.0.0.0 Build 1 "

    }

}