Create Interrupt

client.MagicTransit.Connectors.Interrupts.New(ctx, connectorID, params) (*ConnectorInterruptNewResponse, error)

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

ParametersExpand Collapse

connectorID string

params ConnectorInterruptNewParams

AccountID param.Field[string]

Path param: Account identifier

maxLength32

Reboot param.Field[ConnectorInterruptNewParamsReboot]Optional

Body param

Purge boolOptional

Purge connector state.

Restart param.Field[ConnectorInterruptNewParamsRestart]Optional

Body param

Purge boolOptional

Purge connector state.

Shutdown param.Field[ConnectorInterruptNewParamsShutdown]Optional

Body param

Purge boolOptional

Purge connector state.

ReturnsExpand Collapse

type ConnectorInterruptNewResponse struct{…}

Interrupt action for a connector.

SubmittedAt string

Reboot ConnectorInterruptNewResponseRebootOptional

Purge boolOptional

Purge connector state.

Restart ConnectorInterruptNewResponseRestartOptional

Purge boolOptional

Purge connector state.

Shutdown ConnectorInterruptNewResponseShutdownOptional

Purge boolOptional

Purge connector state.

TriggeredAt stringOptional

Create Interrupt

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/magic_transit"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  interrupt, err := client.MagicTransit.Connectors.Interrupts.New(
    context.TODO(),
    "connector_id",
    magic_transit.ConnectorInterruptNewParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", interrupt.SubmittedAt)
}

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