DigitalOcean

DigitalOcean module for RobinPath.

Package: @robinpath/digitalocean | Category: Devops | Type: Integration

Authentication

digitalocean.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the digitalocean module when you need to:

• listDroplets -- Use digitalocean.listDroplets to perform this operation
• getDroplet -- Use digitalocean.getDroplet to perform this operation
• createDroplet -- Use digitalocean.createDroplet to perform this operation
• deleteDroplet -- Use digitalocean.deleteDroplet to perform this operation
• dropletAction -- Use digitalocean.dropletAction to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure digitalocean credentials.	object
listDroplets	listDroplets	object
getDroplet	getDroplet	object
createDroplet	createDroplet	object
deleteDroplet	deleteDroplet	object
dropletAction	dropletAction	object
listImages	listImages	object
listRegions	listRegions	object
listSizes	listSizes	object
listDomains	listDomains	object
getDomain	getDomain	object
createDomain	createDomain	object
listDomainRecords	listDomainRecords	object
createDomainRecord	createDomainRecord	object
deleteDomainRecord	deleteDomainRecord	object
listDatabases	listDatabases	object
getDatabase	getDatabase	object
listFirewalls	listFirewalls	object
createFirewall	createFirewall	object
listLoadBalancers	listLoadBalancers	object
listVolumes	listVolumes	object
createVolume	createVolume	object
deleteVolume	deleteVolume	object
getAccount	getAccount	object
listSnapshots	listSnapshots	object

Functions

setCredentials

Configure digitalocean credentials.

Module: digitalocean | Returns: object -- API response.

digitalocean.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listDroplets

listDroplets

Module: digitalocean | Returns: object -- API response.

digitalocean.listDroplets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDroplet

getDroplet

Module: digitalocean | Returns: object -- API response.

digitalocean.getDroplet

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDroplet

createDroplet

Module: digitalocean | Returns: object -- API response.

digitalocean.createDroplet

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteDroplet

deleteDroplet

Module: digitalocean | Returns: object -- API response.

digitalocean.deleteDroplet

Parameter	Type	Required	Description
input	string	No	Input parameter

---

dropletAction

dropletAction

Module: digitalocean | Returns: object -- API response.

digitalocean.dropletAction

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listImages

listImages

Module: digitalocean | Returns: object -- API response.

digitalocean.listImages

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listRegions

listRegions

Module: digitalocean | Returns: object -- API response.

digitalocean.listRegions

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listSizes

listSizes

Module: digitalocean | Returns: object -- API response.

digitalocean.listSizes

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDomains

listDomains

Module: digitalocean | Returns: object -- API response.

digitalocean.listDomains

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDomain

getDomain

Module: digitalocean | Returns: object -- API response.

digitalocean.getDomain

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDomain

createDomain

Module: digitalocean | Returns: object -- API response.

digitalocean.createDomain

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDomainRecords

listDomainRecords

Module: digitalocean | Returns: object -- API response.

digitalocean.listDomainRecords

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDomainRecord

createDomainRecord

Module: digitalocean | Returns: object -- API response.

digitalocean.createDomainRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteDomainRecord

deleteDomainRecord

Module: digitalocean | Returns: object -- API response.

digitalocean.deleteDomainRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDatabases

listDatabases

Module: digitalocean | Returns: object -- API response.

digitalocean.listDatabases

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDatabase

getDatabase

Module: digitalocean | Returns: object -- API response.

digitalocean.getDatabase

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listFirewalls

listFirewalls

Module: digitalocean | Returns: object -- API response.

digitalocean.listFirewalls

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createFirewall

createFirewall

Module: digitalocean | Returns: object -- API response.

digitalocean.createFirewall

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listLoadBalancers

listLoadBalancers

Module: digitalocean | Returns: object -- API response.

digitalocean.listLoadBalancers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listVolumes

listVolumes

Module: digitalocean | Returns: object -- API response.

digitalocean.listVolumes

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createVolume

createVolume

Module: digitalocean | Returns: object -- API response.

digitalocean.createVolume

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteVolume

deleteVolume

Module: digitalocean | Returns: object -- API response.

digitalocean.deleteVolume

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAccount

getAccount

Module: digitalocean | Returns: object -- API response.

digitalocean.getAccount

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listSnapshots

listSnapshots

Module: digitalocean | Returns: object -- API response.

digitalocean.listSnapshots

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Digitalocean API error (${res.status}): ${t}	Check the error message for details
digitalocean.setCredentials requires accessToken.	Check the error message for details
digitalocean.deleteDroplet requires an ID.	Check the error message for details
digitalocean.deleteDomainRecord requires an ID.	Check the error message for details
digitalocean.deleteVolume requires an ID.	Check the error message for details
Digitalocean: "..." not configured. Call digitalocean.setCredentials first.	Check the error message for details

@desc "List droplets and validate result"
do
  set $result as digitalocean.listDroplets
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Droplets

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  digitalocean.setCredentials $token
enddo

@desc "List droplets and iterate results"
do
  set $result as digitalocean.listDroplets
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createDroplet

Create a new resource and capture the result.

@desc "Setup authentication"
do
  digitalocean.setCredentials $token
enddo

@desc "Create droplet"
do
  set $result as digitalocean.createDroplet
  print "Created: " + $result
enddo

3. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  digitalocean.setCredentials $token
enddo

@desc "List droplets and create droplet"
do
  set $existing as digitalocean.listDroplets
  if $existing == null
    digitalocean.createDroplet
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step DigitalOcean workflow

Chain multiple digitalocean operations together.

@desc "Setup authentication"
do
  digitalocean.setCredentials $token
enddo

@desc "List droplets, get droplet, and more"
do
  set $r_listDroplets as digitalocean.listDroplets
  set $r_getDroplet as digitalocean.getDroplet
  set $r_createDroplet as digitalocean.createDroplet
  print "All operations complete"
enddo

5. Safe listDroplets with validation

Check results before proceeding.

@desc "Setup authentication"
do
  digitalocean.setCredentials $token
enddo

@desc "List droplets and validate result"
do
  set $result as digitalocean.listDroplets
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• docker -- Docker module for complementary functionality
• git -- Git module for complementary functionality
• github -- GitHub module for complementary functionality
• gitlab -- GitLab module for complementary functionality
• vercel -- Vercel module for complementary functionality