Auth API

Revoke Leaked Key

Revoke an API key by submitting its secret. Use this when you find a Serval API key secret somewhere it shouldn’t be, such as a public repository, a log file, or a chat message. No authentication is required, so anyone who finds a leaked secret can take it out of service immediately.

Serval API key secrets start with svl_secret_ and end in a checksum, so a secret scanner can match them with the pattern svl_secret_(pk|wk|mk)_[0-9A-Za-z]{49}.

Revoking a key stops it from creating new access tokens and ends the sessions of tokens it already created. Revocation can’t be undone. To keep using the API, create a new key from the API Settings page.

Example Request

curl -X POST https://public.api.serval.com/v2/auth/revoke \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "secret=svl_secret_pk_..."

Response

The response is 200 OK with an empty body whether the secret matched a live key, a key that was already revoked, or nothing at all. The endpoint deliberately doesn’t reveal whether a secret was valid.

POST

auth

revoke

Revoke Leaked Key

curl --request POST \
  --url https://public.api.serval.com/v2/auth/revoke \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'secret=<string>'

import requests

url = "https://public.api.serval.com/v2/auth/revoke"

payload = { "secret": "<string>" }
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({secret: '<string>'})
};

fetch('https://public.api.serval.com/v2/auth/revoke', 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://public.api.serval.com/v2/auth/revoke",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "secret=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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://public.api.serval.com/v2/auth/revoke"

	payload := strings.NewReader("secret=%3Cstring%3E")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/auth/revoke")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("secret=%3Cstring%3E")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/auth/revoke")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "secret=%3Cstring%3E"

response = http.request(request)
puts response.read_body

{
  "code": "not_found",
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

{
  "error": "slow_down",
  "error_description": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

Authentication and permissions

Token requirements: No caller token required.

Body

application/x-www-form-urlencoded

secret

string

required

The API key secret to revoke.

Response

The request was processed. If the secret matched a key, that key is now revoked. The body is empty.

Revoke Leaked Key

curl --request POST \
  --url https://public.api.serval.com/v2/auth/revoke \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'secret=<string>'

import requests

url = "https://public.api.serval.com/v2/auth/revoke"

payload = { "secret": "<string>" }
headers = {"Content-Type": "application/x-www-form-urlencoded"}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({secret: '<string>'})
};

fetch('https://public.api.serval.com/v2/auth/revoke', 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://public.api.serval.com/v2/auth/revoke",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "secret=%3Cstring%3E",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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://public.api.serval.com/v2/auth/revoke"

	payload := strings.NewReader("secret=%3Cstring%3E")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/auth/revoke")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("secret=%3Cstring%3E")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/auth/revoke")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "secret=%3Cstring%3E"

response = http.request(request)
puts response.read_body

{
  "code": "not_found",
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

{
  "error": "slow_down",
  "error_description": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "detail": {
    "type": "<string>",
    "value": "<string>",
    "debug": {}
  }
}

​Authentication and permissions

Body

Response

Authentication and permissions