Authentication

This page describes the API for Dbvisit Standby v11 authentication which is needed to perform various tasks via API

Authentication API

All requests are made over HTTPS.

Purpose:

Returns existing authentication cookie in a header.

API:

POST /api/login

Request body:

{
  "UserName": "USERNAME",
  "Password": "PASSWORD"
}

Successful response body:

{
  "Status": 200,
  "Result": {}
}

Successful response header example:

Set-Cookie: dbvisit-standby=MTY0Njg2NTYwOHxEdi1CQkFFQ180SUFBUkFCRUFBQUxmLUNBQUVHYzNSeWFXNW5EQVVBQTNOcFpBWnpkSEpwYm1jTUVnQVFaVEV5TnpnMVkyTTJOREV4TlRJeE53PT18W39Sxb15sXZWvlEQ-mEFcwfusDjPXuFY-CXsaDu6CAU=; Path=/; Expires=Fri, 08 Apr 2022 22:40:08 GMT; Max-Age=2592000

A successful response header contains a cookie that must be supplied along with future API calls.

Alternatively, each request can contain an Authorization header using HTTP BASIC authentication specifying the user name and password.

Curl example of calling Configuration(s) API with HTTP BASIC authentication :

curl -k -u admin:admin https://localhost:4433/api/configurations/1

where username is “admin“ and password is “admin“