Skip to main content
PUT
/
api-keys
/
{apiKey}
Update API key
curl --request PUT \
  --url https://lb.routeme.sh/api-keys/{apiKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Mgmt-Key: <api-key>' \
  --data '
{
  "allowed_domains": [
    "<string>"
  ],
  "name": "<string>",
  "active": true
}
'
{
  "id": 123,
  "name": "<string>",
  "active": true,
  "allowed_domains": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Mgmt-Key
string
header
required

Management API key from the RouteMesh dashboard. Required for customer API endpoints (/api-keys, /usage). Each request also carries the customer's RPC API key in the URL path for the RPC endpoint.

Path Parameters

​
apiKey
string
required

The API key string (not the numeric ID).

Body

application/json
​
allowed_domains
string[] | null

Replace allowed domains list. Omit to keep current value.

​
name
string | null

Update friendly name. Omit to keep current value.

​
active
boolean | null

Activate or deactivate the key. Omit to keep current value.

Response

API key updated

​
id
integer
required

Internal key ID (for filtering /usage).

​
name
string | null
required

Friendly name.

​
active
boolean
required

Whether the key is active.

​
allowed_domains
string[]
required

Allowed domains.

​
routing_strategy
enum<string>
required
Available options:
economy,
performance
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required