Revoke a key

DELETEhttps://sandbox-api.tryflume.ai/partner/v1/keys/{key_id}

Revokes a partner key at once.

You cannot revoke your only working key. Rotate first.

curl -X DELETE "https://sandbox-api.tryflume.ai/partner/v1/keys/pk_9e1b4d7a2c5f4068b3a1d9c7e5f2a0b4" \
  -H "X-Flume-Partner-Key: $FLUME_PARTNER_KEY"

import os

import requests

headers = {
    "X-Flume-Partner-Key": os.environ["FLUME_PARTNER_KEY"],
}

response = requests.delete(
    "https://sandbox-api.tryflume.ai/partner/v1/keys/pk_9e1b4d7a2c5f4068b3a1d9c7e5f2a0b4",
    headers=headers,
    timeout=30,
)
response.raise_for_status()
print(response.status_code)

const response = await fetch("https://sandbox-api.tryflume.ai/partner/v1/keys/pk_9e1b4d7a2c5f4068b3a1d9c7e5f2a0b4", {
  method: "DELETE",
  headers: {
    "X-Flume-Partner-Key": process.env.FLUME_PARTNER_KEY,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
console.log(response.status);

Response: 204. No body.

Request

Headers

Header	Required	Description
`X-Flume-Partner-Key`	Yes	Your partner key. See Authentication and keys.

Path parameters

Parameter	Type	Description
`key_id`	string	The key to revoke, from `GET /keys`.

This call takes no body.

Returns

204 with no body.

Errors

Every error uses one envelope. Branch on error.code.

Status	Code	Meaning
401	`EMBED_TOKEN_INVALID`	You sent an `Authorization` header and no `X-Flume-Partner-Key`. Flume read the call as one from its own iframe.
401	`PARTNER_KEY_INVALID`	The partner key is missing, unknown, revoked, expired, or from the other environment. On live, also a platform Flume has not enabled yet.
404	`NOT_FOUND`	The thing does not exist, or is not this user's. A search id that is not a UUID also returns this code.
409	`LAST_ACTIVE_KEY`	This is your only working key.
422	`VALIDATION_FAILED`	A field is missing, unknown or has an unusable value. `field` names it as a dotted path. Some refusals carry the detail in `details` and leave `field` empty.
500	`INTERNAL`	Something failed on Flume's side.