Browse the API reference

Update API Key

put/v1/user/api-keys/{api_key_id}

Part of User.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
api_key_idrequiredstringApi Key Id

Request body

Required, application/json.

FieldTypeDescription
nameoptionalstring

New name for the API key

descriptionoptionalstring

New description

Example request

curl
curl -X PUT "https://api.robosystems.ai/v1/user/api-keys/{api_key_id}" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string"
}'

Responses

200 Successful Response

FieldTypeDescription
idrequiredstring

API key ID

namerequiredstring

API key name

descriptionoptionalstring

API key description

prefixrequiredstring

API key prefix for identification

is_activerequiredboolean

Whether the key is active

last_used_atoptionalstring

Last used timestamp

expires_atoptionalstring

Expiration timestamp

created_atrequiredstring

Creation timestamp

graph_idoptionalstring

Graph scope; null means account-wide

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error