Type Alias ListServersRequest

ListServersRequest: {
    commercialType?: string;
    name?: string;
    order?: ListServersRequestOrder;
    organization?: string;
    page?: number;
    perPage?: number;
    privateIp?: string;
    privateNetwork?: string;
    privateNetworks?: string[];
    privateNicMacAddress?: string;
    project?: string;
    servers?: string[];
    state?: ServerState;
    tags?: string[];
    withIp?: string;
    withoutIp?: boolean;
    zone?: Zone;
}

Type declaration

  • OptionalcommercialType?: string

    List Instances of this commercial type.

  • Optionalname?: string

    Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo").

  • Optionalorder?: ListServersRequestOrder

    Define the order of the returned servers.

  • Optionalorganization?: string

    List only Instances of this Organization ID.

  • 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.

  • OptionalprivateIp?: string

    Deprecated

    List Instances by private_ip.

  • OptionalprivateNetwork?: string

    List Instances in this Private Network.

  • OptionalprivateNetworks?: string[]

    List Instances from the given Private Networks (use commas to separate them).

  • OptionalprivateNicMacAddress?: string

    List Instances associated with the given private NIC MAC address.

  • Optionalproject?: string

    List only Instances of this Project ID.

  • Optionalservers?: string[]

    List Instances from these server ids (use commas to separate them).

  • Optionalstate?: ServerState

    List Instances in this state.

  • Optionaltags?: string[]

    List Instances with these exact tags (to filter with several tags, use commas to separate them).

  • OptionalwithIp?: string

    List Instances by IP (both private_ip and public_ip are supported).

  • OptionalwithoutIp?: boolean

    List Instances that are not attached to a public IP.

  • Optionalzone?: Zone

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

Settings