VPNDetectionVPNDetection

Create

POST
/api/v1/iam/apikeys

Creates a key and returns its secret.

This is the ONLY response that ever carries the secret, and only because this is the moment it comes into existence. Store it now.

Authorization

bearerAuth apikeys.manage
AuthorizationBearer <token>

Authorization: Bearer <key>.

In: header

Scope: apikeys.manage

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.vpndetection.io/api/v1/iam/apikeys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "rc": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "key": "string",
  "key_prefix": "string",
  "allowed_cidrs": [
    "string"
  ],
  "allowed_scopes": [
    "string"
  ]
}
{
  "rc": "string"
}
{
  "rc": "string"
}
{
  "rc": "string"
}

List GET

Metadata only. A key's secret is never in a list - not here and not in the console - because a list is the response that ends up in logs, caches and support tickets. `retrievable` says whether the secret could still be read back at all. A key issued before this product stored secrets recoverably was never kept, so `reveal` will refuse it permanently; rotating produces one that can be read.

Rotate POST

Replaces the secret behind a key, keeping its id, name and settings. The previous secret stops working immediately.