Skip to content

Enable or disable an API key

PATCH
/api/v1/auth/api-keys/{id}

Parameters

Path Parameters

id*
Type
integer
Required
Format
"int64"

Request Body

application/json
JSON
{
  
"$schema": "https://bpincentives.com/schemas/Auth-apikeys-updateRequest.json",
  
"enabled": true
}

Responses

OK

application/json
JSON
{
  
"$schema": "https://bpincentives.com/schemas/Auth-apikeys-updateResponse.json",
  
"apiKey": {
  
  
"createdAt": 0,
  
  
"enabled": true,
  
  
"expiresAt": 0,
  
  
"id": 0,
  
  
"label": "string",
  
  
"lastUsedAt": 0,
  
  
"prefix": "string"
  
}
}

Playground

Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI