Toggle My Api Key Active

Enable or disable one of the user’s own API keys.

PATCH /api/me/api-keys/{key_id}/active

Toggle My Api Key Active

cURL

curl --request PATCH \
  --url https://your-domain.com/api/me/api-keys/{key_id}/active \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": true
}
'

import requests

url = "https://your-domain.com/api/me/api-keys/{key_id}/active"

payload = { "is_active": True }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({is_active: true})
};

fetch('https://your-domain.com/api/me/api-keys/{key_id}/active', 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://your-domain.com/api/me/api-keys/{key_id}/active",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://your-domain.com/api/me/api-keys/{key_id}/active"

	payload := strings.NewReader("{\n  \"is_active\": true\n}")

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

	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.patch("https://your-domain.com/api/me/api-keys/{key_id}/active")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-domain.com/api/me/api-keys/{key_id}/active")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": true\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "key_prefix": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "scopes": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "total_requests": 0
}

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

Path Parameters

key_id · string · required

Body

application/json

is_active · boolean · required

Response

200

application/json

Successful Response

id · string · required

name · string · required

key_prefix · string · required

is_active · boolean · required

created_at · string · required

scopes · string | null

expires_at · string<date-time> | null

last_used_at · string<date-time> | null

total_requests · integer · default: 0