Skip to main content
PUT
/
api-keys
/
{id}
Update API key
curl --request PUT \
  --url https://api.routeme.sh/api-keys/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "allowed_domains": [
    "<string>"
  ],
  "name": "<string>",
  "active": true
}
'
import requests

url = "https://api.routeme.sh/api-keys/{id}"

payload = {
"allowed_domains": ["<string>"],
"name": "<string>",
"active": True
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({allowed_domains: ['<string>'], name: '<string>', active: true})
};

fetch('https://api.routeme.sh/api-keys/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.routeme.sh/api-keys/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'allowed_domains' => [
'<string>'
],
'name' => '<string>',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.routeme.sh/api-keys/{id}"

payload := strings.NewReader("{\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"active\": true\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.routeme.sh/api-keys/{id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.routeme.sh/api-keys/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allowed_domains\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "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-Api-Key
string
header
required

Management token from the RouteMesh dashboard (Settings → Management Tokens). Required for customer API endpoints (/api-keys, /usage). Tokens are prefixed rmtm_ and scoped to your account. Authenticate by passing the token in the X-Api-Key header. Separate from RPC service keys (rm_), which authenticate dApp traffic to the routing layer.

Path Parameters

id
integer
required

Numeric API key ID (from GET /api-keys). Not the secret rm_ key string.

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