Create Interrupt

POST/accounts/{account_id}/magic/connectors/{connector_id}/interrupts

Creates an interrupt for a Magic WAN Connector.

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

Path ParametersExpand Collapse

account_id: string

Account identifier

maxLength32

connector_id: string

Body ParametersJSONExpand Collapse

reboot: optional object { purge }

purge: optional boolean

Purge connector state.

restart: optional object { purge }

purge: optional boolean

Purge connector state.

shutdown: optional object { purge }

purge: optional boolean

Purge connector state.

ReturnsExpand Collapse

errors: array of object { code, message }

maxLength0

code: number

message: string

messages: array of object { code, message }

code: number

message: string

result: object { submitted_at, reboot, restart, 2 more }

Interrupt action for a connector.

submitted_at: string

reboot: optional object { purge }

purge: optional boolean

Purge connector state.

restart: optional object { purge }

purge: optional boolean

Purge connector state.

shutdown: optional object { purge }

purge: optional boolean

Purge connector state.

triggered_at: optional string

success: boolean

Create Interrupt

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/magic/connectors/$CONNECTOR_ID/interrupts \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{}'

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "submitted_at": "submitted_at",
    "reboot": {
      "purge": true
    },
    "restart": {
      "purge": true
    },
    "shutdown": {
      "purge": true
    },
    "triggered_at": "triggered_at"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "submitted_at": "submitted_at",
    "reboot": {
      "purge": true
    },
    "restart": {
      "purge": true
    },
    "shutdown": {
      "purge": true
    },
    "triggered_at": "triggered_at"
  },
  "success": true
}