Skip to main content
PUT
/
v2
/
admin
/
developer-keys
/
label
Rename a developer key as an admin
curl --request PUT \
  --url https://api.deepl.com/v2/admin/developer-keys/label \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key_id": "ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38",
  "label": "developer key prod"
}
'
{
  "key_id": "ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38",
  "label": "developer key prod",
  "creation_time": "2025-07-08T08:15:29.362Z",
  "deactivated_time": "2025-07-09T08:15:29.362Z",
  "is_deactivated": true,
  "usage_limits": {
    "characters": 5000,
    "speech_to_text_milliseconds": 3600000
  }
}

Authorizations

​
Authorization
string
header
default:DeepL-Auth-Key
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Body

application/json
​
key_id
string
required

API key ID. Consists of two valid GUIDs separated by a colon.

Example:

"ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38"

​
label
string
required

API key label.

Example:

"developer key prod"

Response

The set label function returns a JSON representation of the renamed API key.

The API key.

​
key_id
string

API key ID. Consists of two valid GUIDs separated by a colon.

Example:

"ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38"

​
label
string

API key label. The default value is DeepL API Key.

Example:

"developer key prod"

​
creation_time
string

Timestamp when the key was created (ISO 8601 format)

Example:

"2025-07-08T08:15:29.362Z"

​
deactivated_time
string

Timestamp when the key was deactivated (ISO 8601 format). The default value is null.

Example:

"2025-07-09T08:15:29.362Z"

​
is_deactivated
boolean

Flag indicating whether the API key is deactivated. The default value is false.

Example:

true

​
usage_limits
object

Usage limits for the API key.