List all Droplets with DigitalOcean API

Pipedream makes it easy to connect APIs for DigitalOcean and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List all Droplets with the DigitalOcean API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List all Droplets with the DigitalOcean API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List all Droplets action
1. Connect your DigitalOcean account
2. Configure Include all
3. Optional- Configure Tag name
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List all Droplets with DigitalOcean API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + DigitalOcean

Try it

List all Droplets with DigitalOcean API on New Message (Instant) from Discord API

Discord + DigitalOcean

Try it

List all Droplets with DigitalOcean API on New Message In Channels (Instant) from Slack API

Slack + DigitalOcean

Try it

List all Droplets with DigitalOcean API on New Message in Channel from Discord Bot API

Discord Bot + DigitalOcean

Try it

List all Droplets with DigitalOcean API on New Submission from Typeform API

Typeform + DigitalOcean

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List all Droplets on DigitalOcean

Description:List all Droplets. [See the docs here](https://docs.digitalocean.com/reference/api/api-reference/#operation/list_all_droplets)

Version:0.0.1

Key:digital_ocean-list-all-droplets

View on GitHub

Code#

import digitalOceanApp from "../../digital_ocean.app.mjs";
import digitalOceanConstants from "../../common/constants.mjs";

export default {
  key: "digital_ocean-list-all-droplets",
  name: "List all Droplets",
  description: "List all Droplets. [See the docs here](https://docs.digitalocean.com/reference/api/api-reference/#operation/list_all_droplets)",
  version: "0.0.1",
  type: "action",
  props: {
    digitalOceanApp,
    includeAll: {
      label: "Include all",
      type: "boolean",
      description: "Select either fetch all items or paginated results.",
      default: true,
      reloadProps: true,
    },
    tagName: {
      label: "Tag name",
      type: "string",
      description: "Optionally used to filter by a specific tag.\n\n**Example:** `production`",
      optional: true,
    },
  },
  async additionalProps() {
    if (this.includeAll === true) {
      return {};
    }
    return {
      currentPage: {
        label: "Current page",
        type: "integer",
        description: "Which 'page' of paginated results to return.",
        default: digitalOceanConstants.defaultCurrentPage,
      },
      pageSize: {
        label: "Page size",
        type: "integer",
        description: "Desired pagination size when pulling results",
        default: digitalOceanConstants.defaultPageSize,
      },
    };
  },
  async run({ $ }) {
    const includeAll = this.includeAll;
    const tagName = this.tagName || undefined;
    const pageSize = this.pageSize || digitalOceanConstants.defaultCurrentPage;
    const currentPage = this.currentPage || digitalOceanConstants.defaultCurrentPage;
    const api = this.digitalOceanApp.digitalOceanWrapper(pageSize);

    const args = includeAll
      ? [
        tagName,
        includeAll,
      ]
      : [
        tagName,
        includeAll,
        currentPage,
        pageSize,
      ];
    const response = await api.droplets.getAll(...args);
    $.export("$summary", `Successfully fetched ${response?.length || response?.droplets?.length} droplet(s).`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
DigitalOcean	`digitalOceanApp`	`app`	This component uses the DigitalOcean app.
Include all	`includeAll`	`boolean`	Select either fetch all items or paginated results.
Tag name	`tagName`	`string`	Optionally used to filter by a specific tag. Example: `production`

Authentication#

DigitalOcean uses OAuth authentication. When you connect your DigitalOcean account, Pipedream will open a popup window where you can sign into DigitalOcean and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any DigitalOcean API.

Pipedream requests the following authorization scopes when you connect your account:

readwrite