List BGP announces

List BGP announces with optional filtering by site, origin, announcement status, and client.

GET /security/sifter/v2/protected_addresses/announces

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
client_announces = client.security.bgp_announces.list()
print(client_announces)

package main

import (
	"context"
	"fmt"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/security"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	clientAnnounces, err := client.Security.BgpAnnounces.List(context.TODO(), security.BgpAnnounceListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", clientAnnounces)
}

curl --request GET \
  --url https://api.gcore.com/security/sifter/v2/protected_addresses/announces \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/security/sifter/v2/protected_addresses/announces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/security/sifter/v2/protected_addresses/announces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/security/sifter/v2/protected_addresses/announces")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/security/sifter/v2/protected_addresses/announces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

[
  {
    "announced": [
      "192.9.9.1/32",
      "203.0.113.1/32"
    ],
    "client_id": 128120,
    "not_announced": [
      "122.2.2.1/32",
      "120.0.113.2/32"
    ]
  }
]

{}

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

site · string | null

Required string length: 1 - 100

origin · enum<string>[] | null

Available options: STATIC, DYNAMIC, IAAS, PROTECTED_NETWORK, EDGE_PROXY

announced · boolean | null

limit · integer | null

Required range: x >= 1

offset · integer | null

Required range: x >= 0

client_id · integer | null

A positive integer ID

Required range: 1 <= x <= 1000000000

Response

200

application/json

Successful Response

client_id · integer · required

Required range: x >= 0

Example:

"128120"

announced · string<ipvanynetwork>[] · required

Example:

["192.9.9.1/32", "203.0.113.1/32"]

not_announced · string<ipvanynetwork>[] · required

Example:

["122.2.2.1/32", "120.0.113.2/32"]