Type Alias ListVolumesRequest

ListVolumesRequest: {
    name?: string;
    organization?: string;
    page?: number;
    perPage?: number;
    project?: string;
    tags?: string[];
    volumeType?: VolumeVolumeType;
    zone?: Zone;
}

Type declaration

  • Optionalname?: string

    Filter volume by name (for eg. "vol" will return "myvolume" but not "data").

  • Optionalorganization?: string

    Filter volume by 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.

  • Optionalproject?: string

    Filter volume by Project ID.

  • Optionaltags?: string[]

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

  • OptionalvolumeType?: VolumeVolumeType

    Filter by volume type.

  • Optionalzone?: Zone

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

Settings