Skip to content
Cloudflare API
Start here
API Reference
Addressing
LOA Documents

Upload LOA Document

addressing.loa_documents.create(LOADocumentCreateParams**kwargs) -> LOADocumentCreateResponse
POST/accounts/{account_id}/addressing/loa_documents

Submit LOA document (pdf format) under 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 Write
ParametersExpand Collapse
account_id: str

Identifier of a Cloudflare account.

maxLength32
loa_document: str

LOA document to upload.

ReturnsExpand Collapse
class LOADocumentCreateResponse: …
id: Optional[str]

Identifier for the uploaded LOA document.

maxLength32
account_id: Optional[str]

Identifier of a Cloudflare account.

maxLength32
auto_generated: Optional[bool]

Whether the LOA has been auto-generated for the prefix owner by Cloudflare.

created: Optional[datetime]
formatdate-time
filename: Optional[str]

Name of LOA document. Max file size 10MB, and supported filetype is pdf.

size_bytes: Optional[int]

File size of the uploaded LOA document.

verified: Optional[bool]

Whether the LOA has been verified by Cloudflare staff.

verified_at: Optional[datetime]

Timestamp of the moment the LOA was marked as validated.

formatdate-time

Upload LOA Document

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
)
loa_document = client.addressing.loa_documents.create(
    account_id="258def64c72dae45f3e4c8516e2111f2",
    loa_document="@document.pdf",
)
print(loa_document.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": "d933b1530bc56c9953cf8ce166da8004",
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "auto_generated": true,
    "created": "2014-01-01T05:20:00.12345Z",
    "filename": "site_loa_doc.pdf",
    "size_bytes": 444,
    "verified": true,
    "verified_at": "2019-12-27T18:11:19.117Z"
  }
}
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": "d933b1530bc56c9953cf8ce166da8004",
    "account_id": "258def64c72dae45f3e4c8516e2111f2",
    "auto_generated": true,
    "created": "2014-01-01T05:20:00.12345Z",
    "filename": "site_loa_doc.pdf",
    "size_bytes": 444,
    "verified": true,
    "verified_at": "2019-12-27T18:11:19.117Z"
  }
}