Delete Api Key

Deactivate an API key. Requires JWT Bearer authentication with the token received from the login endpoint.

Authorization

AuthorizationRequiredBearer <token>

🚀 OAuth2 authentication via secure identity provider

In: header

Scope: openid, email, profile

AuthorizationRequiredBearer <token>

🎫 JWT Bearer token from OAuth2 login or direct token

In: header

Authorization<token>

🗝️ API key in format: 'Bearer sk-xxxxxx'

In: header

Path Parameters

key_idRequiredKey Id

Response Body

Schema for API key in database response.

TypeScript Definitions

Use the response body type in TypeScript.

idRequiredId

key_prefixRequiredKey Prefix

namestring | null | null

created_atRequiredCreated At

Format: "date-time"

is_activeRequiredIs Active

is_defaultIs Default

Default: false

encrypted_keystring | null | null

encryption_versionEncryption Version

Default: 1

Validation Error

TypeScript Definitions

Use the response body type in TypeScript.

detailDetail

@minItems 0

curl -X DELETE "https://example.com/api/v1/auth/keys/0" \
  -H "Authorization: Bearer <token>"

fetch("https://example.com/api/v1/auth/keys/0", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})

package main

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

func main() {
  url := "https://example.com/api/v1/auth/keys/0"

  req, _ := http.NewRequest("DELETE", url, nil)
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/api/v1/auth/keys/0"

response = requests.request("DELETE", url, headers = {
  "Authorization": "Bearer <token>"
})

print(response.text)

{
  "id": 0,
  "key_prefix": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "is_default": false,
  "encrypted_key": "string",
  "encryption_version": 1
}

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

How is this guide?