---
title: Get Custom Hostname Quota
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Custom Hostnames](https://developers.cloudflare.com/api/resources/custom_hostnames)
[Quota](https://developers.cloudflare.com/api/resources/custom_hostnames/subresources/quota)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get Custom Hostname Quota
GET/zones/{zone\_id}/custom\_hostnames/quota
Returns custom hostname quota usage for a zone. The allocated quota is a soft limit; creating custom hostnames after usage exceeds this limit can still succeed until the hard cap is reached. Use the exceeded and hard\_cap fields to track when usage is above the soft limit and when new custom hostname creation will be rejected.
##### 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)
`SSL and Certificates Write``SSL and Certificates Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of string
Informational messages returned by the custom hostname API.
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional object {allocated, exceeded, hard\_cap, used }
allocated: number
The allocated custom hostname quota.
formatint64
Link to this property
exceeded: boolean
Whether the current usage has exceeded the allocated quota.
Link to this property
hard\_cap: number
The maximum number of custom hostnames allowed before create requests are rejected.
formatint64
Link to this property
used: number
The number of custom hostnames currently in use.
formatint64
Link to this property
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Get Custom Hostname Quota
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/custom_hostnames/quota \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
"string"
],
"success": true,
"result": {
"allocated": 100,
"exceeded": false,
"hard_cap": 200,
"used": 50
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
"string"
],
"success": true,
"result": {
"allocated": 100,
"exceeded": false,
"hard_cap": 200,
"used": 50
}
}
```