@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface DropletsRequestBuilderGetQueryParameters

    To list all Droplets in your account, send a GET request to /v2/droplets.The response body will be a JSON object with a key of droplets. This will beset to an array containing objects each representing a Droplet. These willcontain the standard Droplet attributes.### Filtering Results by TagIt's possible to request filtered results by including certain query parameters.To only list Droplets assigned to a specific tag, include the tag_name queryparameter set to the name of the tag in your GET request. For example,/v2/droplets?tag_name=$TAG_NAME.### GPU DropletsBy default, only non-GPU Droplets are returned. To list only GPU Droplets, setthe type query parameter to gpus. For example, /v2/droplets?type=gpus.

    interface DropletsRequestBuilderGetQueryParameters {
        name?: string;
        page?: number;
        perPage?: number;
        tagName?: string;
        type?: GetTypeQueryParameterType;
    }
    Index

    Properties

    name? page? perPage? tagName? type?

    Properties

    name?: string

    Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with tag_name.

    Optionalpage

    page?: number

    Which 'page' of paginated results to return.

    perPage?: number

    Number of items returned per page

    tagName?: string

    Used to filter Droplets by a specific tag. Can not be combined with name or type.
    Requires tag:read scope.

    type?: GetTypeQueryParameterType

    When type is set to gpus, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with tag_name.

    Settings

    Member Visibility

    On This Page

    Properties