@swamp/digitalocean
v2026.04.23.2
DigitalOcean infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
digitaloceancloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/digitaloceanRelease Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, dedicated_inference, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, security_scan, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
@swamp/digitalocean/app-platformv2026.04.23.2app_platform.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| spec | object | The desired configuration of an application. |
| update_all_source_versions? | boolean | Whether or not to update the source versions (for example fetching a new commit or image digest) of all components. By default (when this is false) only newly added sources will be updated to avoid changes like updating the scale of a component from also updating the respective code. |
| project_id? | string | The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project.\n<br><br>Requires `project:update` scope.\n |
createCreate a app platform
getGet a app platform
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the app platform |
updateUpdate app platform attributes
deleteDelete the app platform
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the app platform |
syncSync app platform state from DigitalOcean
Resources
state(infinite)— App Platform resource state
@swamp/digitalocean/byoip-prefixv2026.04.23.2byoip_prefix.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| advertise? | boolean | Whether the BYOIP prefix should be advertised |
| prefix | string | The IP prefix in CIDR notation to bring |
| region | enum | The region where the prefix will be created |
| signature | string | The signature hash for the prefix creation request |
createCreate a byoip prefix
getGet a byoip prefix
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the byoip prefix |
updateUpdate byoip prefix attributes
deleteDelete the byoip prefix
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the byoip prefix |
syncSync byoip prefix state from DigitalOcean
Resources
state(infinite)— BYOIP Prefix resource state
@swamp/digitalocean/cdn-endpointv2026.04.23.2cdn_endpoint.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ttl? | union | The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded. |
| certificate_id? | string | The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided. |
| custom_domain? | string | The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint. |
| origin | string | The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space. |
createCreate a cdn endpoint
getGet a cdn endpoint
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the cdn endpoint |
updateUpdate cdn endpoint attributes
deleteDelete the cdn endpoint
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the cdn endpoint |
syncSync cdn endpoint state from DigitalOcean
Resources
state(infinite)— CDN Endpoint resource state
@swamp/digitalocean/container-registryv2026.04.23.2container_registry.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. |
| subscription_tier_slug? | enum | The slug of the subscription tier to sign up for. Valid values can be retrieved using the options endpoint. |
| region? | enum | Slug of the region where registry data is stored. When not provided, a region will be selected. |
createCreate a container registry
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a container registry
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the container registry |
deleteDelete the container registry
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the container registry |
syncSync container registry state from DigitalOcean
list_optionsList available options for container registry (versions, sizes, regions)
Resources
state(infinite)— Container Registry resource state
@swamp/digitalocean/custom-imagev2026.04.23.2custom_image.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. |
| distribution? | enum | The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. |
| description? | string | An optional free-form text field to describe an image. |
| url | string | A URL from which the custom Linux virtual machine image may be retrieved. The image it points to must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB after being decompressed. |
| region | enum | The slug identifier for the region where the resource will initially be available. |
| tags? | array | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. <br><br>Requires `tag:create` scope. |
createCreate a custom image
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a custom image
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the custom image |
updateUpdate custom image attributes
deleteDelete the custom image
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the custom image |
syncSync custom image state from DigitalOcean
convertconvert the custom image
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the custom image |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
transfertransfer the custom image
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the custom image |
| region | enum | The slug identifier for the region where the resource will initially be available. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Custom Image resource state
custom_image_action(ephemeral)— Custom Image action result
@swamp/digitalocean/database-clusterv2026.04.23.2database_cluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A unique, human-readable name referring to a database cluster. |
| engine | enum | A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB, "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey. |
| version? | string | A string representing the version of the database engine in use for the cluster. |
| num_nodes | number | The number of nodes in the database cluster. |
| size | string | The slug identifier representing the size of the nodes in the database cluster. |
| region | enum | The slug identifier for the region where the database cluster is located. |
| private_network_uuid? | string | A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. <br><br>Requires `vpc:read` scope. |
| tags? | array | An array of tags (as strings) to apply to the database cluster. <br><br>Requires `tag:create` scope. |
| ui_connection? | object | The connection details for OpenSearch dashboard. |
| schema_registry_connection? | object | The connection details for Schema Registry. |
| connection? | object | |
| private_connection? | object | |
| standby_connection? | object | |
| standby_private_connection? | object | |
| maintenance_window? | object | |
| project_id? | string | The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.<br><br>Requires `project:update` scope. |
| rules? | array | |
| storage_size_mib? | number | Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. |
| autoscale? | object | Autoscaling configuration for the database cluster. Currently only supports storage autoscaling. If null, autoscaling is not configured for the cluster. |
| do_settings? | object | DigitalOcean-specific settings for the database cluster. |
| backup_restore? | object |
createCreate a database cluster
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
| waitForReady? | boolean | Wait for the resource to reach ready state after creation (default: true) |
getGet a database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
deleteDelete the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
syncSync database cluster state from DigitalOcean
autoscaleautoscale the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| storage? | record | Configuration for database cluster storage autoscaling |
configconfig the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| config? | record |
eviction_policyeviction policy the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| eviction_policy | enum | A string specifying the desired eviction policy for a Caching or Valkey cluster.\n\n- `noeviction`: Don't evict any data, returns error when memory limit is reached.\n- `allkeys_lru:` Evict any key, least recently used (LRU) first.\n- `allkeys_random`: Evict keys in a random order.\n- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.\n- `volatile_random`: Evict keys with expiration only in a random order.\n- `volatile_ttl`: Evict keys with expiration only, shortes |
firewallfirewall the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| rules? | array |
install_updateinstall update the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
maintenancemaintenance the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| day | string | The day of the week on which to apply maintenance updates. |
| hour | string | The hour in UTC at which maintenance updates will be applied in 24 hour format. |
migratemigrate the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| region | string | A slug identifier for the region to which the database cluster will be migrated. |
resizeresize the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| size | string | A slug identifier representing desired the size of the nodes in the database cluster. |
| num_nodes | number | The number of nodes in the database cluster. Valid values are are 1-3. In addition to the primary node, up to two standby nodes may be added for highly available configurations. |
| storage_size_mib? | number | Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. |
sql_modesql mode the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| sql_mode | string | A string specifying the configured SQL modes for the MySQL cluster. |
upgradeupgrade the database cluster
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the database cluster |
| version? | string | A string representing the version of the database engine in use for the cluster. |
list_optionsList available options for database cluster (versions, sizes, regions)
Resources
state(infinite)— Database Cluster resource state
@swamp/digitalocean/dedicated-inferencev2026.04.23.2dedicated_inference.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| spec | object | Structured configuration for a Dedicated Inference deployment. |
| access_tokens? | record | Key-value pairs for provider tokens (e.g. Hugging Face). |
createCreate a dedicated inference
getGet a dedicated inference
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the dedicated inference |
updateUpdate dedicated inference attributes
deleteDelete the dedicated inference
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the dedicated inference |
syncSync dedicated inference state from DigitalOcean
Resources
state(infinite)— Dedicated Inference resource state
@swamp/digitalocean/domainv2026.04.23.2domain.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. |
| ip_address? | string | This optional attribute may contain an IP address. When provided, an A record will be automatically created pointing to the apex domain. |
createCreate a domain
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a domain
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the domain |
deleteDelete the domain
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the domain |
syncSync domain state from DigitalOcean
Resources
state(infinite)— Domain resource state
@swamp/digitalocean/dropletv2026.04.23.2droplet.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the DigitalOcean DNS management system, will configure a PTR record for the Droplet. The name set during creation will also determine the hostname for the Droplet in its internal configuration. |
| region? | enum | The slug identifier for the region that you wish to deploy the Droplet in. If the specific datacenter is not not important, a slug prefix (e.g. `nyc`) can be used to deploy the Droplet in any of the that region's locations (`nyc1`, `nyc2`, or `nyc3`). If the region is omitted from the create request completely, the Droplet may deploy in any region. |
| size | string | The slug identifier for the size that you wish to select for this Droplet. |
| image | string | The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet.<br>Requires `image:read` scope. |
| ssh_keys? | array | An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation. You must add the keys to your team before they can be embedded on a Droplet.<br>Requires `ssh_key:read` scope. |
| backups? | boolean | A boolean indicating whether automated backups should be enabled for the Droplet. |
| backup_policy? | object | An object specifying the backup policy for the Droplet. If omitted and `backups` is `true`, the backup plan will default to daily. |
| ipv6? | boolean | A boolean indicating whether to enable IPv6 on the Droplet. |
| monitoring? | boolean | A boolean indicating whether to install the DigitalOcean agent for monitoring. |
| tags? | array | A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.<br>Requires `tag:create` scope. |
| user_data? | string | A string containing 'user data' which may be used to configure the Droplet on first boot, often a 'cloud-config' file or Bash script. It must be plain text and may not exceed 64 KiB in size. |
| private_networking? | boolean | This parameter has been deprecated. Use `vpc_uuid` instead to specify a VPC network for the Droplet. If no `vpc_uuid` is provided, the Droplet will be placed in your account's default VPC for the region. |
| volumes? | array | An array of IDs for block storage volumes that will be attached to the Droplet once created. The volumes must not already be attached to an existing Droplet.<br>Requires `block_storage:read` scpoe. |
| vpc_uuid? | string | A string specifying the UUID of the VPC to which the Droplet will be assigned. If excluded, the Droplet will be assigned to your account's default VPC for the region.<br>Requires `vpc:read` scope. |
| with_droplet_agent? | boolean | A boolean indicating whether to install the DigitalOcean agent used for providing access to the Droplet web console in the control panel. By default, the agent is installed on new Droplets but installation errors (i.e. OS not supported) are ignored. To prevent it from being installed, set to `false`. To make installation errors fatal, explicitly set it to `true`. |
| public_networking? | boolean | An optional boolean indicating whether this Droplet should be created with public networking or not. By default, all Droplets are created with public networking available. If explicitly set to `false`, only private networking will be enabled, and public networking will be disabled; currently this means that it will not have any public static or Reserved IPv4 or IPv6 address, nor can one be assigned later. If explicitly set to `false`, `ipv6` must also be `false`. |
createCreate a droplet
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
| waitForReady? | boolean | Wait for the resource to reach ready state after creation (default: true) |
getGet a droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
deleteDelete the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
syncSync droplet state from DigitalOcean
change_backup_policychange backup policy the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| backup_policy | record | An object specifying the backup policy for the Droplet. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
change_kernelchange kernel the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| kernel? | number | A unique number used to identify and reference a specific kernel. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
disable_backupsdisable backups the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
enable_backupsenable backups the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| backup_policy? | record | An object specifying the backup policy for the Droplet. If omitted, the backup plan will default to daily. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
enable_ipv6enable ipv6 the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
password_resetpassword reset the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
power_cyclepower cycle the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
power_offpower off the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
power_onpower on the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
rebootreboot the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
rebuildrebuild the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| image? | string | The image ID of a public or private image or the slug identifier for a public image. The Droplet will be rebuilt using this image as its base. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
renamerename the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| name? | string | The new name for the Droplet. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
resizeresize the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| disk? | boolean | When `true`, the Droplet's disk will be resized in addition to its RAM and CPU. This is a permanent change and cannot be reversed as a Droplet's disk size cannot be decreased. |
| size? | string | The slug identifier for the size to which you wish to resize the Droplet. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
restorerestore the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| image? | number | The ID of a backup of the current Droplet instance to restore from. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
shutdownshutdown the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
snapshotsnapshot the droplet
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet |
| name? | string | The name to give the new snapshot of the Droplet. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Droplet resource state
droplet_action(ephemeral)— Droplet action result
@swamp/digitalocean/droplet-autoscalev2026.04.23.2droplet_autoscale.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The human-readable name of the autoscale pool. This field cannot be updated |
| config | object | The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration). |
| droplet_template | object |
createCreate a droplet autoscale
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a droplet autoscale
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet autoscale |
updateUpdate droplet autoscale attributes
deleteDelete the droplet autoscale
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the droplet autoscale |
syncSync droplet autoscale state from DigitalOcean
Resources
state(infinite)— Droplet Autoscale resource state
@swamp/digitalocean/firewallv2026.04.23.2firewall.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). |
| droplet_ids? | array | An array containing the IDs of the Droplets assigned to the firewall. <br><br>Requires `droplet:read` scope. |
| tags? | array | A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. <br><br>Requires `tag:create` and `tag:read` scopes. |
| inbound_rules? | array | |
| outbound_rules? | array |
createCreate a firewall
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a firewall
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the firewall |
updateUpdate firewall attributes
deleteDelete the firewall
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the firewall |
syncSync firewall state from DigitalOcean
Resources
state(infinite)— Firewall resource state
@swamp/digitalocean/floating-ipv2026.04.23.2floating_ip.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| droplet_id? | number | The ID of the Droplet that the floating IP will be assigned to. |
| region? | enum | The slug identifier for the region the floating IP will be reserved to. |
| project_id? | string | The UUID of the project to which the floating IP will be assigned. |
createCreate a floating ip
getGet a floating ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the floating ip |
deleteDelete the floating ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the floating ip |
syncSync floating ip state from DigitalOcean
assignassign the floating ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the floating ip |
| droplet_id | number | The ID of the Droplet that the floating IP will be assigned to. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
unassignunassign the floating ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the floating ip |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Floating IP resource state
floating_ip_action(ephemeral)— Floating IP action result
@swamp/digitalocean/function-namespacev2026.04.23.2function_namespace.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| region | enum | The [datacenter region](https://docs.digitalocean.com/products/platform/availability-matrix/#available-datacenters) in which to create the namespace. |
| label | string | The namespace's unique name. |
createCreate a function namespace
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a function namespace
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the function namespace |
deleteDelete the function namespace
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the function namespace |
syncSync function namespace state from DigitalOcean
Resources
state(infinite)— Function Namespace resource state
@swamp/digitalocean/kubernetes-clusterv2026.04.23.2kubernetes_cluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A human-readable name for a Kubernetes cluster. |
| tags? | array | An array of tags to apply to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. <br><br>Requires `tag:read` and `tag:create` scope, as well as `tag:delete` if existing tags are getting removed. |
| maintenance_policy? | object | An object specifying the maintenance window policy for the Kubernetes cluster. |
| auto_upgrade? | boolean | A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. |
| surge_upgrade? | boolean | A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. |
| ha? | boolean | A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. |
| control_plane_firewall? | object | An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). |
| cluster_autoscaler_configuration? | object | An object specifying custom cluster autoscaler configuration. |
| routing_agent? | object | An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster. |
| amd_gpu_device_plugin? | object | An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an AMD GPU node pool. |
| amd_gpu_device_metrics_exporter_plugin? | object | An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster. |
| nvidia_gpu_device_plugin? | object | An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an Nvidia GPU node pool. |
| rdma_shared_dev_plugin? | object | An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster. |
| region | enum | The slug identifier for the region where the Kubernetes cluster is located. |
| version | string | The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. "1.14"), the latest version within it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions. |
| cluster_subnet? | string | The range of IP addresses for the overlay network of the Kubernetes cluster in CIDR notation. |
| service_subnet? | string | The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. |
| vpc_uuid? | string | A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.<br><br>Requires `vpc:read` scope. |
| node_pools | array | An object specifying the details of the worker nodes available to the Kubernetes cluster. |
createCreate a kubernetes cluster
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
| waitForReady? | boolean | Wait for the resource to reach ready state after creation (default: true) |
getGet a kubernetes cluster
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the kubernetes cluster |
updateUpdate kubernetes cluster attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach ready state after update (default: true) |
deleteDelete the kubernetes cluster
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the kubernetes cluster |
syncSync kubernetes cluster state from DigitalOcean
list_optionsList available options for kubernetes cluster (versions, sizes, regions)
Resources
state(infinite)— Kubernetes Cluster resource state
@swamp/digitalocean/load-balancerv2026.04.23.2load_balancer.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| droplet_ids? | array | An array containing the IDs of the Droplets assigned to the load balancer. |
| region | enum | The slug identifier for the region where the resource will initially be available. |
| name? | string | A human-readable name for a load balancer instance. |
| project_id? | string | The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. |
| size_unit? | number | How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. |
| size? | enum | This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation. |
| algorithm? | enum | This field has been deprecated. You can no longer specify an algorithm for load balancers. |
| forwarding_rules | array | An array of objects specifying the forwarding rules for a load balancer. |
| health_check? | object | An object specifying health check settings for the load balancer. |
| sticky_sessions? | object | An object specifying sticky sessions settings for the load balancer. |
| redirect_http_to_https? | boolean | A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443. |
| enable_proxy_protocol? | boolean | A boolean value indicating whether PROXY Protocol is in use. |
| enable_backend_keepalive? | boolean | A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets. |
| http_idle_timeout_seconds? | number | An integer value which configures the idle timeout for HTTP requests to the target droplets. |
| vpc_uuid? | string | A string specifying the UUID of the VPC to which the load balancer is assigned. |
| disable_lets_encrypt_dns_records? | boolean | A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer. |
| firewall? | object | An object specifying allow and deny rules to control traffic to the load balancer. |
| network? | enum | A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer. |
| network_stack? | enum | A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer. |
| type? | enum | A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer. |
| domains? | array | An array of objects specifying the domain configurations for a Global load balancer. |
| glb_settings? | object | An object specifying forwarding configurations for a Global load balancer. |
| target_load_balancer_ids? | array | An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer. |
| tls_cipher_policy? | enum | A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are `DEFAULT` or `STRONG`. The default value is `DEFAULT`. |
| tag? | string | The name of a Droplet tag corresponding to Droplets assigned to the load balancer. |
createCreate a load balancer
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
| waitForReady? | boolean | Wait for the resource to reach ready state after creation (default: true) |
getGet a load balancer
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the load balancer |
updateUpdate load balancer attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach ready state after update (default: true) |
deleteDelete the load balancer
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the load balancer |
syncSync load balancer state from DigitalOcean
Resources
state(infinite)— Load Balancer resource state
@swamp/digitalocean/monitoring-alert-policyv2026.04.23.2monitoring_alert_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| alerts | object | |
| compare | enum | |
| description | string | |
| enabled | boolean | |
| entities | array | |
| tags | array | |
| type | enum | |
| value | number | |
| window | enum |
createCreate a monitoring alert policy
getGet a monitoring alert policy
| Argument | Type | Description |
|---|---|---|
| uuid | string | The UUID of the monitoring alert policy |
updateUpdate monitoring alert policy attributes
deleteDelete the monitoring alert policy
| Argument | Type | Description |
|---|---|---|
| uuid | string | The UUID of the monitoring alert policy |
syncSync monitoring alert policy state from DigitalOcean
Resources
state(infinite)— Monitoring Alert Policy resource state
@swamp/digitalocean/monitoring-sinkv2026.04.23.2monitoring_sink.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| destination_uuid? | string | A unique identifier for an already-existing destination. |
| resources? | array | List of resources identified by their URNs. |
createCreate a monitoring sink
getGet a monitoring sink
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the monitoring sink |
deleteDelete the monitoring sink
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the monitoring sink |
syncSync monitoring sink state from DigitalOcean
Resources
state(infinite)— Monitoring Sink resource state
@swamp/digitalocean/monitoring-sink-destinationv2026.04.23.2monitoring_sink_destination.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | destination name |
| type | enum | The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch\ncluster or `opensearch_ext` for an externally managed one.\n |
| config | object |
createCreate a monitoring sink destination
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a monitoring sink destination
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the monitoring sink destination |
deleteDelete the monitoring sink destination
| Argument | Type | Description |
|---|---|---|
| id | string | The UUID of the monitoring sink destination |
syncSync monitoring sink destination state from DigitalOcean
Resources
state(infinite)— Monitoring Sink Destination resource state
@swamp/digitalocean/nfsv2026.04.23.2nfs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The human-readable name of the share. |
| size_gib | number | The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. |
| region | enum | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
| vpc_ids | array | List of VPC IDs that should be able to access the share. |
| performance_tier? | string | The performance tier of the share. |
createCreate a nfs
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
deleteDelete the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
syncSync nfs state from DigitalOcean
attachattach the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| vpc_id | string | The ID of the VPC to which the NFS share will be attached |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
detachdetach the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| vpc_id | string | The ID of the VPC from which the NFS share will be detached |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
reassignreassign the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| old_vpc_id | string | The ID of the VPC from which the NFS share will be reassigned |
| new_vpc_id | string | The ID of the VPC to which the NFS share will be reassigned |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
resizeresize the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| size_gib | number | The new size for the NFS share. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
snapshotsnapshot the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| name | string | Snapshot name of the NFS share |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
switch_performance_tierswitch performance tier the nfs
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the nfs |
| region? | string | The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. |
| performance_tier | string | The performance tier to which the NFS share will be switched (e.g., standard, high). |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— NFS resource state
nfs_action(ephemeral)— NFS action result
@swamp/digitalocean/partner-network-connect-attachmentv2026.04.23.2partner_network_connect_attachment.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. |
| vpc_ids | array | An array of VPCs IDs. |
| bgp? | object | Optional BGP configurations |
| connection_bandwidth_in_mbps | union | Bandwidth (in Mbps) of the connection. |
| region | enum | The region to create the partner attachment. |
| naas_provider | string | |
| parent_uuid? | string | Optional associated partner attachment UUID |
| redundancy_zone? | enum | Optional redundancy zone for the partner attachment. |
createCreate a partner network connect attachment
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a partner network connect attachment
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the partner network connect attachment |
updateUpdate partner network connect attachment attributes
deleteDelete the partner network connect attachment
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the partner network connect attachment |
syncSync partner network connect attachment state from DigitalOcean
Resources
state(infinite)— Partner Network Connect Attachment resource state
@swamp/digitalocean/projectv2026.04.23.2project.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The human-readable name for the project. The maximum length is 175 characters and the name must be unique. |
| description? | string | The description of the project. The maximum length is 255 characters. |
| purpose | string | The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, "your custom purpose",\nyour purpose will be stored as `Other: your custom purpose`.\n |
| environment? | enum | The environment of the project's resources. |
| is_default? | boolean | If true, all resources will be added to this project if no project is specified. |
createCreate a project
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a project
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the project |
updateUpdate project attributes
deleteDelete the project
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the project |
syncSync project state from DigitalOcean
Resources
state(infinite)— Project resource state
@swamp/digitalocean/reserved-ipv2026.04.23.2reserved_ip.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| droplet_id? | number | The ID of the Droplet that the reserved IP will be assigned to. |
| region? | enum | The slug identifier for the region the reserved IP will be reserved to. |
| project_id? | string | The UUID of the project to which the reserved IP will be assigned. |
createCreate a reserved ip
getGet a reserved ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the reserved ip |
deleteDelete the reserved ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the reserved ip |
syncSync reserved ip state from DigitalOcean
assignassign the reserved ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the reserved ip |
| droplet_id | number | The ID of the Droplet that the reserved IP will be assigned to. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
unassignunassign the reserved ip
| Argument | Type | Description |
|---|---|---|
| ip | string | The IP address of the reserved ip |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Reserved IP resource state
reserved_ip_action(ephemeral)— Reserved IP action result
@swamp/digitalocean/reserved-ipv6v2026.04.23.2reserved_ipv6.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| region_slug | string | The slug identifier for the region the reserved IPv6 will be reserved to. |
createCreate a reserved ipv6
getGet a reserved ipv6
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the reserved ipv6 |
deleteDelete the reserved ipv6
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the reserved ipv6 |
syncSync reserved ipv6 state from DigitalOcean
assignassign the reserved ipv6
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the reserved ipv6 |
| droplet_id | number | The ID of the Droplet that the reserved IPv6 will be assigned to. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
unassignunassign the reserved ipv6
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the reserved ipv6 |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Reserved IPV6 resource state
reserved_ipv6_action(ephemeral)— Reserved IPV6 action result
@swamp/digitalocean/security-scanv2026.04.23.2security_scan.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
createCreate a security scan
getGet a security scan
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the security scan |
syncSync security scan state from DigitalOcean
Resources
state(infinite)— Security Scan resource state
@swamp/digitalocean/space-keyv2026.04.23.2space_key.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | The access key's name. |
| grants? | array | The list of permissions for the access key. |
createCreate a space key
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a space key
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the space key |
updateUpdate space key attributes
deleteDelete the space key
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the space key |
syncSync space key state from DigitalOcean
Resources
state(infinite)— Space Key resource state
@swamp/digitalocean/ssh-keyv2026.04.23.2ssh_key.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. |
| public_key | string | The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. |
createCreate a ssh key
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a ssh key
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the ssh key |
updateUpdate ssh key attributes
deleteDelete the ssh key
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the ssh key |
syncSync ssh key state from DigitalOcean
Resources
state(infinite)— SSH Key resource state
@swamp/digitalocean/ssl-certificatev2026.04.23.2ssl_certificate.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A unique human-readable name referring to a certificate. |
| type? | enum | A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt. |
| dns_names? | array | An array of fully qualified domain names (FQDNs) for which the certificate was issued. A certificate covering all subdomains can be issued using a wildcard (e.g. `*.example.com`). |
| private_key? | string | The contents of a PEM-formatted private-key corresponding to the SSL certificate. |
| leaf_certificate? | string | The contents of a PEM-formatted public SSL certificate. |
| certificate_chain? | string | The full PEM-formatted trust chain between the certificate authority's certificate and your domain's SSL certificate. |
createCreate a ssl certificate
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a ssl certificate
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the ssl certificate |
deleteDelete the ssl certificate
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the ssl certificate |
syncSync ssl certificate state from DigitalOcean
Resources
state(infinite)— SSL Certificate resource state
@swamp/digitalocean/tagv2026.04.23.2tag.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.\nThere is a limit of 255 characters per tag.\n\n**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.\n\nWhen working with tags in the API, you must use the tag\ |
createCreate a tag
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a tag
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the tag |
deleteDelete the tag
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the tag |
syncSync tag state from DigitalOcean
Resources
state(infinite)— Tag resource state
@swamp/digitalocean/uptime-checkv2026.04.23.2uptime_check.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A human-friendly display name. |
| type | enum | The type of health check to perform. |
| target | string | The endpoint to perform healthchecks on. |
| regions | array | An array containing the selected regions to perform healthchecks from. |
| enabled | boolean | A boolean value indicating whether the check is enabled/disabled. |
createCreate a uptime check
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a uptime check
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the uptime check |
updateUpdate uptime check attributes
deleteDelete the uptime check
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the uptime check |
syncSync uptime check state from DigitalOcean
Resources
state(infinite)— Uptime Check resource state
@swamp/digitalocean/volumev2026.04.23.2volume.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. |
| description? | string | An optional free-form text field to describe a block storage volume. |
| size_gigabytes | number | The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot. |
| tags? | array | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. <br><br>Requires `tag:create` scope. |
| snapshot_id? | string | The unique identifier for the volume snapshot from which to create the volume. |
| filesystem_type? | string | The name of the filesystem type to be used on the volume. When provided, the volume will automatically be formatted to the specified filesystem type. Currently, the available options are `ext4` and `xfs`. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after April 26, 2018. Attaching pre-formatted volumes to other Droplets is not recommended. |
| region | enum | The slug identifier for the region where the resource will initially be available. |
| filesystem_label? | string | The label applied to the filesystem. Labels for ext4 type filesystems may contain 16 characters while labels for xfs type filesystems are limited to 12 characters. May only be used in conjunction with filesystem_type. |
createCreate a volume
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a volume
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the volume |
deleteDelete the volume
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the volume |
syncSync volume state from DigitalOcean
attachattach the volume
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the volume |
| region? | enum | The slug identifier for the region where the resource will initially be available. |
| droplet_id | number | The unique identifier for the Droplet the volume will be attached or detached from. |
| tags? | array | A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. <br><br>Requires `tag:create` scope. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
detachdetach the volume
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the volume |
| region? | enum | The slug identifier for the region where the resource will initially be available. |
| droplet_id | number | The unique identifier for the Droplet the volume will be attached or detached from. |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
resizeresize the volume
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the volume |
| region? | enum | The slug identifier for the region where the resource will initially be available. |
| size_gigabytes | number | The new size of the block storage volume in GiB (1024^3). |
| waitForCompletion? | boolean | Wait for the action to complete before returning (default: true) |
Resources
state(infinite)— Volume resource state
volume_action(ephemeral)— Volume action result
@swamp/digitalocean/vpcv2026.04.23.2vpc.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods. |
| description? | string | A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters. |
| default? | boolean | A boolean value indicating whether or not the VPC is the default network for the region. All applicable resources are placed into the default VPC network unless otherwise specified during their creation. The `default` field cannot be unset from `true`. If you want to set a new default VPC network, update the `default` field of another VPC network in the same region. The previous network's `default` field will be set to `false` when a new default VPC has been defined. |
| region | enum | The slug identifier for the region where the VPC will be created. |
| ip_range? | string | The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than `/28` nor larger than `/16`. If no IP range is specified, a `/20` network range is generated that won't conflict with other VPC networks in your account. |
createCreate a vpc
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a vpc
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc |
updateUpdate vpc attributes
deleteDelete the vpc
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc |
syncSync vpc state from DigitalOcean
Resources
state(infinite)— VPC resource state
@swamp/digitalocean/vpc-nat-gatewayv2026.04.23.2vpc_nat_gateway.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The human-readable name of the VPC NAT gateway. |
| size | number | The size of the VPC NAT gateway. |
| vpcs | array | An array of VPCs associated with the VPC NAT gateway. |
| udp_timeout_seconds? | number | The UDP timeout in seconds for the VPC NAT gateway. |
| icmp_timeout_seconds? | number | The ICMP timeout in seconds for the VPC NAT gateway. |
| tcp_timeout_seconds? | number | The TCP timeout in seconds for the VPC NAT gateway. |
| type | enum | The type of the VPC NAT gateway. |
| region | enum | The region in which the VPC NAT gateway is created. |
createCreate a vpc nat gateway
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a vpc nat gateway
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc nat gateway |
updateUpdate vpc nat gateway attributes
deleteDelete the vpc nat gateway
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc nat gateway |
syncSync vpc nat gateway state from DigitalOcean
Resources
state(infinite)— VPC Nat Gateway resource state
@swamp/digitalocean/vpc-peeringv2026.04.23.2vpc_peering.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | The name of the VPC peering. Must be unique within the team and may only contain alphanumeric characters and dashes. |
| vpc_ids | array | An array of the two peered VPCs IDs. |
createCreate a vpc peering
| Argument | Type | Description |
|---|---|---|
| checkExists? | boolean | If true, check whether a resource with this name already exists before creating and fail if it does (default: false) |
getGet a vpc peering
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc peering |
updateUpdate vpc peering attributes
deleteDelete the vpc peering
| Argument | Type | Description |
|---|---|---|
| id | union | The ID of the vpc peering |
syncSync vpc peering state from DigitalOcean
Resources
state(infinite)— VPC Peering resource state
2026.04.22.195.7 KBApr 22, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, dedicated_inference, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, security_scan, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.04.08.194.0 KBApr 8, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: nfs
Changelog
Models
~nfsmethods: +reassign
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.04.03.293.6 KBApr 3, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, dedicated_inference, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, security_scan, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.31.190.5 KBMar 31, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: droplet, droplet_autoscale
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.30.1100.4 KBMar 31, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: custom_image, database_cluster, droplet, floating_ip, kubernetes_cluster, load_balancer, nfs, reserved_ip, reserved_ipv6, volume
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.27.289.1 KBMar 27, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: container_registry, custom_image, database_cluster, domain, droplet, droplet_autoscale, firewall, function_namespace, kubernetes_cluster, load_balancer, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.23.185.1 KBMar 23, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, dedicated_inference, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, security_scan, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.16.184.8 KBMar 16, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, dedicated_inference, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, security_scan, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.15.184.5 KBMar 15, 2026
DigitalOcean infrastructure models
Release Notes
- Added: security_scan
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.13.184.5 KBMar 13, 2026
DigitalOcean infrastructure models
Release Notes
- Added: security_scan
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.12.183.7 KBMar 12, 2026
DigitalOcean infrastructure models
Release Notes
- Added: dedicated_inference
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.10.582.3 KBMar 10, 2026
DigitalOcean infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.10.482.0 KBMar 10, 2026
DigitalOcean infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.10.382.0 KBMar 10, 2026
DigitalOcean infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.08.281.2 KBMar 8, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.08.177.4 KBMar 8, 2026
DigitalOcean infrastructure models
Release Notes
- Added: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure
2026.03.06.977.5 KBMar 7, 2026
DigitalOcean infrastructure models
Release Notes
- Updated: app_platform, byoip_prefix, cdn_endpoint, container_registry, custom_image, database_cluster, domain, droplet, droplet_autoscale, firewall, floating_ip, function_namespace, kubernetes_cluster, load_balancer, monitoring_alert_policy, monitoring_sink, monitoring_sink_destination, nfs, partner_network_connect_attachment, project, reserved_ip, reserved_ipv6, space_key, ssh_key, ssl_certificate, tag, uptime_check, volume, vpc, vpc_nat_gateway, vpc_peering
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
digitaloceancloudinfrastructure