DEdeepl
AdminApi

Rename a developer key as an admin

Changed on

Change the label of a developer key. Labels are for your own bookkeeping and do not affect the key's permissions. Requires an Admin API key.

put/v2/admin/developer-keys/label

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v2/admin/developer-keys/label
  • Auth
    API key in header Authorization

Request body

key_idstring required

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

labelstring required

API key label.

Example request

{
  "key_id": "ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38",
  "label": "developer key prod"
}

Response

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

key_idstring

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

labelstring

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

creation_timestring

Timestamp when the key was created (ISO 8601 format)

deactivated_timestring

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

is_deactivatedboolean

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

Example response

{
  "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,
    "speech_to_speech_milliseconds": 3600000
  }
}

Changes

  • c7c91cfac5c0Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the optional property / to the response with the status