Update Prefix Description

addressing.prefixes.edit(, ) -> Prefix

PATCH/accounts/{account_id}/addressing/prefixes/{prefix_id}

Modify the description for a prefix owned by the account.

Security

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)

Magic Transit WriteIP Prefixes: Write

ParametersExpand Collapse

account_id: str

Identifier of a Cloudflare account.

maxLength32

prefix_id: str

Identifier of an IP Prefix.

maxLength32

description: str

Description of the prefix.

maxLength1000

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](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) 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]

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 = active).

asn: Optional[int]

Autonomous System Number (ASN) the prefix will be advertised under.

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]

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

Deprecatedon_demand_locked: Optional[bool]

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 provided to demonstrate ownership of the prefix.

rpki_validation_state: Optional[str]

State of one kind of validation for an IP prefix.

Update Prefix Description

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
prefix = client.addressing.prefixes.edit(
    prefix_id="2af39739cc4e3b5910c918468bb89828",
    account_id="258def64c72dae45f3e4c8516e2111f2",
    description="Internal test prefix",
)
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,
    "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,
    "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"
  }
}