POST Vidb Test

POST Vidb Test

Tests a connection with the specified vIDB instance with specified credentials.

Request
URI
POST
https://{api_host}/api/v2/vidb/test
COPY
Request Body

Show optional properties

{
    "hostname": "string",
    "tenant": "string",
    "username": "string",
    "password": "string"
}
{
    "enabled": true,
    "hostname": "example-vc.eng.vmware.com",
    "port": 443,
    "tenant": "customer",
    "username": "exampleVCAdmin",
    "password": "exampleVCPassword",
    "acceptCert": false,
    "redirectUrl": "exampleVIP.ip.or.fqdn"
}
string
hostname
Required

hostname

integer
port
Optional

port

string
tenant
Required

tenant

string
username
Required

username

string
password
Required

password

Authentication
This operation uses the following authentication methods.
Responses
200

HTTP response code 200 indicates that connection was made successfully.

Operation doesn't return any data structure

400

The request failed because the request body either did not contain valid JSON, did not match the required JSON format, or provided vIDB credentials are wrong.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostname:"string","tenant:"string","password:"string","username:"string"}' https://{api_host}/api/v2/vidb/test
On This Page
Vidb Operations
GET
GET Vidb
POST
POST Vidb
POST
POST Vidb Test