Interface InstanceFetchOptions

Name

InstanceFetchOptions

Description

Instance fetch filter.

Param: url

URL of the instance to search.

Param: type

Type of the instances to search.

Param: region

Region of the instances to search.

Param: api_allowed

API access value to search.

Param: health

Filter instances by health.

Param: sorting

Sort by...

Param: limit

Amount of instances to fetch.

interface InstanceFetchOptions {
    api_allowed?: boolean | "any";
    health?: number | "any";
    limit?: number;
    region?: string;
    sorting?: InstanceSorting;
    type?: InstanceTypes | "all";
    url?: string;
}

Hierarchy (view full)

Properties

api_allowed? health? limit? region? sorting? type? url?

Properties

Optional api_allowed

api_allowed?: boolean | "any"

Optional health

health?: number | "any"

Optional limit

limit?: number

Optional region

region?: string

Optional sorting

sorting?: InstanceSorting

Optional type

type?: InstanceTypes | "all"

Optional url

url?: string

Settings

Member Visibility

Theme

On This Page

api_allowedhealthlimitregionsortingtypeurl

Generated using TypeDoc