Skip to main content
POST
/
admin
/
api-keys
/
{id}
/
revoke
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.apiKey.revoke("apk_123")
.then(({ api_key }) => {
  console.log(api_key)
})
{
  "api_key": {
    "id": "<string>",
    "token": "<string>",
    "redacted": "sk_...123",
    "title": "<string>",
    "type": "secret",
    "last_used_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "revoked_by": "<string>",
    "revoked_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The API key's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The details of revoking the API key.

​
revoke_in
number

The time in seconds to revoke the API key after. If not set, the API key is revoked immediately.

Response

OK

The API key's details.

​
api_key
object
required

The API key's details.