Skip to content
Cloudflare API
Start here
API Reference
Addressing
Prefixes

Add Prefix

addressing.prefixes.create(PrefixCreateParams**kwargs) -> Prefix
POST/accounts/{account_id}/addressing/prefixes

Add a new prefix under the account.

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
account_id: str

Identifier of a Cloudflare account.

maxLength32
asn: int

Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare’s ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.

cidr: str

IP Prefix in Classless Inter-Domain Routing format.

delegate_loa_creation: Optional[bool]

Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.

description: Optional[str]

Description of the prefix.

maxLength1000
loa_document_id: Optional[str]

Identifier for the uploaded LOA document.

maxLength32
ReturnsExpand Collapse
class Prefix: …
id: Optional[str]

Identifier of an IP Prefix.

maxLength32
account_id: Optional[str]

Identifier of a Cloudflare account.

maxLength32
Deprecatedadvertised: Optional[bool]

Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

Prefix advertisement status to the Internet. This field is only not ‘null’ if on demand is enabled.

Deprecatedadvertised_modified_at: Optional[datetime]

Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled.

formatdate-time
approved: Optional[str]

Approval state of the prefix (P = pending, V = approved). Approval does not advertise the prefix or activate traffic.

asn: Optional[int]

Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare’s ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.

asn_ownership_validation_state: Optional[Literal["pending", "valid", "missing", "invalid"]]

State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions.

One of the following:
"pending"
"valid"
"missing"
"invalid"
aspa_validation_state: Optional[Literal["pending", "valid", "invalid"]]

State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance.

One of the following:
"pending"
"valid"
"invalid"
cidr: Optional[str]

IP Prefix in Classless Inter-Domain Routing format.

created_at: Optional[datetime]
formatdate-time
delegate_loa_creation: Optional[bool]

Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.

description: Optional[str]

Description of the prefix.

maxLength1000
irr_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

loa_document_id: Optional[str]

Identifier for the uploaded LOA document.

maxLength32
modified_at: Optional[datetime]
formatdate-time
Deprecatedon_demand_enabled: Optional[bool]

Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

Deprecatedon_demand_locked: Optional[bool]

Prefer the BGP Prefixes API instead, which allows for advertising multiple BGP routes within a single IP Prefix.

Whether advertisement status of the prefix is locked, meaning it cannot be changed.

ownership_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

ownership_validation_token: Optional[str]

Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.

rpki_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

Add Prefix

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
prefix = client.addressing.prefixes.create(
    account_id="258def64c72dae45f3e4c8516e2111f2",
    asn=13335,
    cidr="192.0.2.0/24",
)
print(prefix.id)
{
  "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": {
    "id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z",
    "approved": "P",
    "asn": 13335,
    "asn_ownership_validation_state": "pending",
    "aspa_validation_state": "pending",
    "cidr": "192.0.2.0/24",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "delegate_loa_creation": true,
    "description": "Internal test prefix",
    "irr_validation_state": "pending",
    "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "on_demand_enabled": true,
    "on_demand_locked": false,
    "ownership_validation_state": "pending",
    "ownership_validation_token": "1234a5b6-1234-1abc-12a3-1234a5b6789c",
    "rpki_validation_state": "pending"
  }
}
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": {
    "id": "2af39739cc4e3b5910c918468bb89828",
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z",
    "approved": "P",
    "asn": 13335,
    "asn_ownership_validation_state": "pending",
    "aspa_validation_state": "pending",
    "cidr": "192.0.2.0/24",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "delegate_loa_creation": true,
    "description": "Internal test prefix",
    "irr_validation_state": "pending",
    "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "on_demand_enabled": true,
    "on_demand_locked": false,
    "ownership_validation_state": "pending",
    "ownership_validation_token": "1234a5b6-1234-1abc-12a3-1234a5b6789c",
    "rpki_validation_state": "pending"
  }
}