Skip to content
Start here

Get live account usage

client.containers.usage(ContainerUsageParams { account_id } params, RequestOptionsoptions?): ContainerUsageResponse { maximum, usage, utilization }
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
ParametersExpand Collapse
params: ContainerUsageParams { account_id }
account_id: string

Account identifier.

ReturnsExpand Collapse
ContainerUsageResponse { 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: Maximum { 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: Usage { 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: Utilization { 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?: number

Live disk usage as a percentage of maximum disk.

formatfloat
memory_mib?: number

Live memory usage as a percentage of maximum memory.

formatfloat
vcpus?: number

Live vCPU usage as a percentage of maximum vCPU.

formatfloat

Get live account usage

import Cloudflare from 'cloudflare';

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

const response = await client.containers.usage({ account_id: 'account-123' });

console.log(response.maximum);
{
  "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
}