Verify if an API key is valid for a specific environment

Simple endpoint to verify if the provided API key (DYN_API_TOKEN) is valid and has access to the specified environment. Returns true if the token is verified, false otherwise.

POST /environments/{environmentId}/verifyApiKey

Verify if an API key is valid for a specific environment

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/verifyApiKey \
  --header 'Authorization: Bearer <token>'

200

{
  "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verified": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

200

application/json

API key verification result

environmentId · string<uuid> · required

The environment ID for which the API key was verified

verified · boolean · required

Indicates whether the API key is valid and has access to the environment