Skip to content
Cloudflare API
Start here
API Reference
Magic Transit
Connectors

Add a connector to your account

magic_transit.connectors.create(ConnectorCreateParams**kwargs) -> ConnectorCreateResponse
POST/accounts/{account_id}/magic/connectors

Add a connector to your 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
Accepted Permissions (at least one required)
Magic WAN Write
ParametersExpand Collapse
account_id: str

Account identifier

maxLength32
device: Device

Exactly one of id, serial_number, or provision_license must be provided.

id: Optional[str]
provision_license: Optional[bool]

When true, create and provision a new licence key for the connector.

serial_number: Optional[str]
activated: Optional[bool]
interrupt_window_days_of_week: Optional[List[Literal["Sunday", "Monday", "Tuesday", 4 more]]]

Allowed days of the week for upgrades. Default is all days.

One of the following:
"Sunday"
"Monday"
"Tuesday"
"Wednesday"
"Thursday"
"Friday"
"Saturday"
interrupt_window_duration_hours: Optional[float]
maximum24
minimum1
interrupt_window_embargo_dates: Optional[SequenceNotStr[str]]

List of dates (YYYY-MM-DD) when upgrades are blocked.

interrupt_window_hour_of_day: Optional[float]
notes: Optional[str]
timezone: Optional[str]
ReturnsExpand Collapse
class ConnectorCreateResponse: …
id: str
activated: bool
interrupt_window_days_of_week: List[Literal["Sunday", "Monday", "Tuesday", 4 more]]

Allowed days of the week for upgrades. Default is all days.

One of the following:
"Sunday"
"Monday"
"Tuesday"
"Wednesday"
"Thursday"
"Friday"
"Saturday"
interrupt_window_duration_hours: float
maximum24
minimum1
interrupt_window_embargo_dates: List[str]

List of dates (YYYY-MM-DD) when upgrades are blocked.

interrupt_window_hour_of_day: float
last_updated: str
notes: str
timezone: str
device: Optional[Device]
id: str
serial_number: Optional[str]
last_heartbeat: Optional[str]
last_seen_version: Optional[str]
license_key: Optional[str]

Add a connector to your account

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
connector = client.magic_transit.connectors.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    device={},
)
print(connector.id)
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "id": "id",
    "activated": true,
    "interrupt_window_days_of_week": [
      "Sunday"
    ],
    "interrupt_window_duration_hours": 1,
    "interrupt_window_embargo_dates": [
      "string"
    ],
    "interrupt_window_hour_of_day": 0,
    "last_updated": "last_updated",
    "notes": "notes",
    "timezone": "timezone",
    "device": {
      "id": "id",
      "serial_number": "serial_number"
    },
    "last_heartbeat": "last_heartbeat",
    "last_seen_version": "last_seen_version",
    "license_key": "license_key"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "id": "id",
    "activated": true,
    "interrupt_window_days_of_week": [
      "Sunday"
    ],
    "interrupt_window_duration_hours": 1,
    "interrupt_window_embargo_dates": [
      "string"
    ],
    "interrupt_window_hour_of_day": 0,
    "last_updated": "last_updated",
    "notes": "notes",
    "timezone": "timezone",
    "device": {
      "id": "id",
      "serial_number": "serial_number"
    },
    "last_heartbeat": "last_heartbeat",
    "last_seen_version": "last_seen_version",
    "license_key": "license_key"
  },
  "success": true
}