EQTY LabDocs

Revoke API key

Revoke one of the authenticated user's API keys, optionally recording a revocation reason. JWT/session only — API keys cannot manage API keys

deletehttps://localhost:8080/api/v1/api-keys/{keyId}
bash
curl --request DELETE \
  --url 'https://localhost:8080/api/v1/api-keys/{keyId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"reason":"Key compromised"}'
javascript
const response = await fetch("https://localhost:8080/api/v1/api-keys/{keyId}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "reason": "Key compromised"
  })
});

const data = await response.json();
typescript
interface SuccessResponse {
  message?: string;
}

const response = await fetch("https://localhost:8080/api/v1/api-keys/{keyId}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "reason": "Key compromised"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: SuccessResponse = await response.json();
python
import requests

response = requests.delete(
    "https://localhost:8080/api/v1/api-keys/{keyId}",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "reason": "Key compromised",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "reason": "Key compromised"
	}`)
	req, err := http.NewRequest(http.MethodDelete, "https://localhost:8080/api/v1/api-keys/{keyId}", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/api-keys/{keyId}"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("DELETE", HttpRequest.BodyPublishers.ofString("""
                {
                  "reason": "Key compromised"
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Delete, "https://localhost:8080/api/v1/api-keys/{keyId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "reason": "Key compromised"
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/api/v1/api-keys/{keyId}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "reason": "Key compromised"
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/api/v1/api-keys/{keyId}")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "reason": "Key compromised"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .delete("https://localhost:8080/api/v1/api-keys/{keyId}")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "reason": "Key compromised"
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token

Parameters

Path parameters

NameTypeDescription
keyId
required
string

API Key ID

Request body

Optional revocation reason

application/json
  • reasonstring

    Defaults to "Revoked by user"

Examplejson
{
  "reason": "Key compromised"
}

Responses

200API key revoked successfully

application/json
  • messagestring
Examplejson
{
  "message": "Operation completed successfully"
}

400Bad request - Invalid key ID

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401Unauthorized - Authentication required

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403Forbidden - API keys cannot manage API keys, or can only revoke own API keys

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404API key not found

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

409API key already revoked

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Internal server error

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}