Type Alias ListIpsRequest

ListIpsRequest: {
    name?: string;
    organization?: string;
    page?: number;
    perPage?: number;
    project?: string;
    tags?: string[];
    type?: string;
    zone?: Zone;
}

Type declaration

  • Optionalname?: string

    Filter on the IP address (Works as a LIKE operation on the IP address).

  • Optionalorganization?: string

    Organization ID in which the IPs are reserved.

  • Optionalpage?: number

    A positive integer to choose the page to return.

  • OptionalperPage?: number

    A positive integer lower or equal to 100 to select the number of items to return.

  • Optionalproject?: string

    Project ID in which the IPs are reserved.

  • Optionaltags?: string[]

    Filter IPs with these exact tags (to filter with several tags, use commas to separate them).

  • Optionaltype?: string

    Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat').

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings