Revoke API Key

curl --request POST \
  --url https://api.example.com/v1/api-keys/{key_id}/revoke

const options = {method: 'POST'};

fetch('https://api.example.com/v1/api-keys/{key_id}/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://api.example.com/v1/api-keys/{key_id}/revoke",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/api-keys/{key_id}/revoke"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/api-keys/{key_id}/revoke")

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

request = Net::HTTP::Post.new(url)

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

{
  "created_at": "2024-01-01T00:00:00",
  "expiration_date": "2024-12-31T23:59:59",
  "key_id": "507f1f77bcf86cd799439011",
  "name": "Development API Key",
  "permissions": [
    "read",
    "write"
  ],
  "revoked": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api-keys

{key_id}

revoke

Revoke API Key

curl --request POST \
  --url https://api.example.com/v1/api-keys/{key_id}/revoke

const options = {method: 'POST'};

fetch('https://api.example.com/v1/api-keys/{key_id}/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://api.example.com/v1/api-keys/{key_id}/revoke",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/v1/api-keys/{key_id}/revoke"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/api-keys/{key_id}/revoke")

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

request = Net::HTTP::Post.new(url)

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

{
  "created_at": "2024-01-01T00:00:00",
  "expiration_date": "2024-12-31T23:59:59",
  "key_id": "507f1f77bcf86cd799439011",
  "name": "Development API Key",
  "permissions": [
    "read",
    "write"
  ],
  "revoked": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

key_id

string

required

Response

Successful Response

_id

string

required

Unique identifier for this API key in the database

name

string

required

The descriptive name given to this API key

permissions

string[]

required

List of permission scopes granted to this API key

expiration_date

string<date-time>

required

Timestamp when this API key will expire and become invalid

created_at

string<date-time>

required

Timestamp when this API key was created

created_by_user_id

string

required

Identifier of the user who created this API key

revoked

boolean

default:false

Indicates if this API key has been manually revoked before its expiration date

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Call Recording

Post-call Analysis

Phone Numbers

Knowledge Bases

Prompt Generation

Public Sharing

Webhook Subscriptions

API Keys

Revoke API Key

Path Parameters

Response