Skip to main content
PATCH
/
api
/
v3
/
admin
/
api_keys
/
{id}
/
revoke
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const key = await client.apiKeys.revoke('key_xxx')
{
  "id": "key_gbHJdmfrXB",
  "name": "Backend integration",
  "key_type": "secret",
  "token_prefix": "sk_9ntyVz4oF",
  "scopes": [
    "write_all"
  ],
  "created_at": "2026-05-17T22:57:23.620Z",
  "updated_at": "2026-05-17T22:57:23.925Z",
  "revoked_at": "2026-05-17T22:57:23.923Z",
  "last_used_at": null,
  "plaintext_token": null,
  "created_by_email": null
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Response

200 - application/json

API key revoked