cloudflare
Version:
The official TypeScript library for the Cloudflare API
83 lines • 3.02 kB
TypeScript
import { APIResource } from "../../../../core/resource.js";
import { APIPromise } from "../../../../core/api-promise.js";
import { RequestOptions } from "../../../../internal/request-options.js";
export declare class BaseRoas extends APIResource {
static readonly _key: readonly ['radar', 'bgp', 'rpki', 'roas'];
/**
* Retrieves RPKI ROA (Route Origin Authorization) validation ratios over time.
* Returns the selected metric as a time series. Supports filtering by ASN or
* location (country code) — multiple values of the same filter type produce one
* series per value. If no ASN or location is specified, returns the global
* aggregate.
*
* @example
* ```ts
* const response =
* await client.radar.bgp.rpki.roas.timeseries();
* ```
*/
timeseries(query?: RoaTimeseriesParams | null | undefined, options?: RequestOptions): APIPromise<RoaTimeseriesResponse>;
}
export declare class Roas extends BaseRoas {
}
export interface RoaTimeseriesResponse {
meta: RoaTimeseriesResponse.Meta;
serie_0: RoaTimeseriesResponse.Serie0;
}
export declare namespace RoaTimeseriesResponse {
interface Meta {
/**
* Timestamp of the underlying data.
*/
dataTime: string;
/**
* Timestamp when the query was executed.
*/
queryTime: string;
}
interface Serie0 {
timestamps: Array<string>;
values: Array<string>;
}
}
export interface RoaTimeseriesParams {
/**
* Filters results by Autonomous System Number. Specify one or more ASNs. Multiple
* values generate one series per ASN.
*/
asn?: Array<string>;
/**
* End of the date range (inclusive). Alternative to `dateRange`; provide together
* with `dateStart`.
*/
dateEnd?: string;
/**
* Start of the date range (inclusive). Alternative to `dateRange`; provide
* together with `dateEnd`.
*/
dateStart?: string;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by location. Specify a comma-separated list of alpha-2 location
* codes.
*/
location?: Array<string>;
/**
* Which RPKI ROA validation metric to return. validPfxsRatio = ratio of RPKI-valid
* prefixes (IPv4+IPv6 combined). validPfxsV4Ratio / validPfxsV6Ratio = same, split
* by IP version. validIpsRatio = ratio of RPKI-valid address space (IPv4 /24s +
* IPv6 /48s). validIpsV4Ratio / validIpsV6Ratio = same, split by IP version.
*/
metric?: 'validPfxsRatio' | 'validPfxsV4Ratio' | 'validPfxsV6Ratio' | 'validIpsRatio' | 'validIpsV4Ratio' | 'validIpsV6Ratio';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export declare namespace Roas {
export { type RoaTimeseriesResponse as RoaTimeseriesResponse, type RoaTimeseriesParams as RoaTimeseriesParams, };
}
//# sourceMappingURL=roas.d.ts.map