API Information

API Information

This endpoint returns information based on the current API key.

Retrieve information (WhoAmI)

Returns information based on the current API key.

GET /api/v2/whoami

Arguments:

This method has no additional arguments.

Response object:

  • An object with the following properties:
    • id - string : The unique identifier of the current API key
    • name - string : The name of the API key
    • type - string : The authentication type, e.g., “token” for API requests

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    "${JACKDB_API_URL}/whoami"

Example response:

{
    "id": "423a2940-a1c5-40db-8c3f-9900641e2b36",
    "name": "My API Key",
    "type": "token"
}