Skip to main content
PUT
/
developers
/
api_keys
/
{id}
Update an API key
curl --request PUT \
  --url https://api.bitgpt.xyz/developers/api_keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "description": "<string>"
}
'
{
  "status": 200,
  "data": {
    "id": "123"
  },
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "API key updated",
  "env": "development"
}

Authorizations

​
Authorization
string
header
required

Send your access token as header Authorization: Bearer {accessToken}

Path Parameters

​
id
string
required

API Key ID

Body

application/json

Request body for updating an API key

​
label
string
required

Human-readable label for the API key

Maximum string length: 255
​
description
string

Human-readable description for the API key

Response

Successful API key update response

​
status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
​
data
required

Response data containing the requested object

​
message
string
required

Success message

Example:

"Resource created successfully"

​
env
enum<string>
required

API environment

Available options:
development,
production
​
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

​
log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

​
validator
object

Validator response object, each key is the field name and value is the error message

Example:
{
  "email": "Invalid email address",
  "password": "Password is required"
}
​
support_id
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"