curl -X PUT "https://developer.encrata.com/api/account/keys" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"id": "a1b2c3d4-0000-4000-8000-000000000000", "name": "Production key"}'
{
"message": "API key renamed"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "id and name are required",
"request_id": "req_7f3a9c21",
"error": "id and name are required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
API Keys
Rename API Key
Change the display name of an existing API key.
PUT
/
api
/
account
/
keys
curl -X PUT "https://developer.encrata.com/api/account/keys" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"id": "a1b2c3d4-0000-4000-8000-000000000000", "name": "Production key"}'
{
"message": "API key renamed"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "id and name are required",
"request_id": "req_7f3a9c21",
"error": "id and name are required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
Authentication
Requires an API key in theAuthorization header.
Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Request
The key’s database id, as returned by
List API keys. Not the
key_prefix.The new display name. Trimmed, non-blank, and at most 100 bytes. Duplicate
names are currently allowed.
Example request
curl -X PUT "https://developer.encrata.com/api/account/keys" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"id": "a1b2c3d4-0000-4000-8000-000000000000", "name": "Production key"}'
Response
{
"message": "API key renamed"
}
Permissions
readonly members get 403. A tech member can only rename their own keys;
only a workspace admin can rename another member’s key. A key that is out of
your scope returns 404, the same as an unknown id.
Errors
Errors return the shared envelope withsuccess, result.code, message, and
request_id. A legacy error key is included alongside it.
curl -X PUT "https://developer.encrata.com/api/account/keys" \
-H "Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"id": "a1b2c3d4-0000-4000-8000-000000000000", "name": "Production key"}'
{
"message": "API key renamed"
}
{
"success": false,
"result": { "code": "bad_request" },
"message": "id and name are required",
"request_id": "req_7f3a9c21",
"error": "id and name are required"
}
{
"success": false,
"result": { "code": "not_found" },
"message": "API key not found",
"request_id": "req_7f3a9c21",
"error": "API key not found"
}
Was this page helpful?