Get Advertisement Status

Deprecated

client.Addressing.Prefixes.AdvertisementStatus.Get(ctx, prefixID, query) (*PrefixAdvertisementStatusGetResponse, error)

GET/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status

View the current advertisement state for a prefix.

Deprecated: Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing subnets of an IP prefix.

Security

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 Transit ReadMagic Transit WriteIP Prefixes: WriteIP Prefixes: ReadIP Prefixes: BGP On Demand WriteIP Prefixes: BGP On Demand Read

ParametersExpand Collapse

prefixID string

Identifier of an IP Prefix.

maxLength32

query PrefixAdvertisementStatusGetParams

AccountID param.Field[string]

Identifier of a Cloudflare account.

maxLength32

ReturnsExpand Collapse

type PrefixAdvertisementStatusGetResponse struct{…}

Advertised boolOptional

Advertisement status of the prefix. If true, the BGP route for the prefix is advertised to the Internet. If false, the BGP route is withdrawn.

AdvertisedModifiedAt TimeOptional

Last time the advertisement status was changed. This field is only not ‘null’ if on demand is enabled.

formatdate-time

Get Advertisement Status

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/addressing"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  advertisementStatus, err := client.Addressing.Prefixes.AdvertisementStatus.Get(
    context.TODO(),
    "2af39739cc4e3b5910c918468bb89828",
    addressing.PrefixAdvertisementStatusGetParams{
      AccountID: cloudflare.F("258def64c72dae45f3e4c8516e2111f2"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", advertisementStatus.Advertised)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}