InternetDataInternetData

Rotate

POST
/api/v1/iam/apikeys/{id}/rotate

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

Authorization

BearerAuth apikeys.manage
AuthorizationBearer <token>

Authorization: Bearer <key>, with a key from the console. Keys are default-deny: each operation names the scope it needs, and an existing key does not gain an operation until that scope is added to it.

In: header

Scope: apikeys.manage

Path Parameters

id*string

The key's id, as returned by the list endpoint. Never the key itself.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://internetdata.io/api/v1/iam/apikeys/497f6eca-6276-4993-bfeb-53cbbbba6f08/rotate"
{
  "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"
}

Create POST

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.

Revoke POST

Stops the key working. Revocation is soft: the key stays listed with a `revoked_at`, because the organization still owns whatever it did while it was alive.