Toggle APIKey activates or deactivates an API key

PATCH/v1/providers/api-keys/{keyId}/toggle

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

keyId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`keyId`	path	`string`	Yes

Request Body

Property	Type	Required	Description
`isActive`	`boolean`	No

Responses

200 API key toggled successfully

Property	Type	Description
`key`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X PATCH "http://localhost:8089/v1/providers/api-keys/{keyId}/toggle" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"isActive":true}'

const response = await fetch("http://localhost:8089/v1/providers/api-keys/{keyId}/toggle", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "isActive": true
}),
});
const data = await response.json();

import requests

response = requests.patch(
    "http://localhost:8089/v1/providers/api-keys/{keyId}/toggle",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "isActive": true
},
)
data = response.json()

Response

{
  "key": {
    "id": "string",
    "providerConfigId": "string",
    "keyName": "string",
    "keyMasked": "string",
    "weight": 0,
    "isActive": true,
    "createdAt": "string",
    "updatedAt": "string",
    "source": "string"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}