Skip to content
Start here

Get override codes

client.zeroTrust.devices.overrideCodes.get(stringregistrationId, OverrideCodeGetParams { account_id } params, RequestOptionsoptions?): OverrideCodeGetResponse { disable_for_time }
GET/accounts/{account_id}/devices/registrations/{registration_id}/override_codes

Fetches one-time use admin override codes for a registration. This relies on the Admin Override setting being enabled in your device configuration.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
Accepted Permissions (at least one required)
Zero Trust ReadZero Trust Write
ParametersExpand Collapse
registrationId: string
params: OverrideCodeGetParams { account_id }
account_id: string
ReturnsExpand Collapse
OverrideCodeGetResponse { disable_for_time }
disable_for_time?: Record<string, string>

Get override codes

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const overrideCode = await client.zeroTrust.devices.overrideCodes.get('registration_id', {
  account_id: 'account_id',
});

console.log(overrideCode.disable_for_time);
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "disable_for_time": {
      "foo": "string"
    }
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "disable_for_time": {
      "foo": "string"
    }
  },
  "success": true
}