Revoke an API key
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Replaced by a rolled key."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Replaced by a rolled key.'})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke"
payload = { "reason": "Replaced by a rolled key." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Replaced by a rolled key.\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke"
payload := strings.NewReader("{\n \"reason\": \"Replaced by a rolled key.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}: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 => json_encode([
'reason' => 'Replaced by a rolled key.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 12017,
"resource": "api-key",
"partnerId": 1069,
"name": "Redemption service",
"environment": "test",
"keyHint": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_…Qa7Z",
"last4": "Qa7Z",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
],
"status": "revoked",
"expiresAt": "2027-10-22T10:00:00Z",
"lastUsedAt": "2026-10-22T10:05:00Z",
"lastUsedIp": "203.0.113.24",
"rolledFromId": null,
"createdBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedAt": "2026-11-06T10:00:00Z",
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/api-keys/12017",
"type": "application/json"
}
}
}
}
API keys
Revoke an API key
Revokes an active key. Requests with it fail with 401 api-key-invalid within 60 seconds. API keys are managed only in the developer dashboard; API keys cannot call this operation. See API keys.
Required permissions: manage-api-keys · API keys: not allowed · Recent sign-in: required for dashboard users (15 minutes)
POST
/
partner
/
v1
/
api-keys
/
{apiKeyId}
:revoke
Revoke an API key
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Replaced by a rolled key."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Replaced by a rolled key.'})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke"
payload = { "reason": "Replaced by a rolled key." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Replaced by a rolled key.\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}:revoke"
payload := strings.NewReader("{\n \"reason\": \"Replaced by a rolled key.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/api-keys/{apiKeyId}: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 => json_encode([
'reason' => 'Replaced by a rolled key.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 12017,
"resource": "api-key",
"partnerId": 1069,
"name": "Redemption service",
"environment": "test",
"keyHint": "vk_test_01m5h6n1mjfgk9m1g3jg7bx74b_…Qa7Z",
"last4": "Qa7Z",
"scopes": [
"view-consumer-catalog",
"create-consumer-redemptions",
"view-consumer-redemptions"
],
"status": "revoked",
"expiresAt": "2027-10-22T10:00:00Z",
"lastUsedAt": "2026-10-22T10:05:00Z",
"lastUsedIp": "203.0.113.24",
"rolledFromId": null,
"createdBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedBy": {
"type": "partner-user",
"id": 4069,
"label": "ops@example.com"
},
"revokedAt": "2026-11-06T10:00:00Z",
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/api-keys/12017",
"type": "application/json"
}
}
}
}
Dashboard session only. API keys cannot call this operation.
Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Path Parameters
API key id. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.
Required range:
0 <= x <= 18446744073709552000Body
application/json
Revocation.
Reason, kept in the audit log (at most 500 characters).
Maximum string length:
500Response
OK
Single-object envelope around a ApiKey.
An API key (the secret is never returned after creation).
Show child attributes
Show child attributes