GET /v2/droplets

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 be set to an array containing objects each representing a Droplet. These will contain the standard Droplet attributes.

Filtering Results by Tag

It's possible to request filtered results by including certain query parameters. To only list Droplets assigned to a specific tag, include the tag_name query parameter set to the name of the tag in your GET request. For example, /v2/droplets?tag_name=$TAG_NAME.

GPU Droplets

By default, only non-GPU Droplets are returned. To list only GPU Droplets, set the type query parameter to gpus. For example, /v2/droplets?type=gpus.

Servers

Query parameters

Name Type Required Description
page Integer No

Which 'page' of paginated results to return.

Default value: 1

tag_name String No

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

name String No

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

per_page Integer No

Number of items returned per page

Default value: 20

type String No

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.

Possible values:

  • "gpus"
  • "droplets"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.