Connect Retool to DigitalOcean
You can connect to DigitalOcean using Retool's REST API integration and make it available as a resource. Once complete, you can write queries to interact with the DigitalOcean API.
Requirements
All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.
To create your DigitalOcean resource, you need:
DigitalOcean uses Bearer (token) authentication. You must provide an API key or access token for Retool to authorize requests. Refer to the DigitalOcean documentation on authenticating requests to learn how to obtain an API key or access token.
If DigitalOcean is behind a firewall, you must also allow access from Retool's IP addresses. Add these IP addresses to your firewall's allowlist before you create the resource.
1. Create a new resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new, then select Resource.
Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Select the REST API integration.
2. Configure the resource
Provide the necessary details to configure the resource so Retool can connect to DigitalOcean. Not all settings are required but refer to the DigitalOcean documentation to learn what is needed.
General
These settings configure the name and location of the resource within Retool.
Name
The name to use for the resource (e.g., DigitalOcean).
Folder
The folder in which to save the resource.
Description
A brief description of the resource (e.g., DigitalOcean data).
Credentials
These settings configure how Retool connects to DigitalOcean.
Base URL
The base URL for the DigitalOcean API. This must be an absolute URL. Use https://api.digitalocean.com/v2/
.
URL parameters
Key-value pairs to include as URL parameters with DigitalOcean API requests. No additional URL parameters are required.
Headers
Key-value pairs to include as headers with DigitalOcean API requests. Include the following key-value pairs:
Key | Value |
---|---|
Authorization | Bearer TOKEN |
Body
Key-value pairs to include in the body of DigitalOcean API requests. No additional body values are required.
Cookies
Cookies to include with DigitalOcean API requests. No cookies are required.
Authentication
The method of authentication to use with DigitalOcean. Select Bearer
.
Forward all cookies
Whether to forward all cookies. This is useful if you have dynamic cookie names.
3. Save the resource
Click Create resource to complete the setup. You can then click either Create an app to immediately start building a Retool app or Back to resources to return to the list of resources.
Wrap up
Your DigitalOcean resource is now ready to use. You write queries to make API requests by specifying the request method and endpoint, additional parameters to include, and the request body.
To verify you can successfully interact with DigitalOcean, write a test query to retrieve some data. The following example retrieves the current user's account information.
- Request
- Response
GET https://api.digitalocean.com/v2/account
{
"account": {
"droplet_limit": 25,
"floating_ip_limit": 5,
"email": "sam@example.com",
"uuid": "957381eb6fr8156ca9dbf6d9ce5f3c78df",
"email_verified": true,
"status": "active",
"status_message": " ",
"team": {}
}
}