List Interrupts

client.magicTransit.connectors.interrupts.list(, , ?): SinglePage<InterruptListResponse { submitted_at, reboot, restart, 2 more } >

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

Lists interrupts 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

Accepted Permissions (at least one required)

Magic WAN WriteMagic WAN Read

ParametersExpand Collapse

connectorID: string

params: InterruptListParams { account_id }

account_id: string

Account identifier

maxLength32

ReturnsExpand Collapse

InterruptListResponse { submitted_at, reboot, restart, 2 more }

Interrupt action for a connector.

submitted_at: string

reboot?: Reboot { purge }

purge?: boolean

Purge connector state.

restart?: Restart { purge }

purge?: boolean

Purge connector state.

shutdown?: Shutdown { purge }

purge?: boolean

Purge connector state.

triggered_at?: string

List Interrupts

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const interruptListResponse of client.magicTransit.connectors.interrupts.list(
  'connector_id',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
)) {
  console.log(interruptListResponse.submitted_at);
}

{
  "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
}