WanguardInstall

Summary

Retrieve multiple BGP announcements from Wanguard with optional filtering, sorting, pagination, and count-only options.

Inputs

• Status — Filter BGP announcements by their status, either 'Active' or 'Withdrawn'.
• Prefix — Filter BGP announcements by the specified network prefix string.
• BGP Connector ID — Filter BGP announcements associated with a specific BGP connector ID (numeric).
• Sort — Sort the result set by a field name with an optional ASC or DESC direction, for example, 'field_name ASC'.
• Count Only — If enabled, return only the count of matching BGP announcements instead of full data records.
• Limit — Limit the maximum number of BGP announcements returned; must be at least 1. Defaults to 50.
• Offset — Skip the specified number of announcements before starting to return results. Defaults to 0.

Output shape

a list of BGP announcement items or a single object with a count if 'Count Only' is enabled

The output is a JSON array of BGP announcement objects by default. If 'Count Only' is set to true, the output contains only the total count of matching announcements. Pagination applies via 'Limit' and 'Offset' parameters.

Examples

Example 1: Get active BGP announcements for a prefix sorted by timestamp descending, limited to 10 results.

Filters: Status=Active, Prefix='prefix_string'; Options: Sort='timestamp DESC', Limit=10, Offset=0

Example 2: Get only the count of withdrawn BGP announcements.

Filters: Status=Withdrawn; Options: Count Only=true