Get DNS Record Usage for Account

client.dns.usage.account.get(, ?): AccountGetResponse { record_quota, record_usage, internal_record_quota, internal_record_usage }

GET/accounts/{account_id}/dns_records/usage

Get the current DNS record usage and quota for an account. May include internal DNS usage and quota.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Account DNS Settings WriteAccount DNS Settings Read

ParametersExpand Collapse

params: AccountGetParams { account_id }

account_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

AccountGetResponse { record_quota, record_usage, internal_record_quota, internal_record_usage }

record_quota: number | null

Maximum number of DNS records allowed across all public zones in the account. Null if using zone-level quota.

minimum0

record_usage: number

Current number of DNS records across all public zones in the account.

minimum0

internal_record_quota?: number

Maximum number of DNS records allowed across all internal zones in the account. Only present if internal DNS is enabled.

minimum0

internal_record_usage?: number

Current number of DNS records across all internal zones in the account. Only present if internal DNS is enabled.

minimum0

Get DNS Record Usage for Account

import Cloudflare from 'cloudflare';

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

const account = await client.dns.usage.account.get({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(account.record_quota);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "record_quota": 1000000,
    "record_usage": 5000,
    "internal_record_quota": 1000000,
    "internal_record_usage": 5000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "record_quota": 1000000,
    "record_usage": 5000,
    "internal_record_quota": 1000000,
    "internal_record_usage": 5000
  }
}