- About VES Public REST API
- Overview
- Login
- Collectors
- getGet Collector Hierarchy Tree
- getGet List of Registered Collectors
- getGet All Collector Groups
- getGet All Monitoring Jobs
- postMove Collector to Different Group
- postMove Monitoring Jobs to Collector
- postUnregister Collector
- postTrigger Topology Rebuild
- postRebalance Monitoring Load Across All Groups
- postRebalance Monitoring Load in Group
- postCreate Collector Group
- postRename Collector Group
- delDelete Collector Group
- HypervServers
- License
- Settings
- VmwareServers
- getGet VMware Server Hierarchy Tree
- getGet VMware Server Data
- postRegister VMware vCenter or ESXi Host
- postRegister VMware vCenter or ESXi Host Without Immediate Connection
- postRetrieve SSL Certificate
- postUpdate VMware Server Configuration
- postPerform VMware Servers Connectivity Check
- postDiscover Available Monitoring Jobs
- postRemove VMware Servers
- postAdd VMware Topology to Monitoring
- postRemove VMware Topology from Monitoring
- getGet Latest Connectivity Test Results
- postStart Connectivity Test
- postStop Connectivity Test
To start working with the VES Public REST API, users must first authenticate themselves. The VES REST API authorization process is based on the OAuth 2.0 Authorization Framework and involves obtaining an access token and a refresh token.
- Access token is a string that represents authorization issued to the client and that must be used in all requests during the current logon session.
- Refresh token is a string that represents authorization granted to the client and that can be used to obtain a new access token if the current access token expires or becomes lost.
Get Authorization Tokens
The HTTP POST request to the /api/v1/login endpoint retrieves an access token and a refresh token.
Request Body schema: application/json
| password required | string non-empty Password of the specified Windows user. |
| userName required | string non-empty Windows user name. |
OK
Bad Request
Unauthorized
Internal Server Error
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "userName": "CORP\\john.smith",
- "password": "1234567"
}- 200
- 500
{- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJDT1JQXFxqb2huLnNtaXRoIiwiZXhwIjoxNzE5MDAwMDAwfQ.example",
- "expiresAt": "900",
- "refreshToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}Refresh Authorization Tokens
The HTTP POST request to the /api/v1/refreshToken endpoint retrieves a new pair of access and refresh tokens. The previous refresh token becomes invalid and cannot be used again.
Request Body schema: application/json
| refreshToken required | string non-empty Refresh token received in the previous login or refresh response. |
OK
Bad Request
Unauthorized
Internal Server Error
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "refreshToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}- 200
- 500
{- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJDT1JQXFxqb2huLnNtaXRoIiwiZXhwIjoxNzE5MDAwMDAwfQ.example",
- "expiresAt": "900",
- "refreshToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}Log Out
The HTTP DELETE request to the /api/v1/logout endpoint performs logout from the VES API for an authorized user. After logout, both the access token and refresh token become invalid.
No Content
Unauthorized
Internal Server Error
- curl
- Python
- JavaScript
- C#
- Go
- 500
{- "message": "string"
}