Skip to content

Rotate a connection's key

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/connections/{id}/rotate-key
curl --request POST \  --url https://api.xovris.ai/v1/connections/example/rotate-key \  --header 'Authorization: Bearer <token>'

Makes a new ingestion key for one connection and retires the old one safely. Where Xovris can reach the app’s host for this connection, it puts the new key in place itself and the secret never leaves the server; otherwise the answer carries the new secret once, for you to place and redeploy. The old key stays accepted until the new one has sent an event and the old one has been quiet for a day. It needs the connection.grant permission (a workspace owner or admin); an unknown connection is refused with connection-unknown, and a rotation still waiting on its new key with rotation-waiting.

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string

Done.

Media typeapplication/json
One of:
object
tenantId
required
string
principal
object
kind
required
string
Allowed values: user api_token service
id
required
string
role
required
string
Allowed values: admin billing owner member viewer
requestId
required
string

Example

{  "tenantId": "string",  "principal": {    "kind": "user",    "id": "string",    "role": "admin"  },  "requestId": "string"}

Done: something new was made, and the answer is it.

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.