Get the current status of an interconnect object

client.NetworkInterconnects.Interconnects.Status(ctx, icon, query) (*InterconnectStatusResponse, error)

GET/accounts/{account_id}/cni/interconnects/{icon}/status

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 ReadMagic Transit ReadMagic Transit Write

ParametersExpand Collapse

icon string

query InterconnectStatusParams

AccountID param.Field[string]

Customer account tag

ReturnsExpand Collapse

type InterconnectStatusResponse interface{…}

One of the following:

type InterconnectStatusResponsePending struct{…}

State InterconnectStatusResponsePendingState

type InterconnectStatusResponseDown struct{…}

State InterconnectStatusResponseDownState

Reason stringoptional

Diagnostic information, if available

type InterconnectStatusResponseUnhealthy struct{…}

State InterconnectStatusResponseUnhealthyState

Reason stringoptional

Diagnostic information, if available

type InterconnectStatusResponseHealthy struct{…}

State InterconnectStatusResponseHealthyState

Get the current status of an interconnect object

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.NetworkInterconnects.Interconnects.Status(
    context.TODO(),
    "icon",
    network_interconnects.InterconnectStatusParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "state": "Pending"
}

Returns Examples

{
  "state": "Pending"
}