Skip to main content
GET
List Egress Top Destinations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id
string
required

The appId field.

id
string
required

The id field.

Query Parameters

blocked_only
boolean

Restricts results to destinations with at least one denied row -- equivalent to verdict = TB_TRAFFIC_OUTCOME_DENIED, offered separately so the UI can drive it from a standalone toggle.

host_contains
string

Case-insensitive substring match against dest_host. Empty means "every destination".

include_trend
boolean

When set, each returned TBTopDestination carries a call_count trend bucketed across trend_buckets equal-width buckets over [since, until).

limit
integer<int32>

The limit field.

offset
integer<int32>

The offset field.

principal_kind
string

Exact match against source_principal_kind. Empty means "every kind".

since
string<int64>

The since field.

trend_buckets
integer<int32>

Bucket count for include_trend. 0 defaults to 14; capped at 60.

until
string<int64>

The until field.

verdict
enum<string>

Restricts results to destinations with at least one row of this outcome. TB_TRAFFIC_OUTCOME_UNSPECIFIED applies no verdict filter.

Available options:
TB_TRAFFIC_OUTCOME_UNSPECIFIED,
TB_TRAFFIC_OUTCOME_ALLOWED,
TB_TRAFFIC_OUTCOME_DENIED

Response

200 - application/json

Successful response

The EdgeServiceListEgressTopDestinationsResponse message.

destinations
Tb Top Destination · object[] | null

Ordered by call_count descending, limited to limit. No pagination cursor -- this is a fixed top-N, not a full list.

distinctDestinationCount
string<int64>

uniqExact(dest_host) over the whole window, unaffected by any request filter -- lets the UI show "top N of distinct_destination_count destinations".

matchingDestinationCount
string<int64>

Count of destinations matching the request's filters (host_contains, verdict, principal_kind, blocked_only), independent of limit/offset -- the paging total for the Dense table.