Get live account usage

GET/accounts/{account_id}/containers/usage

Get current live resource usage and maximum limits for your account. Usage includes active and assigned instances.

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

Path ParametersExpand Collapse

account_id: string

ReturnsExpand Collapse

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: object { maximum, usage, utilization }

Current live usage, maximum limits, and utilization percentages for your account. Usage includes active and assigned instances and is a current snapshot, not a historical or billable metric.

maximum: object { disk_mb, memory_mib, vcpus }

Lists account limits for the resources reported in usage.

disk_mb: number

Maximum disk in MB for the account.

memory_mib: number

Maximum memory in MiB for the account.

vcpus: number

Maximum vCPU for the account.

formatfloat

usage: object { disk_mb, instances, memory_mib, vcpus }

Lists current resource consumption for active and assigned instances.

disk_mb: number

instances: number

memory_mib: number

vcpus: number

formatfloat

utilization: object { disk_mb, memory_mib, vcpus }

Live resource utilization percentages. A value of 100 represents full utilization. Values can exceed 100 when usage exceeds quota. The API omits fields whose corresponding maximum is zero.

disk_mb: optional number

Live disk usage as a percentage of maximum disk.

formatfloat

memory_mib: optional number

Live memory usage as a percentage of maximum memory.

formatfloat

vcpus: optional number

Live vCPU usage as a percentage of maximum vCPU.

formatfloat

success: boolean

Whether the API call was successful.

Get live account usage

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/containers/usage \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "maximum": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "usage": {
      "disk_mb": 0,
      "instances": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "utilization": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    }
  },
  "success": true
}

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"
      }
    }
  ],
  "result": {
    "maximum": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "usage": {
      "disk_mb": 0,
      "instances": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "utilization": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    }
  },
  "success": true
}