Orbital OK API

GET /v0/ok

This API simply validates that a client’s credentials work, while offering some information about the service.

Example Request:

http https://$service/v0/ok \
     "Authorization:Bearer $token"

200 OK

On success, this API will return some information about the client.

{
    // login information reflects the user that created the client.
    "login": {
        "email": "joe.maldive@threatgrid.com",
        "organization": "149f631c-4b50-478b-ae16-f86fabda0d31",
        "user": "9b16e8ca-1b43-42c0-9fb9-3f6d2cd8aa8d",
        "userName": "Joe Maldive"
    },
    "message": "OK"
}

Return to Table of Contents