Official DigitalOcean API for Droplets, databases, Kubernetes, networking, applications and account resources. Each command makes one request with your scoped personal access token.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Get an Actor's Limits
Help me with this task in DigitalOcean: Get an Actor's Limits. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: digitalocean.actorlimits_get
List Provider Credentials
Help me with this task in DigitalOcean: List Provider Credentials. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: digitalocean.providercredentials_list
What you can do (794)
What you can do
Available commands: 794 (422 read, 372 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Get an Actor's Limits — digitalocean.actorlimits_get |
Read |
Clear an Actor's Limits — digitalocean.actorlimits_delete |
Write |
Set an Actor's Limits — digitalocean.actorlimits_update |
Write |
Create a Provider Credential — digitalocean.providercredentials_create |
Write |
List Provider Credentials — digitalocean.providercredentials_list |
Read |
Get a Provider Credential — digitalocean.providercredentials_get |
Read |
Delete a Provider Credential — digitalocean.providercredentials_delete |
Write |
Create a Connection — digitalocean.connections_create |
Write |
List Connections — digitalocean.connections_list |
Read |
Get a Connection — digitalocean.connections_get |
Read |
Delete a Connection — digitalocean.connections_delete |
Write |
Register an MCP Server — digitalocean.mcpservers_create |
Write |
List MCP Servers — digitalocean.mcpservers_list |
Read |
Get an MCP Server — digitalocean.mcpservers_get |
Read |
Update an MCP Server — digitalocean.mcpservers_patch |
Write |
Delete an MCP Server — digitalocean.mcpservers_delete |
Write |
Discover an MCP Server's Tools — digitalocean.mcpservers_run_resync |
Write |
List an MCP Server's Tools — digitalocean.mcpservers_list_tools |
Read |
Set Which of an MCP Server's Tools Are Enabled — digitalocean.mcpservers_update_tools |
Write |
Create an Output View — digitalocean.outputviews_create |
Write |
List Output Views — digitalocean.outputviews_list |
Read |
Preview an Output View — digitalocean.outputviews_validate |
Write |
Get an Output View — digitalocean.outputviews_get |
Read |
Delete an Output View — digitalocean.outputviews_delete |
Write |
Create a Session — digitalocean.sessions_create |
Write |
List Sessions — digitalocean.sessions_list |
Read |
Search Sessions — digitalocean.sessions_list_search |
Read |
Delete a Session — digitalocean.sessions_delete |
Write |
Create a Toolbelt — digitalocean.toolbelts_create |
Write |
List Toolbelts — digitalocean.toolbelts_list |
Read |
Search Toolbelts — digitalocean.toolbelts_list_search |
Read |
Get a Toolbelt — digitalocean.toolbelts_get |
Read |
Delete a Toolbelt — digitalocean.toolbelts_delete |
Write |
List the Providers in a Toolbelt — digitalocean.toolbelts_list_providers |
Read |
List a Toolbelt's Tools from One Provider — digitalocean.toolbelts_list_provider_tools |
Read |
Add Tools to a Toolbelt — digitalocean.toolbelts_add_tools |
Write |
Remove Tools from a Toolbelt — digitalocean.toolbelts_delete_tools |
Write |
List Tools — digitalocean.tools_list |
Read |
List Tool Health — digitalocean.tools_list_health |
Read |
List Provider Health — digitalocean.tools_list_health_providers |
Read |
Get Tool Health — digitalocean.tools_get_health |
Read |
List Providers — digitalocean.tools_list_providers |
Read |
Search Providers — digitalocean.tools_list_search_providers |
Read |
Search Tools — digitalocean.tools_list_search |
Read |
List Toolkits — digitalocean.tools_list_toolkits |
Read |
List Users — digitalocean.users_list |
Read |
Get a User — digitalocean.users_get |
Read |
List 1-Click Applications — digitalocean.oneclicks_list |
Read |
Install Kubernetes 1-Click Applications — digitalocean.oneclicks_install_kubernetes |
Write |
Get User Information — digitalocean.account_get |
Read |
List All SSH Keys — digitalocean.sshkeys_list |
Read |
Create a New SSH Key — digitalocean.sshkeys_create |
Write |
Retrieve an Existing SSH Key — digitalocean.sshkeys_get |
Read |
Update an SSH Key's Name — digitalocean.sshkeys_update |
Write |
Delete an SSH Key — digitalocean.sshkeys_delete |
Write |
List All Actions — digitalocean.actions_list |
Read |
Retrieve an Existing Action — digitalocean.actions_get |
Read |
List Available Add-On Applications — digitalocean.addons_get_app |
Read |
Get Metadata for an Add-On Application — digitalocean.addons_get_app_metadata |
Read |
List all Add-On Resources — digitalocean.addons_list |
Read |
Create/Provision a New Add-on Resource — digitalocean.addons_create |
Write |
Get details on an Add-On Resource — digitalocean.addons_get |
Read |
Delete/Deprovision an Add-on Resource — digitalocean.addons_delete |
Write |
Update the name for an Add-On Resource — digitalocean.addons_patch |
Write |
Update the plan for an Add-On Resource — digitalocean.addons_patch_plan |
Write |
List active Environment Configs for the caller's team. — digitalocean.harness_list_configs |
Read |
Create an Environment Config (environment spec + optional Insights opt-in). — digitalocean.harness_create_config |
Write |
Get an active Environment Config and its environment spec. — digitalocean.harness_get_config |
Read |
Soft-delete an Environment Config. — digitalocean.harness_delete_config |
Write |
Clone an Environment Config under a new name. — digitalocean.harness_create_config_clone |
Write |
List the sessions created from one Environment Config. — digitalocean.harness_list_config_sessions |
Read |
ListSessions enumerates sessions for the caller's tenant. — digitalocean.harness_list_sessions |
Read |
CreateSession provisions a sandbox and starts a Harness Runtime session. — digitalocean.harness_create_session |
Write |
ListSandboxSizes returns the customer-selectable sandbox (microVM) size catalog. — digitalocean.harness_list_session_sandbox_sizes |
Read |
DestroySession tears down the sandbox and marks the session DESTROYED. — digitalocean.harness_delete_session |
Write |
GetSession returns the current snapshot of a session. — digitalocean.harness_get_session |
Read |
PatchSession updates session-scoped settings on an existing session. — digitalocean.harness_update_session |
Write |
ListCheckpoints enumerates a session's checkpoints, newest first. — digitalocean.harness_list_session_checkpoints |
Read |
CreateCheckpoint captures the session's live sandbox state as a durable checkpoint. — digitalocean.harness_create_session_checkpoint |
Write |
GetCheckpoint returns the current snapshot of a checkpoint. — digitalocean.harness_get_session_checkpoint |
Read |
DeleteCheckpoint removes a checkpoint and its underlying machine-state capture. — digitalocean.harness_delete_session_checkpoint |
Write |
RollbackToCheckpoint rewinds a session to a checkpoint. — digitalocean.harness_revert_session_checkpoint |
Write |
ForkSession creates child sessions from a checkpoint of this session. — digitalocean.harness_create_session_fork |
Write |
ResolveHITL records the user's decision on a pending HITL request. — digitalocean.harness_post_session_hitl |
Write |
SendInput delivers a user chat message into the session. — digitalocean.harness_create_session_input |
Write |
PauseSession freezes the session's microVM sandbox. — digitalocean.harness_post_session_pause |
Write |
ResumeSession explicitly thaws a PAUSED session's microVM sandbox. — digitalocean.harness_post_session_resume |
Write |
ExecInSandbox runs a one-shot command inside the session's sandbox. — digitalocean.harness_post_session_sandbox_exec |
Write |
Start a staged (large-file) workspace transfer. — digitalocean.harness_create_session_workspace_transfer |
Write |
Get the status of a staged workspace transfer. — digitalocean.harness_get_session_workspace_transfer |
Read |
Cancel a staged workspace transfer. — digitalocean.harness_cancel_session_workspace_transfer |
Write |
Finalize a staged upload. — digitalocean.harness_commit_session_workspace_transfer |
Write |
Mint presigned PUT URLs for one or more multipart upload parts. — digitalocean.harness_create_session_workspace_part_upload_urls |
Write |
GetIngressURL returns the public HTTPS URL of the session's OpenHands Agent Server. — digitalocean.harness_get_session_ingress |
Read |
ListTeamTemplates returns the caller's team custom templates. — digitalocean.harness_list_templates |
Read |
CreateTemplate creates a team custom template and kicks a build. — digitalocean.harness_create_template |
Write |
GetTemplate returns a team custom template by public id. — digitalocean.harness_get_template |
Read |
UpdateTemplate updates a team template's source and kicks a new build. — digitalocean.harness_update_template |
Write |
DeleteTemplate deletes a team custom template. — digitalocean.harness_delete_template |
Write |
ListTemplateBuilds returns build history for a template. — digitalocean.harness_list_template_builds |
Read |
GetTemplateBuild returns a single template build. — digitalocean.harness_get_template_build |
Read |
ListTriggers enumerates the calling team's triggers. — digitalocean.harness_list_triggers |
Read |
CreateTrigger creates a webhook or cron trigger. — digitalocean.harness_create_trigger |
Write |
GetTriggerBySession reverse-looks-up the trigger that produced or binds a session. — digitalocean.harness_get_trigger_by_session |
Read |
ListReusableSessions lists the team's PAUSED sessions for the reuse picker. — digitalocean.harness_list_reusable_sessions |
Read |
GetTrigger returns a single trigger by id. — digitalocean.harness_get_trigger |
Read |
UpdateTrigger updates, pauses, or re-enables a trigger. — digitalocean.harness_update_trigger |
Write |
DeleteTrigger soft-deletes a trigger. — digitalocean.harness_delete_trigger |
Write |
ListTriggerExecutions returns a trigger's execution history. — digitalocean.harness_list_trigger_executions |
Read |
GetTriggerExecution returns a single execution, including its payload. — digitalocean.harness_get_trigger_execution |
Read |
CancelExecution ends a running execution and frees the trigger's in-flight slot. — digitalocean.harness_cancel_trigger_execution |
Write |
RotateTriggerSecret issues a new webhook secret. — digitalocean.harness_post_trigger_rotate_secret |
Write |
ListWebhookProviders lists supported webhook providers for the create-trigger UI. — digitalocean.harness_list_webhook_providers |
Read |
List All Apps — digitalocean.apps_list |
Read |
Delete an App — digitalocean.apps_delete |
Write |
Retrieve an Existing App — digitalocean.apps_get |
Read |
Update an App — digitalocean.apps_update |
Write |
Restart an App — digitalocean.apps_restart |
Write |
Retrieve Active Deployment Logs — digitalocean.apps_get_logs_active_deployment |
Read |
Retrieve Exec URL — digitalocean.apps_get_exec_active_deployment |
Read |
Retrieve App Instances — digitalocean.apps_get_instances |
Read |
List App Deployments — digitalocean.apps_list_deployments |
Read |
Create an App Deployment — digitalocean.apps_create_deployment |
Write |
Retrieve an App Deployment — digitalocean.apps_get_deployment |
Read |
Cancel a Deployment — digitalocean.apps_cancel_deployment |
Write |
Retrieve Deployment Logs — digitalocean.apps_get_logs |
Read |
Retrieve Aggregate Deployment Logs — digitalocean.apps_get_logs_aggregate |
Read |
Retrieve Exec URL for Deployment — digitalocean.apps_get_exec |
Read |
Retrieve Active Deployment Aggregate Logs — digitalocean.apps_get_logs_active_deployment_aggregate |
Read |
List Job Invocations — digitalocean.apps_list_job_invocations |
Read |
Get Job Invocations — digitalocean.apps_get_job_invocation |
Read |
Cancel Job Invocation — digitalocean.apps_cancel_job_invocation |
Write |
Retrieve Job Invocation Logs — digitalocean.apps_get_job_invocation_logs |
Read |
List App Events — digitalocean.apps_list_events |
Read |
Get an Event — digitalocean.apps_get_event |
Read |
Cancel an Event — digitalocean.apps_cancel_event |
Write |
Retrieve Event Logs — digitalocean.apps_get_event_logs |
Read |
List Instance Sizes — digitalocean.apps_list_instancesizes |
Read |
Retrieve an Instance Size — digitalocean.apps_get_instancesize |
Read |
List App Regions — digitalocean.apps_list_regions |
Read |
Propose an App Spec — digitalocean.apps_validate_appspec |
Write |
List all app alerts — digitalocean.apps_list_alerts |
Read |
Update destinations for alerts — digitalocean.apps_assign_alertdestinations |
Write |
Rollback App — digitalocean.apps_create_rollback |
Write |
Validate App Rollback — digitalocean.apps_validate_rollback |
Write |
Commit App Rollback — digitalocean.apps_commit_rollback |
Write |
Revert App Rollback — digitalocean.apps_revert_rollback |
Write |
Retrieve App Daily Bandwidth Metrics — digitalocean.apps_get_metrics_bandwidth_daily |
Read |
Retrieve Multiple Apps' Daily Bandwidth Metrics — digitalocean.apps_list_metrics_bandwidth_daily |
Write |
Retrieve App Health — digitalocean.apps_get_health |
Read |
List All CDN Endpoints — digitalocean.cdn_list_endpoints |
Read |
Create a New CDN Endpoint — digitalocean.cdn_create_endpoint |
Write |
Retrieve an Existing CDN Endpoint — digitalocean.cdn_get_endpoint |
Read |
Update a CDN Endpoint — digitalocean.cdn_update_endpoints |
Write |
Delete a CDN Endpoint — digitalocean.cdn_delete_endpoint |
Write |
Purge the Cache for an Existing CDN Endpoint — digitalocean.cdn_purge_cache |
Write |
List All Certificates — digitalocean.certificates_list |
Read |
Create a New Certificate — digitalocean.certificates_create |
Write |
Retrieve an Existing Certificate — digitalocean.certificates_get |
Read |
Delete a Certificate — digitalocean.certificates_delete |
Write |
Get Customer Balance — digitalocean.balance_get |
Read |
Get Customer Prepayment Configuration — digitalocean.prepaymentconfig_get |
Read |
Get Customer Prepayment Status — digitalocean.prepaymentstatus_get |
Read |
List Billing History — digitalocean.billinghistory_list |
Read |
List All Invoices — digitalocean.invoices_list |
Read |
Retrieve an Invoice by UUID — digitalocean.invoices_get_byuuid |
Read |
Retrieve an Invoice CSV by UUID — digitalocean.invoices_get_csvbyuuid |
Read |
Retrieve an Invoice Summary by UUID — digitalocean.invoices_get_summarybyuuid |
Read |
List Billing Insights — digitalocean.billinginsights_list |
Read |
List Database Options — digitalocean.databases_list_options |
Read |
List All Database Clusters — digitalocean.databases_list_clusters |
Read |
Create a New Database Cluster — digitalocean.databases_create_cluster |
Write |
Retrieve an Existing Database Cluster — digitalocean.databases_get_cluster |
Read |
Destroy a Database Cluster — digitalocean.databases_destroy_cluster |
Write |
Retrieve an Existing Database Cluster Configuration — digitalocean.databases_get_config |
Read |
Update the Database Configuration for an Existing Database — digitalocean.databases_patch_config |
Write |
Retrieve the Public Certificate — digitalocean.databases_get_ca |
Read |
Retrieve the Status of an Online Migration — digitalocean.databases_get_migrationstatus |
Read |
Start an Online Migration — digitalocean.databases_update_onlinemigration |
Write |
Stop an Online Migration — digitalocean.databases_delete_onlinemigration |
Write |
Migrate a Database Cluster to a New Region — digitalocean.databases_update_region |
Write |
Resize a Database Cluster — digitalocean.databases_update_clustersize |
Write |
List Firewall Rules (Trusted Sources) for a Database Cluster — digitalocean.databases_list_firewall_rules |
Read |
Update Firewall Rules (Trusted Sources) for a Database — digitalocean.databases_update_firewall_rules |
Write |
Retrieve DO Settings for a Database Cluster — digitalocean.databases_get_do_settings |
Read |
Update DO Settings for a Database Cluster — digitalocean.databases_update_do_settings |
Write |
Configure a Database Cluster's Maintenance Window — digitalocean.databases_update_maintenancewindow |
Write |
Start Database Maintenance — digitalocean.databases_install_update |
Write |
List Backups for a Database Cluster — digitalocean.databases_list_backups |
Read |
List All Read-only Replicas — digitalocean.databases_list_replicas |
Read |
Create a Read-only Replica — digitalocean.databases_create_replica |
Write |
List all Events Logs — digitalocean.databases_list_events_logs |
Read |
Retrieve an Existing Read-only Replica — digitalocean.databases_get_replica |
Read |
Destroy a Read-only Replica — digitalocean.databases_destroy_replica |
Write |
Promote a Read-only Replica to become a Primary Cluster — digitalocean.databases_promote_replica |
Write |
List all Database Users — digitalocean.databases_list_users |
Read |
Add a Database User — digitalocean.databases_add_user |
Write |
Retrieve an Existing Database User — digitalocean.databases_get_user |
Read |
Remove a Database User — digitalocean.databases_delete_user |
Write |
Update a Database User — digitalocean.databases_update_user |
Write |
Reset a Database User's Password or Authentication Method — digitalocean.databases_reset_auth |
Write |
List All Databases — digitalocean.databases_list |
Read |
Add a New Database — digitalocean.databases_add |
Write |
Retrieve an Existing Database — digitalocean.databases_get |
Read |
Delete a Database — digitalocean.databases_delete |
Write |
List Connection Pools (PostgreSQL) — digitalocean.databases_list_connectionpools |
Read |
Add a New Connection Pool (PostgreSQL) — digitalocean.databases_add_connectionpool |
Write |
Retrieve Existing Connection Pool (PostgreSQL) — digitalocean.databases_get_connectionpool |
Read |
Update Connection Pools (PostgreSQL) — digitalocean.databases_update_connectionpool |
Write |
Delete a Connection Pool (PostgreSQL) — digitalocean.databases_delete_connectionpool |
Write |
Retrieve the Eviction Policy for a Caching or Valkey Cluster — digitalocean.databases_get_evictionpolicy |
Read |
Configure the Eviction Policy for a Caching or Valkey Cluster — digitalocean.databases_update_evictionpolicy |
Write |
Retrieve the SQL Modes for a MySQL Cluster — digitalocean.databases_get_sql_mode |
Read |
Update SQL Mode for a Cluster — digitalocean.databases_update_sql_mode |
Write |
Upgrade Major Version for a Database — digitalocean.databases_update_major_version |
Write |
Retrieve Autoscale Configuration for a Database Cluster — digitalocean.databases_get_autoscale |
Read |
Configure Autoscale Settings for a Database Cluster — digitalocean.databases_update_autoscale |
Write |
List Topics for a Kafka Cluster — digitalocean.databases_list_kafka_topics |
Read |
Create Topic for a Kafka Cluster — digitalocean.databases_create_kafka_topic |
Write |
Get Topic for a Kafka Cluster — digitalocean.databases_get_kafka_topic |
Read |
Update Topic for a Kafka Cluster — digitalocean.databases_update_kafka_topic |
Write |
Delete Topic for a Kafka Cluster — digitalocean.databases_delete_kafka_topic |
Write |
List Logsinks for a Database Cluster — digitalocean.databases_list_logsink |
Read |
Create Logsink for a Database Cluster — digitalocean.databases_create_logsink |
Write |
Get Logsink for a Database Cluster — digitalocean.databases_get_logsink |
Read |
Update Logsink for a Database Cluster — digitalocean.databases_update_logsink |
Write |
Delete Logsink for a Database Cluster — digitalocean.databases_delete_logsink |
Write |
List Schemas for Kafka Cluster — digitalocean.databases_list_kafka_schemas |
Read |
Create Schema Registry for Kafka Cluster — digitalocean.databases_create_kafka_schema |
Write |
Get a Kafka Schema by Subject Name — digitalocean.databases_get_kafka_schema |
Read |
Delete a Kafka Schema by Subject Name — digitalocean.databases_delete_kafka_schema |
Write |
Get Kafka Schema by Subject Version — digitalocean.databases_get_kafka_schema_version |
Read |
Retrieve Schema Registry Configuration for a kafka Cluster — digitalocean.databases_get_kafka_schema_config |
Read |
Update Schema Registry Configuration for a kafka Cluster — digitalocean.databases_update_kafka_schema_config |
Write |
Retrieve Schema Registry Configuration for a Subject of kafka Cluster — digitalocean.databases_get_kafka_schema_subject_config |
Read |
Update Schema Registry Configuration for a Subject of kafka Cluster — digitalocean.databases_update_kafka_schema_subject_config |
Write |
Retrieve Database Clusters' Metrics Endpoint Credentials — digitalocean.databases_get_cluster_metrics_credentials |
Read |
Update Database Clusters' Metrics Endpoint Credentials — digitalocean.databases_update_cluster_metrics_credentials |
Write |
List Indexes for a OpenSearch Cluster — digitalocean.databases_list_opeasearch_indexes |
Read |
Delete Index for OpenSearch Cluster — digitalocean.databases_delete_opensearch_index |
Write |
Get a Dedicated Inference — digitalocean.dedicatedinferences_get |
Read |
Update a Dedicated Inference — digitalocean.dedicatedinferences_patch |
Write |
Delete a Dedicated Inference — digitalocean.dedicatedinferences_delete |
Write |
List Dedicated Inferences — digitalocean.dedicatedinferences_list |
Read |
Create a Dedicated Inference — digitalocean.dedicatedinferences_create |
Write |
List Dedicated Inference Accelerators — digitalocean.dedicatedinferences_list_accelerators |
Read |
Get a Dedicated Inference Accelerator — digitalocean.dedicatedinferences_get_accelerator |
Read |
Get Dedicated Inference CA Certificate — digitalocean.dedicatedinferences_get_ca |
Read |
List Dedicated Inference Tokens — digitalocean.dedicatedinferences_list_tokens |
Read |
Create a Dedicated Inference Token — digitalocean.dedicatedinferences_create_tokens |
Write |
Revoke a Dedicated Inference Token — digitalocean.dedicatedinferences_delete_tokens |
Write |
List Dedicated Inference Sizes — digitalocean.dedicatedinferences_list_sizes |
Read |
Get Dedicated Inference GPU Model Config — digitalocean.dedicatedinferences_get_gpu_model_config |
Read |
List All Domains — digitalocean.domains_list |
Read |
Create a New Domain — digitalocean.domains_create |
Write |
Retrieve an Existing Domain — digitalocean.domains_get |
Read |
Delete a Domain — digitalocean.domains_delete |
Write |
List All Domain Records — digitalocean.domains_list_records |
Read |
Create a New Domain Record — digitalocean.domains_create_record |
Write |
Retrieve an Existing Domain Record — digitalocean.domains_get_record |
Read |
Update a Domain Record — digitalocean.domains_patch_record |
Write |
Update a Domain Record — digitalocean.domains_update_record |
Write |
Delete a Domain Record — digitalocean.domains_delete_record |
Write |
List All Droplets — digitalocean.droplets_list |
Read |
Create a New Droplet — digitalocean.droplets_create |
Write |
Deleting Droplets by Tag — digitalocean.droplets_destroy_bytag |
Write |
Retrieve an Existing Droplet — digitalocean.droplets_get |
Read |
Delete an Existing Droplet — digitalocean.droplets_destroy |
Write |
List Backups for a Droplet — digitalocean.droplets_list_backups |
Read |
Retrieve the Backup Policy for an Existing Droplet — digitalocean.droplets_get_backup_policy |
Read |
List Backup Policies for All Existing Droplets — digitalocean.droplets_list_backup_policies |
Read |
List Supported Droplet Backup Policies — digitalocean.droplets_list_supported_backup_policies |
Read |
List Snapshots for a Droplet — digitalocean.droplets_list_snapshots |
Read |
List Actions for a Droplet — digitalocean.dropletactions_list |
Read |
Initiate a Droplet Action — digitalocean.dropletactions_post |
Write |
Acting on Tagged Droplets — digitalocean.dropletactions_post_bytag |
Write |
Retrieve a Droplet Action — digitalocean.dropletactions_get |
Read |
List All Available Kernels for a Droplet — digitalocean.droplets_list_kernels |
Read |
List all Firewalls Applied to a Droplet — digitalocean.droplets_list_firewalls |
Read |
List Neighbors for a Droplet — digitalocean.droplets_list_neighbors |
Read |
List Associated Resources for a Droplet — digitalocean.droplets_list_associatedresources |
Read |
Selectively Destroy a Droplet and its Associated Resources — digitalocean.droplets_destroy_withassociatedresourcesselective |
Write |
Destroy a Droplet and All of its Associated Resources (Dangerous) — digitalocean.droplets_destroy_withassociatedresourcesdangerous |
Write |
Check Status of a Droplet Destroy with Associated Resources Request — digitalocean.droplets_get_destroyassociatedresourcesstatus |
Read |
Retry a Droplet Destroy with Associated Resources Request — digitalocean.droplets_destroy_retrywithassociatedresources |
Write |
List All Autoscale Pools — digitalocean.autoscalepools_list |
Read |
Create a New Autoscale Pool — digitalocean.autoscalepools_create |
Write |
Retrieve an Existing Autoscale Pool — digitalocean.autoscalepools_get |
Read |
Update Autoscale Pool — digitalocean.autoscalepools_update |
Write |
Delete autoscale pool — digitalocean.autoscalepools_delete |
Write |
Delete autoscale pool and resources — digitalocean.autoscalepools_delete_dangerous |
Write |
List members — digitalocean.autoscalepools_list_members |
Read |
List history events — digitalocean.autoscalepools_list_history |
Read |
List All Firewalls — digitalocean.firewalls_list |
Read |
Create a New Firewall — digitalocean.firewalls_create |
Write |
Retrieve an Existing Firewall — digitalocean.firewalls_get |
Read |
Update a Firewall — digitalocean.firewalls_update |
Write |
Delete a Firewall — digitalocean.firewalls_delete |
Write |
Add Droplets to a Firewall — digitalocean.firewalls_assign_droplets |
Write |
Remove Droplets from a Firewall — digitalocean.firewalls_delete_droplets |
Write |
Add Tags to a Firewall — digitalocean.firewalls_add_tags |
Write |
Remove Tags from a Firewall — digitalocean.firewalls_delete_tags |
Write |
Add Rules to a Firewall — digitalocean.firewalls_add_rules |
Write |
Remove Rules from a Firewall — digitalocean.firewalls_delete_rules |
Write |
List All Floating IPs — digitalocean.floatingips_list |
Read |
Create a New Floating IP — digitalocean.floatingips_create |
Write |
Retrieve an Existing Floating IP — digitalocean.floatingips_get |
Read |
Delete a Floating IP — digitalocean.floatingips_delete |
Write |
List All Actions for a Floating IP — digitalocean.floatingipsaction_list |
Read |
Initiate a Floating IP Action — digitalocean.floatingipsaction_post |
Write |
Retrieve an Existing Floating IP Action — digitalocean.floatingipsaction_get |
Read |
List Namespaces — digitalocean.functions_list_namespaces |
Read |
Create Namespace — digitalocean.functions_create_namespace |
Write |
Get Namespace — digitalocean.functions_get_namespace |
Read |
Delete Namespace — digitalocean.functions_delete_namespace |
Write |
List Triggers — digitalocean.functions_list_triggers |
Read |
Create Trigger — digitalocean.functions_create_trigger |
Write |
Get Trigger — digitalocean.functions_get_trigger |
Read |
Update Trigger — digitalocean.functions_update_trigger |
Write |
Delete Trigger — digitalocean.functions_delete_trigger |
Write |
List Namespace Access Keys — digitalocean.functionsaccesskey_list |
Read |
Create a Namespace Access Key — digitalocean.functionsaccesskey_create |
Write |
Update a Namespace Access Key — digitalocean.functionsaccesskey_update |
Write |
Delete a Namespace Access Key — digitalocean.functionsaccesskey_delete |
Write |
List All Images — digitalocean.images_list |
Read |
Create a Custom Image — digitalocean.images_create_custom |
Write |
Retrieve an Existing Image — digitalocean.images_get |
Read |
Update an Image — digitalocean.images_update |
Write |
Delete an Image — digitalocean.images_delete |
Write |
Initiate an Image Account Transfer — digitalocean.images_post_account_transfer_create |
Write |
Accept an Image Account Transfer — digitalocean.images_post_account_transfer_accept |
Write |
Cancel an Image Account Transfer — digitalocean.images_post_account_transfer_cancel |
Write |
Decline an Image Account Transfer — digitalocean.images_post_account_transfer_decline |
Write |
List All Actions for an Image — digitalocean.imageactions_list |
Read |
Initiate an Image Action — digitalocean.imageactions_post |
Write |
Retrieve an Existing Action — digitalocean.imageactions_get |
Read |
List Alert Instances — digitalocean.insights_list_alertinstances |
Read |
Retrieve an Alert Instance — digitalocean.insights_get_alertinstance |
Read |
List Alert Rules — digitalocean.insights_list_alertrules |
Read |
Retrieve an Alert Rule — digitalocean.insights_get_alertrule |
Read |
Update an Alert Rule — digitalocean.insights_update_alertrule |
Write |
Delete an Alert Rule — digitalocean.insights_delete_alertrule |
Write |
List Notification Channels — digitalocean.insights_list_notificationchannels |
Read |
Create a Notification Channel — digitalocean.insights_create_notificationchannel |
Write |
Retrieve a Notification Channel — digitalocean.insights_get_notificationchannel |
Read |
Update a Notification Channel — digitalocean.insights_update_notificationchannel |
Write |
Delete a Notification Channel — digitalocean.insights_delete_notificationchannel |
Write |
Execute an instant PromQL query — digitalocean.insights_get_promquery |
Read |
Execute a range PromQL query — digitalocean.insights_get_promqueryrange |
Read |
List label names — digitalocean.insights_get_promlabels |
Read |
List values for a label — digitalocean.insights_get_promlabelvalues |
Read |
Find series by label selectors — digitalocean.insights_get_promseries |
Read |
Retrieve an existing trace — digitalocean.insights_get_trace |
Read |
List Resource Signal Enablement — digitalocean.insights_list_resources |
Read |
Retrieve Resource Signal Enablement — digitalocean.insights_get_resource |
Read |
Update Resource Signal Enablement — digitalocean.insights_update_resourcesignals |
Write |
List All Consent Records — digitalocean.signals_list_consents |
Read |
Update Team-Level Consent — digitalocean.signals_update_team_consent |
Write |
Retrieve Consent for an Environment — digitalocean.signals_get_consent |
Read |
Update Consent for an Environment — digitalocean.signals_update_consent |
Write |
List Sessions for an Environment — digitalocean.signals_list_agent_sessions |
Read |
List Dialogues for a Session — digitalocean.signals_list_session_dialogues |
Read |
List Export Jobs — digitalocean.signals_list_exports |
Read |
Create an Export Job — digitalocean.signals_create_export |
Write |
Get Export Options — digitalocean.signals_get_export_options |
Read |
Retrieve an Export Job — digitalocean.signals_get_export |
Read |
Get Export Download URL — digitalocean.signals_get_export_download |
Read |
List Data Deletion Jobs — digitalocean.signals_list_deletions |
Read |
Create a Data Deletion Job — digitalocean.signals_create_deletion |
Write |
Retrieve a Data Deletion Job — digitalocean.signals_get_deletion |
Read |
List All Kubernetes Clusters — digitalocean.kubernetes_list_clusters |
Read |
Create a New Kubernetes Cluster — digitalocean.kubernetes_create_cluster |
Write |
Retrieve an Existing Kubernetes Cluster — digitalocean.kubernetes_get_cluster |
Read |
Update a Kubernetes Cluster — digitalocean.kubernetes_update_cluster |
Write |
Delete a Kubernetes Cluster — digitalocean.kubernetes_delete_cluster |
Write |
List Associated Resources for Cluster Deletion — digitalocean.kubernetes_list_associatedresources |
Read |
Selectively Delete a Cluster and its Associated Resources — digitalocean.kubernetes_destroy_associatedresourcesselective |
Write |
Delete a Cluster and All of its Associated Resources (Dangerous) — digitalocean.kubernetes_destroy_associatedresourcesdangerous |
Write |
Retrieve Credentials for a Kubernetes Cluster — digitalocean.kubernetes_get_credentials |
Read |
Retrieve Available Upgrades for an Existing Kubernetes Cluster — digitalocean.kubernetes_get_availableupgrades |
Read |
Upgrade a Kubernetes Cluster — digitalocean.kubernetes_upgrade_cluster |
Write |
List All Node Pools in a Kubernetes Clusters — digitalocean.kubernetes_list_nodepools |
Read |
Retrieve a Node Pool for a Kubernetes Cluster — digitalocean.kubernetes_get_nodepool |
Read |
Update a Node Pool in a Kubernetes Cluster — digitalocean.kubernetes_update_nodepool |
Write |
Delete a Node Pool in a Kubernetes Cluster — digitalocean.kubernetes_delete_nodepool |
Write |
Delete a Node in a Kubernetes Cluster — digitalocean.kubernetes_delete_node |
Write |
Retrieve User Information for a Kubernetes Cluster — digitalocean.kubernetes_get_clusteruser |
Read |
List Available Regions, Node Sizes, and Versions of Kubernetes — digitalocean.kubernetes_list_options |
Read |
Run Clusterlint Checks on a Kubernetes Cluster — digitalocean.kubernetes_run_clusterlint |
Write |
Fetch Clusterlint Diagnostics for a Kubernetes Cluster — digitalocean.kubernetes_get_clusterlintresults |
Read |
Add Container Registry to Kubernetes Clusters — digitalocean.kubernetes_add_registry |
Write |
Remove Container Registry from Kubernetes Clusters — digitalocean.kubernetes_remove_registry |
Write |
Add Container Registries to Kubernetes Clusters — digitalocean.kubernetes_add_registries |
Write |
Remove Container Registries from Kubernetes Clusters — digitalocean.kubernetes_remove_registries |
Write |
Fetch Status Messages for a Kubernetes Cluster — digitalocean.kubernetes_get_status_messages |
Read |
List All Load Balancers — digitalocean.loadbalancers_list |
Read |
Retrieve an Existing Load Balancer — digitalocean.loadbalancers_get |
Read |
Delete a Load Balancer — digitalocean.loadbalancers_delete |
Write |
Delete a Global Load Balancer CDN Cache — digitalocean.loadbalancers_delete_cache |
Write |
Add Forwarding Rules to a Load Balancer — digitalocean.loadbalancers_add_forwardingrules |
Write |
Remove Forwarding Rules from a Load Balancer — digitalocean.loadbalancers_remove_forwardingrules |
Write |
List all MicroVMs — digitalocean.microvms_list |
Read |
Create a MicroVM — digitalocean.microvms_create |
Write |
List MicroVM options — digitalocean.microvms_get_options |
Read |
List checkpoints — digitalocean.microvmcheckpoints_list |
Read |
Retrieve a checkpoint — digitalocean.microvmcheckpoints_get |
Read |
Delete a checkpoint — digitalocean.microvmcheckpoints_delete |
Write |
Retrieve a MicroVM — digitalocean.microvms_get |
Read |
Delete a MicroVM — digitalocean.microvms_delete |
Write |
Pause a MicroVM — digitalocean.microvms_post_pause |
Write |
Resume a MicroVM — digitalocean.microvms_post_resume |
Write |
Run a command in a MicroVM — digitalocean.microvms_run_command |
Write |
Create a checkpoint of a MicroVM — digitalocean.microvmcheckpoints_create |
Write |
List Alert Policies — digitalocean.monitoring_list_alertpolicy |
Read |
Create Alert Policy — digitalocean.monitoring_create_alertpolicy |
Write |
Retrieve an Existing Alert Policy — digitalocean.monitoring_get_alertpolicy |
Read |
Update an Alert Policy — digitalocean.monitoring_update_alertpolicy |
Write |
Delete an Alert Policy — digitalocean.monitoring_delete_alertpolicy |
Write |
Get Droplet Bandwidth Metrics — digitalocean.monitoring_get_dropletbandwidthmetrics |
Read |
Get Droplet CPU Metrics — digitalocean.monitoring_get_dropletcpumetrics |
Read |
Get Droplet Filesystem Free Metrics — digitalocean.monitoring_get_dropletfilesystemfreemetrics |
Read |
Get Droplet Filesystem Size Metrics — digitalocean.monitoring_get_dropletfilesystemsizemetrics |
Read |
Get Droplet Load1 Metrics — digitalocean.monitoring_get_dropletload1metrics |
Read |
Get Droplet Load5 Metrics — digitalocean.monitoring_get_dropletload5metrics |
Read |
Get Droplet Load15 Metrics — digitalocean.monitoring_get_dropletload15metrics |
Read |
Get Droplet Cached Memory Metrics — digitalocean.monitoring_get_dropletmemorycachedmetrics |
Read |
Get Droplet Free Memory Metrics — digitalocean.monitoring_get_dropletmemoryfreemetrics |
Read |
Get Droplet Total Memory Metrics — digitalocean.monitoring_get_dropletmemorytotalmetrics |
Read |
Get Droplet Available Memory Metrics — digitalocean.monitoring_get_dropletmemoryavailablemetrics |
Read |
Get App Memory Percentage Metrics — digitalocean.monitoring_get_appmemorypercentagemetrics |
Read |
Get App CPU Percentage Metrics — digitalocean.monitoring_get_appcpupercentagemetrics |
Read |
Get App Restart Count Metrics — digitalocean.monitoring_get_apprestartcountmetrics.yml |
Read |
Get Load Balancer Frontend Total Current Active Connections Metrics — digitalocean.monitoring_get_lb_frontend_connections_current |
Read |
Get Load Balancer Frontend Max Connections Limit Metrics — digitalocean.monitoring_get_lb_frontend_connections_limit |
Read |
Get Load Balancer Frontend Average Percentage CPU Utilization Metrics — digitalocean.monitoring_get_lb_frontend_cpu_utilization |
Read |
Get Load Balancer Frontend Firewall Dropped Bytes Metrics — digitalocean.monitoring_get_lb_frontend_firewall_dropped_bytes |
Read |
Get Load Balancer Frontend Firewall Dropped Packets Metrics — digitalocean.monitoring_get_lb_frontend_firewall_dropped_packets |
Read |
Get Load Balancer Frontend HTTP Rate Of Response Code Metrics — digitalocean.monitoring_get_lb_frontend_http_responses |
Read |
Get Load Balancer Frontend HTTP Requests Metrics — digitalocean.monitoring_get_lb_frontend_http_requests_per_second |
Read |
Get Load Balancer Frontend HTTP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_http |
Read |
Get Load Balancer Frontend UDP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_udp |
Read |
Get Load Balancer Frontend TCP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_tcp |
Read |
Get Network Load Balancer Frontend TCP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_nlb_tcp_network_throughput |
Read |
Get Network Load Balancer Frontend UDP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_nlb_udp_network_throughput |
Read |
Get Load Balancer Frontend Current TLS Connections Rate Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_current |
Read |
Get Load Balancer Frontend Max TLS Connections Limit Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_limit |
Read |
Get Load Balancer Frontend Closed TLS Connections For Exceeded Rate Limit Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit |
Read |
Get Load Balancer Droplets Average HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_avg |
Read |
Get Load Balancer Droplets 50th Percentile HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_50p |
Read |
Get Load Balancer Droplets 95th Percentile HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_95p |
Read |
Get Load Balancer Droplets Average HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_avg |
Read |
Get Load Balancer Droplets 50th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_50p |
Read |
Get Load Balancer Droplets 95th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_95p |
Read |
Get Load Balancer Droplets 99th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_99p |
Read |
Get Load Balancer Droplets Queue Size Metrics — digitalocean.monitoring_get_lb_droplets_queue_size |
Read |
Get Load Balancer Droplets HTTP Rate Of Response Code Metrics — digitalocean.monitoring_get_lb_droplets_http_responses |
Read |
Get Load Balancer Droplets Active Connections Metrics — digitalocean.monitoring_get_lb_droplets_connections |
Read |
Get Load Balancer Droplets Health Check Status Metrics — digitalocean.monitoring_get_lb_droplets_health_checks |
Read |
Get Load Balancer Droplets Downtime Status Metrics — digitalocean.monitoring_get_lb_droplets_downtime |
Read |
Get Droplet Autoscale Pool Current Size — digitalocean.monitoring_get_droplet_autoscale_current_instances |
Read |
Get Droplet Autoscale Pool Target Size — digitalocean.monitoring_get_droplet_autoscale_target_instances |
Read |
Get Droplet Autoscale Pool Current Average CPU utilization — digitalocean.monitoring_get_droplet_autoscale_current_cpu_utilization.yml |
Read |
Get Droplet Autoscale Pool Target Average CPU utilization — digitalocean.monitoring_get_droplet_autoscale_target_cpu_utilization |
Read |
Get Droplet Autoscale Pool Current Average Memory utilization — digitalocean.monitoring_get_droplet_autoscale_current_memory_utilization |
Read |
Get Droplet Autoscale Pool Target Average Memory utilization — digitalocean.monitoring_get_droplet_autoscale_target_memory_utilization |
Read |
Get Database MySQL CPU Usage Metrics — digitalocean.monitoring_get_database_mysql_cpu_usage |
Read |
Get Database MySQL Load Average Metrics — digitalocean.monitoring_get_database_mysql_load |
Read |
Get Database MySQL Memory Usage Metrics — digitalocean.monitoring_get_database_mysql_memory_usage |
Read |
Get Database MySQL Disk Usage Metrics — digitalocean.monitoring_get_database_mysql_disk_usage |
Read |
Get Database MySQL Threads Connected Metrics — digitalocean.monitoring_get_database_mysql_threads_connected |
Read |
Get Database MySQL Threads Created Rate Metrics — digitalocean.monitoring_get_database_mysql_threads_created_rate |
Read |
Get Database MySQL Threads Active Metrics — digitalocean.monitoring_get_database_mysql_threads_active |
Read |
Get Database MySQL Index vs Sequential Reads Metrics — digitalocean.monitoring_get_database_mysql_index_vs_sequential_reads |
Read |
Get Database MySQL Operations Throughput Metrics — digitalocean.monitoring_get_database_mysql_op_rates |
Read |
Get Database MySQL Schema Throughput Metrics — digitalocean.monitoring_get_database_mysql_schema_throughput |
Read |
Get Database MySQL Schema Latency Metrics — digitalocean.monitoring_get_database_mysql_schema_latency |
Read |
Create Logging Destination — digitalocean.monitoring_create_destination |
Write |
List Logging Destinations — digitalocean.monitoring_list_destinations |
Read |
Get Logging Destination — digitalocean.monitoring_get_destination |
Read |
Update Logging Destination — digitalocean.monitoring_update_destination |
Write |
Delete Logging Destination — digitalocean.monitoring_delete_destination |
Write |
Create Sink — digitalocean.monitoring_create_sink |
Write |
Lists all sinks — digitalocean.monitoring_list_sinks |
Read |
Get Sink — digitalocean.monitoring_get_sink |
Read |
Delete Sink — digitalocean.monitoring_delete_sink |
Write |
Create a new NFS share — digitalocean.nfs_create |
Write |
List NFS shares per region — digitalocean.nfs_list |
Read |
Get an NFS share — digitalocean.nfs_get |
Read |
Delete an NFS share — digitalocean.nfs_delete |
Write |
Initiate an NFS action — digitalocean.nfs_create_action |
Write |
List NFS snapshots per region — digitalocean.nfs_list_snapshot |
Read |
Get an NFS snapshot by ID — digitalocean.nfs_get_snapshot |
Read |
Delete an NFS snapshot — digitalocean.nfs_delete_snapshot |
Write |
Create an NFS access point — digitalocean.nfs_create_access_point |
Write |
List NFS access points for a share — digitalocean.nfs_list_access_points |
Read |
Get an NFS access point — digitalocean.nfs_get_access_point |
Read |
Delete an NFS access point — digitalocean.nfs_delete_access_point |
Write |
Create a Team in an Organization — digitalocean.organizations_create_team |
Write |
List Teams in an Organization — digitalocean.organizations_list_teams |
Read |
List all partner attachments — digitalocean.partnerattachments_list |
Read |
Create a new partner attachment — digitalocean.partnerattachments_create |
Write |
Retrieve an existing partner attachment — digitalocean.partnerattachments_get |
Read |
Update an existing partner attachment — digitalocean.partnerattachments_patch |
Write |
Delete an existing partner attachment — digitalocean.partnerattachments_delete |
Write |
Get current BGP auth key for the partner attachment — digitalocean.partnerattachments_get_bgp_auth_key |
Read |
List remote routes for a partner attachment — digitalocean.partnerattachments_list_remote_routes |
Read |
Get the current service key for the partner attachment — digitalocean.partnerattachments_get_service_key |
Read |
Regenerate the service key for the partner attachment — digitalocean.partnerattachments_create_service_key |
Write |
List All Projects — digitalocean.projects_list |
Read |
Create a Project — digitalocean.projects_create |
Write |
Retrieve the Default Project — digitalocean.projects_get_default |
Read |
Patch the Default Project — digitalocean.projects_patch_default |
Write |
Retrieve an Existing Project — digitalocean.projects_get |
Read |
Patch a Project — digitalocean.projects_patch |
Write |
Delete an Existing Project — digitalocean.projects_delete |
Write |
List Project Resources — digitalocean.projects_list_resources |
Read |
Assign Resources to a Project — digitalocean.projects_assign_resources |
Write |
List Default Project Resources — digitalocean.projects_list_resources_default |
Read |
Assign Resources to Default Project — digitalocean.projects_assign_resources_default |
Write |
List All Data Center Regions — digitalocean.regions_list |
Read |
List All Container Registries — digitalocean.registries_list |
Read |
Create Container Registry — digitalocean.registries_create |
Write |
Get a Container Registry By Name — digitalocean.registries_get |
Read |
Delete Container Registry By Name — digitalocean.registries_delete |
Write |
Get Docker Credentials By Registry Name — digitalocean.registries_get_dockercredentials |
Read |
Get Subscription Information — digitalocean.registries_get_subscription |
Read |
Update Subscription Tier — digitalocean.registries_update_subscription |
Write |
List Registry Options (Subscription Tiers and Available Regions) — digitalocean.registries_get_options |
Read |
Get Active Garbage Collection — digitalocean.registries_get_garbagecollection |
Read |
Start Garbage Collection — digitalocean.registries_run_garbagecollection |
Write |
List Garbage Collections — digitalocean.registries_list_garbagecollections |
Read |
Update Garbage Collection — digitalocean.registries_update_garbagecollection |
Write |
List All Container Registry Repositories (V2) — digitalocean.registries_list_repositoriesv2 |
Read |
Delete Container Registry Repository — digitalocean.registries_delete_repository |
Write |
List All Container Registry Repository Tags — digitalocean.registries_list_repositorytags |
Read |
Delete Container Registry Repository Tag — digitalocean.registries_delete_repositorytag |
Write |
List All Container Registry Repository Manifests — digitalocean.registries_list_repositorymanifests |
Read |
Delete Container Registry Repository Manifest — digitalocean.registries_delete_repositorymanifest |
Write |
Validate a Container Registry Name — digitalocean.registries_validate_name |
Write |
List All Droplet Neighbors — digitalocean.droplets_list_neighborsids |
Read |
List All Reserved IPs — digitalocean.reservedips_list |
Read |
Create a New Reserved IP — digitalocean.reservedips_create |
Write |
Retrieve an Existing Reserved IP — digitalocean.reservedips_get |
Read |
Delete a Reserved IP — digitalocean.reservedips_delete |
Write |
List All Actions for a Reserved IP — digitalocean.reservedipsactions_list |
Read |
Initiate a Reserved IP Action — digitalocean.reservedipsactions_post |
Write |
Retrieve an Existing Reserved IP Action — digitalocean.reservedipsactions_get |
Read |
List All Reserved IPv6s — digitalocean.reservedipv6_list |
Read |
Create a New Reserved IPv6 — digitalocean.reservedipv6_create |
Write |
Retrieve an Existing Reserved IPv6 — digitalocean.reservedipv6_get |
Read |
Delete a Reserved IPv6 — digitalocean.reservedipv6_delete |
Write |
Initiate a Reserved IPv6 Action — digitalocean.reservedipv6actions_post |
Write |
Create a BYOIP Prefix — digitalocean.byoipprefixes_create |
Write |
List BYOIP Prefixes — digitalocean.byoipprefixes_list |
Read |
Get a BYOIP Prefix — digitalocean.byoipprefixes_get |
Read |
Delete a BYOIP Prefix — digitalocean.byoipprefixes_delete |
Write |
Update a BYOIP Prefix — digitalocean.byoipprefixes_patch |
Write |
List BYOIP Prefix Resources — digitalocean.byoipprefixes_list_resources |
Read |
List Scans — digitalocean.security_list_scans |
Read |
Create Scan — digitalocean.security_create_scan |
Write |
Get Scan — digitalocean.security_get_scan |
Read |
Get Latest Scan — digitalocean.security_get_latest_scan |
Read |
Create Scan Rule — digitalocean.security_create_scan_rule |
Write |
List Finding Affected Resources — digitalocean.security_list_scan_finding_affected_resources |
Read |
List Settings — digitalocean.security_list_settings |
Read |
Update Plan — digitalocean.security_update_settings_plan |
Write |
Create Suppression — digitalocean.security_create_suppression |
Write |
Delete Suppression — digitalocean.security_delete_suppression |
Write |
List Secrets — digitalocean.security_list_secrets |
Read |
Create Secret — digitalocean.security_create_secret |
Write |
Get Secret — digitalocean.security_get_secret |
Read |
Update Secret — digitalocean.security_update_secret |
Write |
Delete Secret — digitalocean.security_delete_secret |
Write |
List Secret Versions — digitalocean.security_list_secret_versions |
Read |
Revert Secret — digitalocean.security_revert_secret |
Write |
Restore Secret — digitalocean.security_post_restore_secret |
Write |
List All Droplet Sizes — digitalocean.sizes_list |
Read |
List All Snapshots — digitalocean.snapshots_list |
Read |
Retrieve an Existing Snapshot — digitalocean.snapshots_get |
Read |
Delete a Snapshot — digitalocean.snapshots_delete |
Write |
List Spaces Access Keys — digitalocean.spaceskey_list |
Read |
Create a New Spaces Access Key — digitalocean.spaceskey_create |
Write |
Get a Spaces Access Key — digitalocean.spaceskey_get |
Read |
Delete a Spaces Access Key — digitalocean.spaceskey_delete |
Write |
Update Spaces Access Keys — digitalocean.spaceskey_update |
Write |
Update Spaces Access Keys — digitalocean.spaceskey_patch |
Write |
List All Tags — digitalocean.tags_list |
Read |
List All Vector Databases — digitalocean.vectordatabases_list |
Read |
Create a New Vector Database — digitalocean.vectordatabases_create |
Write |
Retrieve an Existing Vector Database — digitalocean.vectordatabases_get |
Read |
Update a Vector Database — digitalocean.vectordatabases_update |
Write |
Delete a Vector Database — digitalocean.vectordatabases_delete |
Write |
List Backups for a Vector Database — digitalocean.vectordatabases_list_backups |
Read |
Retrieve the Status of a Restore — digitalocean.vectordatabases_get_restore_status |
Read |
Restore a Vector Database from a Backup — digitalocean.vectordatabases_post_restore_backup |
Write |
Retrieve Admin Credentials for a Vector Database — digitalocean.vectordatabases_get_credentials |
Read |
Resize a Vector Database — digitalocean.vectordatabases_post_resize |
Write |
Update Tags on a Vector Database — digitalocean.vectordatabases_update_tags |
Write |
List All Block Storage Volumes — digitalocean.volumes_list |
Read |
Create a New Block Storage Volume — digitalocean.volumes_create |
Write |
Delete a Block Storage Volume by Name — digitalocean.volumes_delete_byname |
Write |
Initiate A Block Storage Action By Volume Name — digitalocean.volumeactions_post |
Write |
Retrieve an Existing Volume Snapshot — digitalocean.volumesnapshots_get_byid |
Read |
Delete a Volume Snapshot — digitalocean.volumesnapshots_delete_byid |
Write |
Retrieve an Existing Block Storage Volume — digitalocean.volumes_get |
Read |
Delete a Block Storage Volume — digitalocean.volumes_delete |
Write |
List All Actions for a Volume — digitalocean.volumeactions_list |
Read |
Initiate A Block Storage Action By Volume Id — digitalocean.volumeactions_post_byid |
Write |
Retrieve an Existing Volume Action — digitalocean.volumeactions_get |
Read |
List Snapshots for a Volume — digitalocean.volumesnapshots_list |
Read |
Create Snapshot from a Volume — digitalocean.volumesnapshots_create |
Write |
List All VPCs — digitalocean.vpcs_list |
Read |
Create a New VPC — digitalocean.vpcs_create |
Write |
Retrieve an Existing VPC — digitalocean.vpcs_get |
Read |
Update a VPC — digitalocean.vpcs_update |
Write |
Partially Update a VPC — digitalocean.vpcs_patch |
Write |
Delete a VPC — digitalocean.vpcs_delete |
Write |
List the Member Resources of a VPC — digitalocean.vpcs_list_members |
Read |
List the Peerings of a VPC — digitalocean.vpcs_list_peerings |
Read |
Create a Peering with a VPC — digitalocean.vpcs_create_peerings |
Write |
Update a VPC Peering — digitalocean.vpcs_patch_peerings |
Write |
List VPC Routes — digitalocean.vpcroutes_list |
Read |
List VPC Subnets — digitalocean.vpcsubnets_list |
Read |
Create a VPC Subnet — digitalocean.vpcsubnets_create |
Write |
Retrieve a VPC Subnet — digitalocean.vpcsubnets_get |
Read |
Update a VPC Subnet — digitalocean.vpcsubnets_update |
Write |
Delete a VPC Subnet — digitalocean.vpcsubnets_delete |
Write |
List the Member Resources of a VPC Subnet — digitalocean.vpcsubnets_list_members |
Read |
List VPC Subnet Routes — digitalocean.vpcsubnetroutes_list |
Read |
Create a VPC Subnet Route — digitalocean.vpcsubnetroutes_create |
Write |
Update a VPC Subnet Route — digitalocean.vpcsubnetroutes_update |
Write |
Delete a VPC Subnet Route — digitalocean.vpcsubnetroutes_delete |
Write |
List All VPC Peerings — digitalocean.vpcpeerings_list |
Read |
Create a New VPC Peering — digitalocean.vpcpeerings_create |
Write |
Retrieve an Existing VPC Peering — digitalocean.vpcpeerings_get |
Read |
Update a VPC peering — digitalocean.vpcpeerings_patch |
Write |
Delete a VPC peering — digitalocean.vpcpeerings_delete |
Write |
List All VPC NAT Gateways — digitalocean.vpcnatgateways_list |
Read |
Create a New VPC NAT Gateway — digitalocean.vpcnatgateways_create |
Write |
Retrieve an Existing VPC NAT Gateway — digitalocean.vpcnatgateways_get |
Read |
Update VPC NAT Gateway — digitalocean.vpcnatgateways_update |
Write |
Delete VPC NAT Gateway — digitalocean.vpcnatgateways_delete |
Write |
List All Checks — digitalocean.uptime_list_checks |
Read |
Create a New Check — digitalocean.uptime_create_check |
Write |
Retrieve an Existing Check — digitalocean.uptime_get_check |
Read |
Update a Check — digitalocean.uptime_update_check |
Write |
Delete a Check — digitalocean.uptime_delete_check |
Write |
Retrieve Check State — digitalocean.uptime_get_checkstate |
Read |
List All Alerts — digitalocean.uptime_list_alerts |
Read |
Create a New Alert — digitalocean.uptime_create_alert |
Write |
Retrieve an Existing Alert — digitalocean.uptime_get_alert |
Read |
Update an Alert — digitalocean.uptime_update_alert |
Write |
Delete an Alert — digitalocean.uptime_delete_alert |
Write |
List Agents — digitalocean.genai_list_agents |
Read |
Create an Agent — digitalocean.genai_create_agent |
Write |
List Agent API Keys — digitalocean.genai_list_agent_api_keys |
Read |
Create an Agent API Key — digitalocean.genai_create_agent_api_key |
Write |
Update API Key for an Agent — digitalocean.genai_update_agent_api_key |
Write |
Delete API Key for an Agent — digitalocean.genai_delete_agent_api_key |
Write |
Regenerate API Key for an Agent — digitalocean.genai_regenerate_agent_api_key |
Write |
Add Function Route to an Agent — digitalocean.genai_attach_agent_function |
Write |
Update Function Route for an Agent — digitalocean.genai_update_agent_function |
Write |
Delete Function Route for an Agent — digitalocean.genai_detach_agent_function |
Write |
Attach Guardrails to an Agent — digitalocean.genai_attach_agent_guardrails |
Write |
Detach a Guardrail from an Agent — digitalocean.genai_detach_agent_guardrail |
Write |
Attach Knowledge Bases to an Agent — digitalocean.genai_attach_knowledge_bases |
Write |
Attach Knowledge Base to an Agent — digitalocean.genai_attach_knowledge_base |
Write |
Detach Knowledge Base from an Agent — digitalocean.genai_detach_knowledge_base |
Write |
Add Agent Route to an Agent — digitalocean.genai_attach_agent |
Write |
Update Agent Route for an Agent — digitalocean.genai_update_attached_agent |
Write |
Delete Agent Route for an Agent — digitalocean.genai_detach_agent |
Write |
Retrieve an Existing Agent — digitalocean.genai_get_agent |
Read |
Update an Agent — digitalocean.genai_update_agent |
Write |
Delete an Agent — digitalocean.genai_delete_agent |
Write |
View Agent Routes — digitalocean.genai_get_agent_children |
Read |
Update Agent Status — digitalocean.genai_update_agent_deployment_visibility |
Write |
Get Agent Usage — digitalocean.genai_get_agent_usage |
Read |
List Agent Versions — digitalocean.genai_list_agent_versions |
Read |
Rollback to Agent Version — digitalocean.genai_rollback_to_agent_version |
Write |
List Anthropic API Keys — digitalocean.genai_list_anthropic_api_keys |
Read |
Create Anthropic API Key — digitalocean.genai_create_anthropic_api_key |
Write |
Get Anthropic API Key — digitalocean.genai_get_anthropic_api_key |
Read |
Update Anthropic API Key — digitalocean.genai_update_anthropic_api_key |
Write |
Delete Anthropic API Key — digitalocean.genai_delete_anthropic_api_key |
Write |
List agents by Anthropic key — digitalocean.genai_list_agents_by_anthropic_key |
Read |
List Custom Models — digitalocean.genai_list_custom_models |
Read |
Import Custom Model — digitalocean.genai_import_custom_model |
Write |
Get Custom Model — digitalocean.genai_get_custom_model |
Read |
Delete Custom Model — digitalocean.genai_delete_custom_model |
Write |
Update Custom Model Metadata — digitalocean.genai_update_custom_model_metadata |
Write |
List Evaluation Datasets — digitalocean.genai_list_evaluation_datasets |
Read |
Create Evaluation Dataset — digitalocean.genai_create_evaluation_dataset |
Write |
Create Presigned URLs for Evaluation Dataset File Upload — digitalocean.genai_create_evaluation_dataset_file_upload_presigned_urls |
Write |
Delete Evaluation Dataset — digitalocean.genai_delete_evaluation_dataset |
Write |
Get Download URL for Evaluation Dataset — digitalocean.genai_get_evaluation_dataset_download_url |
Read |
List Evaluation Metrics — digitalocean.genai_list_evaluation_metrics |
Read |
Create Custom Evaluation Metric — digitalocean.genai_create_custom_evaluation_metric |
Write |
Update Custom Evaluation Metric — digitalocean.genai_update_custom_evaluation_metric |
Write |
Delete Custom Evaluation Metric — digitalocean.genai_delete_custom_evaluation_metric |
Write |
Run an Evaluation Test Case — digitalocean.genai_run_evaluation_test_case |
Write |
Retrieve Information About an Existing Evaluation Run — digitalocean.genai_get_evaluation_run |
Read |
Retrieve Results of an Evaluation Run — digitalocean.genai_get_evaluation_run_results |
Read |
Retrieve Results of an Evaluation Run Prompt — digitalocean.genai_get_evaluation_run_prompt_results |
Read |
List Evaluation Test Cases — digitalocean.genai_list_evaluation_test_cases |
Read |
Create Evaluation Test Case. — digitalocean.genai_create_evaluation_test_case |
Write |
List Evaluation Runs by Test Case — digitalocean.genai_list_evaluation_runs_by_test_case |
Read |
Retrieve Information About an Existing Evaluation Test Case — digitalocean.genai_get_evaluation_test_case |
Read |
Update an Evaluation Test Case. — digitalocean.genai_update_evaluation_test_case |
Write |
List Indexing Jobs for a Knowledge Base — digitalocean.genai_list_indexing_jobs |
Read |
Start Indexing Job for a Knowledge Base — digitalocean.genai_create_indexing_job |
Write |
List Data Sources for Indexing Job for a Knowledge Base — digitalocean.genai_list_indexing_job_data_sources |
Read |
Get Signed URL for Indexing Job Details — digitalocean.genai_get_indexing_job_details_signed_url |
Read |
Retrieve Status of Indexing Job for a Knowledge Base — digitalocean.genai_get_indexing_job |
Read |
Cancel Indexing Job for a Knowledge Base — digitalocean.genai_cancel_indexing_job |
Write |
List Knowledge Bases — digitalocean.genai_list_knowledge_bases |
Read |
Create a Knowledge Base — digitalocean.genai_create_knowledge_base |
Write |
Create Presigned URLs for Data Source File Upload — digitalocean.genai_create_data_source_file_upload_presigned_urls |
Write |
List Data Sources for a Knowledge Base — digitalocean.genai_list_knowledge_base_data_sources |
Read |
Add Data Source to a Knowledge Base — digitalocean.genai_create_knowledge_base_data_source |
Write |
Update Data Source options — digitalocean.genai_update_knowledge_base_data_source |
Write |
Delete a Data Source from a Knowledge Base — digitalocean.genai_delete_knowledge_base_data_source |
Write |
List Indexing Jobs for a Knowledge Base — digitalocean.genai_list_indexing_jobs_by_knowledge_base |
Read |
Retrieve Information About an Existing Knowledge Base — digitalocean.genai_get_knowledge_base |
Read |
Update a Knowledge Base — digitalocean.genai_update_knowledge_base |
Write |
Delete a Knowledge Base — digitalocean.genai_delete_knowledge_base |
Write |
Create Presigned URLs for Model Evaluation Dataset File Upload — digitalocean.genai_create_model_eval_dataset_upload_presigned_urls |
Write |
List Model Evaluation Metrics — digitalocean.genai_list_model_evaluation_metrics |
Read |
List Model Evaluation Presets — digitalocean.genai_list_model_evaluation_presets |
Read |
Retrieve Model Evaluation Preset — digitalocean.genai_get_model_evaluation_preset |
Read |
Delete Model Evaluation Preset — digitalocean.genai_delete_model_evaluation_preset |
Write |
List Model Evaluation Runs — digitalocean.genai_list_model_evaluation_runs |
Read |
Create Model Evaluation Run — digitalocean.genai_create_model_evaluation_run |
Write |
Retrieve Model Evaluation Run — digitalocean.genai_get_model_evaluation_run |
Read |
Delete Model Evaluation Run — digitalocean.genai_delete_model_evaluation_run |
Write |
Update Model Evaluation Run — digitalocean.genai_update_model_evaluation_run |
Write |
Cancel Model Evaluation Run — digitalocean.genai_cancel_model_evaluation_run |
Write |
Get Download URL for Model Evaluation Run Results — digitalocean.genai_get_model_evaluation_run_results_download_url |
Read |
List Available Models — digitalocean.genai_list_models |
Read |
List Model API Keys — digitalocean.genai_list_model_api_keys |
Read |
Update API Key for a Model — digitalocean.genai_update_model_api_key |
Write |
Delete API Key for a Model — digitalocean.genai_delete_model_api_key |
Write |
Regenerate API Key for a Model — digitalocean.genai_regenerate_model_api_key |
Write |
List Model Catalog — digitalocean.genai_list_model_catalog |
Read |
Get Model Catalog Card — digitalocean.genai_get_model_catalog_card |
Read |
List Model Routers — digitalocean.genai_list_model_routers |
Read |
Create a Model Router — digitalocean.genai_create_model_router |
Write |
List Model Router Presets — digitalocean.genai_list_model_router_presets |
Read |
List Model Router Task Presets — digitalocean.genai_list_model_router_task_presets |
Read |
Retrieve an Existing Model Router — digitalocean.genai_get_model_router |
Read |
Update a Model Router — digitalocean.genai_update_model_router |
Write |
Delete a Model Router — digitalocean.genai_delete_model_router |
Write |
Get Oauth2 Dropbox Tokens — digitalocean.genai_create_oauth2_dropbox_tokens |
Write |
Get Oauth2 URL — digitalocean.genai_get_oauth2_url |
Read |
List OpenAI API Keys — digitalocean.genai_list_openai_api_keys |
Read |
Create OpenAI API Key — digitalocean.genai_create_openai_api_key |
Write |
Get OpenAI API Key — digitalocean.genai_get_openai_api_key |
Read |
Update OpenAI API Key — digitalocean.genai_update_openai_api_key |
Write |
Delete OpenAI API Key — digitalocean.genai_delete_openai_api_key |
Write |
List agents by OpenAI key — digitalocean.genai_list_agents_by_openai_key |
Read |
List Datacenter Regions — digitalocean.genai_list_datacenter_regions |
Read |
List Common Scenario & Goal Library — digitalocean.genai_list_scenario_library |
Read |
Create Scenario Set From Library — digitalocean.genai_create_scenario_set_from_library |
Write |
List Scenarios In Library Entry — digitalocean.genai_list_scenario_library_scenarios |
Read |
List Scenario Sets — digitalocean.genai_list_scenario_sets |
Read |
Create Scenario Set — digitalocean.genai_create_scenario_set |
Write |
Create Presigned URLs for Scenario Set File Upload — digitalocean.genai_create_scenario_set_upload_presigned_urls |
Write |
Generate Scenario Set — digitalocean.genai_create_generated_scenario_set |
Write |
Retrieve Scenario Set — digitalocean.genai_get_scenario_set |
Read |
Update Scenario Set — digitalocean.genai_update_scenario_set |
Write |
Delete Scenario Set — digitalocean.genai_delete_scenario_set |
Write |
Retrieve Scenario Set Download URL — digitalocean.genai_get_scenario_set_download_url |
Read |
Duplicate Scenario Set — digitalocean.genai_create_duplicate_scenario_set |
Write |
List Scenarios — digitalocean.genai_list_scenarios |
Read |
Create scheduled indexing for knowledge base — digitalocean.genai_create_scheduled_indexing |
Write |
Get Scheduled Indexing for Knowledge Base — digitalocean.genai_get_scheduled_indexing |
Read |
Delete Scheduled Indexing — digitalocean.genai_delete_scheduled_indexing |
Write |
List Simulation Runs — digitalocean.genai_list_simulation_runs |
Read |
Create Simulation Run — digitalocean.genai_create_simulation_run |
Write |
Retrieve Simulation Run — digitalocean.genai_get_simulation_run |
Read |
Update Simulation Run — digitalocean.genai_update_simulation_run |
Write |
Delete Simulation Run — digitalocean.genai_delete_simulation_run |
Write |
Cancel Simulation Run — digitalocean.genai_patch_cancel_simulation_run |
Write |
List Simulation Episodes — digitalocean.genai_list_simulation_episodes |
Read |
Retrieve Simulation Episode — digitalocean.genai_get_simulation_episode |
Read |
Retrieve Episode Trajectory — digitalocean.genai_get_simulation_episode_trajectory |
Read |
Retrieve Episode Trajectory Download URL — digitalocean.genai_get_simulation_episode_trajectory_url |
Read |
List Workspaces — digitalocean.genai_list_workspaces |
Read |
Create a Workspace — digitalocean.genai_create_workspace |
Write |
Retrieve an Existing Workspace — digitalocean.genai_get_workspace |
Read |
Update a Workspace — digitalocean.genai_update_workspace |
Write |
Delete a Workspace — digitalocean.genai_delete_workspace |
Write |
List agents by Workspace — digitalocean.genai_list_agents_by_workspace |
Read |
Move Agents to a Workspace — digitalocean.genai_update_agents_workspace |
Write |
List Evaluation Test Cases by Workspace — digitalocean.genai_list_evaluation_test_cases_by_workspace |
Read |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for DigitalOcean, then enter the issued values in the connection form below.
- In the DigitalOcean control panel, open API → Tokens → Generate New Token. Select an expiry and custom scopes for the commands you need; begin with read scopes. Copy the personal access token into this connection’s DigitalOcean personal access token field, enable commands and create a Tooluse.net API key. Creating or resizing infrastructure can incur charges. Spaces S3 credentials are separate and are not accepted here.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| DigitalOcean personal access token | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {
"path": {
"actor_id": "alice"
}
}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Get an Actor's Limits — digitalocean.actorlimits_get
Returns the per-minute limits set for the actor and the limits in effect, each the lower of your team's limit and the actor's override. Returns 404 when the actor has no sessions, connections, or limit overrides.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.actor_id |
string | Required | Actor ID: a session actor_id or a connection user_id, 1 to 64 characters from [A-Za-z0-9._-]. |
pattern: "^[A-Za-z0-9._-]{1,64}$" |
Full JSON Schema
Example input
{
"path": {
"actor_id": "alice"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clear an Actor's Limits — digitalocean.actorlimits_delete
Removes the actor's overrides for the listed categories, which then follow your team's limits again. Clearing a category without an override succeeds.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.actor_id |
string | Required | Actor ID: a session actor_id or a connection user_id, 1 to 64 characters from [A-Za-z0-9._-]. |
pattern: "^[A-Za-z0-9._-]{1,64}$" |
body |
— | Required | $ref: "#/definitions/clear_actor_limits" |
Full JSON Schema
Example input
{
"path": {
"actor_id": "alice"
},
"body": {
"categories": [
"LIMIT_CATEGORY_WEB_SEARCH_REQUESTS_PER_MINUTE"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set an Actor's Limits — digitalocean.actorlimits_update
Sets per-minute limits for the listed categories and leaves the others unchanged. A limit may not exceed your team's current limit for the category (400 otherwise), and 0 blocks every call in the category. The actor does not need to exist yet.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.actor_id |
string | Required | Actor ID: a session actor_id or a connection user_id, 1 to 64 characters from [A-Za-z0-9._-]. |
pattern: "^[A-Za-z0-9._-]{1,64}$" |
body |
— | Required | $ref: "#/definitions/set_actor_limits" |
Full JSON Schema
Example input
{
"path": {
"actor_id": "alice"
},
"body": {
"overrides": [
{
"category": "LIMIT_CATEGORY_WEB_SEARCH_REQUESTS_PER_MINUTE",
"requests_per_minute": "30"
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Provider Credential — digitalocean.providercredentials_create
Stores an API key or OAuth client for a catalog provider that supports that credential type. Secret material is write-only. Only you can see and use the credential unless you share it with your team using reusable_by_team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/provider_credential_create" |
Full JSON Schema
Example input
{
"body": {
"provider": "example-provider",
"kind": "PROVIDER_CREDENTIAL_KIND_API_KEY",
"display_name": "Production key",
"api_key": "<provider-api-key>"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Provider Credentials — digitalocean.providercredentials_list
Lists registered credentials visible to you, ordered by provider and display name. Optionally filter by provider slug, ignoring case. An unknown provider returns an empty list. Results are not paginated and exclude DigitalOcean-owned OAuth applications and credentials managed by MCP server registrations.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.provider |
string | Optional | Optional provider slug, matched case-insensitively. Omit to list credentials for all providers. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Provider Credential — digitalocean.providercredentials_get
Returns metadata for a provider credential, never its secret material. Returns 404 if the credential is unknown, deleted, or not visible to you.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Provider credential ID returned when the credential was created. |
Full JSON Schema
Example input
{
"path": {
"id": "example-credential-id"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Provider Credential — digitalocean.providercredentials_delete
Deletes a provider credential and every connection that uses it. There is no confirmation step. Warn affected users before deleting; sessions relying on those connections lose provider access. To rotate a key without removing connections, update the credential instead.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Provider credential ID returned when the credential was created. |
Full JSON Schema
Example input
{
"path": {
"id": "example-credential-id"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Connection — digitalocean.connections_create
Connects one of your users, identified by user_id, to a provider so tools can act on their account. An OAuth connection starts pending, and authorization carries the URL to send the user to; read the connection until it is active or expired. A connection through a team API-key credential is active immediately. Register the API key with POST /v2/action-gateway/provider-credentials first, then set credential.team_credential.credential_id to the returned credential.id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/connection_create" |
Full JSON Schema
Example input
{
"body": {
"provider": "jira",
"user_id": "alice"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Connections — digitalocean.connections_list
Returns the connections you can see, excluding revoked ones. Offset-paged with page and per_page; filter by provider, user_id, and status.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.provider |
string | Optional | Optional provider slug, matched exactly. | |
query.user_id |
string | Optional | Optional substring of user_id. It must use the user_id alphabet, [A-Za-z0-9._-]. |
|
query.status |
string | Optional | pending|active|revoked|expired. List results always omit revoked connections, including when this filter is revoked. | enum: ["pending","active","expired"] |
query.sort |
string | Optional | created_at, provider, user_id, or status. Defaults to provider, then user_id. |
enum: ["created_at","provider","user_id","status"] |
query.sort_direction |
string | Optional | asc (the default) or desc. | enum: ["asc","desc"] |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Connection — digitalocean.connections_get
Returns the connection and, while it is pending, the authorization the user still has to complete. Reading a pending connection picks up a completed authorization, and marks the connection expired once its link has lapsed. Returns 404 for an unknown connection or one you cannot see.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Connection ID. |
Full JSON Schema
Example input
{
"path": {
"id": "39f9f768-a7f9-4c91-9557-3328c53dd054"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Connection — digitalocean.connections_delete
Marks the connection revoked and returns it; for an OAuth connection, its stored tokens are deleted first. Creating a connection for the same provider and user_id later reuses the same ID. Only the user who created the connection can delete it; for anyone else it is 404.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Connection ID. |
Full JSON Schema
Example input
{
"path": {
"id": "39f9f768-a7f9-4c91-9557-3328c53dd054"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Register an MCP Server — digitalocean.mcpservers_create
Registers a remote MCP server for your team, using the streamable HTTP transport. The server starts with syncStatus pending and no tools: discover its tools with POST .../mcp-servers/{server_ref}/resync, then choose which to enable with PUT .../mcp-servers/{server_ref}/tools. The endpoint must be HTTPS and resolve only to public IP addresses. The number of servers per team is limited (10 by default); registering beyond it returns 429. Returns 409 when serverRef is already in use.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/mcp_server_create" |
Full JSON Schema
Example input
{
"body": {
"serverRef": "docs",
"endpoint": "https://mcp.example.com/mcp"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List MCP Servers — digitalocean.mcpservers_list
Returns every MCP server your team has registered, sorted by serverRef.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an MCP Server — digitalocean.mcpservers_get
Returns one of your team's MCP servers, or 404 when your team has none with this serverRef.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an MCP Server — digitalocean.mcpservers_patch
Changes the server's description, which is shown on its catalog card immediately. The endpoint and credentials cannot be changed; to change them, delete the server and register it again.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
|
body |
— | Required | $ref: "#/definitions/mcp_server_update" |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an MCP Server — digitalocean.mcpservers_delete
Disables all of the server's tools, removes them from your team's catalog, and deletes the server. An api_key supplied at registration is deleted; a credentialRef you supplied is left untouched. For a server registered with credentialRefSource connection, every user connection made through its OAuth client is revoked. Returns the deleted server, or 404 when it does not exist.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Discover an MCP Server's Tools — digitalocean.mcpservers_run_resync
Connects to the server, lists its tools, and records them. Discovered tools are not callable until you enable them.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
|
body |
— | Required | $ref: "#/definitions/mcp_server_resync" |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List an MCP Server's Tools — digitalocean.mcpservers_list_tools
Returns every tool discovered on the server, sorted by name, with whether each is enabled. Tools that have since disappeared from the server stay listed.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Set Which of an MCP Server's Tools Are Enabled — digitalocean.mcpservers_update_tools
enabledToolSlugs is the complete set to enable; every other tool of the server is disabled. An enabled tool is added to your team's catalog at its latest discovered version, and a disabled one is removed from it. Repeating the same set changes nothing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.server_ref |
string | Required | Server identifier (serverRef) of one of your team's MCP servers. |
|
body |
— | Required | $ref: "#/definitions/mcp_server_tools_update" |
Full JSON Schema
Example input
{
"path": {
"server_ref": "docs"
},
"body": {
"enabledToolSlugs": [
"docs_search",
"docs_get_page"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an Output View — digitalocean.outputviews_create
An output view is a named projection of one tool version's output: tool calls that use it return only the listed fields, and its output_schema describes the result. The view is bound to the tool version your catalog currently releases. Returns 409 when your team already has a view with this name on the tool version, and 429 when your team already has the maximum of 20 views on it.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/output_view_create" |
Full JSON Schema
Example input
{
"body": {
"name": "titles-and-urls",
"fields": [
"results.title",
"results.url"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Output Views — digitalocean.outputviews_list
Returns the output views your team can use: views DigitalOcean publishes to every team, plus your team's own. Cursor-paged with page_size and page_token; no total is reported.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.tool |
string | Optional | At most one of tool or tool_id, as on create. With one set, the list is the published views plus your team's own on that tool version. With neither, it is every live view your team owns plus every published view on a tool version your catalog exposes, across tools. |
|
query.tool_id |
string | Optional | Opaque ID of the tool version; see tool. | |
query.page_size |
integer | Optional | Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400. | default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | next_page_token from the previous response. Valid only with the same tool selection; otherwise the request is rejected with 400. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Preview an Output View — digitalocean.outputviews_validate
Validates a projection exactly as create does and returns the view it would produce, including output_schema, without storing anything. name and description are optional here; name uniqueness and the per-tool-version limit are not checked.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/output_view_preview" |
Full JSON Schema
Example input
{
"body": {
"fields": [
"results.title",
"results.url"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an Output View — digitalocean.outputviews_get
Returns one of your team's views, or a published view on a tool version your catalog exposes. Returns 404 when the view does not exist, was deleted, or belongs to another team.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.view_id |
string | Required | Output view ID. |
Full JSON Schema
Example input
{
"path": {
"view_id": "ov_4f0c2a9d8e1b47c6a3d5f7e9b1c3a5d7"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Output View — digitalocean.outputviews_delete
Deletes one of your team's views and returns it with audit.deleted_at set; it can no longer be used. Published views cannot be deleted. Returns 404 when the view does not exist, is already deleted, or is not your team's.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.view_id |
string | Required | Output view ID. |
Full JSON Schema
Example input
{
"path": {
"view_id": "ov_4f0c2a9d8e1b47c6a3d5f7e9b1c3a5d7"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Session — digitalocean.sessions_create
Creates a session owned by your team, with a new session URN, and returns the MCP URL an agent connects to. tools selects the tools and toolbelts the session exposes, and policy decides which calls run, need approval, or are refused.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/session_create" |
Full JSON Schema
Example input
{
"body": {
"name": "support-bot-alice"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Sessions — digitalocean.sessions_list
Returns the sessions you can see, newest first. Offset-paged with page and per_page; end_user_id filters to one actor.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.end_user_id |
string | Optional | Optional actor_id, matched exactly. |
|
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search Sessions — digitalocean.sessions_list_search
Returns the sessions you can see whose name, actor_id, session_urn, or agentName contains query, case-insensitively, ranked across the whole result set. Cursor-paged with page_size and page_token; no total is reported.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | Matched case-insensitively as a substring of name, actor_id, session_urn, or agentName. Empty matches every session you can see. Results are ordered by match quality (an exact name, session_urn, or actor_id match, then a prefix, then a substring), then by name, across the whole result set, so a client must not re-sort a page to rank it. |
|
query.end_user_id |
string | Optional | end_user_id, when set, is an exact filter on actor_id (the same filter as on the session list) and combines with query as AND. |
|
query.page_size |
integer | Optional | Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400. | default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | next_page_token from the previous response. Valid only with the same query and end_user_id; otherwise the request is rejected with 400. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Session — digitalocean.sessions_delete
Deletes the session and its policy. Succeeds without deleting anything when the session does not exist or you cannot delete it, so repeating a delete also succeeds. A malformed session_urn is rejected with 400.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_urn |
string | Required | URN of the session, for example do:managed_agent_session:<uuid>. |
Full JSON Schema
Example input
{
"path": {
"session_urn": "do:managed_agent_session:2b3c9f0e-1a4d-4e5f-8a7b-6c5d4e3f2a1b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Toolbelt — digitalocean.toolbelts_create
A toolbelt is a named set of tools, each pinned to a version, that your team can attach to sessions as toolbelt:<name>@<version>. The first version is 1 unless version is set. Returns 409 if an active toolbelt with the same name exists. The name of a deleted toolbelt can be reused; its versions start again from the initial version.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/toolbelt_create" |
Full JSON Schema
Example input
{
"body": {
"name": "search-toolbelt"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Toolbelts — digitalocean.toolbelts_list
Returns your team's toolbelts, one entry per name describing its latest version, sorted by name. Offset-paged with page and per_page; pagination reports the total.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.status |
string | Optional | active (default), deprecated, or all. Case-insensitive. | enum: ["active","deprecated","all"]; default: "active" |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search Toolbelts — digitalocean.toolbelts_list_search
Returns your team's toolbelts whose name, display name, or description contains query, case-insensitively, sorted by name. Cursor-paged with page_size and page_token; no total is reported.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | Matched case-insensitively as a substring of name, display_name, or description. Empty matches every toolbelt of your team. |
|
query.status |
string | Optional | active (default), deprecated, or all. Case-insensitive. | enum: ["active","deprecated","all"]; default: "active" |
query.page_size |
integer | Optional | Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400. | default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | next_page_token from the previous response. Valid only with the same query and status; otherwise the request is rejected with 400. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Toolbelt — digitalocean.toolbelts_get
Returns the latest version of the named toolbelt, or the version requested, with catalog metadata for one page of its members in tool_details. A deleted toolbelt returns 404 unless a version is requested.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
query |
object | Optional | additionalProperties: false |
|
query.version |
string | Optional | Version number to read. Empty returns the latest version. | pattern: "^[0-9]+$" |
query.page_size |
integer | Optional | Page size for tool_details only; toolbelt.tools always lists every member. Defaults to 20; values above 100 are capped at 100. |
default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | next_page_token from the previous response, to continue tool_details. Treat it as opaque, and send it only with the same toolbelt, version, and search. |
|
query.search |
string | Optional | Restricts tool_details to members whose tool slug, name, title, description, provider, or category contains this value, case-insensitively. It does not filter toolbelt.tools. This is a substring match, not a filter expression. |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Toolbelt — digitalocean.toolbelts_delete
Marks the toolbelt deleted and returns its latest version with status deprecated. Its versions stay readable by explicit version until the name is reused. The name is free to reuse immediately; a new toolbelt with it starts a fresh version history. Returns 404 when the toolbelt does not exist or is already deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List the Providers in a Toolbelt — digitalocean.toolbelts_list_providers
Returns the distinct providers of the toolbelt's members, each with its member count, sorted by provider ID. List one provider's members with GET .../toolbelts/{name}/providers/{provider}/tools.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
query |
object | Optional | additionalProperties: false |
|
query.version |
string | Optional | Version number to read. Empty reads the latest version. | pattern: "^[0-9]+$" |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
query.search |
string | Optional | Restricts providers whose ID, name, or description contains this value, case-insensitively. |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List a Toolbelt's Tools from One Provider — digitalocean.toolbelts_list_provider_tools
Returns a page of catalog metadata for the toolbelt's members from the named provider, sorted by tool slug. An unknown provider returns an empty page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
path.provider |
string | Required | A provider ID from the toolbelt's provider list, or _legacy for members recorded without a provider. Matched exactly. |
|
query |
object | Optional | additionalProperties: false |
|
query.version |
string | Optional | Version number to read. Empty reads the latest version. | pattern: "^[0-9]+$" |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
query.search |
string | Optional | Restricts tools whose slug, name, title, description, provider, or category contains this value, case-insensitively, within the provider only. |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt",
"provider": "exa"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Tools to a Toolbelt — digitalocean.toolbelts_add_tools
Adds the listed tools and returns the toolbelt. When membership changes, this creates a new version that keeps the display name and description. Tools already in the toolbelt are left as they are, so a request that adds nothing new returns the current version unchanged. Returns 400 when a tool is not an active catalog tool, when a pin differs from the tool's current released version or from the version the toolbelt already holds, or when the toolbelt would exceed 500 tools. Returns 404 for an unknown or deleted toolbelt.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name, from the path. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
body |
— | Required | $ref: "#/definitions/toolbelt_tools" |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt"
},
"body": {
"tools": [
"exa_web_search"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Tools from a Toolbelt — digitalocean.toolbelts_delete_tools
Removes the listed tools and returns the toolbelt. When membership changes, this creates a new version that keeps the display name and description. Tools that are not members are ignored, and removing every tool is allowed; deleting the toolbelt itself is a separate DELETE. Returns 400 when a pin differs from the version the toolbelt holds, and 404 for an unknown or deleted toolbelt.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.name |
string | Required | Toolbelt name, from the path. | pattern: "^[a-z][a-z0-9_-]{0,63}$" |
body |
— | Required | $ref: "#/definitions/toolbelt_tools" |
Full JSON Schema
Example input
{
"path": {
"name": "search-toolbelt"
},
"body": {
"tools": [
"exa_web_search"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Tools — digitalocean.tools_list
Returns one page of the tools your team can use: released catalog tools plus the enabled tools of your team's MCP servers. definitions[i] describes tools[i]. Offset-paged with page and per_page; an unknown toolkitId returns an empty page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.toolkit_id |
string | Optional | Restricts the page to one provider. It accepts the provider ID the catalog returns, including the serverRef of one of your team's MCP servers. |
|
query.page |
integer | Optional | 1-based page index; values below 1 are treated as 1. A page past the end returns an empty tools list with the real total. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 100 when omitted or 0; values above 100 are capped at 100. | default: 100; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Tool Health — digitalocean.tools_list_health
Returns availability and latency for each catalog tool over the requested window, sorted by provider and then tool slug. A tool with no calls in the window is listed with data_status HEALTH_DATA_STATUS_NO_DATA. Metrics are aggregated across all customers; request volumes are not reported. Tools of your team's MCP servers are not included. Offset-paged with page and per_page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.provider |
string | Optional | Optional provider ID, matched exactly, to return only that provider's tools. | |
query.window |
string | Optional | Window to aggregate over. Defaults to twenty-four hours. - HEALTH_WINDOW_UNSPECIFIED: Twenty-four hours. - HEALTH_WINDOW_ONE_HOUR: One hour; history points are 10 minutes. - HEALTH_WINDOW_TWENTY_FOUR_HOURS: Twenty-four hours; history points are 1 hour. - HEALTH_WINDOW_SEVEN_DAYS: Seven days; history points are 6 hours. - HEALTH_WINDOW_THIRTY_DAYS: Thirty days; history points are 24 hours. |
enum: ["HEALTH_WINDOW_ONE_HOUR","HEALTH_WINDOW_TWENTY_FOUR_HOURS","HEALTH_WINDOW_SEVEN_DAYS","HEALTH_WINDOW_THIRTY_DAYS"]; default: "HEALTH_WINDOW_TWENTY_FOUR_HOURS" |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Provider Health — digitalocean.tools_list_health_providers
Returns availability and latency for each catalog provider over the requested window, sorted by provider ID. Metrics are aggregated across all customers; request volumes are not reported. Tools of your team's MCP servers are not included. Offset-paged with page and per_page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.provider |
string | Optional | Optional provider ID, matched exactly, to return only that provider. | |
query.window |
string | Optional | Window to aggregate over. Defaults to twenty-four hours. - HEALTH_WINDOW_UNSPECIFIED: Twenty-four hours. - HEALTH_WINDOW_ONE_HOUR: One hour; history points are 10 minutes. - HEALTH_WINDOW_TWENTY_FOUR_HOURS: Twenty-four hours; history points are 1 hour. - HEALTH_WINDOW_SEVEN_DAYS: Seven days; history points are 6 hours. - HEALTH_WINDOW_THIRTY_DAYS: Thirty days; history points are 24 hours. |
enum: ["HEALTH_WINDOW_ONE_HOUR","HEALTH_WINDOW_TWENTY_FOUR_HOURS","HEALTH_WINDOW_SEVEN_DAYS","HEALTH_WINDOW_THIRTY_DAYS"]; default: "HEALTH_WINDOW_TWENTY_FOUR_HOURS" |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tool Health — digitalocean.tools_get_health
Returns availability and latency for one catalog tool over the requested window, optionally with a history series. Metrics are aggregated across all customers; request volumes are not reported. Returns 404 when tool_slug is not a catalog tool.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.tool_slug |
string | Required | Catalog tool slug, for example exa_search. Required. |
|
query |
object | Optional | additionalProperties: false |
|
query.window |
string | Optional | Window to aggregate over. Defaults to twenty-four hours. - HEALTH_WINDOW_UNSPECIFIED: Twenty-four hours. - HEALTH_WINDOW_ONE_HOUR: One hour; history points are 10 minutes. - HEALTH_WINDOW_TWENTY_FOUR_HOURS: Twenty-four hours; history points are 1 hour. - HEALTH_WINDOW_SEVEN_DAYS: Seven days; history points are 6 hours. - HEALTH_WINDOW_THIRTY_DAYS: Thirty days; history points are 24 hours. |
enum: ["HEALTH_WINDOW_ONE_HOUR","HEALTH_WINDOW_TWENTY_FOUR_HOURS","HEALTH_WINDOW_SEVEN_DAYS","HEALTH_WINDOW_THIRTY_DAYS"]; default: "HEALTH_WINDOW_TWENTY_FOUR_HOURS" |
query.include_history |
boolean | Optional | Additionally returns the window split into resolution-aligned points (the history field below). | default: false |
Full JSON Schema
Example input
{
"path": {
"tool_slug": "exa_web_search"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Providers — digitalocean.tools_list_providers
Returns the active catalog providers with at least one released tool, sorted by display name, with the credential kinds each accepts and the parameters a connection or team credential needs. Your team's MCP servers are listed separately under /v2/action-gateway/mcp-servers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search Providers — digitalocean.tools_list_search_providers
Returns the providers of GET /v2/action-gateway/tools/providers whose name, display name, or description contains query, case-insensitively, sorted by name. Cursor-paged with page_size and page_token; no total is reported.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | Matched case-insensitively as a substring of name, display_name, or description. It does not match the titles of the tools a provider owns: "providers owning a tool that matches" is a tool search grouped by the provider field of each result. |
|
query.page_size |
integer | Optional | Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400. | default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | next_page_token from the previous response. Valid only with the same query; otherwise the request is rejected with 400. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Search Tools — digitalocean.tools_list_search
Returns the tools your team can use that match query, optionally restricted to some providers or to the members of one of your toolbelts. Results are ranked across the whole result set: exact tool name matches first, then name or title prefixes, then name or title substrings, then other matches. Cursor-paged with page_size and page_token; no total is reported.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.query |
string | Optional | Matched case- and accent-insensitively as a substring of the tool's name, title, description, category, provider ID, or tool slug. Empty matches every tool your team can use. | |
query.provider |
array | Optional | Restricts results to these provider IDs, OR'd together. Repeat the parameter to select several. An unknown ID matches nothing. | |
query.provider[] |
string | Optional | ||
query.toolbelt |
string | Optional | Restricts results to the members of that toolbelt of your team at its latest version, combined with query and provider as AND. Members are matched at the version the toolbelt pins, which is the same set and the same versions GET /v2/action-gateway/toolbelts/{name} reports. An unknown or deleted toolbelt returns 404 rather than an empty page. |
|
query.page_size |
integer | Optional | Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400. | default: 20; minimum: 1; maximum: 100 |
query.page_token |
string | Optional | A next_page_token from the preceding response. It is pinned to the query and filters that produced it: replaying one against a different search is rejected with 400, not a silent restart from the top. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Toolkits — digitalocean.tools_list_toolkits
Returns the providers (toolkits) whose tools your team can use: catalog providers with at least one released tool, plus your team's registered MCP servers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Users — digitalocean.users_list
Returns the user IDs known for your team: session actor_id values, the user_id of connections that are not revoked, and actors with limit overrides. Only sessions and connections you can see count. Offset-paged with page and per_page.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.user_id |
string | Optional | User ID prefix to return. An empty value returns all users. | |
query.sort |
string | Optional | user_id|created_at|session_count|connection_count. created_at is the earliest creation time among the user's sessions, connections, and limit overrides. Defaults to created_at. |
enum: ["created_at","user_id","session_count","connection_count"]; default: "created_at" |
query.sort_direction |
string | Optional | asc|desc. Defaults to desc. | enum: ["asc","desc"] |
query.page |
integer | Optional | 1-based page number. Values below 1 are treated as 1. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Page size. Defaults to 20; values above 100 are capped at 100. | default: 20; minimum: 1; maximum: 100 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a User — digitalocean.users_get
Returns the sessions and non-revoked connections of one user ID. Returns 404 when the user has none you can see and no limit overrides.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.user_id |
string | Required | User ID. |
Full JSON Schema
Example input
{
"path": {
"user_id": "alice"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List 1-Click Applications — digitalocean.oneclicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.type |
string | Optional | Restrict results to a certain type of 1-Click. | enum: ["droplet","kubernetes"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Install Kubernetes 1-Click Applications — digitalocean.oneclicks_install_kubernetes
To install a Kubernetes 1-Click application on a cluster, send a POST request to /v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body parameter in order to specify which 1-Click application(s) to install. To list all available 1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/oneClicks_create" |
Full JSON Schema
Example input
{
"body": {
"addon_slugs": [
"kube-state-metrics",
"loki"
],
"cluster_uuid": "50a994b6-c303-438f-9495-7e896cfe6b08"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get User Information — digitalocean.account_get
To show information about the current user account, send a GET request to /v2/account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All SSH Keys — digitalocean.sshkeys_list
To list all of the keys in your account, send a GET request to /v2/account/keys. The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New SSH Key — digitalocean.sshkeys_create
To add a new SSH public key to your DigitalOcean account, send a POST request to /v2/account/keys. Set the name attribute to the name you wish to use and the public_key attribute to the full public key you are adding.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/sshKeys" |
Full JSON Schema
Example input
{
"body": {
"public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
"name": "My SSH Public Key"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing SSH Key — digitalocean.sshkeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ssh_key_identifier |
— | Required | Either the ID or the fingerprint of an existing SSH key. | |
path.ssh_key_identifier |
— | Required | anyOf[1]; $ref: "#/definitions/ssh_key_id" |
|
path.ssh_key_identifier |
— | Required | anyOf[2]; $ref: "#/definitions/ssh_key_fingerprint" |
Full JSON Schema
Example input
{
"path": {
"ssh_key_identifier": 512189
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an SSH Key's Name — digitalocean.sshkeys_update
To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ssh_key_identifier |
— | Required | Either the ID or the fingerprint of an existing SSH key. | |
path.ssh_key_identifier |
— | Required | anyOf[1]; $ref: "#/definitions/ssh_key_id" |
|
path.ssh_key_identifier |
— | Required | anyOf[2]; $ref: "#/definitions/ssh_key_fingerprint" |
|
body |
object | Required | ||
body.name |
— | Optional | $ref: "#/definitions/ssh_key_name" |
Full JSON Schema
Example input
{
"path": {
"ssh_key_identifier": 512189
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an SSH Key — digitalocean.sshkeys_delete
To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. A 204 status will be returned, indicating that the action was successful and that the response body is empty.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.ssh_key_identifier |
— | Required | Either the ID or the fingerprint of an existing SSH key. | |
path.ssh_key_identifier |
— | Required | anyOf[1]; $ref: "#/definitions/ssh_key_id" |
|
path.ssh_key_identifier |
— | Required | anyOf[2]; $ref: "#/definitions/ssh_key_fingerprint" |
Full JSON Schema
Example input
{
"path": {
"ssh_key_identifier": 512189
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Actions — digitalocean.actions_list
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Action — digitalocean.actions_get
To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Available Add-On Applications — digitalocean.addons_get_app
To fetch details of all available Add-On Applications, send a GET request to /v2/add-ons/apps.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metadata for an Add-On Application — digitalocean.addons_get_app_metadata
To find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata. Metadata varies by application.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_slug |
string | Required | The slug identifier for the application whose metadata is being requested. |
Full JSON Schema
Example input
{
"path": {
"app_slug": "example_app"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all Add-On Resources — digitalocean.addons_list
To fetch all Add-On Resources under your team, send a GET request to /v2/add-ons/saas.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create/Provision a New Add-on Resource — digitalocean.addons_create
To create an add-on resource, send a POST request to /v2/add-ons/saas with required parameters. Some add-ons require additional metadata to be provided in the request body. To find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app_slug}/metadata.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/addons_resource_new" |
Full JSON Schema
Example input
{
"body": {
"name": "my-resource-01",
"app_slug": "example-app",
"plan_slug": "basic_plan",
"metadata": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get details on an Add-On Resource — digitalocean.addons_get
To fetch details of a specific Add-On Resource, send a GET request to /v2/add-ons/saas/{resource_uuid}. Replace {resource_uuid} with the UUID of the resource you want to retrieve.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_uuid |
string | Required | The UUID of the add-on resource to retrieve. |
Full JSON Schema
Example input
{
"path": {
"resource_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete/Deprovision an Add-on Resource — digitalocean.addons_delete
To delete an add-on resource, send a DELETE request to /v2/add-ons/saas/{resource_uuid} with the UUID of the resource to delete. You cannot retrieve the resource after it has been deleted. The response indicates a request was sent to the 3rd party add-on provider to delete the resource. You will no longer be billed for this resource.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_uuid |
string | Required | A unique identifier for the add-on resource. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"resource_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the name for an Add-On Resource — digitalocean.addons_patch
To change the name of an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource_uuid}. Replace {resource_uuid} with the UUID of the resource for which you want to change the name.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_uuid |
string | Required | The UUID of the add-on resource to rename. | |
body |
object | Required | ||
body.name |
string | Required | The new name for the add-on resource. |
Full JSON Schema
Example input
{
"path": {
"resource_uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"body": {
"name": "new-name"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the plan for an Add-On Resource — digitalocean.addons_patch_plan
To change the plan associated with an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource_uuid}/plan. Replace {resource_uuid} with the UUID of the resource for which you want to change the plan.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_uuid |
string | Required | The UUID of the add-on resource to update. | |
body |
object | Required | ||
body.plan_slug |
string | Required | The slug identifier for the new plan to apply to the add-on resource. |
Full JSON Schema
Example input
{
"path": {
"resource_uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"body": {
"plan_slug": "basic_plan"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List active Environment Configs for the caller's team. — digitalocean.harness_list_configs
Returns lightweight team-scoped config metadata without loading or returning environment-spec JSON. Soft-deleted configs are excluded.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted. Values above 200 are rejected. | default: 50; minimum: 1; maximum: 200 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. | |
query.search |
string | Optional | Optional case-insensitive substring filter on config name (contains). Empty or omitted returns the unfiltered page. At most 64 characters. | maxLength: 64 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an Environment Config (environment spec + optional Insights opt-in). — digitalocean.harness_create_config
Accepts name, environment-spec YAML text, and optional Insights telemetry opt-in. Tenant secrets are declared inside the environment spec (write-only values), not as sibling request fields. Responses never echo secret values; GET/create may include credential slot metadata (name/source/provider only). Configs are immutable after create.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/agent_config_create_request" |
Full JSON Schema
Example input
{
"body": {
"name": "support-agent",
"manifest_yaml": "apiVersion: agents.digitalocean.com/v1alpha1\nkind: Agent\nspec:\n runtime:\n adapter: opencode\n"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an active Environment Config and its environment spec. — digitalocean.harness_get_config
Returns one team-scoped Environment Config including the sanitized environment spec and redacted credential slot metadata. Secret values are never returned.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.config_id |
string | Required | The Environment Config UUID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"config_id": "019fb39c-14d9-7080-933e-b9b90e25acda"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Soft-delete an Environment Config. — digitalocean.harness_delete_config
Releases the active team-scoped name; the config row is retained (soft delete), so sessions created from it keep a resolvable config_id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.config_id |
string | Required | The Environment Config UUID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"config_id": "019fb39c-14d9-7080-933e-b9b90e25acda"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone an Environment Config under a new name. — digitalocean.harness_create_config_clone
Copies the source config's sanitized manifest to a new UUID. Source and clone are independent (no lineage). Credential bindings are never copied: if the manifest declares secret slots, supply secrets/oauth_assignments again (write-only). content_hash matches the source when the manifest is unchanged.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.config_id |
string | Required | The Environment Config UUID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/agent_config_clone_request" |
Full JSON Schema
Example input
{
"path": {
"config_id": "019fb39c-14d9-7080-933e-b9b90e25acda"
},
"body": {
"name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List the sessions created from one Environment Config. — digitalocean.harness_list_config_sessions
Enumerates the caller's team sessions whose session was created from this durable Environment Config. Keyset-paginated on an opaque cursor, newest first, same shape and status semantics as GET /v2/agents/sessions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.config_id |
string | Required | The Environment Config UUID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive; values above 200 are clamped to 200. | default: 50; minimum: 1; maximum: 200 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. | |
query.status |
string | Optional | Optional filter on session status. Empty / SESSION_STATUS_UNSPECIFIED still hides destroyed and failed sessions by default; SESSION_STATUS_ALL opts out and returns every session regardless of status. | enum: ["SESSION_STATUS_UNSPECIFIED","SESSION_STATUS_PROVISIONING","SESSION_STATUS_READY","SESSION_STATUS_DETACHED","SESSION_STATUS_DESTROYING","SESSION_STATUS_DESTROYED","SESSION_STATUS_FAILED","SESSION_STATUS_PAUSED","SESSION_STATUS_ALL"] |
Full JSON Schema
Example input
{
"path": {
"config_id": "019fb39c-14d9-7080-933e-b9b90e25acda"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListSessions enumerates sessions for the caller's tenant. — digitalocean.harness_list_sessions
Keyset-paginated on an opaque cursor. Results are scoped to the authenticated team. Destroyed and failed sessions are omitted by default (matching the Cloud Console); pass status=SESSION_STATUS_ALL to list every session regardless of status, or an explicit status such as status=SESSION_STATUS_FAILED or status=SESSION_STATUS_DESTROYED to list only those.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive; values above 200 are clamped to 200 (not rejected). | default: 50; minimum: 1; maximum: 200 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. | |
query.status |
— | Optional | Optional filter on session status. Empty / SESSION_STATUS_UNSPECIFIED means no explicit filter, which still hides destroyed and failed sessions by default; SESSION_STATUS_ALL opts out and returns every session regardless of status (no session is ever actually in this status; it only means something as a filter value here); any other explicit status overrides the default. | $ref: "#/definitions/session_status" |
query.name |
string | Optional | Optional exact-name filter (case-insensitive). Returns the single live (non-terminal) session that currently holds this name for the caller's team, or an empty list if none does. Matches the live holder only, so historical terminal rows and reused names never make it ambiguous (per-team live-name uniqueness bounds it to at most one). This is how clients (doctl / Console) resolve a session name to its id; the {session_id} path stays UUID-only. | |
query.search |
string | Optional | Optional case-insensitive substring filter on session name (contains), for callers that don't know the exact name (e.g. a UI search box). Unlike name, this may return zero, one, or many sessions, including terminal ones. Independent of name; at most 64 characters. |
maxLength: 64 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
CreateSession provisions a sandbox and starts a Harness Runtime session. — digitalocean.harness_create_session
Returns once the session row is allocated. Sandbox boot completes asynchronously.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Optional | additionalProperties: false |
|
headers.X-Device-UUID |
string | Optional | Optional hardware device id forwarded by doctl. Persisted on the session row for lifecycle attribution. Values over 128 bytes are ignored. | |
query |
object | Optional | additionalProperties: false |
|
query.openai_session_id |
string | Optional | OpenAI Agents API session id (sess_…) for adapter: codex-agentapi. doctl creates the OpenAI session before calling DO and passes the resulting id here; harness-api persists it for correlation. Empty/omitted for every other agent kind. | |
query.resume_on_topoff |
boolean | Optional | Opt the new session in to automatic resumption when the team's prepayment balance is restored. Defaults to false. Exists as a query parameter so the environment spec (YAML body) form can carry it too. On the application/json form the body field is idiomatic, but this parameter wins when both are present. Must be exactly one of true/false/1/0; anything else is a 400. | |
body |
— | Required | $ref: "#/definitions/create_session_config_request" |
Full JSON Schema
Example input
{
"body": {
"name": "demo-agent",
"config_id": "11111111-2222-3333-4444-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListSandboxSizes returns the customer-selectable sandbox (microVM) size catalog. — digitalocean.harness_list_session_sandbox_sizes
Read-only catalog the UI (and other clients) render as the size picker, instead of hardcoding the list. The set is the single source of truth shared with create-time validation and the default-size fallback, so every slug returned here is accepted by CreateSession as spec.sandbox.sizeSlug. Sizes are returned smallest-to-largest. Static and safe to cache; independent of team/session; no pagination.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
DestroySession tears down the sandbox and marks the session DESTROYED. — digitalocean.harness_delete_session
Persistent workspace contents are retained per tenant policy. Returns 204 No Content on success.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
headers |
object | Optional | additionalProperties: false |
|
headers.X-Device-UUID |
string | Optional | Optional hardware device id forwarded by doctl. Recorded on the session row as the device that performed the destroy. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetSession returns the current snapshot of a session. — digitalocean.harness_get_session
GetSession returns the current snapshot of a session.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
PatchSession updates session-scoped settings on an existing session. — digitalocean.harness_update_session
Partial update of session-scoped settings (not the agent manifest / config). The body must include at least one recognized patchable property; an empty object {} is 400. Only properties listed on PatchSessionRequest are accepted — any other top-level JSON key is rejected with 400. Omitted properties are left unchanged. Today the only patchable field is resume_on_topoff; more session settings may be added over time. Terminal sessions (DESTROYED, FAILED) cannot be patched.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
— | Required | $ref: "#/definitions/patch_session_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListCheckpoints enumerates a session's checkpoints, newest first. — digitalocean.harness_list_session_checkpoints
Keyset-paginated on an opaque cursor, like ListSessions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive. | |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
CreateCheckpoint captures the session's live sandbox state as a durable checkpoint. — digitalocean.harness_create_session_checkpoint
Synchronous: blocks until the capture reaches READY and returns the terminal Checkpoint — clients never see PENDING on this endpoint and need no poll loop. The checkpoint binds the machine-state capture to the event-log cursor at the cut, so it can later seed forks (POST .../fork) and rollback. Checkpoints are taken between turns; a session with an active turn in flight returns 409.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
— | Optional | $ref: "#/definitions/create_checkpoint_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetCheckpoint returns the current snapshot of a checkpoint. — digitalocean.harness_get_session_checkpoint
GetCheckpoint returns the current snapshot of a checkpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.checkpoint_id |
string | Required | The checkpoint id. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"checkpoint_id": "cp_9f2c1a4b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
DeleteCheckpoint removes a checkpoint and its underlying machine-state capture. — digitalocean.harness_delete_session_checkpoint
Idempotent: deleting an already-gone checkpoint still returns 200. Removes the DB row and the substrate checkpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.checkpoint_id |
string | Required | The checkpoint id. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"checkpoint_id": "cp_9f2c1a4b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
RollbackToCheckpoint rewinds a session to a checkpoint. — digitalocean.harness_revert_session_checkpoint
In-place restore: boots a fresh sandbox from the checkpoint and atomically swaps the session's sandbox pointer to it, so the session keeps its same session_id; the old sandbox is then torn down.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.checkpoint_id |
string | Required | The checkpoint id. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"checkpoint_id": "cp_9f2c1a4b"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ForkSession creates child sessions from a checkpoint of this session. — digitalocean.harness_create_session_fork
Each child boots a fresh sandbox from the checkpoint's machine-state capture and is drivable exactly like any other session (input, HITL), with parent_session_id and fork_id set for lineage. When from_checkpoint_id is omitted, an implicit checkpoint of the session "now" is captured first and the children fork from that. All-or-nothing: on failure nothing is left running.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
— | Optional | $ref: "#/definitions/fork_session_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ResolveHITL records the user's decision on a pending HITL request. — digitalocean.harness_post_session_hitl
harness-api forwards the decision into the owning microVM via the inbound runtime.v1.OHR.ResolveHITL RPC (dialed through the guest-fronting proxy), which unblocks the gated agent action. The resolution is also echoed to all attached clients as a HITLResolved event on StreamSession. Returns 204 No Content on success.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.request_id |
string | Required | The HITL request identifier. | |
headers |
object | Optional | additionalProperties: false |
|
headers.X-Device-UUID |
string | Optional | Optional hardware device id forwarded by doctl. Recorded on the resulting HITL decision. | |
body |
— | Required | $ref: "#/definitions/resolve_hitl_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"request_id": "hitl_example"
},
"body": {
"outcome": "HITL_OUTCOME_UNSPECIFIED"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
SendInput delivers a user chat message into the session. — digitalocean.harness_create_session_input
The agent observes it on its next turn and emits subsequent events via StreamSession. The input is forwarded to the owning microVM's OHR inbound surface, which attributes it to a run and returns the run id.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
— | Required | $ref: "#/definitions/send_input_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {
"text": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
PauseSession freezes the session's microVM sandbox. — digitalocean.harness_post_session_pause
Supported on microvm-substrate sessions only; dewdrop/docker sessions return 501 Not Implemented. Paused sessions count against quota. Clients learn state via GetSession/ListSessions; no live session.updated event is emitted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
headers |
object | Optional | additionalProperties: false |
|
headers.X-Device-UUID |
string | Optional | Optional hardware device id forwarded by doctl. Recorded for audit. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ResumeSession explicitly thaws a PAUSED session's microVM sandbox. — digitalocean.harness_post_session_resume
Only valid for microvm-substrate sessions; dewdrop/docker sessions return 501 Not Implemented. Implicit resume also occurs when SendInput or ResolveHITL is called on a paused session. Returns synchronously once the sandbox is ready.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
headers |
object | Optional | additionalProperties: false |
|
headers.X-Device-UUID |
string | Optional | Optional hardware device id forwarded by doctl. Recorded for audit. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ExecInSandbox runs a one-shot command inside the session's sandbox. — digitalocean.harness_post_session_sandbox_exec
Runs argv directly in the guest (no shell). Stdout/stderr are buffered and capped at 1 MiB each; truncation is indicated via response headers when present. A non-zero exit code is still HTTP 200.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
— | Required | $ref: "#/definitions/exec_in_sandbox_request" |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {
"argv": [
"uname",
"-a"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start a staged (large-file) workspace transfer. — digitalocean.harness_create_session_workspace_transfer
Creates an asynchronous, object-storage-backed transfer for payloads larger than the streaming path supports (> ~50 MiB). Bulk bytes never traverse harness-api: the client PUTs/GETs presigned DO Spaces URLs directly.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
body |
object | Required | ||
body.direction |
string | Required | Transfer direction. | enum: ["upload","download"] |
body.path |
string | Required | Workspace-relative path. Destination for upload, source for download. Paths that escape the workspace root are rejected. | |
body.is_archive |
boolean | Optional | Upload only. When true, the payload is a tar the guest extracts at path. |
|
body.as_archive |
boolean | Optional | Download only. When true, path is exported as a tar stream. |
|
body.size_bytes |
string | Optional | Optional total payload size. Validated against the maximum staged object size (50 GiB); a larger value returns 413. | |
body.sha256 |
string | Optional | Optional lowercase hex SHA-256 of the full payload. If set on an upload, it must match on commit. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {
"direction": "upload",
"path": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the status of a staged workspace transfer. — digitalocean.harness_get_session_workspace_transfer
Returns the current transfer state. For a completed download the response also carries a freshly minted presigned GET download_url (its TTL starts at poll time) and the payload sha256 for client-side verification.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.transfer_id |
string | Required | The workspace transfer identifier. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"transfer_id": "tr_example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel a staged workspace transfer. — digitalocean.harness_cancel_session_workspace_transfer
Aborts an in-flight transfer. Idempotent: cancelling an already-terminal transfer returns aborted: false with the current status. The request body is optional.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.transfer_id |
string | Required | The workspace transfer identifier. | |
body |
object | Optional | ||
body.reason |
string | Optional | Optional caller-visible audit/debug context. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"transfer_id": "tr_example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Finalize a staged upload. — digitalocean.harness_commit_session_workspace_transfer
Upload only. Call once, after all parts have been uploaded. Completes the multipart upload and starts the asynchronous import into the workspace. Responds 202; poll the transfer until completed or failed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.transfer_id |
string | Required | The workspace transfer identifier. | |
body |
object | Optional | ||
body.sha256 |
string | Optional | Optional lowercase hex SHA-256. Must match the value supplied at create when both are set. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"transfer_id": "tr_example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Mint presigned PUT URLs for one or more multipart upload parts. — digitalocean.harness_create_session_workspace_part_upload_urls
Upload only. Pass one or more 1-based part_numbers; the response returns a presigned upload_url per part (all sharing one expires_at), so a client can drive parallel part uploads without a round trip per part. PUT each part's bytes directly to its URL (bypassing harness-api). If URLs expire before the PUT, request them again.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. | |
path.transfer_id |
string | Required | The workspace transfer identifier. | |
body |
object | Required | ||
body.part_numbers |
array | Required | 1-based part indices to presign (single or batched). | |
body.part_numbers[] |
integer | Optional |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"transfer_id": "tr_example"
},
"body": {
"part_numbers": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetIngressURL returns the public HTTPS URL of the session's OpenHands Agent Server. — digitalocean.harness_get_session_ingress
Publishes the URL on first call and returns it. Idempotent while the session runs: the same URL is returned until the session is paused, locked or rolled back, after which the next call returns a new hostname (pause and lock revoke the URL; rollback moves the session to a new sandbox, so re-fetch after resume, unlock or rollback). The URL fronts guest port 8000 (the OpenHands Agent Server, HTTP + WebSocket) and replaces the port-forward bridge for browser clients. Requests to the URL carry the caller's DO token as a Bearer header. Poll until state is INGRESS_URL_STATE_READY; there is no failed state. Only OpenHands sessions support ingress, and it is gated per team.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListTeamTemplates returns the caller's team custom templates. — digitalocean.harness_list_templates
team_id is stamped from the authenticated principal; never accepted from the client.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive. | |
query.page_token |
string | Optional | Optional pagination cursor (opaque). Empty starts from the beginning. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
CreateTemplate creates a team custom template and kicks a build. — digitalocean.harness_create_template
Creates a team-owned template from a customer OCI ref rebased onto a base template. team_id is stamped from the authenticated principal.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_template_request" |
Full JSON Schema
Example input
{
"body": {
"name": "example",
"base_template": "example",
"source_oci_ref": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetTemplate returns a team custom template by public id. — digitalocean.harness_get_template
GetTemplate returns a team custom template by public id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.template_id |
string | Required | The template UUID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"template_id": "11111111-2222-3333-4444-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
UpdateTemplate updates a team template's source and kicks a new build. — digitalocean.harness_update_template
UpdateTemplate updates a team template's source and kicks a new build.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.template_id |
string | Required | The template UUID. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/update_template_request" |
Full JSON Schema
Example input
{
"path": {
"template_id": "11111111-2222-3333-4444-555555555555"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
DeleteTemplate deletes a team custom template. — digitalocean.harness_delete_template
Global templates cannot be deleted via this API.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.template_id |
string | Required | The template UUID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"template_id": "11111111-2222-3333-4444-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListTemplateBuilds returns build history for a template. — digitalocean.harness_list_template_builds
ListTemplateBuilds returns build history for a template.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.template_id |
string | Required | The template UUID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive. | |
query.page_token |
string | Optional | Optional pagination cursor (opaque). Empty starts from the beginning. |
Full JSON Schema
Example input
{
"path": {
"template_id": "11111111-2222-3333-4444-555555555555"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetTemplateBuild returns a single template build. — digitalocean.harness_get_template_build
GetTemplateBuild returns a single template build.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.template_id |
string | Required | The template UUID. | format: "uuid" |
path.build_id |
string | Required | The build UUID. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"template_id": "11111111-2222-3333-4444-555555555555",
"build_id": "22222222-3333-4444-5555-666666666666"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListTriggers enumerates the calling team's triggers. — digitalocean.harness_list_triggers
Keyset-paginated on an opaque cursor. Excludes soft-deleted triggers. Scoped to the authenticated team.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive; server-clamped. | minimum: 1 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. | |
query.kind |
— | Optional | Optional filter by trigger kind. | $ref: "#/definitions/trigger_kind" |
query.status |
— | Optional | Optional filter by trigger status. | $ref: "#/definitions/trigger_status" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
CreateTrigger creates a webhook or cron trigger. — digitalocean.harness_create_trigger
Validation is synchronous, so a mistake is a 400/409 at creation, not a silent miss at the first fire. Exactly one of webhook / cron must be present and match kind. kind=cron forbids a webhook block and requires a parseable cron.cron_expr and a valid IANA cron.timezone. session_mode=fresh requires session_template (a well-formed agents.yaml Agent manifest) and forbids bound_session_id; session_mode=reuse requires bound_session_id (an existing team-owned session) and forbids session_template. output.mode selects the destination block (email/slack), which is stored encrypted. name must be unique per team among non-deleted triggers.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_trigger_request" |
Full JSON Schema
Example input
{
"body": {
"kind": "webhook",
"name": "nightly-deploy-check",
"session_mode": "fresh",
"prompt_template": "Review the latest push and summarize risks.",
"output": {
"mode": "email"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetTriggerBySession reverse-looks-up the trigger that produced or binds a session. — digitalocean.harness_get_trigger_by_session
Returns the trigger that produced (fresh) or binds (reuse) the given session. Resolves to the row even after the trigger is soft-deleted.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | The session UUID. |
Full JSON Schema
Example input
{
"path": {
"session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListReusableSessions lists the team's PAUSED sessions for the reuse picker. — digitalocean.harness_list_reusable_sessions
Returns the team's sessions in status PAUSED, for binding a session_mode=reuse trigger. The item shape is the hosted-agents Session, so agent_kind and status use the AGENT_KIND_ / SESSION_STATUS_ spelling; status is always SESSION_STATUS_PAUSED here.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive; server-clamped. | minimum: 1 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetTrigger returns a single trigger by id. — digitalocean.harness_get_trigger
GetTrigger returns a single trigger by id. Write-only fields (webhook secret, output destination, session_template env values) are never included.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
UpdateTrigger updates, pauses, or re-enables a trigger. — digitalocean.harness_update_trigger
Partial update: only the supplied fields change. kind and webhook.provider are immutable (409 on change). Mutable: name (409 on duplicate), status (active<->paused), prompt_template, output, session_template (fresh), bound_session_id (reuse), cron.cron_expr / cron.timezone (recomputes next_run_at). Re-enabling never produces a catch-up run. PATCHing session_template is a full replacement, so every spec.secrets slot value the new manifest declares must be resupplied (secret values are never echoed back), or the request is a 400.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. | |
body |
— | Required | $ref: "#/definitions/update_trigger_request" |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
DeleteTrigger soft-deletes a trigger. — digitalocean.harness_delete_trigger
Marks the trigger deleted, fails any pending executions, and purges the webhook secret / cron schedule. A fresh trigger owns no session; a reuse trigger only UNBINDS - it never destroys the customer's session. Execution history and by-session lookups continue to resolve to the deleted row. Returns 204 No Content on success.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListTriggerExecutions returns a trigger's execution history. — digitalocean.harness_list_trigger_executions
Keyset-paginated. The large payload field is omitted from list items; fetch a single execution to read it.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.page_size |
integer | Optional | Page size. Defaults to 50 when omitted or non-positive; server-clamped. | minimum: 1 |
query.page_token |
string | Optional | Opaque keyset cursor returned by the previous page. Empty starts from the beginning. | |
query.status |
— | Optional | Optional filter by execution status. | $ref: "#/definitions/trigger_execution_status" |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
GetTriggerExecution returns a single execution, including its payload. — digitalocean.harness_get_trigger_execution
Returns the full execution row, including the payload, output_text, and output_truncated fields omitted from list items.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. | |
path.execution_id |
string | Required | The execution UUID. |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d",
"execution_id": "7c1f9e2a-3b4c-5d6e-7f80-91a2b3c4d5e6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
CancelExecution ends a running execution and frees the trigger's in-flight slot. — digitalocean.harness_cancel_trigger_execution
Fails the execution and frees the trigger's in-flight slot. A fresh-mode session is destroyed outright. A reuse-mode session is only paused, not stopped - harness has no run-interrupt call, so the agent's turn may still be in flight server-side; this frees the queue, not necessarily the agent's work. A non-running execution is a no-op that still returns 200.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. | |
path.execution_id |
string | Required | The execution UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.force |
boolean | Optional | Cancel even if the execution has not started a run yet (the worker's own dispatch may still be in flight). Without this, that case returns 409; reclaim clears it automatically within 15m regardless. |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d",
"execution_id": "7c1f9e2a-3b4c-5d6e-7f80-91a2b3c4d5e6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
RotateTriggerSecret issues a new webhook secret. — digitalocean.harness_post_trigger_rotate_secret
Webhook triggers only (409 for cron). Issues a new secret (shown once) and moves the old value to the previous slot, where it keeps verifying deliveries until previous_secret_expires_at. Default grace is 5 minutes when grace_period_seconds is omitted, so deliveries already in flight (signed with the old value) still succeed while the customer updates their external system. After that instant the old value is refused with 401. Pass grace_period_seconds=0 to retire the old secret on this call (breach response), or a positive value (up to the server max, default 1 hour) for a custom window; above the max is 400.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.trigger_id |
string | Required | The trigger UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.grace_period_seconds |
integer | Optional | How long the outgoing secret keeps verifying deliveries. Omit for the default (5 minutes). 0 retires the old secret immediately (compromised-secret path). Positive values set a custom window up to the server max (default 1 hour); above the max is 400. Send at most once with an explicit non-negative integer - bare keys, empty values, non-integers, negatives, and duplicates are 400. | minimum: 0 |
Full JSON Schema
Example input
{
"path": {
"trigger_id": "b1a0c6de-1f2e-4a3b-9c8d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
ListWebhookProviders lists supported webhook providers for the create-trigger UI. — digitalocean.harness_list_webhook_providers
A static, code-defined registry (not a database table), webhook-only. Cron triggers have no provider and never call this. Used to populate the provider dropdown with display name, docs link, paste hint, and the signature scheme.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Apps — digitalocean.apps_list
List all apps on your account. Information about the current active deployment as well as any in progress ones will also be included for each app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.with_projects |
boolean | Optional | Whether the project_id of listed apps should be fetched and included. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an App — digitalocean.apps_delete
Delete an existing app. Once deleted, all active deployments will be permanently shut down and the app deleted. If needed, be sure to back up your app specification so that you may re-create it at a later time.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the app |
Full JSON Schema
Example input
{
"path": {
"id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing App — digitalocean.apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the app | |
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | The name of the app to retrieve. |
Full JSON Schema
Example input
{
"path": {
"id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an App — digitalocean.apps_update
Update an existing app by submitting a new app specification. For documentation on app specifications (AppSpec objects), please refer to the product documentation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the app | |
body |
— | Required | $ref: "#/definitions/apps_update_app_request" |
Full JSON Schema
Example input
{
"path": {
"id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"body": {
"spec": {
"name": "web-app-01"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restart an App — digitalocean.apps_restart
Perform a rolling restart of all or specific components in an app.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
body |
— | Optional | $ref: "#/definitions/apps_restart_request" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Active Deployment Logs — digitalocean.apps_get_logs_active_deployment
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.component_name |
string | Required | An optional component name. If set, logs will be limited to this component only. | |
query |
object | Required | additionalProperties: false |
|
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id) | enum: ["UNSPECIFIED","BUILD","DEPLOY","RUN","RUN_RESTARTED","AUTOSCALE_EVENT"]; default: "UNSPECIFIED" |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"component_name": "component"
},
"query": {
"type": "BUILD"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Exec URL — digitalocean.apps_get_exec_active_deployment
Returns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.component_name |
string | Required | An optional component name. If set, logs will be limited to this component only. | |
query |
object | Optional | additionalProperties: false |
|
query.instance_name |
string | Optional | The name of the actively running ephemeral compute instance |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"component_name": "component"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve App Instances — digitalocean.apps_get_instances
Retrieve the list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List App Deployments — digitalocean.apps_list_deployments
List all deployments of an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.deployment_types |
array | Optional | Optional. Filter deployments by deployment_type - MANUAL: manual deployment - DEPLOY_ON_PUSH: deployment triggered by a push to the app's repository - MAINTENANCE: deployment for maintenance purposes - MANUAL_ROLLBACK: manual revert to a previous deployment - AUTO_ROLLBACK: automatic revert to a previous deployment - UPDATE_DATABASE_TRUSTED_SOURCES: update database trusted sources - AUTOSCALED: deployment that has been autoscaled | |
query.deployment_types[] |
string | Optional | enum: ["MANUAL","DEPLOY_ON_PUSH","MAINTENANCE","MANUAL_ROLLBACK","AUTO_ROLLBACK","UPDATE_DATABASE_TRUSTED_SOURCES","AUTOSCALED"] |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an App Deployment — digitalocean.apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
body |
— | Required | $ref: "#/definitions/apps_create_deployment_request" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an App Deployment — digitalocean.apps_get_deployment
Retrieve information about an app deployment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.deployment_id |
string | Required | The deployment ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"deployment_id": "3aa4d20e-5527-4c00-b496-601fbd22520a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel a Deployment — digitalocean.apps_cancel_deployment
Immediately cancel an in-progress deployment.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.deployment_id |
string | Required | The deployment ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"deployment_id": "3aa4d20e-5527-4c00-b496-601fbd22520a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Deployment Logs — digitalocean.apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.deployment_id |
string | Required | The deployment ID | |
path.component_name |
string | Required | An optional component name. If set, logs will be limited to this component only. | |
query |
object | Required | additionalProperties: false |
|
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id) | enum: ["UNSPECIFIED","BUILD","DEPLOY","RUN","RUN_RESTARTED","AUTOSCALE_EVENT"]; default: "UNSPECIFIED" |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"deployment_id": "3aa4d20e-5527-4c00-b496-601fbd22520a",
"component_name": "component"
},
"query": {
"type": "BUILD"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Aggregate Deployment Logs — digitalocean.apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.deployment_id |
string | Required | The deployment ID | |
query |
object | Required | additionalProperties: false |
|
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id) | enum: ["UNSPECIFIED","BUILD","DEPLOY","RUN","RUN_RESTARTED","AUTOSCALE_EVENT"]; default: "UNSPECIFIED" |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"deployment_id": "3aa4d20e-5527-4c00-b496-601fbd22520a"
},
"query": {
"type": "BUILD"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Exec URL for Deployment — digitalocean.apps_get_exec
Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.deployment_id |
string | Required | The deployment ID | |
path.component_name |
string | Required | An optional component name. If set, logs will be limited to this component only. | |
query |
object | Optional | additionalProperties: false |
|
query.instance_name |
string | Optional | The name of the actively running ephemeral compute instance |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"deployment_id": "3aa4d20e-5527-4c00-b496-601fbd22520a",
"component_name": "component"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Active Deployment Aggregate Logs — digitalocean.apps_get_logs_active_deployment_aggregate
Retrieve the logs of the active deployment if one exists. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. Note log_type=BUILD logs will return logs associated with the current active deployment (being served). To view build logs associated with in-progress build, the query must explicitly reference the deployment id.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
query |
object | Required | additionalProperties: false |
|
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id) | enum: ["UNSPECIFIED","BUILD","DEPLOY","RUN","RUN_RESTARTED","AUTOSCALE_EVENT"]; default: "UNSPECIFIED" |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"query": {
"type": "BUILD"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Job Invocations — digitalocean.apps_list_job_invocations
List all job invocations for an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
query |
object | Optional | additionalProperties: false |
|
query.job_names |
array | Optional | The job names to list job invocations for. | |
query.job_names[] |
— | Optional | $ref: "#/definitions/schema" |
|
query.deployment_id |
string | Optional | The deployment ID | |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Job Invocations — digitalocean.apps_get_job_invocation
Get a specific job invocation for an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.job_invocation_id |
string | Required | The ID of the job invocation to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.job_name |
string | Optional | The job name to list job invocations for. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"job_invocation_id": "123e4567-e89b-12d3-a456-426"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel Job Invocation — digitalocean.apps_cancel_job_invocation
Cancel a specific job invocation for an app.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.job_invocation_id |
string | Required | The ID of the job invocation to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.job_name |
string | Optional | The job name to list job invocations for. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"job_invocation_id": "123e4567-e89b-12d3-a456-426"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Job Invocation Logs — digitalocean.apps_get_job_invocation_logs
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.job_name |
string | Required | The job name to list job invocations for. | |
path.job_invocation_id |
string | Required | The ID of the job invocation to retrieve. | |
query |
object | Required | additionalProperties: false |
|
query.deployment_id |
string | Optional | The deployment ID | |
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve | enum: ["JOB_INVOCATION"] |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
|
query.tail_lines |
string | Optional | The number of lines from the end of the logs to retrieve. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"job_name": "component",
"job_invocation_id": "123e4567-e89b-12d3-a456-426"
},
"query": {
"type": "JOB_INVOCATION"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List App Events — digitalocean.apps_list_events
List all events for an app, including deployments and autoscaling events.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.event_types |
array | Optional | Filter events by event type. | |
query.event_types[] |
string | Optional | enum: ["UNKNOWN","DEPLOYMENT","AUTOSCALING"] |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an Event — digitalocean.apps_get_event
Get a single event for an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.event_id |
string | Required | The event ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"event_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel an Event — digitalocean.apps_cancel_event
Cancel an in-progress autoscaling event.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.event_id |
string | Required | The event ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"event_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Event Logs — digitalocean.apps_get_event_logs
Retrieve the logs of an autoscaling event for an app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.event_id |
string | Required | The event ID | |
query |
object | Required | additionalProperties: false |
|
query.follow |
boolean | Optional | Whether the logs should follow live updates. | |
query.type |
string | Required | The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - AUTOSCALE_EVENT: Logs of an autoscaling event (requires event_id) | enum: ["UNSPECIFIED","BUILD","DEPLOY","RUN","RUN_RESTARTED","AUTOSCALE_EVENT"]; default: "UNSPECIFIED" |
query.pod_connection_timeout |
string | Optional | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"event_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"query": {
"type": "BUILD"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Instance Sizes — digitalocean.apps_list_instancesizes
List all instance sizes for service, worker, and job components.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Instance Size — digitalocean.apps_get_instancesize
Retrieve information about a specific instance size for service, worker, and job components.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.slug |
string | Required | The slug of the instance size |
Full JSON Schema
Example input
{
"path": {
"slug": "apps-s-1vcpu-0.5gb"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List App Regions — digitalocean.apps_list_regions
List all regions supported by App Platform.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Propose an App Spec — digitalocean.apps_validate_appspec
To propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/app_propose" |
Full JSON Schema
Example input
{
"body": {
"spec": {
"name": "web-app-01"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all app alerts — digitalocean.apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update destinations for alerts — digitalocean.apps_assign_alertdestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
path.alert_id |
string | Required | The alert ID | |
body |
— | Required | $ref: "#/definitions/apps_assign_app_alert_destinations_request" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"alert_id": "5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Rollback App — digitalocean.apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed or reverted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
body |
— | Required | $ref: "#/definitions/apps_rollback_app_request" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Validate App Rollback — digitalocean.apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer than usual.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
body |
— | Required | $ref: "#/definitions/apps_rollback_app_request" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Commit App Rollback — digitalocean.apps_commit_rollback
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revert App Rollback — digitalocean.apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve App Daily Bandwidth Metrics — digitalocean.apps_get_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for a single app.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID | |
query |
object | Optional | additionalProperties: false |
|
query.date |
string | Optional | Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. | format: "date-time" |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Multiple Apps' Daily Bandwidth Metrics — digitalocean.apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/app_metrics_bandwidth_usage_request" |
Full JSON Schema
Example input
{
"body": {
"app_ids": [
"4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf",
"c2a93513-8d9b-4223-9d61-5e7272c81cf5"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve App Health — digitalocean.apps_get_health
Retrieve information like health status, cpu and memory utilization of app components.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.app_id |
string | Required | The app ID |
Full JSON Schema
Example input
{
"path": {
"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All CDN Endpoints — digitalocean.cdn_list_endpoints
To list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New CDN Endpoint — digitalocean.cdn_create_endpoint
To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The origin attribute must be set to the fully qualified domain name (FQDN) of a DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/cdn_endpoint" |
Full JSON Schema
Example input
{
"body": {
"origin": "static-images.nyc3.digitaloceanspaces.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing CDN Endpoint — digitalocean.cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET request to /v2/cdn/endpoints/$ENDPOINT_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cdn_id |
string | Required | A unique identifier for a CDN endpoint. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cdn_id": "19f06b6a-3ace-4315-b086-499a0e521b76"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a CDN Endpoint — digitalocean.cdn_update_endpoints
To update the TTL, certificate ID, or the FQDN of the custom subdomain for an existing CDN endpoint, send a PUT request to /v2/cdn/endpoints/$ENDPOINT_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cdn_id |
string | Required | A unique identifier for a CDN endpoint. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/update_endpoint" |
Full JSON Schema
Example input
{
"path": {
"cdn_id": "19f06b6a-3ace-4315-b086-499a0e521b76"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a CDN Endpoint — digitalocean.cdn_delete_endpoint
To delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cdn_id |
string | Required | A unique identifier for a CDN endpoint. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cdn_id": "19f06b6a-3ace-4315-b086-499a0e521b76"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Purge the Cache for an Existing CDN Endpoint — digitalocean.cdn_purge_cache
To purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID/cache. The body of the request should include a files attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard () to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged. There is a rate limit of 50 files per 20 seconds that can be purged. CDN endpoints have a rate limit of 5 requests per 10 seconds. Purging files using a wildcard path counts as a single request against the API's rate limit. Two identical purge requests cannot be sent at the same time.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cdn_id |
string | Required | A unique identifier for a CDN endpoint. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/purge_cache" |
Full JSON Schema
Example input
{
"path": {
"cdn_id": "19f06b6a-3ace-4315-b086-499a0e521b76"
},
"body": {
"files": [
"path/to/image.png",
"path/to/css/*"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Certificates — digitalocean.certificates_list
To list all of the certificates available on your account, send a GET request to /v2/certificates.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.name |
string | Optional | Name of expected certificate | default: "" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Certificate — digitalocean.certificates_create
To upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | ||
body |
— | Required | oneOf[1]; $ref: "#/definitions/certificate_request_lets_encrypt" |
|
body |
— | Required | oneOf[2]; $ref: "#/definitions/certificate_request_custom" |
Full JSON Schema
Example input
{
"body": {
"name": "web-cert-01",
"dns_names": [
"www.example.com",
"example.com"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Certificate — digitalocean.certificates_get
To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.certificate_id |
string | Required | A unique identifier for a certificate. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"certificate_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Certificate — digitalocean.certificates_delete
To delete a specific certificate, send a DELETE request to /v2/certificates/$CERTIFICATE_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.certificate_id |
string | Required | A unique identifier for a certificate. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"certificate_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Customer Balance — digitalocean.balance_get
To retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Customer Prepayment Configuration — digitalocean.prepaymentconfig_get
To retrieve the prepayment configuration and current prepayment status for a customer's account, send a GET request to /v2/customers/my/prepayment_config.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Customer Prepayment Status — digitalocean.prepaymentstatus_get
To retrieve the prepayment gate status and balances for a customer's account, send a GET request to /v2/customers/my/prepayment_status.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Billing History — digitalocean.billinghistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Invoices — digitalocean.invoices_list
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Invoice by UUID — digitalocean.invoices_get_byuuid
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.invoice_uuid |
string | Required | UUID of the invoice | |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Invoice CSV by UUID — digitalocean.invoices_get_csvbyuuid
To retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/csv.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.invoice_uuid |
string | Required | UUID of the invoice |
Full JSON Schema
Example input
{
"path": {
"invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Invoice Summary by UUID — digitalocean.invoices_get_summarybyuuid
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.invoice_uuid |
string | Required | UUID of the invoice |
Full JSON Schema
Example input
{
"path": {
"invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Billing Insights — digitalocean.billinginsights_list
This endpoint returns day-over-day changes in billing resource usage based on nightly invoice items, including total amount, region, SKU, and description for a specified date range. It is important to note that the daily resource usage may not reflect month-end billing totals when totaled for a given month as nightly invoice item estimates do not necessarily encompass all invoicing factors for the entire month.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.account_urn |
string | Required | URN of the customer account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid) | |
path.start_date |
string | Required | Start date for billing insights in YYYY-MM-DD format | format: "date" |
path.end_date |
string | Required | End date for billing insights in YYYY-MM-DD format. Must be within 31 days of start_date | format: "date" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"account_urn": "do:team:12345678-1234-1234-1234-123456789012",
"start_date": "2025-01-01",
"end_date": "2025-01-31"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Database Options — digitalocean.databases_list_options
To list all of the options available for the offered database engines, send a GET request to /v2/databases/options. The result will be a JSON object with an options key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Database Clusters — digitalocean.databases_list_clusters
To list all of the database clusters available on your account, send a GET request to /v2/databases. To limit the results to database clusters with a specific tag, include the tag_name query parameter set to the name of the tag. For example, /v2/databases?tag_name=$TAG_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.tag_name |
string | Optional | Limits the results to database clusters with a specific tag. Requires tag:read scope. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Database Cluster — digitalocean.databases_create_cluster
To create a database cluster, send a POST request to /v2/databases. To see a list of options for each engine, such as available regions, size slugs, and versions, send a GET request to the /v2/databases/options endpoint. The available sizes for the storage_size_mib field depends on the cluster's size. To see a list of available sizes, see Managed Database Pricing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/database_cluster" |
|
body |
object | Required | allOf[2] |
|
body.backup_restore |
— | Optional | allOf[2]; $ref: "#/definitions/database_backup" |
Full JSON Schema
Example input
{
"body": {
"name": "backend",
"engine": "pg",
"version": "14",
"region": "nyc3",
"size": "db-s-2vcpu-4gb",
"storage_size_mib": 61440,
"num_nodes": 2,
"tags": [
"production"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Database Cluster — digitalocean.databases_get_cluster
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Destroy a Database Cluster — digitalocean.databases_destroy_cluster
To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Database Cluster Configuration — digitalocean.databases_get_config
Shows configuration parameters for an existing database cluster by sending a GET request to /v2/databases/$DATABASE_ID/config. The response is a JSON object with a config key, which is set to an object containing any database configuration parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update the Database Configuration for an Existing Database — digitalocean.databases_patch_config
To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE_ID/config.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/database_config" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Public Certificate — digitalocean.databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Status of an Online Migration — digitalocean.databases_get_migrationstatus
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start an Online Migration — digitalocean.databases_update_onlinemigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, Caching, and Valkey clusters. If the existing database is continuously being written to, the migration process will continue for up to two weeks unless it is manually stopped. Online migration is only available for MySQL, PostgreSQL, Caching, and Valkey clusters.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/source_database" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"source": {}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Stop an Online Migration — digitalocean.databases_delete_onlinemigration
To stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.migration_id |
string | Required | A unique identifier assigned to the online migration. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"migration_id": "77b28fc8-19ff-11eb-8c9c-c68e24557488"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Migrate a Database Cluster to a New Region — digitalocean.databases_update_region
To migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE_ID/migrate. The body of the request must specify a region attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
object | Required | ||
body.region |
string | Required | A slug identifier for the region to which the database cluster will be migrated. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"region": "lon1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Resize a Database Cluster — digitalocean.databases_update_clustersize
To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/database_cluster_resize" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"size": "db-s-4vcpu-8gb",
"num_nodes": 3
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Firewall Rules (Trusted Sources) for a Database Cluster — digitalocean.databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Firewall Rules (Trusted Sources) for a Database — digitalocean.databases_update_firewall_rules
To update a database cluster's firewall rules (known as "trusted sources" in the control panel), send a PUT request to /v2/databases/$DATABASE_ID/firewall specifying which resources should be able to open connections to the database. You may limit connections to specific Droplets, Kubernetes clusters, or IP addresses. When a tag is provided, any Droplet or Kubernetes node with that tag applied to it will have access. The firewall is limited to 100 rules (or trusted sources). You cannot add IPv6 addresses as trusted sources. For additional limits, see your database engine's limits page. When possible, we recommend placing your databases into a VPC network to limit access to them instead of using a firewall. A successful request returns a 204 status code with no content.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
object | Required | ||
body.rules |
array | Optional | ||
body.rules[] |
— | Optional | $ref: "#/definitions/firewall_rule" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"rules": [
{
"type": "ip_addr",
"value": "192.168.1.1"
},
{
"type": "k8s",
"value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61"
},
{
"type": "droplet",
"value": "163973392"
},
{
"type": "tag",
"value": "backend",
"description": "a backend tag"
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve DO Settings for a Database Cluster — digitalocean.databases_get_do_settings
To retrieve the DigitalOcean-specific settings for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/do_settings. The response will include the current service_cnames configuration.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update DO Settings for a Database Cluster — digitalocean.databases_update_do_settings
To update the DigitalOcean-specific settings for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/do_settings. Currently, the only supported setting is service_cnames, which allows you to specify custom DNS names (CNAMEs) to be included in the TLS certificate Subject Alternative Names (SANs) for the database cluster nodes. This enables TLS verification when connecting via a custom hostname. After updating, the database nodes will be replaced to apply the new certificate. This process is performed as a rolling replacement and does not cause downtime. To clear all custom CNAMEs, send an empty array or omit the field.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
object | Required | ||
body.do_settings |
— | Required | $ref: "#/definitions/do_settings" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"do_settings": {
"service_cnames": [
"db.example.com",
"db-replica.example.com"
]
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Configure a Database Cluster's Maintenance Window — digitalocean.databases_update_maintenancewindow
To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/database_maintenance_window" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"day": "tuesday",
"hour": "14:00"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start Database Maintenance — digitalocean.databases_install_update
To start the installation of updates for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/install_update. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Backups for a Database Cluster — digitalocean.databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Caching or Valkey clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain the size of the backup and the timestamp at which it was created.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Read-only Replicas — digitalocean.databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Read-only Replica — digitalocean.databases_create_replica
To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to /v2/databases/$DATABASE_ID/replicas specifying the name it should be given, the size of the node to be used, and the region where it will be located.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/database_replica" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all Events Logs — digitalocean.databases_list_events_logs
To list all of the cluster events, send a GET request to /v2/databases/$DATABASE_ID/events.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Read-only Replica — digitalocean.databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.replica_name |
string | Required | The name of the database replica. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"replica_name": "read-nyc3-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Destroy a Read-only Replica — digitalocean.databases_destroy_replica
To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.replica_name |
string | Required | The name of the database replica. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"replica_name": "read-nyc3-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Promote a Read-only Replica to become a Primary Cluster — digitalocean.databases_promote_replica
To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.replica_name |
string | Required | The name of the database replica. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"replica_name": "read-nyc3-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all Database Users — digitalocean.databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a Database User — digitalocean.databases_add_user
To add a new database user, send a POST request to /v2/databases/$DATABASE_ID/users with the desired username.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/database_user" |
|
body |
object | Required | allOf[2] |
|
body.readonly |
boolean | Optional | (To be deprecated: use settings.mongo_user_settings.role instead for access controls to MongoDB databases). For MongoDB clusters, set to true to create a read-only user. This option is not currently supported for other database engines. |
allOf[2] |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"name": "app-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Database User — digitalocean.databases_get_user
To show information about an existing database user, send a GET request to /v2/databases/$DATABASE_ID/users/$USERNAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.username |
string | Required | The name of the database user. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"username": "app-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove a Database User — digitalocean.databases_delete_user
To remove a specific database user, send a DELETE request to /v2/databases/$DATABASE_ID/users/$USERNAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.username |
string | Required | The name of the database user. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"username": "app-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Database User — digitalocean.databases_update_user
To update an existing database user, send a PUT request to /v2/databases/$DATABASE_ID/users/$USERNAME with the desired settings.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.username |
string | Required | The name of the database user. | |
body |
— | Required | ||
body |
object | Required | allOf[1] |
|
body.settings |
— | Required | allOf[1]; $ref: "#/definitions/user_settings_update" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"username": "app-01"
},
"body": {
"settings": {
"pg_allow_replication": true
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Reset a Database User's Password or Authentication Method — digitalocean.databases_reset_auth
To reset the password for a database user, send a POST request to /v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.username |
string | Required | The name of the database user. | |
body |
object | Required | ||
body.mysql_settings |
— | Optional | $ref: "#/definitions/mysql_settings" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"username": "app-01"
},
"body": {
"mysql_settings": {
"auth_plugin": "caching_sha2_password"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Databases — digitalocean.databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a New Database — digitalocean.databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/database" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"name": "alpha"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Database — digitalocean.databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.database_name |
string | Required | The name of the database. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"database_name": "alpha"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Database — digitalocean.databases_delete
To delete a specific database, send a DELETE request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.database_name |
string | Required | The name of the database. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"database_name": "alpha"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Connection Pools (PostgreSQL) — digitalocean.databases_list_connectionpools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add a New Connection Pool (PostgreSQL) — digitalocean.databases_add_connectionpool
For PostgreSQL database clusters, connection pools can be used to allow a database to share its idle connections. The popular PostgreSQL connection pooling utility PgBouncer is used to provide this service. See here for more information about how and why to use PgBouncer connection pooling including details about the available transaction modes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/connection_pool" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"name": "backend-pool",
"mode": "transaction",
"size": 10,
"db": "defaultdb"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Existing Connection Pool (PostgreSQL) — digitalocean.databases_get_connectionpool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.pool_name |
string | Required | The name used to identify the connection pool. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"pool_name": "backend-pool"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Connection Pools (PostgreSQL) — digitalocean.databases_update_connectionpool
To update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.pool_name |
string | Required | The name used to identify the connection pool. | |
body |
— | Required | $ref: "#/definitions/connection_pool_update" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"pool_name": "backend-pool"
},
"body": {
"mode": "transaction",
"size": 10,
"db": "defaultdb"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Connection Pool (PostgreSQL) — digitalocean.databases_delete_connectionpool
To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.pool_name |
string | Required | The name used to identify the connection pool. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"pool_name": "backend-pool"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Eviction Policy for a Caching or Valkey Cluster — digitalocean.databases_get_evictionpolicy
To retrieve the configured eviction policy for an existing Caching or Valkey cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy. The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Configure the Eviction Policy for a Caching or Valkey Cluster — digitalocean.databases_update_evictionpolicy
To configure an eviction policy for an existing Caching or Valkey cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired policy.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
object | Required | ||
body.eviction_policy |
— | Required | $ref: "#/definitions/eviction_policy_model" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"eviction_policy": "allkeys_lru"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the SQL Modes for a MySQL Cluster — digitalocean.databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update SQL Mode for a Cluster — digitalocean.databases_update_sql_mode
To configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE_ID/sql_mode specifying the desired modes. See the official MySQL 8 documentation for a full list of supported SQL modes. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/sql_mode" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Upgrade Major Version for a Database — digitalocean.databases_update_major_version
To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/version-2" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Autoscale Configuration for a Database Cluster — digitalocean.databases_get_autoscale
To retrieve the autoscale configuration for an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/autoscale. The response will be a JSON object with autoscaling configuration details.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Configure Autoscale Settings for a Database Cluster — digitalocean.databases_update_autoscale
To configure autoscale settings for an existing database cluster, send a PUT request to /v2/databases/$DATABASE_ID/autoscale, specifying the autoscale configuration. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/database_autoscale_params" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Topics for a Kafka Cluster — digitalocean.databases_list_kafka_topics
To list all of a Kafka cluster's topics, send a GET request to /v2/databases/$DATABASE_ID/topics.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Topic for a Kafka Cluster — digitalocean.databases_create_kafka_topic
To create a topic attached to a Kafka cluster, send a POST request to /v2/databases/$DATABASE_ID/topics.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/kafka_topic_create" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Topic for a Kafka Cluster — digitalocean.databases_get_kafka_topic
To retrieve a given topic by name from the set of a Kafka cluster's topics, send a GET request to /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.topic_name |
string | Required | The name used to identify the Kafka topic. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"topic_name": "customer-events"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Topic for a Kafka Cluster — digitalocean.databases_update_kafka_topic
To update a topic attached to a Kafka cluster, send a PUT request to /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.topic_name |
string | Required | The name used to identify the Kafka topic. | |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/kafka_topic_update" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"topic_name": "customer-events"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Topic for a Kafka Cluster — digitalocean.databases_delete_kafka_topic
To delete a single topic within a Kafka cluster, send a DELETE request to /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.topic_name |
string | Required | The name used to identify the Kafka topic. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"topic_name": "customer-events"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Logsinks for a Database Cluster
— digitalocean.databases_list_logsink
To list logsinks for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Logsink for a Database Cluster
— digitalocean.databases_create_logsink
To create logsink for a database cluster, send a POST request to /v2/databases/$DATABASE_ID/logsink.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/logsink_create" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"sink_name": "logs-sink",
"sink_type": "opensearch",
"config": {
"url": "https://user:[email protected]:25060",
"index_prefix": "opensearch-logs",
"index_days_max": 5
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Logsink for a Database Cluster
— digitalocean.databases_get_logsink
To get a logsink for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.logsink_id |
string | Required | A unique identifier for a logsink of a database cluster |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"logsink_id": "50484ec3-19d6-4cd3-b56f-3b0381c289a6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Logsink for a Database Cluster
— digitalocean.databases_update_logsink
To update a logsink for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.logsink_id |
string | Required | A unique identifier for a logsink of a database cluster | |
body |
— | Required | $ref: "#/definitions/logsink_update" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"logsink_id": "50484ec3-19d6-4cd3-b56f-3b0381c289a6"
},
"body": {
"config": {
"server": "192.168.0.1",
"port": 514,
"tls": false,
"format": "rfc5424"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Logsink for a Database Cluster
— digitalocean.databases_delete_logsink
To delete a logsink for a database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.logsink_id |
string | Required | A unique identifier for a logsink of a database cluster |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"logsink_id": "50484ec3-19d6-4cd3-b56f-3b0381c289a6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Schemas for Kafka Cluster
— digitalocean.databases_list_kafka_schemas
To list all schemas for a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Schema Registry for Kafka Cluster
— digitalocean.databases_create_kafka_schema
To create a Kafka schema for a database cluster, send a POST request to /v2/databases/$DATABASE_ID/schema-registry.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/database_kafka_schema_create" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
},
"body": {
"subject_name": "customer-schema",
"schema_type": "AVRO",
"schema": "{\n \"type\": \"record\",\n \"name\": \"Customer\",\n \"fields\": [\n {\"name\": \"id\", \"type\": \"string\"},\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\": \"email\", \"type\": \"string\"},\n {\"name\": \"created_at\", \"type\": \"long\"}\n ]\n}\n"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Kafka Schema by Subject Name
— digitalocean.databases_get_kafka_schema
To get a specific schema by subject name for a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.subject_name |
string | Required | The name of the Kafka schema subject. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"subject_name": "customer-schema"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Kafka Schema by Subject Name
— digitalocean.databases_delete_kafka_schema
To delete a specific schema by subject name for a Kafka cluster, send a DELETE request to /v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.subject_name |
string | Required | The name of the Kafka schema subject. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"subject_name": "customer-schema"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Kafka Schema by Subject Version — digitalocean.databases_get_kafka_schema_version
To get a specific schema by subject name for a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME/versions/$VERSION.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.subject_name |
string | Required | The name of the Kafka schema subject. | |
path.version |
string | Required | The version of the Kafka schema subject. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"subject_name": "customer-schema",
"version": "1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Schema Registry Configuration for a kafka Cluster — digitalocean.databases_get_kafka_schema_config
To retrieve the Schema Registry configuration for a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry/config. The response is a JSON object with a compatibility_level key, which is set to an object containing any database configuration parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Schema Registry Configuration for a kafka Cluster — digitalocean.databases_update_kafka_schema_config
To update the Schema Registry configuration for a Kafka cluster, send a PUT request to /v2/databases/$DATABASE_ID/schema-registry/config. The response is a JSON object with a compatibility_level key, which is set to an object containing any database configuration parameters.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
body |
object | Optional | ||
body.compatibility_level |
string | Required | The compatibility level of the schema registry. | enum: ["NONE","BACKWARD","BACKWARD_TRANSITIVE","FORWARD","FORWARD_TRANSITIVE","FULL","FULL_TRANSITIVE"] |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Schema Registry Configuration for a Subject of kafka Cluster — digitalocean.databases_get_kafka_schema_subject_config
To retrieve the Schema Registry configuration for a Subject of a Kafka cluster, send a GET request to /v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME. The response is a JSON object with a compatibility_level key, which is set to an object containing any database configuration parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.subject_name |
string | Required | The name of the Kafka schema subject. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"subject_name": "customer-schema"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Schema Registry Configuration for a Subject of kafka Cluster — digitalocean.databases_update_kafka_schema_subject_config
To update the Schema Registry configuration for a Subject of a Kafka cluster, send a PUT request to /v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME. The response is a JSON object with a compatibility_level key, which is set to an object containing any database configuration parameters.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.subject_name |
string | Required | The name of the Kafka schema subject. | |
body |
object | Optional | ||
body.compatibility_level |
string | Required | The compatibility level of the schema registry. | enum: ["NONE","BACKWARD","BACKWARD_TRANSITIVE","FORWARD","FORWARD_TRANSITIVE","FULL","FULL_TRANSITIVE"] |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"subject_name": "customer-schema"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Database Clusters' Metrics Endpoint Credentials — digitalocean.databases_get_cluster_metrics_credentials
To show the credentials for all database clusters' metrics endpoints, send a GET request to /v2/databases/metrics/credentials. The result will be a JSON object with a credentials key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Database Clusters' Metrics Endpoint Credentials — digitalocean.databases_update_cluster_metrics_credentials
To update the credentials for all database clusters' metrics endpoints, send a PUT request to /v2/databases/metrics/credentials. A successful request will receive a 204 No Content status code with no body in response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/database_metrics_credentials" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Indexes for a OpenSearch Cluster — digitalocean.databases_list_opeasearch_indexes
To list all of a OpenSearch cluster's indexes, send a GET request to /v2/databases/$DATABASE_ID/indexes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Index for OpenSearch Cluster — digitalocean.databases_delete_opensearch_index
To delete a single index within OpenSearch cluster, send a DELETE request to /v2/databases/$DATABASE_ID/indexes/$INDEX_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.database_cluster_uuid |
string | Required | A unique identifier for a database cluster. | format: "uuid" |
path.index_name |
string | Required | The name of the OpenSearch index. |
Full JSON Schema
Example input
{
"path": {
"database_cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"index_name": "logs-*"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Dedicated Inference — digitalocean.dedicatedinferences_get
Retrieve an existing Dedicated Inference by ID. Send a GET request to /v2/dedicated-inferences/{dedicated_inference_id}. The status in the response is one of active, new, provisioning, updating, deleting, or error.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Dedicated Inference — digitalocean.dedicatedinferences_patch
Update an existing Dedicated Inference. Send a PATCH request to /v2/dedicated-inferences/{dedicated_inference_id} with updated spec and/or access_tokens. Status will move to updating and return to active when done.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/dedicated_inference_update_request" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Dedicated Inference — digitalocean.dedicatedinferences_delete
Delete an existing Dedicated Inference. Send a DELETE request to /v2/dedicated-inferences/{dedicated_inference_id}. The response 202 Accepted indicates the request was accepted for processing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Dedicated Inferences — digitalocean.dedicatedinferences_list
List all Dedicated Inference instances for your team. Send a GET request to /v2/dedicated-inferences. You may filter by region and use page and per_page for pagination.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.region |
string | Optional | Filter by region. Dedicated Inference is only available in nyc2, tor1, and atl1. | enum: ["nyc2","tor1","atl1"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Dedicated Inference — digitalocean.dedicatedinferences_create
Create a new Dedicated Inference for your team. Send a POST request to /v2/dedicated-inferences with a spec object (version, name, region, vpc, enable_public_endpoint, model_deployments) and optional access_tokens (e.g. hugging_face_token for gated models). The response code 202 Accepted indicates the request was accepted for processing; it does not indicate success or failure. The token value is returned only on create; store it securely.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/dedicated_inference_create_request" |
Full JSON Schema
Example input
{
"body": {
"spec": {
"version": 1,
"name": "new-dedicated-inference",
"region": "atl1",
"vpc": {
"uuid": "997615ce-132d-4bae-9270-9ee21b395e5d"
},
"enable_public_endpoint": false,
"model_deployments": [
{}
]
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Dedicated Inference Accelerators — digitalocean.dedicatedinferences_list_accelerators
List all accelerators (GPUs) in use by a Dedicated Inference instance. Send a GET request to /v2/dedicated-inferences/{dedicated_inference_id}/accelerators. Optionally filter by slug and use page/per_page for pagination.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.slug |
string | Optional | Filter accelerators by GPU slug. |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Dedicated Inference Accelerator — digitalocean.dedicatedinferences_get_accelerator
Retrieve a single accelerator by ID for a Dedicated Inference instance. Send a GET request to /v2/dedicated-inferences/{dedicated_inference_id}/accelerators/{accelerator_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
path.accelerator_id |
string | Required | A unique identifier for a Dedicated Inference accelerator. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d",
"accelerator_id": "5b5c619c-359c-44ca-87e2-47e98170c02f"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Dedicated Inference CA Certificate — digitalocean.dedicatedinferences_get_ca
Get the CA certificate for a Dedicated Inference instance (base64-encoded). Required for private endpoint connectivity. Send a GET request to /v2/dedicated-inferences/{dedicated_inference_id}/ca.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Dedicated Inference Tokens — digitalocean.dedicatedinferences_list_tokens
List all access tokens for a Dedicated Inference instance. Token values are not returned; only id, name, created_at, and is_managed. Send a GET request to /v2/dedicated-inferences/{dedicated_inference_id}/tokens.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Dedicated Inference Token — digitalocean.dedicatedinferences_create_tokens
Create a new access token for a Dedicated Inference instance. Send a POST request to /v2/dedicated-inferences/{dedicated_inference_id}/tokens with a name. The token value is returned only once in the response; store it securely.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/dedicated_inference_token_create_request" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d"
},
"body": {
"name": "new-inference-token"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revoke a Dedicated Inference Token — digitalocean.dedicatedinferences_delete_tokens
Revoke (delete) an access token for a Dedicated Inference instance. Send a DELETE request to /v2/dedicated-inferences/{dedicated_inference_id}/tokens/{token_id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dedicated_inference_id |
string | Required | A unique identifier for a Dedicated Inference instance. | format: "uuid" |
path.token_id |
string | Required | A unique identifier for a Dedicated Inference access token. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"dedicated_inference_id": "6b5c619c-359c-44ca-87e2-47e98170c01d",
"token_id": "f11d4795-c1db-4ac3-9aa6-a0ea3c58877e"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Dedicated Inference Sizes — digitalocean.dedicatedinferences_list_sizes
Get available Dedicated Inference sizes and pricing for supported GPUs. Send a GET request to /v2/dedicated-inferences/sizes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Dedicated Inference GPU Model Config — digitalocean.dedicatedinferences_get_gpu_model_config
Get supported GPU and model configurations for Dedicated Inference. Use this to discover supported GPU slugs and model slugs (e.g. Hugging Face). Send a GET request to /v2/dedicated-inferences/gpu-model-config.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Domains — digitalocean.domains_list
To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Domain — digitalocean.domains_create
To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/domain" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Domain — digitalocean.domains_get
To get details about a specific domain, send a GET request to /v2/domains/$DOMAIN_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Domain — digitalocean.domains_delete
To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Domain Records — digitalocean.domains_list_records
To get a listing of all records configured for a domain, send a GET request to /v2/domains/$DOMAIN_NAME/records. The list of records returned can be filtered by using the name and type query parameters. For example, to only include A records for a domain, send a GET request to /v2/domains/$DOMAIN_NAME/records?type=A. name must be a fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to /v2/domains/$DOMAIN_NAME/records?name=sub.example.com. Both name and type may be used together.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to /v2/domains/$DOMAIN_NAME/records?name=sub.example.com. |
|
query.type |
string | Optional | The type of the DNS record. For example: A, CNAME, TXT, ... | enum: ["A","AAAA","CAA","CNAME","MX","NS","SOA","SRV","TXT"] |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Domain Record — digitalocean.domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/domain_record_a" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/domain_record_aaaa" |
|
body |
— | Optional | anyOf[3]; $ref: "#/definitions/domain_record_caa" |
|
body |
— | Optional | anyOf[4]; $ref: "#/definitions/domain_record_cname" |
|
body |
— | Optional | anyOf[5]; $ref: "#/definitions/domain_record_mx" |
|
body |
— | Optional | anyOf[6]; $ref: "#/definitions/domain_record_ns" |
|
body |
— | Optional | anyOf[7]; $ref: "#/definitions/domain_record_soa" |
|
body |
— | Optional | anyOf[8]; $ref: "#/definitions/domain_record_srv" |
|
body |
— | Optional | anyOf[9]; $ref: "#/definitions/domain_record_txt" |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Domain Record — digitalocean.domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
path.domain_record_id |
integer | Required | The unique identifier of the domain record. |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com",
"domain_record_id": 3352896
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Domain Record — digitalocean.domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
path.domain_record_id |
integer | Required | The unique identifier of the domain record. | |
body |
— | Optional | $ref: "#/definitions/domain_record" |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com",
"domain_record_id": 3352896
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Domain Record — digitalocean.domains_update_record
To update an existing record, send a PUT request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
path.domain_record_id |
integer | Required | The unique identifier of the domain record. | |
body |
— | Optional | $ref: "#/definitions/domain_record" |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com",
"domain_record_id": 3352896
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Domain Record — digitalocean.domains_delete_record
To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.domain_name |
string | Required | The name of the domain itself. | |
path.domain_record_id |
integer | Required | The unique identifier of the domain record. |
Full JSON Schema
Example input
{
"path": {
"domain_name": "example.com",
"domain_record_id": 3352896
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Droplets — digitalocean.droplets_list
To list all Droplets in your account, send a GET request to /v2/droplets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.tag_name |
string | Optional | Used to filter Droplets by a specific tag. Can not be combined with name or type. Requires tag:read scope. |
|
query.name |
string | Optional | Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with tag_name. |
|
query.type |
string | Optional | 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. |
enum: ["droplets","gpus"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Droplet — digitalocean.droplets_create
To create a new Droplet, send a POST request to /v2/droplets setting the required attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | ||
body |
— | Optional | oneOf[1]; $ref: "#/definitions/droplet_single_create" |
|
body |
— | Optional | oneOf[2]; $ref: "#/definitions/droplet_multi_create" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Deleting Droplets by Tag — digitalocean.droplets_destroy_bytag
To delete all Droplets assigned to a specific tag, include the tag_name query parameter set to the name of the tag in your DELETE request. For example, /v2/droplets?tag_name=$TAG_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.tag_name |
string | Required | Specifies Droplets to be deleted by tag. |
Full JSON Schema
Example input
{
"query": {
"tag_name": "env:test"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Droplet — digitalocean.droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Existing Droplet — digitalocean.droplets_destroy
To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Backups for a Droplet — digitalocean.droplets_list_backups
To retrieve any backups associated with a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/backups.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Backup Policy for an Existing Droplet — digitalocean.droplets_get_backup_policy
To show information about an individual Droplet's backup policy, send a GET request to /v2/droplets/$DROPLET_ID/backups/policy.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Backup Policies for All Existing Droplets — digitalocean.droplets_list_backup_policies
To list information about the backup policies for all Droplets in the account, send a GET request to /v2/droplets/backups/policies.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Supported Droplet Backup Policies — digitalocean.droplets_list_supported_backup_policies
To retrieve a list of all supported Droplet backup policies, send a GET request to /v2/droplets/backups/supported_policies.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Snapshots for a Droplet — digitalocean.droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Actions for a Droplet — digitalocean.dropletactions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a Droplet Action — digitalocean.dropletactions_post
To initiate an action on a Droplet send a POST request to /v2/droplets/$DROPLET_ID/actions. In the JSON body to the request, set the type attribute to one of the supported action types:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/droplet_action" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/droplet_action_enable_backups" |
|
body |
— | Optional | anyOf[3]; $ref: "#/definitions/droplet_action_change_backup_policy" |
|
body |
— | Optional | anyOf[4]; $ref: "#/definitions/droplet_action_restore" |
|
body |
— | Optional | anyOf[5]; $ref: "#/definitions/droplet_action_resize" |
|
body |
— | Optional | anyOf[6]; $ref: "#/definitions/droplet_action_rebuild" |
|
body |
— | Optional | anyOf[7]; $ref: "#/definitions/droplet_action_rename" |
|
body |
— | Optional | anyOf[8]; $ref: "#/definitions/droplet_action_change_kernel" |
|
body |
— | Optional | anyOf[9]; $ref: "#/definitions/droplet_action_snapshot" |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Acting on Tagged Droplets — digitalocean.dropletactions_post_bytag
Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.tag_name |
string | Optional | Used to filter Droplets by a specific tag. Can not be combined with name or type. Requires tag:read scope. |
|
body |
— | Optional | ||
body |
— | Optional | oneOf[1]; $ref: "#/definitions/droplet_action" |
|
body |
— | Optional | oneOf[2]; $ref: "#/definitions/droplet_action_snapshot" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a Droplet Action — digitalocean.dropletactions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444,
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Available Kernels for a Droplet — digitalocean.droplets_list_kernels
To retrieve a list of all kernels available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/kernels
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all Firewalls Applied to a Droplet — digitalocean.droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Neighbors for a Droplet — digitalocean.droplets_list_neighbors
To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on the same physical hardware) for a specific Droplet, send a GET request to /v2/droplets/$DROPLET_ID/neighbors.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Associated Resources for a Droplet — digitalocean.droplets_list_associatedresources
To list the associated billable resources that can be destroyed along with a Droplet, send a GET request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Selectively Destroy a Droplet and its Associated Resources — digitalocean.droplets_destroy_withassociatedresourcesselective
To destroy a Droplet along with a sub-set of its associated resources, send a DELETE request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/selective endpoint. The JSON body of the request should include reserved_ips, snapshots, volumes, or volume_snapshots keys each set to an array of IDs for the associated resources to be destroyed. The IDs can be found by querying the Droplet's associated resources. Any associated resource not included in the request will remain and continue to accrue changes on your account.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
body |
— | Optional | $ref: "#/definitions/selective_destroy_associated_resource" |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Destroy a Droplet and All of its Associated Resources (Dangerous) — digitalocean.droplets_destroy_withassociatedresourcesdangerous
To destroy a Droplet along with all of its associated resources, send a DELETE request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/dangerous endpoint. The headers of this request must include an X-Dangerous key set to true. To preview which resources will be destroyed, first query the Droplet's associated resources. This operation _can not_ be reverse and should be used with caution.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
headers |
object | Required | additionalProperties: false |
|
headers.X-Dangerous |
boolean | Required | Acknowledge this action will destroy the Droplet and all associated resources and can not be reversed. |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
},
"headers": {
"X-Dangerous": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Check Status of a Droplet Destroy with Associated Resources Request — digitalocean.droplets_get_destroyassociatedresourcesstatus
To check on the status of a request to destroy a Droplet with its associated resources, send a GET request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retry a Droplet Destroy with Associated Resources Request — digitalocean.droplets_destroy_retrywithassociatedresources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.droplet_id |
integer | Required | A unique identifier for a Droplet instance. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"droplet_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Autoscale Pools — digitalocean.autoscalepools_list
To list all autoscale pools in your team, send a GET request to /v2/droplets/autoscale. The response body will be a JSON object with a key of autoscale_pools containing an array of autoscale pool objects. These each contain the standard autoscale pool attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.name |
string | Optional | The name of the autoscale pool |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Autoscale Pool — digitalocean.autoscalepools_create
To create a new autoscale pool, send a POST request to /v2/droplets/autoscale setting the required attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/autoscale_pool_create" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Autoscale Pool — digitalocean.autoscalepools_get
To show information about an individual autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Autoscale Pool — digitalocean.autoscalepools_update
To update the configuration of an existing autoscale pool, send a PUT request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID. The request must contain a full representation of the autoscale pool including existing attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
body |
— | Optional | $ref: "#/definitions/autoscale_pool_create" |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete autoscale pool — digitalocean.autoscalepools_delete
To destroy an autoscale pool, send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE_POOL_ID endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete autoscale pool and resources — digitalocean.autoscalepools_delete_dangerous
To destroy an autoscale pool and its associated resources (Droplets), send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/dangerous endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
headers |
object | Required | additionalProperties: false |
|
headers.X-Dangerous |
boolean | Required | Acknowledge this action will destroy the autoscale pool and its associated resources and can not be reversed. |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
},
"headers": {
"X-Dangerous": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List members — digitalocean.autoscalepools_list_members
To list the Droplets in an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List history events — digitalocean.autoscalepools_list_history
To list all of the scaling history events of an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/history.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
path |
object | Required | additionalProperties: false |
|
path.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. |
Full JSON Schema
Example input
{
"path": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Firewalls — digitalocean.firewalls_list
To list all of the firewalls available on your account, send a GET request to /v2/firewalls.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Firewall — digitalocean.firewalls_create
To create a new firewall, send a POST request to /v2/firewalls. The request must contain at least one inbound or outbound access rule.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/firewall" |
|
body |
— | Optional | allOf[2] |
|
body |
— | Optional | allOf[3] |
|
body |
— | Optional | Inbound Rules | allOf[3]; anyOf[1] |
body |
— | Optional | Outbound Rules | allOf[3]; anyOf[2] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Firewall — digitalocean.firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Firewall — digitalocean.firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values. You must have read access (e.g. droplet:read) to all resources attached to the firewall to successfully update the firewall.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/firewall" |
|
body |
— | Optional | allOf[2] |
|
body |
— | Optional | Inbound Rules | allOf[2]; anyOf[1] |
body |
— | Optional | Outbound Rules | allOf[2]; anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Firewall — digitalocean.firewalls_delete
To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Droplets to a Firewall — digitalocean.firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
body |
object | Optional | ||
body.droplet_ids |
array | Required | An array containing the IDs of the Droplets to be assigned to the firewall. | |
body.droplet_ids[] |
integer | Optional |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Droplets from a Firewall — digitalocean.firewalls_delete_droplets
To remove a Droplet from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
body |
object | Optional | ||
body.droplet_ids |
array | Required | An array containing the IDs of the Droplets to be removed from the firewall. | |
body.droplet_ids[] |
integer | Optional |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Rules to a Firewall — digitalocean.firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/firewall_rules" |
|
body |
— | Optional | allOf[2] |
|
body |
— | Optional | Inbound Rules | allOf[2]; anyOf[1] |
body |
— | Optional | Outbound Rules | allOf[2]; anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Rules from a Firewall — digitalocean.firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.firewall_id |
string | Required | A unique ID that can be used to identify and reference a firewall. | format: "uuid" |
body |
— | Optional | ||
body |
— | Optional | allOf[1]; $ref: "#/definitions/firewall_rules" |
|
body |
— | Optional | allOf[2] |
|
body |
— | Optional | Inbound Rules | allOf[2]; anyOf[1] |
body |
— | Optional | Outbound Rules | allOf[2]; anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"firewall_id": "bb4b2611-3d72-467b-8602-280330ecd65c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Floating IPs — digitalocean.floatingips_list
To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Floating IP — digitalocean.floatingips_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/floating_ip_create" |
Full JSON Schema
Example input
{
"body": {
"droplet_id": 2457247
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Floating IP — digitalocean.floatingips_get
To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.floating_ip |
string | Required | A floating IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"floating_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Floating IP — digitalocean.floatingips_delete
To delete a floating IP and remove it from your account, send a DELETE request to /v2/floating_ips/$FLOATING_IP_ADDR.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.floating_ip |
string | Required | A floating IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"floating_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Actions for a Floating IP — digitalocean.floatingipsaction_list
To retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP/actions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.floating_ip |
string | Required | A floating IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"floating_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a Floating IP Action — digitalocean.floatingipsaction_post
To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.floating_ip |
string | Required | A floating IP address. | minimum: 1; format: "ipv4" |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/floating_ip_action_unassign" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/floating_ip_action_assign" |
Full JSON Schema
Example input
{
"path": {
"floating_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Floating IP Action — digitalocean.floatingipsaction_get
To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.floating_ip |
string | Required | A floating IP address. | minimum: 1; format: "ipv4" |
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"floating_ip": "45.55.96.47",
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Namespaces — digitalocean.functions_list_namespaces
Returns a list of namespaces associated with the current user. To get all namespaces, send a GET request to /v2/functions/namespaces.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Namespace — digitalocean.functions_create_namespace
Creates a new serverless functions namespace in the desired region and associates it with the provided label. A namespace is a collection of functions and their associated packages, triggers, and project specifications. To create a namespace, send a POST request to /v2/functions/namespaces with the region and label properties.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_namespace" |
Full JSON Schema
Example input
{
"body": {
"region": "nyc1",
"label": "my namespace"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Namespace — digitalocean.functions_get_namespace
Gets the namespace details for the given namespace UUID. To get namespace details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID with no parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Namespace — digitalocean.functions_delete_namespace
Deletes the given namespace. When a namespace is deleted all assets, in the namespace are deleted, this includes packages, functions and triggers. Deleting a namespace is a destructive operation and assets in the namespace are not recoverable after deletion. Some metadata is retained, such as activations, or soft deleted for reporting purposes. To delete namespace, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID. A successful deletion returns a 204 response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Triggers — digitalocean.functions_list_triggers
Returns a list of triggers associated with the current user and namespace. To get all triggers, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Trigger — digitalocean.functions_create_trigger
Creates a new trigger for a given function in a namespace. To create a trigger, send a POST request to /v2/functions/namespaces/$NAMESPACE_ID/triggers with the name, function, type, is_enabled and scheduled_details properties.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
body |
— | Required | $ref: "#/definitions/create_trigger" |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"body": {
"name": "my trigger",
"function": "hello",
"type": "SCHEDULED",
"is_enabled": true,
"scheduled_details": {
"cron": "* * * * *"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Trigger — digitalocean.functions_get_trigger
Gets the trigger details. To get the trigger details, send a GET request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
path.trigger_name |
string | Required | The name of the trigger to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"trigger_name": "my trigger"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Trigger — digitalocean.functions_update_trigger
Updates the details of the given trigger. To update a trigger, send a PUT request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME with new values for the is_enabled or scheduled_details properties.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
path.trigger_name |
string | Required | The name of the trigger to be managed. | |
body |
— | Required | $ref: "#/definitions/update_trigger" |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"trigger_name": "my trigger"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Trigger — digitalocean.functions_delete_trigger
Deletes the given trigger. To delete trigger, send a DELETE request to /v2/functions/namespaces/$NAMESPACE_ID/triggers/$TRIGGER_NAME. A successful deletion returns a 204 response.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
path.trigger_name |
string | Required | The name of the trigger to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"trigger_name": "my trigger"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Namespace Access Keys — digitalocean.functionsaccesskey_list
Lists all access keys for a serverless functions namespace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Namespace Access Key — digitalocean.functionsaccesskey_create
Creates a new access key for a serverless functions namespace. The access key can be used to authenticate requests to the namespace's functions. The secret key is only returned once upon creation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
body |
— | Required | $ref: "#/definitions/access_key_create_request" |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"body": {
"name": "my-function-access-key"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Namespace Access Key — digitalocean.functionsaccesskey_update
Updates the name of an access key for a serverless functions namespace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
path.key_id |
string | Required | The ID of the access key to be managed. | |
body |
object | Required | ||
body.name |
string | Required | The new name for the access key. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"key_id": "dof-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"body": {
"name": "updated-key-name"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Namespace Access Key — digitalocean.functionsaccesskey_delete
Deletes an access key for a serverless functions namespace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.namespace_id |
string | Required | The ID of the namespace to be managed. | |
path.key_id |
string | Required | The ID of the access key to be managed. |
Full JSON Schema
Example input
{
"path": {
"namespace_id": "fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"key_id": "dof-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Images — digitalocean.images_list
To list all of the images available on your account, send a GET request to /v2/images.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.type |
string | Optional | Filters results based on image type which can be either application or distribution. |
enum: ["application","distribution"] |
query.private |
boolean | Optional | Used to filter only user images. | |
query.tag_name |
string | Optional | Used to filter images by a specific tag. | |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Custom Image — digitalocean.images_create_custom
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image 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.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/image_new_custom" |
Full JSON Schema
Example input
{
"body": {
"name": "ubuntu-18.04-minimal",
"url": "http://cloud-images.ubuntu.com/minimal/releases/bionic/release/ubuntu-18.04-minimal-cloudimg-amd64.img",
"distribution": "Ubuntu",
"region": "nyc3",
"description": "Cloud-optimized image w/ small footprint",
"tags": [
"base-image",
"prod"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Image — digitalocean.images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
— | Required | A unique number (id) or string (slug) used to identify and reference a specific image. Public images can be identified by image id or slug. Private images must be identified by image id. |
|
path.image_id |
integer | Required | anyOf[1] |
|
path.image_id |
string | Required | anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"image_id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Image — digitalocean.images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Required | $ref: "#/definitions/image_update" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Image — digitalocean.images_delete
To delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate an Image Account Transfer — digitalocean.images_post_account_transfer_create
To initiate an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Required | $ref: "#/definitions/images_post_account_transfer_create" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
},
"body": {
"recipient_email": "[email protected]"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Accept an Image Account Transfer — digitalocean.images_post_account_transfer_accept
To accept an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/accept.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Required | $ref: "#/definitions/images_post_account_transfer_accept" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
},
"body": {
"transfer_id": 3164444,
"recipient_uuid": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel an Image Account Transfer — digitalocean.images_post_account_transfer_cancel
To cancel an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/cancel.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Required | $ref: "#/definitions/images_post_account_transfer_cancel" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
},
"body": {
"transfer_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Decline an Image Account Transfer — digitalocean.images_post_account_transfer_decline
To decline an account transfer for an image, send a POST request to /v2/images/$IMAGE_ID/account_transfer/decline.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Required | $ref: "#/definitions/images_post_account_transfer_decline" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
},
"body": {
"transfer_id": 3164444
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Actions for an Image — digitalocean.imageactions_list
To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate an Image Action — digitalocean.imageactions_post
The following actions are available on an Image.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/image_action_base" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/image_action_transfer" |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Action — digitalocean.imageactions_get
To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.image_id |
integer | Required | A unique number that can be used to identify and reference a specific image. | |
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"image_id": 62137902,
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Alert Instances — digitalocean.insights_list_alertinstances
To list alert instances for your account, send a GET request to /v2/insights/alert-instances. Alert instances are read-only records of alert rule firings against your resources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.status |
string | Optional | Optional filter. When set, only alert instances with this status are returned. | enum: ["active","resolved"] |
query.rule_id |
string | Optional | Optional filter. When set, only alert instances fired by the alert rule with this ID are returned. | format: "uuid" |
query.resource_urn |
string | Optional | Optional filter. When set, only resources associated with this resource URN are returned. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Alert Instance — digitalocean.insights_get_alertinstance
To retrieve a single alert instance, send a GET request to /v2/insights/alert-instances/{id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for an alert instance. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Alert Rules — digitalocean.insights_list_alertrules
To list alert rules for your account, send a GET request to /v2/insights/alert-rules. Results are paginated with page and per_page (default 20, maximum 200). Optionally filter by resource_urn.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.resource_urn |
string | Optional | Optional filter. When set, only resources associated with this resource URN are returned. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Alert Rule — digitalocean.insights_get_alertrule
To retrieve an alert rule, send a GET request to /v2/insights/alert-rules/{id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for an alert rule. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Alert Rule — digitalocean.insights_update_alertrule
This PUT endpoint uses merge semantics. To update an alert rule, send a request to /v2/insights/alert-rules/{id} with a full spec. Omit notification_channels to keep existing bindings. Omit status or re_alert_duration to keep those existing values.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for an alert rule. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/alert_rule_request" |
Full JSON Schema
Example input
{
"path": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"body": {
"spec": {
"name": "High CPU",
"query": {
"metric": "do.droplets.cpu_utilization"
},
"thresholds": {
"operator": "THRESHOLD_OPERATOR_GREATER_THAN",
"warning": 80
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Alert Rule — digitalocean.insights_delete_alertrule
To delete an alert rule, send a DELETE request to /v2/insights/alert-rules/{id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for an alert rule. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Notification Channels — digitalocean.insights_list_notificationchannels
To list all notification channels for your account, send a GET request to /v2/insights/notification-channels. Results are paginated with page and per_page (default 20, maximum 200).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Notification Channel — digitalocean.insights_create_notificationchannel
To create a notification channel, send a POST request to /v2/insights/notification-channels with a name and exactly one of email, slack, or webhook.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/notification_channel_request" |
Full JSON Schema
Example input
{
"body": {
"name": "Platform alerts",
"email": {
"to": "[email protected], [email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a Notification Channel — digitalocean.insights_get_notificationchannel
To retrieve a notification channel, send a GET request to /v2/insights/notification-channels/{id}. Secret credentials are never returned. When a secret is configured, the response includes an optional _status object (for example webhook_url_status) with configured: true.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for a notification channel. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Notification Channel — digitalocean.insights_update_notificationchannel
To update a notification channel, send a PUT request to /v2/insights/notification-channels/{id} with a name and exactly one of email, slack, or webhook.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for a notification channel. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/notification_channel_request" |
Full JSON Schema
Example input
{
"path": {
"id": "550e8400-e29b-41d4-a716-446655440000"
},
"body": {
"name": "Platform alerts",
"email": {
"to": "[email protected], [email protected]"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Notification Channel — digitalocean.insights_delete_notificationchannel
To delete a notification channel, send a DELETE request to /v2/insights/notification-channels/{id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | A unique identifier for a notification channel. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Execute an instant PromQL query — digitalocean.insights_get_promquery
To evaluate a PromQL expression at a single point in time, send a GET request to /v2/insights/query/{region}/prom/api/v1/query.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
query |
object | Required | additionalProperties: false |
|
query.query |
string | Required | A PromQL expression. This may be a metric selector (for example do.droplets.cpu_time) or a fuller expression (for example rate(do.droplets.cpu_time[5m])). |
|
query.time |
string | Optional | Evaluation timestamp for an instant query. Accepts a RFC3339 string or a UNIX timestamp. Defaults to now when omitted. | |
query.timeout |
string | Optional | Optional evaluation timeout as a Prometheus duration string. |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3"
},
"query": {
"query": "do.droplets.cpu_time"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Execute a range PromQL query — digitalocean.insights_get_promqueryrange
To evaluate a PromQL expression over a time range, send a GET request to /v2/insights/query/{region}/prom/api/v1/query_range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
query |
object | Required | additionalProperties: false |
|
query.query |
string | Required | A PromQL expression. This may be a metric selector (for example do.droplets.cpu_time) or a fuller expression (for example rate(do.droplets.cpu_time[5m])). |
|
query.start |
string | Required | Start timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.end |
string | Required | End timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.step |
string | Required | Query resolution step width as a Prometheus duration string (for example 15s, 1m, 1h). |
|
query.timeout |
string | Optional | Optional evaluation timeout as a Prometheus duration string. |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3"
},
"query": {
"query": "do.droplets.cpu_time",
"start": "1620683817",
"end": "1620705417",
"step": "15s"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List label names — digitalocean.insights_get_promlabels
To list label names, send a GET request to /v2/insights/query/{region}/prom/api/v1/labels.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
query |
object | Optional | additionalProperties: false |
|
query.start |
string | Optional | Optional start timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.end |
string | Optional | Optional end timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.match[] |
array | Optional | One or more series selectors. Repeat the parameter for multiple matchers. | |
query.match[][] |
string | Optional |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List values for a label — digitalocean.insights_get_promlabelvalues
To list values for a label name, send a GET request to /v2/insights/query/{region}/prom/api/v1/label/{name}/values.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
path.name |
string | Required | The label name whose values should be listed. | |
query |
object | Optional | additionalProperties: false |
|
query.start |
string | Optional | Optional start timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.end |
string | Optional | Optional end timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.match[] |
array | Optional | One or more series selectors. Repeat the parameter for multiple matchers. | |
query.match[][] |
string | Optional |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3",
"name": "__name__"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Find series by label selectors — digitalocean.insights_get_promseries
To find series matching one or more selectors, send a GET request to /v2/insights/query/{region}/prom/api/v1/series.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
query |
object | Required | additionalProperties: false |
|
query.match[] |
array | Required | One or more series selectors. At least one matcher is required. Repeat the parameter for multiple matchers. | |
query.match[][] |
string | Optional | ||
query.start |
string | Optional | Optional start timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. | |
query.end |
string | Optional | Optional end timestamp (inclusive). Accepts a RFC3339 string or a UNIX timestamp. |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3"
},
"query": {
"match[]": [
"{__name__=\"do.droplets.cpu_time\"}"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an existing trace — digitalocean.insights_get_trace
To retrieve a single trace and all of its spans, send a GET request to /v2/insights/query/{region}/traces/{trace_id}. Only spans that started within the lookup window are returned. The window defaults to the last 7 days and can be narrowed with the from and to query parameters; it must not exceed 7 days, and from must not be after to. Spans are returned ordered by start time. At most 10,000 spans are returned; truncated is true when the trace has more. A trace ID with no spans in the window returns 404, as do malformed or uppercase trace IDs. A trace is only resolvable in the region that ingested it; querying another region also returns 404. Supported regions are ams2, ams3, atl1, blr1, fra1, lon1, mem1, nyc1, nyc2, nyc3, ric1, sfo1, sfo2, sfo3, sgp1, syd1, and tor1. Requests time out after 60 seconds. Errors produced by the traces service (400, and 404 when no trace is found) have a text/plain body containing a short message. Authentication and authorization errors (401, 403), rate limiting (429), and routing errors (for example, 404 for an unknown region) come from the API gateway and use the standard JSON error object with id and message. 403 is also returned for accounts that are in a trial or not in good standing. If the regional traces backend cannot be reached, the response is 502 with a text/plain body. JSON field names use snake_case (trace_id, span_id, start_time, end_time, duration_ns, service_name, status_code, parent_span_id).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.region |
string | Required | The datacenter region slug for the query. | |
path.trace_id |
string | Required | The OpenTelemetry trace ID to retrieve, as 32 lowercase hexadecimal characters. IDs are matched exactly; an ID with no spans in the lookup window returns 404. Malformed or uppercase IDs are not rejected with 400; they also return 404. |
|
query |
object | Optional | additionalProperties: false |
|
query.from |
string | Optional | Start of the trace lookup window. Accepts a relative time (now, a bare duration such as 24h to look back from now, or now-2h) or an absolute time (RFC3339, or a Unix epoch integer in seconds, milliseconds, microseconds, or nanoseconds). Defaults to 7 days before now. |
|
query.to |
string | Optional | End of the trace lookup window, in the same formats as from. Defaults to now. |
Full JSON Schema
Example input
{
"path": {
"region": "nyc3",
"trace_id": "7b0b4e56abab38362b24e5498eb9ec64"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Resource Signal Enablement — digitalocean.insights_list_resources
To list the resources in your account that have telemetry signal enablement recorded, along with the current state of their metrics, logs, and traces signals, send a GET request to /v2/insights/resources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.filter.product_types |
array | Optional | Optional filter. When set, only resources of these product types are returned. Repeat the parameter for multiple product types. | |
query.filter.product_types[] |
string | Optional | ||
query.filter.regions |
array | Optional | Optional filter. When set, only resources in these regions are returned. Repeat the parameter for multiple regions. | |
query.filter.regions[] |
string | Optional | ||
query.pagination.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.pagination.per_page |
integer | Optional | Number of items returned per page. | default: 20; minimum: 1; maximum: 200 |
query.pagination.sort |
string | Optional | Field to sort by. Defaults to resource_urn. |
enum: ["resource_urn","effective_at"] |
query.pagination.sort_direction |
string | Optional | Sort direction. Defaults to asc. |
enum: ["asc","desc"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Resource Signal Enablement — digitalocean.insights_get_resource
To retrieve the current metrics, logs, and traces signal enablement for a single resource, send a GET request to /v2/insights/resources/{resource_urn}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_urn |
string | Required | The uniform resource name (URN) of the resource, for example do:droplet:12345. |
Full JSON Schema
Example input
{
"path": {
"resource_urn": "do:droplet:12345"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Resource Signal Enablement — digitalocean.insights_update_resourcesignals
To enable or disable telemetry signals for a resource, send a PUT request to /v2/insights/resources/{resource_urn}/signals.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.resource_urn |
string | Required | The uniform resource name (URN) of the resource, for example do:droplet:12345. |
|
body |
— | Required | $ref: "#/definitions/resource_signals_update_request" |
Full JSON Schema
Example input
{
"path": {
"resource_urn": "do:droplet:12345"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Consent Records — digitalocean.signals_list_consents
To list all signals consent records for your team, send a GET request to /v1/consent. Each record indicates whether signals collection is enabled for a source: per-environment records (source: agent) for Harness Runtime, and the team-level record (source: inference) for Serverless Inference chat completions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.source |
string | Optional | Filter consent records by source. agent returns per-environment records (Harness Runtime); inference returns the team-level record for Serverless Inference chat completions. When omitted, records for all sources are returned. |
enum: ["agent","inference"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Team-Level Consent — digitalocean.signals_update_team_consent
To enable or disable signals collection for a source that is consented at the team level, send a PUT request to /v1/consent?source=inference with an enabled boolean in the request body. Currently the only team-level source is inference, which covers Serverless Inference chat completions made by your team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.source |
string | Required | The consent source to update. Only team-level sources are accepted on this endpoint; currently inference (Serverless Inference chat completions). Per-environment consent (agent) is managed with PUT /v1/consent/{environment_id} instead. |
enum: ["inference"] |
body |
object | Required | ||
body.enabled |
boolean | Required | Whether to enable signals collection for this source. |
Full JSON Schema
Example input
{
"query": {
"source": "inference"
},
"body": {
"enabled": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Consent for an Environment — digitalocean.signals_get_consent
To retrieve the consent record for a specific environment, send a GET request to /v1/consent/{environment_id}. The response includes an enabled field indicating whether signals collection is on for this environment.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.environment_id |
string | Required | A unique identifier for an environment. For Harness Runtime, this is the Environment Config ID. Formerly named agent_id. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"environment_id": "019fb3d2-8a56-72cc-8bf9-9d21510b2a99"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Consent for an Environment — digitalocean.signals_update_consent
To enable or disable signals collection for a specific environment, send a PUT request to /v1/consent/{environment_id} with an enabled boolean in the request body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.environment_id |
string | Required | A unique identifier for an environment. For Harness Runtime, this is the Environment Config ID. Formerly named agent_id. | format: "uuid" |
body |
object | Required | ||
body.enabled |
boolean | Required | Whether to enable signals collection for this environment. |
Full JSON Schema
Example input
{
"path": {
"environment_id": "019fb3d2-8a56-72cc-8bf9-9d21510b2a99"
},
"body": {
"enabled": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Sessions for an Environment — digitalocean.signals_list_agent_sessions
To list signals sessions for a specific environment, send a GET request to /v1/signals/agents/{environment_id}/sessions. Results are paginated using cursor-based pagination with limit and after parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.environment_id |
string | Required | A unique identifier for an environment. For Harness Runtime, this is the Environment Config ID. Formerly named agent_id. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of items to return per page. | default: 20; minimum: 1; maximum: 100 |
query.after |
string | Optional | An opaque cursor string returned from a previous page. Pass this value to retrieve the next page of results. | |
query.start_time |
string | Optional | Filter results to those occurring at or after this timestamp (RFC 3339). | format: "date-time" |
query.end_time |
string | Optional | Filter results to those occurring at or before this timestamp (RFC 3339). | format: "date-time" |
query.signal_type |
string | Optional | Filter results by signal type. Use the export options endpoint to list available signal types. |
Full JSON Schema
Example input
{
"path": {
"environment_id": "019fb3d2-8a56-72cc-8bf9-9d21510b2a99"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Dialogues for a Session — digitalocean.signals_list_session_dialogues
To list the dialogue turns within a specific session, send a GET request to /v1/signals/sessions/{session_id}/dialogues. Each dialogue represents a single turn of conversation between a user and the environment, along with any signals detected. Results are paginated using cursor-based pagination.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.session_id |
string | Required | A unique identifier for a signals session. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of items to return per page. | default: 20; minimum: 1; maximum: 100 |
query.after |
string | Optional | An opaque cursor string returned from a previous page. Pass this value to retrieve the next page of results. | |
query.start_time |
string | Optional | Filter results to those occurring at or after this timestamp (RFC 3339). | format: "date-time" |
query.end_time |
string | Optional | Filter results to those occurring at or before this timestamp (RFC 3339). | format: "date-time" |
query.signal_type |
string | Optional | Filter results by signal type. Use the export options endpoint to list available signal types. |
Full JSON Schema
Example input
{
"path": {
"session_id": "01a0f3d5-d5f1-798a-9352-2cd8f8b81e78"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Export Jobs — digitalocean.signals_list_exports
To list signals export jobs for your team, send a GET request to /v1/signals/exports. Results are paginated using cursor-based pagination with limit and after parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.environment_id |
string | Optional | Optional filter by environment ID. | format: "uuid" |
query.agent_id |
string | Optional | Deprecated alias for environment_id. Accepted for backward compatibility; must equal environment_id when both are set. Both set and different returns 400. | format: "uuid" |
query.limit |
integer | Optional | Maximum number of items to return per page. | default: 20; minimum: 1; maximum: 100 |
query.after |
string | Optional | An opaque cursor string returned from a previous page. Pass this value to retrieve the next page of results. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an Export Job — digitalocean.signals_create_export
To create a new signals data export, send a POST request to /v1/signals/exports. To export one Harness Runtime environment, include its environment_id (type defaults to agent). Deprecated agent_id is still accepted. To export the team's Serverless Inference Signals conversations, set type to inference and omit environment_id and agent_id. You may optionally filter the export by signal_type, session_ids, start_time, and end_time. Use the export options endpoint to discover available signal types.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_export_request" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Export Options — digitalocean.signals_get_export_options
To retrieve the available filter options for creating an export, send a GET request to /v1/signals/exports/options. The response lists valid signal types that can be used in the signal_type filter when creating an export.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Export Job — digitalocean.signals_get_export
To retrieve the status and details of a signals export job, send a GET request to /v1/signals/exports/{export_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.export_id |
string | Required | A unique identifier for an export job. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"export_id": "9f13c09c-c877-436b-9863-dcc39c9dd737"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Export Download URL — digitalocean.signals_get_export_download
To retrieve a pre-signed download URL for a completed export, send a GET request to /v1/signals/exports/{export_id}/download. The export must have a complete status. The URL is temporary and will expire.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.export_id |
string | Required | A unique identifier for an export job. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"export_id": "9f13c09c-c877-436b-9863-dcc39c9dd737"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Data Deletion Jobs — digitalocean.signals_list_deletions
To list signals data deletion jobs for your team, newest first, send a GET request to /v1/signals/deletions. Results are paginated using cursor-based pagination with limit and after parameters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.limit |
integer | Optional | Maximum number of items to return per page. | default: 20; minimum: 1; maximum: 100 |
query.after |
string | Optional | An opaque cursor string returned from a previous page. Pass this value to retrieve the next page of results. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Data Deletion Job — digitalocean.signals_create_deletion
To permanently delete Signals conversation data, send a POST request to /v1/signals/deletions. Deletion cannot be undone.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_deletion_request" |
Full JSON Schema
Example input
{
"body": {
"type": "agent",
"team_id": 12345678
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a Data Deletion Job — digitalocean.signals_get_deletion
To retrieve the status of a signals data deletion job, send a GET request to /v1/signals/deletions/{deletion_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.deletion_id |
string | Required | A unique identifier for a data deletion job. |
Full JSON Schema
Example input
{
"path": {
"deletion_id": "01J9ZX0N5Q7M2K3R4S5T6V7W8X"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Kubernetes Clusters — digitalocean.kubernetes_list_clusters
To list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Kubernetes Cluster — digitalocean.kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/cluster" |
Full JSON Schema
Example input
{
"body": {
"name": "prod-cluster-01",
"region": "nyc1",
"version": "1.18.6-do.0",
"node_pools": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Kubernetes Cluster — digitalocean.kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Kubernetes Cluster — digitalocean.kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/cluster_update" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
},
"body": {
"name": "prod-cluster-01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Kubernetes Cluster — digitalocean.kubernetes_delete_cluster
To delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Associated Resources for Cluster Deletion — digitalocean.kubernetes_list_associatedresources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Selectively Delete a Cluster and its Associated Resources — digitalocean.kubernetes_destroy_associatedresourcesselective
To delete a Kubernetes cluster along with a subset of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/selective.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/destroy_associated_kubernetes_resources" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Cluster and All of its Associated Resources (Dangerous) — digitalocean.kubernetes_destroy_associatedresourcesdangerous
To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous. A 204 status code with no body will be returned in response to a successful request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Credentials for a Kubernetes Cluster — digitalocean.kubernetes_get_credentials
This endpoint returns a JSON object . It can be used to programmatically construct Kubernetes clients which cannot parse kubeconfig files.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.expiry_seconds |
integer | Optional | The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. | default: 0; minimum: 0 |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Available Upgrades for an Existing Kubernetes Cluster — digitalocean.kubernetes_get_availableupgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Upgrade a Kubernetes Cluster — digitalocean.kubernetes_upgrade_cluster
To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade. The body of the request must specify a version attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
body |
object | Required | ||
body.version |
string | Optional | The slug identifier for the version of Kubernetes that the cluster will be upgraded to. |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Node Pools in a Kubernetes Clusters — digitalocean.kubernetes_list_nodepools
To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a Node Pool for a Kubernetes Cluster — digitalocean.kubernetes_get_nodepool
To show information about a specific node pool in a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
path.node_pool_id |
string | Required | A unique ID that can be used to reference a Kubernetes node pool. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af",
"node_pool_id": "cdda885e-7663-40c8-bc74-3a036c66545d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Node Pool in a Kubernetes Cluster — digitalocean.kubernetes_update_nodepool
To update the name of a node pool, edit the tags applied to it, or adjust its number of nodes, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID with the following attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
path.node_pool_id |
string | Required | A unique ID that can be used to reference a Kubernetes node pool. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/kubernetes_node_pool_update" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af",
"node_pool_id": "cdda885e-7663-40c8-bc74-3a036c66545d"
},
"body": {
"name": "frontend-pool",
"count": 3
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Node Pool in a Kubernetes Cluster — digitalocean.kubernetes_delete_nodepool
To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
path.node_pool_id |
string | Required | A unique ID that can be used to reference a Kubernetes node pool. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af",
"node_pool_id": "cdda885e-7663-40c8-bc74-3a036c66545d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Node in a Kubernetes Cluster — digitalocean.kubernetes_delete_node
To delete a single node in a pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
path.node_pool_id |
string | Required | A unique ID that can be used to reference a Kubernetes node pool. | minimum: 1; format: "uuid" |
path.node_id |
string | Required | A unique ID that can be used to reference a node in a Kubernetes node pool. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.skip_drain |
integer | Optional | Specifies whether or not to drain workloads from a node before it is deleted. Setting it to 1 causes node draining to be skipped. Omitting the query parameter or setting its value to 0 carries out draining prior to deletion. |
default: 0; minimum: 0; maximum: 1 |
query.replace |
integer | Optional | Specifies whether or not to replace a node after it has been deleted. Setting it to 1 causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to 0 deletes without replacement. |
default: 0; minimum: 0; maximum: 1 |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af",
"node_pool_id": "cdda885e-7663-40c8-bc74-3a036c66545d",
"node_id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve User Information for a Kubernetes Cluster — digitalocean.kubernetes_get_clusteruser
To show information the user associated with a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Available Regions, Node Sizes, and Versions of Kubernetes — digitalocean.kubernetes_list_options
To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to /v2/kubernetes/options.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run Clusterlint Checks on a Kubernetes Cluster — digitalocean.kubernetes_run_clusterlint
Clusterlint helps operators conform to Kubernetes best practices around resources, security and reliability to avoid common problems while operating or upgrading the clusters.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
body |
— | Optional | $ref: "#/definitions/clusterlint_request" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Fetch Clusterlint Diagnostics for a Kubernetes Cluster — digitalocean.kubernetes_get_clusterlintresults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.run_id |
string | Optional | Specifies the clusterlint run whose results will be retrieved. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Container Registry to Kubernetes Clusters — digitalocean.kubernetes_add_registry
To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/cluster_registry" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Container Registry from Kubernetes Clusters — digitalocean.kubernetes_remove_registry
To remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/cluster_registry" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Container Registries to Kubernetes Clusters — digitalocean.kubernetes_add_registries
To integrate the container registries with Kubernetes clusters, send a POST request to /v2/kubernetes/registries.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/cluster_registries" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Container Registries from Kubernetes Clusters — digitalocean.kubernetes_remove_registries
To remove the container registries from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registries.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/cluster_registries" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Fetch Status Messages for a Kubernetes Cluster — digitalocean.kubernetes_get_status_messages
To retrieve status messages for a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/status_messages. Status messages inform users of any issues that come up during the cluster lifecycle.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.cluster_id |
string | Required | A unique ID that can be used to reference a Kubernetes cluster. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.since |
string | Optional | A timestamp used to return status messages emitted since the specified time. The timestamp should be in ISO8601 format. | format: "date-time" |
Full JSON Schema
Example input
{
"path": {
"cluster_id": "bd5f5959-5e1e-4205-a714-a914373942af"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Load Balancers — digitalocean.loadbalancers_list
To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Load Balancer — digitalocean.loadbalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.lb_id |
string | Required | A unique identifier for a load balancer. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Load Balancer — digitalocean.loadbalancers_delete
To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.lb_id |
string | Required | A unique identifier for a load balancer. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Global Load Balancer CDN Cache — digitalocean.loadbalancers_delete_cache
To delete a Global load balancer CDN cache, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/cache.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.lb_id |
string | Required | A unique identifier for a load balancer. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Forwarding Rules to a Load Balancer — digitalocean.loadbalancers_add_forwardingrules
To add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be added.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.lb_id |
string | Required | A unique identifier for a load balancer. | minimum: 1 |
body |
object | Required | ||
body.forwarding_rules |
array | Required | minItems: 1 |
|
body.forwarding_rules[] |
— | Optional | $ref: "#/definitions/forwarding_rule" |
Full JSON Schema
Example input
{
"path": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"forwarding_rules": [
{
"entry_protocol": "https",
"entry_port": 443,
"target_protocol": "http",
"target_port": 80
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Forwarding Rules from a Load Balancer — digitalocean.loadbalancers_remove_forwardingrules
To remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be removed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.lb_id |
string | Required | A unique identifier for a load balancer. | minimum: 1 |
body |
object | Required | ||
body.forwarding_rules |
array | Required | minItems: 1 |
|
body.forwarding_rules[] |
— | Optional | $ref: "#/definitions/forwarding_rule" |
Full JSON Schema
Example input
{
"path": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"forwarding_rules": [
{
"entry_protocol": "https",
"entry_port": 443,
"target_protocol": "http",
"target_port": 80
}
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all MicroVMs — digitalocean.microvms_list
To list all of the MicroVMs on your team, send a GET request to /v2/microvms.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page. | default: 25; minimum: 1; maximum: 200 |
query.region |
string | Optional | Only return MicroVMs in this region. | |
query.name |
string | Optional | Only return the MicroVM with this exact name. | |
query.tag_name |
string | Optional | Only return MicroVMs with this tag. A tag that matches no MicroVMs returns an empty list. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a MicroVM — digitalocean.microvms_create
To create a MicroVM, send a POST request to /v2/microvms.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/microvm_create" |
Full JSON Schema
Example input
{
"body": {
"name": "example-microvm",
"source": {}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List MicroVM options — digitalocean.microvms_get_options
To list the default region, sizes, prices, account limits, and features available to your team, send a GET request to /v2/microvms/options.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List checkpoints — digitalocean.microvmcheckpoints_list
To list your team's checkpoints, newest first, send a GET request to /v2/microvms/checkpoints. To list one MicroVM's checkpoints, add the microvm_id query parameter.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.per_page |
integer | Optional | Number of items returned per page. | default: 25; minimum: 1; maximum: 200 |
query.microvm_id |
string | Optional | Only return checkpoints taken from this MicroVM. | format: "uuid" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a checkpoint — digitalocean.microvmcheckpoints_get
To show information about a checkpoint, send a GET request to /v2/microvms/checkpoints/{checkpoint_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.checkpoint_id |
string | Required | The unique ID of the checkpoint. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"checkpoint_id": "01a0ed98-0a74-75dd-a625-e4856adbc298"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a checkpoint — digitalocean.microvmcheckpoints_delete
To delete a checkpoint, send a DELETE request to /v2/microvms/checkpoints/{checkpoint_id}. You can no longer create MicroVMs from a deleted checkpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.checkpoint_id |
string | Required | The unique ID of the checkpoint. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"checkpoint_id": "01a0ed98-0a74-75dd-a625-e4856adbc298"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a MicroVM — digitalocean.microvms_get
To show information about a MicroVM, send a GET request to /v2/microvms/{microvm_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a MicroVM — digitalocean.microvms_delete
To delete a MicroVM and the data on its disk, send a DELETE request to /v2/microvms/{microvm_id}. The MicroVM's checkpoints are not deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Pause a MicroVM — digitalocean.microvms_post_pause
To pause a MicroVM, send a POST request to /v2/microvms/{microvm_id}/pause.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Resume a MicroVM — digitalocean.microvms_post_resume
To resume a paused MicroVM, send a POST request to /v2/microvms/{microvm_id}/resume.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run a command in a MicroVM — digitalocean.microvms_run_command
To run a command in a MicroVM's workload container, send a POST request to /v2/microvms/{microvm_id}/exec.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/exec_request" |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
},
"body": {
"argv": [
"nginx",
"-v"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a checkpoint of a MicroVM — digitalocean.microvmcheckpoints_create
To create a checkpoint of a running or paused MicroVM, send a POST request to /v2/microvms/{microvm_id}/checkpoints.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.microvm_id |
string | Required | The unique ID of the MicroVM. | format: "uuid" |
body |
object | Optional | ||
body.name |
string | Optional | A name for the checkpoint. If you omit it, a name such as checkpoint-20260929-143559 is generated. |
Full JSON Schema
Example input
{
"path": {
"microvm_id": "01a0ef1a-d873-793d-ae6a-5dd6239be62a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Alert Policies — digitalocean.monitoring_list_alertpolicy
Returns all alert policies that are configured for the given account. To List all alert policies, send a GET request to /v2/monitoring/alerts.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Alert Policy — digitalocean.monitoring_create_alertpolicy
To create a new alert, send a POST request to /v2/monitoring/alerts.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/alert_policy_request" |
Full JSON Schema
Example input
{
"body": {
"type": "v1/insights/droplet/cpu",
"description": "CPU Alert",
"compare": "GreaterThan",
"value": 80,
"window": "5m",
"entities": [
"192018292"
],
"tags": [
"droplet_tag"
],
"alerts": {
"slack": [],
"email": [
"[email protected]"
]
},
"enabled": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Alert Policy — digitalocean.monitoring_get_alertpolicy
To retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert_uuid}
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.alert_uuid |
string | Required | A unique identifier for an alert policy. |
Full JSON Schema
Example input
{
"path": {
"alert_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Alert Policy — digitalocean.monitoring_update_alertpolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.alert_uuid |
string | Required | A unique identifier for an alert policy. | |
body |
— | Required | $ref: "#/definitions/alert_policy_request" |
Full JSON Schema
Example input
{
"path": {
"alert_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"type": "v1/insights/droplet/cpu",
"description": "CPU Alert",
"compare": "GreaterThan",
"value": 80,
"window": "5m",
"entities": [
"192018292"
],
"tags": [
"droplet_tag"
],
"alerts": {
"slack": [],
"email": [
"[email protected]"
]
},
"enabled": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Alert Policy — digitalocean.monitoring_delete_alertpolicy
To delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert_uuid}
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.alert_uuid |
string | Required | A unique identifier for an alert policy. |
Full JSON Schema
Example input
{
"path": {
"alert_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Bandwidth Metrics — digitalocean.monitoring_get_dropletbandwidthmetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traffic. The metrics in the response body are in megabits per second (Mbps).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.interface |
string | Required | The network interface. | enum: ["private","public"] |
query.direction |
string | Required | The traffic direction. | enum: ["inbound","outbound"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"interface": "private",
"direction": "inbound",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet CPU Metrics — digitalocean.monitoring_get_dropletcpumetrics
To retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Filesystem Free Metrics — digitalocean.monitoring_get_dropletfilesystemfreemetrics
To retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_free.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Filesystem Size Metrics — digitalocean.monitoring_get_dropletfilesystemsizemetrics
To retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_size.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Load1 Metrics — digitalocean.monitoring_get_dropletload1metrics
To retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_1.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Load5 Metrics — digitalocean.monitoring_get_dropletload5metrics
To retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_5.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Load15 Metrics — digitalocean.monitoring_get_dropletload15metrics
To retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load_15.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Cached Memory Metrics — digitalocean.monitoring_get_dropletmemorycachedmetrics
To retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_cached.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Free Memory Metrics — digitalocean.monitoring_get_dropletmemoryfreemetrics
To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Total Memory Metrics — digitalocean.monitoring_get_dropletmemorytotalmetrics
To retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_total.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Available Memory Metrics — digitalocean.monitoring_get_dropletmemoryavailablemetrics
To retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_available.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.host_id |
string | Required | The droplet ID. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"host_id": "17209102",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get App Memory Percentage Metrics — digitalocean.monitoring_get_appmemorypercentagemetrics
To retrieve memory percentage metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/memory_percentage.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.app_id |
string | Required | The app UUID. | |
query.app_component |
string | Optional | The app component name. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"app_id": "2db3c021-15ad-4088-bfe8-99dc972b9cf6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get App CPU Percentage Metrics — digitalocean.monitoring_get_appcpupercentagemetrics
To retrieve cpu percentage metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/cpu_percentage.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.app_id |
string | Required | The app UUID. | |
query.app_component |
string | Optional | The app component name. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"app_id": "2db3c021-15ad-4088-bfe8-99dc972b9cf6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get App Restart Count Metrics — digitalocean.monitoring_get_apprestartcountmetrics.yml
To retrieve restart count metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/restart_count.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.app_id |
string | Required | The app UUID. | |
query.app_component |
string | Optional | The app component name. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"app_id": "2db3c021-15ad-4088-bfe8-99dc972b9cf6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Total Current Active Connections Metrics — digitalocean.monitoring_get_lb_frontend_connections_current
To retrieve frontend total current active connections for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_connections_current.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Max Connections Limit Metrics — digitalocean.monitoring_get_lb_frontend_connections_limit
To retrieve frontend max connections limit for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_connections_limit.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Average Percentage CPU Utilization Metrics — digitalocean.monitoring_get_lb_frontend_cpu_utilization
To retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_cpu_utilization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Firewall Dropped Bytes Metrics — digitalocean.monitoring_get_lb_frontend_firewall_dropped_bytes
To retrieve firewall dropped bytes for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes. This is currently only supported for network load balancers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Firewall Dropped Packets Metrics — digitalocean.monitoring_get_lb_frontend_firewall_dropped_packets
To retrieve firewall dropped packets per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets. This is currently only supported for network load balancers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend HTTP Rate Of Response Code Metrics — digitalocean.monitoring_get_lb_frontend_http_responses
To retrieve frontend HTTP rate of response code for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_http_responses.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend HTTP Requests Metrics — digitalocean.monitoring_get_lb_frontend_http_requests_per_second
To retrieve frontend HTTP requests per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend HTTP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_http
To retrieve frontend HTTP throughput in bytes per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_network_throughput_http.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend UDP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_udp
To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend TCP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_network_throughput_tcp
To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Network Load Balancer Frontend TCP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_nlb_tcp_network_throughput
To retrieve frontend TCP throughput in bytes per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Network Load Balancer Frontend UDP Throughput Metrics — digitalocean.monitoring_get_lb_frontend_nlb_udp_network_throughput
To retrieve frontend UDP throughput in bytes per second for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Current TLS Connections Rate Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_current
To retrieve frontend current TLS connections rate for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_tls_connections_current.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Max TLS Connections Limit Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_limit
To retrieve frontend max TLS connections limit for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Frontend Closed TLS Connections For Exceeded Rate Limit Metrics — digitalocean.monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit
To retrieve frontend closed TLS connections for exceeded rate limit for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Average HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_avg
To retrieve Droplets average HTTP session duration in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets 50th Percentile HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_50p
To retrieve Droplets 50th percentile HTTP session duration in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets 95th Percentile HTTP Session Duration Metrics — digitalocean.monitoring_get_lb_droplets_http_session_duration_95p
To retrieve Droplets 95th percentile HTTP session duration in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Average HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_avg
To retrieve Droplets average HTTP response time in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets 50th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_50p
To retrieve Droplets 50th percentile HTTP response time in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets 95th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_95p
To retrieve Droplets 95th percentile HTTP response time in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets 99th Percentile HTTP Response Time Metrics — digitalocean.monitoring_get_lb_droplets_http_response_time_99p
To retrieve Droplets 99th percentile HTTP response time in seconds for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Queue Size Metrics — digitalocean.monitoring_get_lb_droplets_queue_size
To retrieve Droplets queue size for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_queue_size.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets HTTP Rate Of Response Code Metrics — digitalocean.monitoring_get_lb_droplets_http_responses
To retrieve Droplets HTTP rate of response code for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_http_responses.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Active Connections Metrics — digitalocean.monitoring_get_lb_droplets_connections
To retrieve Droplets active connections for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_connections.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Health Check Status Metrics — digitalocean.monitoring_get_lb_droplets_health_checks
To retrieve Droplets health check status for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_health_checks.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Load Balancer Droplets Downtime Status Metrics — digitalocean.monitoring_get_lb_droplets_downtime
To retrieve Droplets downtime status for a given load balancer, send a GET request to /v2/monitoring/metrics/load_balancer/droplets_downtime.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.lb_id |
string | Required | A unique identifier for a load balancer. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"lb_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Current Size — digitalocean.monitoring_get_droplet_autoscale_current_instances
To retrieve the current size for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/current_instances.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Target Size — digitalocean.monitoring_get_droplet_autoscale_target_instances
To retrieve the target size for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/target_instances.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Current Average CPU utilization — digitalocean.monitoring_get_droplet_autoscale_current_cpu_utilization.yml
To retrieve the current average CPU utilization for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Target Average CPU utilization — digitalocean.monitoring_get_droplet_autoscale_target_cpu_utilization
To retrieve the target average CPU utilization for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Current Average Memory utilization — digitalocean.monitoring_get_droplet_autoscale_current_memory_utilization
To retrieve the current average memory utilization for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/current_memory_utilization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Droplet Autoscale Pool Target Average Memory utilization — digitalocean.monitoring_get_droplet_autoscale_target_memory_utilization
To retrieve the target average memory utilization for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet_autoscale/target_memory_utilization.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.autoscale_pool_id |
string | Required | A unique identifier for an autoscale pool. | |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"autoscale_pool_id": "0d3db13e-a604-4944-9827-7ec2642d32ac",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL CPU Usage Metrics — digitalocean.monitoring_get_database_mysql_cpu_usage
Retrieve CPU usage (percent) for a MySQL cluster. Response is a time series of cluster-level CPU usage. Use aggregate to get avg, max, or min over the range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.aggregate |
string | Required | Aggregation over the time range (avg, max, or min). | enum: ["avg","max","min"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"aggregate": "avg",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Load Average Metrics — digitalocean.monitoring_get_database_mysql_load
Retrieve load metrics for a MySQL cluster. Use metric for the window: load1 (1-minute), load5 (5-minute), or load15 (15-minute). Use aggregate to get either the average (avg) or maximum (max) over that window over the time range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.metric |
string | Required | Load window: load1 (1-minute), load5 (5-minute), load15 (15-minute). The value is either average or max over that window, depending on the aggregate parameter (avg or max). | enum: ["load1","load5","load15"] |
query.aggregate |
string | Required | Aggregation over the time range (avg or max). | enum: ["avg","max"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"metric": "load1",
"aggregate": "avg",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Memory Usage Metrics — digitalocean.monitoring_get_database_mysql_memory_usage
Retrieve memory usage (percent) for a MySQL cluster. Use aggregate (avg, max, or min) over the time range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.aggregate |
string | Required | Aggregation over the time range (avg, max, or min). | enum: ["avg","max","min"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"aggregate": "avg",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Disk Usage Metrics — digitalocean.monitoring_get_database_mysql_disk_usage
Retrieve disk usage (percent) for a MySQL cluster. Use aggregate (avg, max, or min) over the time range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.aggregate |
string | Required | Aggregation over the time range (avg, max, or min). | enum: ["avg","max","min"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"aggregate": "avg",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Threads Connected Metrics — digitalocean.monitoring_get_database_mysql_threads_connected
Retrieve current threads connected for a MySQL service (gauge).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Threads Created Rate Metrics — digitalocean.monitoring_get_database_mysql_threads_created_rate
Retrieve threads created rate for a MySQL service (per second).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Threads Active Metrics — digitalocean.monitoring_get_database_mysql_threads_active
Retrieve active (running) threads for a MySQL service.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Index vs Sequential Reads Metrics — digitalocean.monitoring_get_database_mysql_index_vs_sequential_reads
Retrieve index vs sequential reads ratio (percent) for a MySQL service — i.e. percentage of reads using an index.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Operations Throughput Metrics — digitalocean.monitoring_get_database_mysql_op_rates
Retrieve operations rate (per second) for a MySQL service. Use metric to choose select, insert, update, or delete.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.metric |
string | Required | Operation type (select, insert, update, or delete). | enum: ["select","insert","update","delete"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"metric": "select",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Schema Throughput Metrics — digitalocean.monitoring_get_database_mysql_schema_throughput
Retrieve table I/O throughput (rows per second) for a schema. Requires schema and metric (insert, fetch, update, delete).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.schema |
string | Required | The schema (database) name. | |
query.metric |
string | Required | Table I/O operation (insert, fetch, update, or delete). | enum: ["insert","fetch","update","delete"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"schema": "defaultdb",
"metric": "insert",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Database MySQL Schema Latency Metrics — digitalocean.monitoring_get_database_mysql_schema_latency
Retrieve table I/O latency (seconds) for a schema. Requires schema and metric (insert, fetch, update, delete).
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.db_id |
string | Required | The DBaaS cluster UUID (database ID). | format: "uuid" |
query.schema |
string | Required | The schema (database) name. | |
query.metric |
string | Required | Table I/O operation (insert, fetch, update, or delete). | enum: ["insert","fetch","update","delete"] |
query.start |
string | Required | UNIX timestamp to start metric window. | |
query.end |
string | Required | UNIX timestamp to end metric window. |
Full JSON Schema
Example input
{
"query": {
"db_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
"schema": "defaultdb",
"metric": "insert",
"start": "1620683817",
"end": "1620705417"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Logging Destination — digitalocean.monitoring_create_destination
To create a new destination, send a POST request to /v2/monitoring/sinks/destinations.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/destination_request" |
Full JSON Schema
Example input
{
"body": {
"config": {
"endpoint": "example.com"
},
"type": "opensearch_dbaas"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Logging Destinations — digitalocean.monitoring_list_destinations
To list all logging destinations, send a GET request to /v2/monitoring/sinks/destinations.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Logging Destination — digitalocean.monitoring_get_destination
To get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.destination_uuid |
string | Required | A unique identifier for a destination. |
Full JSON Schema
Example input
{
"path": {
"destination_uuid": "1a64809f-1708-48ee-a742-dec8d481b8d1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Logging Destination — digitalocean.monitoring_update_destination
To update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.destination_uuid |
string | Required | A unique identifier for a destination. | |
body |
— | Required | $ref: "#/definitions/destination_request" |
Full JSON Schema
Example input
{
"path": {
"destination_uuid": "1a64809f-1708-48ee-a742-dec8d481b8d1"
},
"body": {
"config": {
"endpoint": "example.com"
},
"type": "opensearch_dbaas"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Logging Destination — digitalocean.monitoring_delete_destination
To delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.destination_uuid |
string | Required | A unique identifier for a destination. |
Full JSON Schema
Example input
{
"path": {
"destination_uuid": "1a64809f-1708-48ee-a742-dec8d481b8d1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Sink — digitalocean.monitoring_create_sink
To create a new sink, send a POST request to /v2/monitoring/sinks. Forwards logs from the resources identified in resources to the specified pre-existing destination.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.destination_uuid |
string | Optional | A unique identifier for an already-existing destination. | |
body.resources |
array | Optional | List of resources identified by their URNs. | |
body.resources[] |
— | Optional | $ref: "#/definitions/sink_resource" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Lists all sinks — digitalocean.monitoring_list_sinks
To list all sinks, send a GET request to /v2/monitoring/sinks.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.resource_id |
— | Optional | A unique URN for a resource. | $ref: "#/definitions/urn" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Sink — digitalocean.monitoring_get_sink
To get the details of a sink (resources and destination), send a GET request to /v2/monitoring/sinks/${sink_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.sink_uuid |
string | Required | A unique identifier for a sink. |
Full JSON Schema
Example input
{
"path": {
"sink_uuid": "78b172b6-52c3-4a4b-96d5-78d3f1a0b18c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Sink — digitalocean.monitoring_delete_sink
To delete a sink, send a DELETE request to /v2/monitoring/sinks/${sink_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.sink_uuid |
string | Required | A unique identifier for a sink. |
Full JSON Schema
Example input
{
"path": {
"sink_uuid": "78b172b6-52c3-4a4b-96d5-78d3f1a0b18c"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new NFS share — digitalocean.nfs_create
To create a new NFS share, send a POST request to /v2/nfs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/nfs_request" |
Full JSON Schema
Example input
{
"body": {
"name": "my-nfs-share",
"size_gib": 50,
"region": "atl1",
"vpc_ids": [
"796c6fe3-2a1d-4da2-9f3e-38239827dc91"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List NFS shares per region — digitalocean.nfs_list
To list NFS shares, send a GET request to /v2/nfs?region=${region}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an NFS share — digitalocean.nfs_get
To get an NFS share, send a GET request to /v2/nfs/{nfs_id}?region=${region}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.nfs_id |
string | Required | The unique ID of the NFS share | |
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
Full JSON Schema
Example input
{
"path": {
"nfs_id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an NFS share — digitalocean.nfs_delete
To delete an NFS share, send a DELETE request to /v2/nfs/{nfs_id}?region=${region}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.nfs_id |
string | Required | The unique ID of the NFS share | |
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
Full JSON Schema
Example input
{
"path": {
"nfs_id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate an NFS action — digitalocean.nfs_create_action
To execute an action (such as resize) on a specified NFS share, send a POST request to /v2/nfs/{nfs_id}/actions. In the JSON body to the request, set the type attribute to on of the supported action types:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.nfs_id |
string | Required | The unique ID of the NFS share | |
body |
— | Required | ||
body |
— | Required | anyOf[1]; $ref: "#/definitions/nfs_action_resize" |
|
body |
— | Required | anyOf[2]; $ref: "#/definitions/nfs_action_snapshot" |
|
body |
— | Required | anyOf[3]; $ref: "#/definitions/nfs_action_attach" |
|
body |
— | Required | anyOf[4]; $ref: "#/definitions/nfs_action_detach" |
|
body |
— | Required | anyOf[5]; $ref: "#/definitions/nfs_action_reassign" |
|
body |
— | Required | anyOf[6]; $ref: "#/definitions/nfs_action_switch_performance_tier" |
Full JSON Schema
Example input
{
"path": {
"nfs_id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
},
"body": {
"type": "resize"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List NFS snapshots per region — digitalocean.nfs_list_snapshot
To list all NFS snapshots, send a GET request to /v2/nfs/snapshots?region=${region}&share_id={share_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. | |
query.share_id |
string | Optional | The unique ID of an NFS share. If provided, only snapshots of this specific share will be returned. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an NFS snapshot by ID — digitalocean.nfs_get_snapshot
To get an NFS snapshot, send a GET request to /v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.nfs_snapshot_id |
string | Required | The unique ID of the NFS snapshot | |
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
Full JSON Schema
Example input
{
"path": {
"nfs_snapshot_id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an NFS snapshot — digitalocean.nfs_delete_snapshot
To delete an NFS snapshot, send a DELETE request to /v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.nfs_snapshot_id |
string | Required | The unique ID of the NFS snapshot | |
query |
object | Optional | additionalProperties: false |
|
query.region |
string | Optional | The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. |
Full JSON Schema
Example input
{
"path": {
"nfs_snapshot_id": "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an NFS access point — digitalocean.nfs_create_access_point
To create a new access point on an NFS share, send a POST request to /v2/nfs/shares/{share_id}/access_points.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.share_id |
string | Required | The unique identifier of the NFS share. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/access_point_request" |
Full JSON Schema
Example input
{
"path": {
"share_id": "baf4827c-6fa9-456f-9dbd-9ddfcacd0720"
},
"body": {
"name": "other-vpc",
"path": "/other-vpc",
"access_policy": {
"anonuid": 65534,
"anongid": 65534,
"protocols": [
"NFS4",
"NFS"
],
"squash_config": "ROOT_SQUASH",
"identity_enforcement_enabled": false
},
"vpc_id": "3f34cdb2-1e4f-4100-b5c7-f55f2762085f"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List NFS access points for a share — digitalocean.nfs_list_access_points
To list access points for an NFS share, send a GET request to /v2/nfs/shares/{share_id}/access_points. You may use query parameters to filter by status.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.share_id |
string | Required | The unique identifier of the NFS share. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.status |
string | Optional | Filter access points by status. | enum: ["ACCESS_POINT_CREATING","ACCESS_POINT_ACTIVE","ACCESS_POINT_FAILED","ACCESS_POINT_DELETED"] |
Full JSON Schema
Example input
{
"path": {
"share_id": "baf4827c-6fa9-456f-9dbd-9ddfcacd0720"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get an NFS access point — digitalocean.nfs_get_access_point
To get an NFS access point, send a GET request to /v2/nfs/access_points/{access_point_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_point_id |
string | Required | The unique identifier of the NFS access point. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"access_point_id": "becd9f04-8afa-4ccd-b03e-9676447df603"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an NFS access point — digitalocean.nfs_delete_access_point
To delete an NFS access point, send a DELETE request to /v2/nfs/access_points/{access_point_id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_point_id |
string | Required | The unique identifier of the NFS access point. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"access_point_id": "becd9f04-8afa-4ccd-b03e-9676447df603"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Team in an Organization — digitalocean.organizations_create_team
To create a new team within an organization, send a POST request to /v2/organizations/team.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/create_team_request" |
Full JSON Schema
Example input
{
"body": {
"name": "production"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Teams in an Organization — digitalocean.organizations_list_teams
To list all teams in an organization, send a GET request to /v2/organizations/teams.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List all partner attachments — digitalocean.partnerattachments_list
To list all of the Partner Attachments on your account, send a GET request to /v2/partner_network_connect/attachments.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a new partner attachment — digitalocean.partnerattachments_create
To create a new partner attachment, send a POST request to /v2/partner_network_connect/attachments with a JSON object containing the required configuration details.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/partner_attachment_writable" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an existing partner attachment — digitalocean.partnerattachments_get
To get the details of a partner attachment, send a GET request to /v2/partner_network_connect/attachments/{pa_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an existing partner attachment — digitalocean.partnerattachments_patch
To update an existing partner attachment, send a PATCH request to /v2/partner_network_connect/attachments/{pa_id} with a JSON object containing the fields to be updated.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
body |
— | Optional | $ref: "#/definitions/partner_attachment_updatable" |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an existing partner attachment — digitalocean.partnerattachments_delete
To delete an existing partner attachment, send a DELETE request to /v2/partner_network_connect/attachments/{pa_id}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get current BGP auth key for the partner attachment — digitalocean.partnerattachments_get_bgp_auth_key
To get the current BGP auth key for a partner attachment, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List remote routes for a partner attachment — digitalocean.partnerattachments_list_remote_routes
To list all remote routes associated with a partner attachment, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/remote_routes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get the current service key for the partner attachment — digitalocean.partnerattachments_get_service_key
To get the current service key for a partner attachment, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/service_key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Regenerate the service key for the partner attachment — digitalocean.partnerattachments_create_service_key
This operation generates a new service key for the specified partner attachment. The operation is asynchronous, and the response is an empty JSON object returned with a 202 status code. To poll for the new service key, send a GET request to /v2/partner_network_connect/attachments/{pa_id}/service_key.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.pa_id |
string | Required | A unique identifier for a partner attachment. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"pa_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Projects — digitalocean.projects_list
To list all your projects, send a GET request to /v2/projects.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Project — digitalocean.projects_create
To create a project, send a POST request to /v2/projects.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/project_base" |
Full JSON Schema
Example input
{
"body": {
"name": "my-web-api",
"purpose": "Service or API"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Default Project — digitalocean.projects_get_default
To get your default project, send a GET request to /v2/projects/default.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Patch the Default Project — digitalocean.projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/project" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Project — digitalocean.projects_get
To get a project, send a GET request to /v2/projects/$PROJECT_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_id |
string | Required | A unique identifier for a project. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Patch a Project — digitalocean.projects_patch
To update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT_ID. At least one of the following attributes needs to be sent.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_id |
string | Required | A unique identifier for a project. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/project" |
Full JSON Schema
Example input
{
"path": {
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Existing Project — digitalocean.projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_id |
string | Required | A unique identifier for a project. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Project Resources — digitalocean.projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_id |
string | Required | A unique identifier for a project. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Assign Resources to a Project — digitalocean.projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.project_id |
string | Required | A unique identifier for a project. | minimum: 1; format: "uuid" |
body |
— | Required | $ref: "#/definitions/project_assignment" |
Full JSON Schema
Example input
{
"path": {
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Default Project Resources — digitalocean.projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Assign Resources to Default Project — digitalocean.projects_assign_resources_default
To assign resources to your default project, send a POST request to /v2/projects/default/resources.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/project_assignment" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Data Center Regions — digitalocean.regions_list
To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Container Registries — digitalocean.registries_list
To get information about any container registry in your account, send a GET request to /v2/registries/.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Container Registry — digitalocean.registries_create
To create your container registry, send a POST request to /v2/registries.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/multiregistry_create" |
Full JSON Schema
Example input
{
"body": {
"name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Container Registry By Name — digitalocean.registries_get
To get information about any container registry in your account, send a GET request to /v2/registries/{registry_name}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Container Registry By Name — digitalocean.registries_delete
To delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registries/{registry_name}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Docker Credentials By Registry Name — digitalocean.registries_get_dockercredentials
In order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication. The necessary JSON configuration can be retrieved by sending a GET request to /v2/registries/{registry_name}/docker-credentials.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Subscription Information — digitalocean.registries_get_subscription
A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to /v2/registries/subscription. It is similar to GET /v2/registry/subscription.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Subscription Tier — digitalocean.registries_update_subscription
After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registries/subscription. It is similar to POST /v2/registry/subscription.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Optional | ||
body.tier_slug |
string | Optional | The slug of the subscription tier to sign up for. | enum: ["starter","basic","professional"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Registry Options (Subscription Tiers and Available Regions) — digitalocean.registries_get_options
This endpoint serves to provide additional information as to which option values are available when creating a container registry. There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. There are multiple regions available for container registry and controls where your data is stored. To list the available options, send a GET request to /v2/registries/options. This is similar to GET /v2/registry/options.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Active Garbage Collection — digitalocean.registries_get_garbagecollection
To get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collection.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start Garbage Collection — digitalocean.registries_run_garbagecollection
Garbage collection enables users to clear out unreferenced blobs (layer & manifest data) after deleting one or more manifests from a repository. If there are no unreferenced blobs resulting from the deletion of one or more manifests, garbage collection is effectively a noop. See here for more information about how and why you should clean up your container registry periodically.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Garbage Collections — digitalocean.registries_list_garbagecollections
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Garbage Collection — digitalocean.registries_update_garbagecollection
To cancel the currently-active garbage collection for a registry, send a PUT request to /v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID and specify one or more of the attributes below. It is similar to PUT /v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
path.garbage_collection_uuid |
string | Required | The UUID of a garbage collection run. | |
body |
— | Required | $ref: "#/definitions/update_registry" |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example",
"garbage_collection_uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Container Registry Repositories (V2) — digitalocean.registries_list_repositoriesv2
To list all repositories in your container registry, send a GET request to /v2/registries/$REGISTRY_NAME/repositoriesV2. It is similar to GET /v2/registry/$REGISTRY_NAME/repositoriesV2.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. Ignored when 'page_token' is provided. | default: 1; minimum: 1 |
query.page_token |
string | Optional | Token to retrieve of the next or previous set of results more quickly than using 'page'. | |
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Container Registry Repository — digitalocean.registries_delete_repository
To delete a container repository including all of its tags, send a DELETE request to /v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
path.repository_name |
string | Required | The name of a container registry repository. If the name contains / characters, they must be URL-encoded, e.g. %2F. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example",
"repository_name": "repo-1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Container Registry Repository Tag — digitalocean.registries_delete_repositorytag
To delete a container repository tag in on of our container registries, send a DELETE request to /v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
path.repository_name |
string | Required | The name of a container registry repository. If the name contains / characters, they must be URL-encoded, e.g. %2F. |
|
path.repository_tag |
string | Required | The name of a container registry repository tag. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example",
"repository_name": "repo-1",
"repository_tag": "06a447a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Container Registry Repository Manifests — digitalocean.registries_list_repositorymanifests
To list all manifests in your container registry repository, send a GET request to /v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
path.repository_name |
string | Required | The name of a container registry repository. If the name contains / characters, they must be URL-encoded, e.g. %2F. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example",
"repository_name": "repo-1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Container Registry Repository Manifest — digitalocean.registries_delete_repositorymanifest
To delete a container repository manifest by digest in one of your registries, send a DELETE request to /v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.registry_name |
string | Required | The name of a container registry. | |
path.repository_name |
string | Required | The name of a container registry repository. If the name contains / characters, they must be URL-encoded, e.g. %2F. |
|
path.manifest_digest |
string | Required | The manifest digest of a container registry repository tag. |
Full JSON Schema
Example input
{
"path": {
"registry_name": "example",
"repository_name": "repo-1",
"manifest_digest": "sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Validate a Container Registry Name — digitalocean.registries_validate_name
To validate that a container registry name is available for use, send a POST request to /v2/registries/validate-name.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/validate_registry" |
Full JSON Schema
Example input
{
"body": {
"name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Droplet Neighbors — digitalocean.droplets_list_neighborsids
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Reserved IPs — digitalocean.reservedips_list
To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Reserved IP — digitalocean.reservedips_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/reserved_ip_create" |
Full JSON Schema
Example input
{
"body": {
"droplet_id": 2457247
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Reserved IP — digitalocean.reservedips_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ip |
string | Required | A reserved IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"reserved_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Reserved IP — digitalocean.reservedips_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ips/$RESERVED_IP_ADDR.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ip |
string | Required | A reserved IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"reserved_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Actions for a Reserved IP — digitalocean.reservedipsactions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ip |
string | Required | A reserved IP address. | minimum: 1; format: "ipv4" |
Full JSON Schema
Example input
{
"path": {
"reserved_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a Reserved IP Action — digitalocean.reservedipsactions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ip |
string | Required | A reserved IP address. | minimum: 1; format: "ipv4" |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/reserved_ip_action_unassign" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/reserved_ip_action_assign" |
Full JSON Schema
Example input
{
"path": {
"reserved_ip": "45.55.96.47"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Reserved IP Action — digitalocean.reservedipsactions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ip |
string | Required | A reserved IP address. | minimum: 1; format: "ipv4" |
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"reserved_ip": "45.55.96.47",
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Reserved IPv6s — digitalocean.reservedipv6_list
To list all of the reserved IPv6s available on your account, send a GET request to /v2/reserved_ipv6.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Reserved IPv6 — digitalocean.reservedipv6_create
On creation, a reserved IPv6 must be reserved to a region. To create a new reserved IPv6 reserved to a region, send a POST request to /v2/reserved_ipv6 with the region_slug attribute.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/reserved_ipv6_create" |
Full JSON Schema
Example input
{
"body": {
"region_slug": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Reserved IPv6 — digitalocean.reservedipv6_get
To show information about a reserved IPv6, send a GET request to /v2/reserved_ipv6/$RESERVED_IPV6.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ipv6 |
string | Required | A reserved IPv6 address. | minimum: 1; format: "ipv6" |
Full JSON Schema
Example input
{
"path": {
"reserved_ipv6": "2409:40d0:f7:1017:74b4:3a96:105e:4c6e"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Reserved IPv6 — digitalocean.reservedipv6_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ipv6/$RESERVED_IPV6.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ipv6 |
string | Required | A reserved IPv6 address. | minimum: 1; format: "ipv6" |
Full JSON Schema
Example input
{
"path": {
"reserved_ipv6": "2409:40d0:f7:1017:74b4:3a96:105e:4c6e"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate a Reserved IPv6 Action — digitalocean.reservedipv6actions_post
To initiate an action on a reserved IPv6 send a POST request to /v2/reserved_ipv6/$RESERVED_IPV6/actions. In the JSON body to the request, set the type attribute to on of the supported action types:
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.reserved_ipv6 |
string | Required | A reserved IPv6 address. | minimum: 1; format: "ipv6" |
body |
— | Optional | ||
body |
— | Optional | anyOf[1]; $ref: "#/definitions/reserved_ipv6_action_unassign" |
|
body |
— | Optional | anyOf[2]; $ref: "#/definitions/reserved_ipv6_action_assign" |
Full JSON Schema
Example input
{
"path": {
"reserved_ipv6": "2409:40d0:f7:1017:74b4:3a96:105e:4c6e"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a BYOIP Prefix — digitalocean.byoipprefixes_create
To create a BYOIP prefix, send a POST request to /v2/byoip_prefixes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/byoip_prefix_create" |
Full JSON Schema
Example input
{
"body": {
"prefix": "203.11.13.0/24",
"region": "nyc3",
"signature": "<sample-signature>"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List BYOIP Prefixes — digitalocean.byoipprefixes_list
To list all BYOIP prefixes, send a GET request to /v2/byoip_prefixes. A successful response will return a list of all BYOIP prefixes associated with the account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a BYOIP Prefix — digitalocean.byoipprefixes_get
To get a BYOIP prefix, send a GET request to /v2/byoip_prefixes/$byoip_prefix_uuid.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.byoip_prefix_uuid |
string | Required | The unique identifier for the BYOIP Prefix. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"byoip_prefix_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a BYOIP Prefix — digitalocean.byoipprefixes_delete
To delete a BYOIP prefix and remove it from your account, send a DELETE request to /v2/byoip_prefixes/$byoip_prefix_uuid.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.byoip_prefix_uuid |
string | Required | The unique identifier for the BYOIP Prefix. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"byoip_prefix_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a BYOIP Prefix — digitalocean.byoipprefixes_patch
To update a BYOIP prefix, send a PATCH request to /v2/byoip_prefixes/$byoip_prefix_uuid.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.byoip_prefix_uuid |
string | Required | A unique identifier for a BYOIP prefix. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/byoip_prefix_update" |
Full JSON Schema
Example input
{
"path": {
"byoip_prefix_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List BYOIP Prefix Resources — digitalocean.byoipprefixes_list_resources
To list resources associated with BYOIP prefixes, send a GET request to /v2/byoip_prefixes/{byoip_prefix_uuid}/ips.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.byoip_prefix_uuid |
string | Required | The unique identifier for the BYOIP Prefix. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"byoip_prefix_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Scans — digitalocean.security_list_scans
To list all CSPM scans, send a GET request to /v2/security/scans.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Scan — digitalocean.security_create_scan
To create a CSPM scan, send a POST request to /v2/security/scans.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Scan — digitalocean.security_get_scan
To get a CSPM scan by ID, send a GET request to /v2/security/scans/{scan_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scan_id |
string | Required | The scan UUID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.severity |
string | Optional | The finding severity level to include. | enum: ["LOW","MEDIUM","HIGH","CRITICAL"] |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.type |
string | Optional | The finding type to include. |
Full JSON Schema
Example input
{
"path": {
"scan_id": "497dcba3-ecbf-4587-a2dd-5eb0665e6880"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Latest Scan — digitalocean.security_get_latest_scan
To get the latest CSPM scan, send a GET request to /v2/security/scans/latest.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.severity |
string | Optional | The finding severity level to include. | enum: ["LOW","MEDIUM","HIGH","CRITICAL"] |
query.type |
string | Optional | The finding type to include. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Scan Rule — digitalocean.security_create_scan_rule
To mark a scan finding as a false positive, send a POST request to /v2/security/scans/rules to create a new scan rule.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.resource |
string | Optional | The URN of a resource to exclude from future scans. |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Finding Affected Resources — digitalocean.security_list_scan_finding_affected_resources
To get affected resources for a scan finding, send a GET request to /v2/security/scans/{scan_id}/findings/{finding_uuid}/affected_resources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scan_id |
string | Required | The scan UUID. | format: "uuid" |
path.finding_uuid |
string | Required | The finding UUID. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"scan_id": "497dcba3-ecbf-4587-a2dd-5eb0665e6880",
"finding_uuid": "50e14f43-dd4e-412f-864d-78943ea28d91"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Settings — digitalocean.security_list_settings
To list CSPM scan settings, send a GET request to /v2/security/settings.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Plan — digitalocean.security_update_settings_plan
To update CSPM plan coverage, send a PUT request to /v2/security/settings/plan.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.tier_coverage |
object | Optional | Scan coverage for each available plan tier. | additionalProperties: {"type":"object","properties":{"resources":{"type":"array","items":{"type":"string"},"description":"The URNs of resources to scan for the tier.","default":[],"examples":[["do:droplet:fe3a2fd7-903d-46e6-ada3-3e4f285fb89d"]]},"tags":{"type":"array","items":{"type":"string"},"description":"Resource tags to scan for the tier.","default":[],"examples":[["production"]]}}} |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Suppression — digitalocean.security_create_suppression
To suppress scan findings, send a POST request to /v2/security/settings/suppressions.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.rule_uuid |
string | Optional | The rule UUID to suppress for the listed resources. | |
body.resources |
array | Optional | The URNs of resources to suppress for the rule. | |
body.resources[] |
string | Optional |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Suppression — digitalocean.security_delete_suppression
To remove a suppression, send a DELETE request to /v2/security/settings/suppressions/{suppression_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.suppression_uuid |
string | Required | The suppression UUID to remove. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"suppression_uuid": "5b3b2b2d-5c9c-4a61-9e2f-4d8f80f30a12"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Secrets — digitalocean.security_list_secrets
To list secrets across all configured regions, send a GET request to /v2/security/secrets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.include_deleted |
boolean | Optional | Whether to include secrets that are pending deletion. | default: false |
query.name |
string | Optional | Only return secrets whose names start with this value. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Secret — digitalocean.security_create_secret
To create a secret, send a POST request to /v2/security/secrets.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body.name |
string | Required | The name of the secret to create. | |
body.region |
string | Required | The region where the secret will be stored. | |
body.values |
object | Required | Key-value pairs to store in the secret. | additionalProperties: {"type":"string"} |
Full JSON Schema
Example input
{
"body": {
"name": "my-database-password",
"region": "nyc3",
"values": {
"password": "s3cr3t"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Secret — digitalocean.security_get_secret
To retrieve a secret and its values, send a GET request to /v2/security/secrets/{secret}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
query |
object | Required | additionalProperties: false |
|
query.region |
string | Required | The region where the secret is stored. |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password"
},
"query": {
"region": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Secret — digitalocean.security_update_secret
To update a secret, send a PUT request to /v2/security/secrets/{secret}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
body |
object | Required | ||
body.region |
string | Required | The region where the secret is stored. | |
body.version |
integer | Required | The current version of the secret to update. | |
body.values |
object | Required | Updated key-value pairs for the secret. | additionalProperties: {"type":"string"} |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password"
},
"body": {
"region": "nyc3",
"version": 1,
"values": {
"password": "n3w-s3cr3t"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Secret — digitalocean.security_delete_secret
To schedule a secret for deletion, send a DELETE request to /v2/security/secrets/{secret}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
query |
object | Required | additionalProperties: false |
|
query.region |
string | Required | The region where the secret is stored. |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password"
},
"query": {
"region": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Secret Versions — digitalocean.security_list_secret_versions
To list all versions of a secret, send a GET request to /v2/security/secrets/{secret}/versions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
query |
object | Required | additionalProperties: false |
|
query.region |
string | Required | The region where the secret is stored. |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password"
},
"query": {
"region": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Revert Secret — digitalocean.security_revert_secret
To revert a secret to a prior version, send a POST request to /v2/security/secrets/{secret}/versions/{version}/revert.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
path.version |
integer | Required | The target version to revert to. Reverting creates a new version with the contents of this version. | minimum: 1 |
query |
object | Required | additionalProperties: false |
|
query.region |
string | Required | The region where the secret is stored. | |
body |
object | Required | ||
body.current_version |
integer | Required | The current version of the secret. Used to reject the request if the secret changed. | minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password",
"version": 1
},
"query": {
"region": "nyc3"
},
"body": {
"current_version": 3
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restore Secret — digitalocean.security_post_restore_secret
To restore a secret that is pending deletion, send a POST request to /v2/security/secrets/{secret}/restore.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.secret |
string | Required | The name of the secret. | |
query |
object | Required | additionalProperties: false |
|
query.region |
string | Required | The region where the secret is stored. |
Full JSON Schema
Example input
{
"path": {
"secret": "my-database-password"
},
"query": {
"region": "nyc3"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Droplet Sizes — digitalocean.sizes_list
To list all of available Droplet sizes, send a GET request to /v2/sizes. The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard size attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.cpu_minimum |
integer | Optional | Filter sizes with an inclusive minimum CPU count | minimum: 1 |
query.cpu_maximum |
integer | Optional | Filter sizes with an inclusive maximum CPU count | minimum: 1 |
query.gpu_minimum |
integer | Optional | Filter sizes with an inclusive minimum GPU count | minimum: 1 |
query.gpu_maximum |
integer | Optional | Filter sizes with an inclusive maximum GPU count. Zero is allowed to filter to sizes without GPUs. | minimum: 0 |
query.gpu_fabric |
boolean | Optional | Filter sizes to those with a given GPU fabric setting | |
query.memory_minimum |
integer | Optional | Filter sizes with an inclusive minimum memory amount (in megabytes) | minimum: 8; multipleOf: 8 |
query.memory_maximum |
integer | Optional | Filter sizes with an inclusive maximum memory amount (in megabytes) | minimum: 8; multipleOf: 8 |
query.price_hourly_minimum |
string | Optional | Filter sizes with an inclusive minimum hourly price (in USD) | |
query.price_hourly_maximum |
string | Optional | Filter sizes with an inclusive maximum hourly price (in USD) | |
query.price_monthly_minimum |
string | Optional | Filter sizes with an inclusive minimum monthly price (in USD) | |
query.price_monthly_maximum |
string | Optional | Filter sizes with an inclusive maximum monthly price (in USD) |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Snapshots — digitalocean.snapshots_list
To list all of the snapshots available on your account, send a GET request to /v2/snapshots.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.resource_type |
string | Optional | Used to filter snapshots by a resource type. | enum: ["droplet","volume"] |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Snapshot — digitalocean.snapshots_get
To retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.snapshot_id |
— | Required | Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. | |
path.snapshot_id |
integer | Required | The ID of a Droplet snapshot. | anyOf[1] |
path.snapshot_id |
string | Required | The ID of a volume snapshot. | anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"snapshot_id": 6372321
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Snapshot — digitalocean.snapshots_delete
Both Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint. To delete a snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.snapshot_id |
— | Required | Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. | |
path.snapshot_id |
integer | Required | The ID of a Droplet snapshot. | anyOf[1] |
path.snapshot_id |
string | Required | The ID of a volume snapshot. | anyOf[2] |
Full JSON Schema
Example input
{
"path": {
"snapshot_id": 6372321
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Spaces Access Keys — digitalocean.spaceskey_list
To list Spaces Access Key, send a GET request to /v2/spaces/keys. Sort parameter must be used with Sort Direction.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.sort |
string | Optional | The field to sort by. | default: "created_at" |
query.sort_direction |
string | Optional | The direction to sort by. Possible values are asc or desc. |
default: "desc" |
query.name |
string | Optional | The access key's name. | |
query.bucket |
string | Optional | The bucket's name. | |
query.permission |
string | Optional | The permission of the access key. Possible values are read, readwrite, fullaccess, or an empty string. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Spaces Access Key — digitalocean.spaceskey_create
To create a new Spaces Access Key, send a POST request to /v2/spaces/keys. At the moment, you cannot mix a fullaccess permission with scoped permissions. A fullaccess permission will be prioritized if fullaccess and scoped permissions are both added.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | $ref: "#/definitions/key" |
Full JSON Schema
Example input
{
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get a Spaces Access Key — digitalocean.spaceskey_get
To get a Spaces Access Key, send a GET request to /v2/spaces/keys/$ACCESS_KEY.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_key |
string | Required | The access key's ID. |
Full JSON Schema
Example input
{
"path": {
"access_key": "DOACCESSKEYEXAMPLE"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Spaces Access Key — digitalocean.spaceskey_delete
To delete a Spaces Access Key, send a DELETE request to /v2/spaces/keys/$ACCESS_KEY.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_key |
string | Required | The access key's ID. |
Full JSON Schema
Example input
{
"path": {
"access_key": "DOACCESSKEYEXAMPLE"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Spaces Access Keys — digitalocean.spaceskey_update
To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert a fullaccess key to a scoped key or vice versa. You can only update the name of the key.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_key |
string | Required | The access key's ID. | |
body |
— | Required | $ref: "#/definitions/key" |
Full JSON Schema
Example input
{
"path": {
"access_key": "DOACCESSKEYEXAMPLE"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Spaces Access Keys — digitalocean.spaceskey_patch
To update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS_KEY. At the moment, you cannot convert a fullaccess key to a scoped key or vice versa. You can only update the name of the key.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.access_key |
string | Required | The access key's ID. | |
body |
— | Required | $ref: "#/definitions/key" |
Full JSON Schema
Example input
{
"path": {
"access_key": "DOACCESSKEYEXAMPLE"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Vector Databases — digitalocean.vectordatabases_list
To list all of the vector databases on your account, send a GET request to /v2/vector-databases. Use the page and per_page query parameters to paginate the results. The response body contains a vector_dbs array of vector database objects and a total field with the overall count.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | ||
query.per_page |
integer | Optional |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Vector Database — digitalocean.vectordatabases_create
To create a vector database, send a POST request to /v2/vector-databases. The response body contains a JSON object with a vector_db key holding the newly created database. Its initial status is creating and changes to active once the database is ready to receive traffic.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/vectordbCreateVectorDBRequest" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Vector Database — digitalocean.vectordatabases_get
To show information about an existing vector database, send a GET request to /v2/vector-databases/{id}. The response body contains a JSON object with a vector_db key holding the standard vector database attributes, including an embedded endpoints object with the connection information needed to access the database.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the vector database. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Vector Database — digitalocean.vectordatabases_update
To update an existing vector database, send a PUT request to /v2/vector-databases/{id}. The response body contains a JSON object with a vector_db key holding the updated vector database.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the vector database. | |
body |
— | Optional | $ref: "#/definitions/vectordbUpdateVectorDBRequest" |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Vector Database — digitalocean.vectordatabases_delete
To delete a vector database, send a DELETE request to /v2/vector-databases/{id}. Deleting a vector database is irreversible and destroys the underlying instance along with its data.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the vector database. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Backups for a Vector Database — digitalocean.vectordatabases_list_backups
To list the available backups for a vector database, send a GET request to /v2/vector-databases/{id}/backups. Only backups with a status of SUCCESS are returned.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Required. ID of the vector database. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve the Status of a Restore — digitalocean.vectordatabases_get_restore_status
To check the status of a restore operation, send a GET request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The response body contains the current status of the restore.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Required. ID of the vector database. | |
path.backup_id |
string | Required | Required. ID of the backup being restored. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\"",
"backup_id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Restore a Vector Database from a Backup — digitalocean.vectordatabases_post_restore_backup
To restore a vector database from a backup, send a POST request to /v2/vector-databases/{id}/backups/{backup_id}/restore. The restore runs asynchronously; use the restore-status endpoint to monitor its progress.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Required. ID of the vector database. | |
path.backup_id |
string | Required | Required. ID of the backup to restore from. | |
body |
— | Optional | $ref: "#/definitions/vectordbRestoreBackupRequest" |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\"",
"backup_id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Admin Credentials for a Vector Database — digitalocean.vectordatabases_get_credentials
To retrieve the admin credentials for a vector database, send a GET request to /v2/vector-databases/{id}/credentials. The response body contains the user_id and api_token for the admin user provisioned on the cluster.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the vector database. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Resize a Vector Database — digitalocean.vectordatabases_post_resize
To resize a vector database, send a POST request to /v2/vector-databases/{id}/resize. This changes the database's resource tier. The response body contains a JSON object with the updated vector database.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Required. ID of the vector database to resize. | |
body |
— | Optional | $ref: "#/definitions/vectordbResizeVectorDBRequest" |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Block Storage Volumes — digitalocean.volumes_list
To list all of the block storage volumes available on your account, send a GET request to /v2/volumes. ## Filtering Results ### By Region The region may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: /v2/volumes?region=nyc1 ### By Name It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to /v2/volumes?name=$VOLUME_NAME. Note: You can only create one volume per region with the same name. ### By Name and Region It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME®ion=nyc1.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | The block storage volume's name. | |
query.region |
— | Optional | The slug identifier for the region where the resource is available. | $ref: "#/definitions/region_slug" |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Block Storage Volume — digitalocean.volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. 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 Droplets without support for auto-mounting is not recommended.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Required | ||
body |
— | Required | anyOf[1]; $ref: "#/definitions/volumes_ext4" |
|
body |
— | Required | anyOf[2]; $ref: "#/definitions/volumes_xfs" |
Full JSON Schema
Example input
{
"body": {
"size_gigabytes": 10,
"name": "ext4-example",
"description": "Block store for examples",
"region": "nyc1",
"filesystem_type": "ext4",
"filesystem_label": "ext4_volume_01"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Block Storage Volume by Name — digitalocean.volumes_delete_byname
Block storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME®ion=nyc1. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.name |
string | Optional | The block storage volume's name. | |
query.region |
— | Optional | The slug identifier for the region where the resource is available. | $ref: "#/definitions/region_slug" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate A Block Storage Action By Volume Name — digitalocean.volumeactions_post
To initiate an action on a block storage volume by Name, send a POST request to ~/v2/volumes/actions. The body should contain the appropriate attributes for the respective action.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
body |
— | Required | ||
body |
— | Required | anyOf[1]; $ref: "#/definitions/volume_action_post_attach" |
|
body |
— | Required | anyOf[2]; $ref: "#/definitions/volume_action_post_detach" |
Full JSON Schema
Example input
{
"body": {
"type": "attach",
"volume_name": "example",
"droplet_id": 11612190,
"region": "nyc1",
"tags": [
"aninterestingtag"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Volume Snapshot — digitalocean.volumesnapshots_get_byid
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.snapshot_id |
string | Required | The unique identifier for the snapshot. |
Full JSON Schema
Example input
{
"path": {
"snapshot_id": "fbe805e8-866b-11e6-96bf-000f53315a41"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Volume Snapshot — digitalocean.volumesnapshots_delete_byid
To delete a volume snapshot, send a DELETE request to /v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.snapshot_id |
string | Required | The unique identifier for the snapshot. |
Full JSON Schema
Example input
{
"path": {
"snapshot_id": "fbe805e8-866b-11e6-96bf-000f53315a41"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Block Storage Volume — digitalocean.volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Block Storage Volume — digitalocean.volumes_delete
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Actions for a Volume — digitalocean.volumeactions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Initiate A Block Storage Action By Volume Id — digitalocean.volumeactions_post_byid
To initiate an action on a block storage volume by Id, send a POST request to ~/v2/volumes/$VOLUME_ID/actions. The body should contain the appropriate attributes for the respective action.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
body |
— | Required | ||
body |
— | Required | anyOf[1]; $ref: "#/definitions/volume_action_post_attach" |
|
body |
— | Required | anyOf[2]; $ref: "#/definitions/volume_action_post_detach" |
|
body |
— | Required | anyOf[3]; $ref: "#/definitions/volume_action_post_resize" |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
},
"body": {
"type": "attach",
"droplet_id": 11612190,
"region": "nyc1",
"tags": [
"aninterestingtag"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Volume Action — digitalocean.volumeactions_get
To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
path.action_id |
integer | Required | A unique numeric ID that can be used to identify and reference an action. | minimum: 1 |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51",
"action_id": 36804636
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Snapshots for a Volume — digitalocean.volumesnapshots_list
To retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME_ID/snapshots.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Snapshot from a Volume — digitalocean.volumesnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.volume_id |
string | Required | The ID of the block storage volume. | format: "uuid" |
body |
object | Required | ||
body.name |
string | Required | A human-readable name for the volume snapshot. | |
body.tags |
— | Optional | $ref: "#/definitions/tags_array" |
Full JSON Schema
Example input
{
"path": {
"volume_id": "7724db7c-e098-11e5-b522-000f53304e51"
},
"body": {
"name": "big-data-snapshot1475261774"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All VPCs — digitalocean.vpcs_list
To list all of the VPCs on your account, send a GET request to /v2/vpcs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New VPC — digitalocean.vpcs_create
To create a VPC, send a POST request to /v2/vpcs specifying the attributes in the table below in the JSON body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_updatable" |
|
body |
— | Required | allOf[2]; $ref: "#/definitions/vpc_create" |
Full JSON Schema
Example input
{
"body": {
"name": "example",
"region": "nyc1"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing VPC — digitalocean.vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a VPC — digitalocean.vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_updatable" |
|
body |
— | Required | allOf[2]; $ref: "#/definitions/vpc_default" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"name": "example"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Partially Update a VPC — digitalocean.vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
body |
— | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_updatable" |
|
body |
— | Required | allOf[2]; $ref: "#/definitions/vpc_default" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a VPC — digitalocean.vpcs_delete
To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 status code with no body will be returned in response to a successful request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List the Member Resources of a VPC — digitalocean.vpcs_list_members
To list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC_ID/members.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.resource_type |
string | Optional | Used to filter VPC members by a resource type. | enum: ["droplet","loadbalancer","kubernetes","dbaas","nat_gateway","app","nfs_share"] |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List the Peerings of a VPC — digitalocean.vpcs_list_peerings
To list all of a VPC's peerings, send a GET request to /v2/vpcs/$VPC_ID/peerings.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Peering with a VPC — digitalocean.vpcs_create_peerings
To create a new VPC peering for a given VPC, send a POST request to /v2/vpcs/$VPC_ID/peerings.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
body |
object | Required | ||
body.name |
string | Required | The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods. | pattern: "^[a-zA-Z0-9\\-\\.]+$" |
body.vpc_id |
string | Required | The ID of the VPC to peer with. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"name": "nyc1-blr1-peering",
"vpc_id": "c140286f-e6ce-4131-8b7b-df4590ce8d6a"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a VPC Peering — digitalocean.vpcs_patch_peerings
To update the name of a VPC peering in a particular VPC, send a PATCH request to /v2/vpcs/$VPC_ID/peerings/$VPC_PEERING_ID with the new name in the request body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_id |
string | Required | A unique identifier for a VPC. | minimum: 1; format: "uuid" |
path.vpc_peering_id |
string | Required | A unique identifier for a VPC peering. | format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_peering_updatable" |
Full JSON Schema
Example input
{
"path": {
"vpc_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"vpc_peering_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4"
},
"body": {
"name": "nyc1-blr1-peering"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List VPC Routes — digitalocean.vpcroutes_list
To list the read-only VPC-scoped routes for a VPC, send a GET request to /v2/vpcs/$VPC_UUID/routes. VPC-scoped routes cannot be created, updated, or deleted through the public API.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List VPC Subnets — digitalocean.vpcsubnets_list
To list all subnets within a VPC, send a GET request to /v2/vpcs/$VPC_UUID/subnets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a VPC Subnet — digitalocean.vpcsubnets_create
To create a subnet within a VPC, send a POST request to /v2/vpcs/$VPC_UUID/subnets with a name and, optionally, an IP range.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/vpc_subnet_create" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d"
},
"body": {
"name": "new-subnet"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve a VPC Subnet — digitalocean.vpcsubnets_get
To retrieve a specific subnet within a VPC, send a GET request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of a VPC subnet. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a VPC Subnet — digitalocean.vpcsubnets_update
To update the name of a specific subnet within a VPC, send a PATCH request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of a VPC subnet. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/vpc_subnet_update" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"name": "renamed-subnet"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a VPC Subnet — digitalocean.vpcsubnets_delete
To delete a specific subnet from a VPC, send a DELETE request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID. A successful request returns a 204 status code with no response body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of a VPC subnet. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List the Member Resources of a VPC Subnet — digitalocean.vpcsubnets_list_members
To list all resources that are members of a VPC subnet, send a GET request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID/members.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC to which the subnet belongs. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of a VPC subnet. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.resource_type |
string | Optional | Used to filter VPC subnet members by resource type. | enum: ["droplet","loadbalancer","kubernetes","dbaas","nat_gateway","app","nfs_share"] |
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List VPC Subnet Routes — digitalocean.vpcsubnetroutes_list
To list routes for a VPC subnet, send a GET request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID/routes. The response includes VPC-scoped routes propagated into the subnet and subnet-scoped routes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of the VPC subnet. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a VPC Subnet Route — digitalocean.vpcsubnetroutes_create
To add a static route to a VPC subnet, send a POST request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID/routes. This route is additional to the routes the VPC already propagates to the subnet. The server assigns the route's id and type.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of the VPC subnet. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/route_create" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"destination_cidr": "0.0.0.0/0",
"target_urns": [
"do:droplet:4126873"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a VPC Subnet Route — digitalocean.vpcsubnetroutes_update
To update the next hop for a user-defined VPC subnet route, send a PATCH request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID/routes/$ROUTE_UUID. The destination_cidr cannot be changed.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of the VPC subnet. | format: "uuid" |
path.route_uuid |
string | Required | The unique identifier of the route. | format: "uuid" |
body |
— | Required | $ref: "#/definitions/route_update" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"route_uuid": "f0e1d2c3-b4a5-6789-0fed-cba987654321"
},
"body": {
"target_urns": [
"do:droplet:4126873"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a VPC Subnet Route — digitalocean.vpcsubnetroutes_delete
To delete a user-defined VPC subnet route, send a DELETE request to /v2/vpcs/$VPC_UUID/subnets/$SUBNET_UUID/routes/$ROUTE_UUID. Managed routes cannot be deleted. A successful request returns a 204 status code with no response body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_uuid |
string | Required | The unique identifier of the VPC. | format: "uuid" |
path.subnet_uuid |
string | Required | The unique identifier of the VPC subnet. | format: "uuid" |
path.route_uuid |
string | Required | The unique identifier of the route. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_uuid": "997615ce-132d-4bae-9270-9ee21b395e5d",
"subnet_uuid": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"route_uuid": "f0e1d2c3-b4a5-6789-0fed-cba987654321"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All VPC Peerings — digitalocean.vpcpeerings_list
To list all of the VPC peerings on your account, send a GET request to /v2/vpc_peerings.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.region |
— | Optional | The slug identifier for the region where the resource is available. | $ref: "#/definitions/region_slug" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New VPC Peering — digitalocean.vpcpeerings_create
To create a new VPC Peering, send a POST request to /v2/vpc_peerings specifying a name and a list of two VPC IDs to peer. The response code, 202 Accepted, does not indicate the success or failure of the operation, just that the request has been accepted for processing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_peering_updatable" |
|
body |
— | Required | allOf[2]; $ref: "#/definitions/vpc_peering_create" |
Full JSON Schema
Example input
{
"body": {
"name": "example",
"vpc_ids": [
"c140286f-e6ce-4131-8b7b-df4590ce8d6a",
"994a2735-dc84-11e8-80bc-3cfdfea9fba1"
]
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing VPC Peering — digitalocean.vpcpeerings_get
To show information about an existing VPC Peering, send a GET request to /v2/vpc_peerings/$VPC_PEERING_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_peering_id |
string | Required | A unique identifier for a VPC peering. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_peering_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a VPC peering — digitalocean.vpcpeerings_patch
To update the name of a VPC peering, send a PATCH request to /v2/vpc_peerings/$VPC_PEERING_ID with the new name in the request body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_peering_id |
string | Required | A unique identifier for a VPC peering. | format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/vpc_peering_updatable" |
Full JSON Schema
Example input
{
"path": {
"vpc_peering_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4"
},
"body": {
"name": "nyc1-blr1-peering"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a VPC peering — digitalocean.vpcpeerings_delete
To delete a VPC peering, send a DELETE request to /v2/vpc_peerings/$VPC_PEERING_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.vpc_peering_id |
string | Required | A unique identifier for a VPC peering. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"vpc_peering_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All VPC NAT Gateways — digitalocean.vpcnatgateways_list
To list all VPC NAT gateways in your team, send a GET request to /v2/vpc_nat_gateways. The response body will be a JSON object with a key of vpc_nat_gateways containing an array of VPC NAT gateway objects. These each contain the standard VPC NAT gateway attributes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
query.state |
string | Optional | The current state of the VPC NAT gateway. | enum: ["new","provisioning","active","deleting","error","invalid"] |
query.region |
string | Optional | The region where the VPC NAT gateway is located. | enum: ["nyc1","nyc2","nyc3","ams2","ams3","sfo1","sfo2","sfo3","sgp1","lon1","fra1","tor1","blr1","syd1","atl1"] |
query.type |
string | Optional | The type of the VPC NAT gateway. | enum: ["public"] |
query.name |
string | Optional | The name of the VPC NAT gateway. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New VPC NAT Gateway — digitalocean.vpcnatgateways_create
To create a new VPC NAT gateway, send a POST request to /v2/vpc_nat_gateways setting the required attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/vpc_nat_gateway_create" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing VPC NAT Gateway — digitalocean.vpcnatgateways_get
To show information about an individual VPC NAT gateway, send a GET request to /v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the VPC NAT gateway. |
Full JSON Schema
Example input
{
"path": {
"id": "70e1b58d-cdec-4e95-b3ee-2d4d95feff51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update VPC NAT Gateway — digitalocean.vpcnatgateways_update
To update the configuration of an existing VPC NAT Gateway, send a PUT request to /v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID. The request must contain a full representation of the VPC NAT Gateway including existing attributes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the VPC NAT gateway. | |
body |
— | Optional | $ref: "#/definitions/vpc_nat_gateway_update" |
Full JSON Schema
Example input
{
"path": {
"id": "70e1b58d-cdec-4e95-b3ee-2d4d95feff51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete VPC NAT Gateway — digitalocean.vpcnatgateways_delete
To destroy a VPC NAT Gateway, send a DELETE request to the /v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID endpoint.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the VPC NAT gateway. |
Full JSON Schema
Example input
{
"path": {
"id": "70e1b58d-cdec-4e95-b3ee-2d4d95feff51"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Checks — digitalocean.uptime_list_checks
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Check — digitalocean.uptime_create_check
To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/check_updatable" |
Full JSON Schema
Example input
{
"body": {
"name": "Landing page check",
"method": "example",
"target": "https://www.landingpage.com",
"regions": [
"us_east",
"eu_west"
],
"type": "https",
"enabled": true
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Check — digitalocean.uptime_get_check
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Check — digitalocean.uptime_update_check
To update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/check_updatable" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Check — digitalocean.uptime_delete_check
To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 status code with no body will be returned in response to a successful request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Check State — digitalocean.uptime_get_checkstate
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List All Alerts — digitalocean.uptime_list_alerts
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
query |
object | Optional | additionalProperties: false |
|
query.per_page |
integer | Optional | Number of items returned per page | default: 20; minimum: 1; maximum: 200 |
query.page |
integer | Optional | Which 'page' of paginated results to return. | default: 1; minimum: 1 |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a New Alert — digitalocean.uptime_create_alert
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/alert" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6"
},
"body": {
"name": "Landing page degraded performance",
"type": "latency",
"notifications": {
"slack": [],
"email": [
"[email protected]"
]
},
"period": "2m"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Alert — digitalocean.uptime_get_alert
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
path.alert_id |
string | Required | A unique identifier for an alert. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"alert_id": "17f0f0ae-b7e5-4ef6-86e3-aa569db58284"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Alert — digitalocean.uptime_update_alert
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
path.alert_id |
string | Required | A unique identifier for an alert. | format: "uuid" |
body |
object | Required | ||
body |
— | Required | allOf[1]; $ref: "#/definitions/alert_updatable" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"alert_id": "17f0f0ae-b7e5-4ef6-86e3-aa569db58284"
},
"body": {
"name": "Landing page degraded performance",
"type": "latency",
"notifications": {
"slack": [],
"email": [
"[email protected]"
]
},
"period": "2m"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Alert — digitalocean.uptime_delete_alert
To delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID. A 204 status code with no body will be returned in response to a successful request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.check_id |
string | Required | A unique identifier for a check. | format: "uuid" |
path.alert_id |
string | Required | A unique identifier for an alert. | format: "uuid" |
Full JSON Schema
Example input
{
"path": {
"check_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"alert_id": "17f0f0ae-b7e5-4ef6-86e3-aa569db58284"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Agents — digitalocean.genai_list_agents
To list all agents, send a GET request to /v2/gen-ai/agents.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.only_deployed |
boolean | Optional | Only list agents that are deployed. | |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an Agent — digitalocean.genai_create_agent
To create a new agent, send a POST request to /v2/gen-ai/agents. The response body contains a JSON object with the newly created agent object.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateAgentInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Agent API Keys — digitalocean.genai_list_agent_api_keys
To list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create an Agent API Key — digitalocean.genai_create_agent_api_key
To create an agent API key, send a POST request to /v2/gen-ai/agents/{agent_uuid}/api_keys.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
body |
— | Optional | $ref: "#/definitions/apiCreateAgentAPIKeyInputPublic" |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update API Key for an Agent — digitalocean.genai_update_agent_api_key
To update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
path.api_key_uuid |
string | Required | API key ID | |
body |
— | Optional | $ref: "#/definitions/apiUpdateAgentAPIKeyInputPublic" |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete API Key for an Agent — digitalocean.genai_delete_agent_api_key
To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | A unique identifier for your agent. | |
path.api_key_uuid |
string | Required | API key for an agent. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Regenerate API Key for an Agent — digitalocean.genai_regenerate_agent_api_key
To regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Function Route to an Agent — digitalocean.genai_attach_agent_function
To create a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/functions.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
body |
— | Optional | $ref: "#/definitions/apiLinkAgentFunctionInputPublic" |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Function Route for an Agent — digitalocean.genai_update_agent_function
To update the function route, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
path.function_uuid |
string | Required | Function id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateAgentFunctionInputPublic" |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"function_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Function Route for an Agent — digitalocean.genai_detach_agent_function
To delete a function route from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | The id of the agent the function route belongs to. | |
path.function_uuid |
string | Required | The function route to be destroyed. This does not destroy the function itself. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"function_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attach Guardrails to an Agent — digitalocean.genai_attach_agent_guardrails
To attach guardrails to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/guardrails.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | The UUID of the agent. | |
body |
— | Optional | $ref: "#/definitions/apiLinkAgentGuardrailsInputPublic" |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Detach a Guardrail from an Agent — digitalocean.genai_detach_agent_guardrail
To detach a guardrail from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | The UUID of the agent. | |
path.guardrail_uuid |
string | Required | The UUID of the guardrail to detach. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"guardrail_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attach Knowledge Bases to an Agent — digitalocean.genai_attach_knowledge_bases
To attach knowledge bases to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | A unique identifier for an agent. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Attach Knowledge Base to an Agent — digitalocean.genai_attach_knowledge_base
To attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | A unique identifier for an agent. | |
path.knowledge_base_uuid |
string | Required | A unique identifier for a knowledge base. |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Detach Knowledge Base from an Agent — digitalocean.genai_detach_knowledge_base
To detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.agent_uuid |
string | Required | Agent id | |
path.knowledge_base_uuid |
string | Required | Knowledge base id |
Full JSON Schema
Example input
{
"path": {
"agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Agent Route to an Agent — digitalocean.genai_attach_agent
To add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.parent_agent_uuid |
string | Required | A unique identifier for the parent agent. | |
path.child_agent_uuid |
string | Required | Routed agent id | |
body |
— | Optional | $ref: "#/definitions/apiLinkAgentInputPublic" |
Full JSON Schema
Example input
{
"path": {
"parent_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"child_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Agent Route for an Agent — digitalocean.genai_update_attached_agent
To update an agent route for an agent, send a PUT request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.parent_agent_uuid |
string | Required | A unique identifier for the parent agent. | |
path.child_agent_uuid |
string | Required | Routed agent id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateLinkedAgentInputPublic" |
Full JSON Schema
Example input
{
"path": {
"parent_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"child_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Agent Route for an Agent — digitalocean.genai_detach_agent
To delete an agent route from a parent agent, send a DELETE request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.parent_agent_uuid |
string | Required | Pagent agent id | |
path.child_agent_uuid |
string | Required | Routed agent id |
Full JSON Schema
Example input
{
"path": {
"parent_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"child_agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Agent — digitalocean.genai_get_agent
To retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique agent id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Agent — digitalocean.genai_update_agent
To update an agent, send a PUT request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique agent id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateAgentInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete an Agent — digitalocean.genai_delete_agent
To delete an agent, send a DELETE request to /v2/gen-ai/agents/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique agent id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
View Agent Routes — digitalocean.genai_get_agent_children
To view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child_agents.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Agent id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Agent Status — digitalocean.genai_update_agent_deployment_visibility
Check whether an agent is public or private. To update the agent status, send a PUT request to /v2/gen-ai/agents/{uuid}/deployment_visibility.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateAgentDeploymentVisibilityInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Agent Usage — digitalocean.genai_get_agent_usage
To get agent usage, send a GET request to /v2/gen-ai/agents/{uuid}/usage. Returns usage metrics for the specified agent within the provided time range.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Agent id | |
query |
object | Optional | additionalProperties: false |
|
query.start |
string | Optional | Return all usage data from this date. | |
query.stop |
string | Optional | Return all usage data up to this date, if omitted, will return up to the current date. |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Agent Versions — digitalocean.genai_list_agent_versions
To list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Agent uuid | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Rollback to Agent Version — digitalocean.genai_rollback_to_agent_version
To update to a specific agent version, send a PUT request to /v2/gen-ai/agents/{uuid}/versions.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Agent unique identifier | |
body |
— | Optional | $ref: "#/definitions/apiRollbackToAgentVersionInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Anthropic API Keys — digitalocean.genai_list_anthropic_api_keys
To list all Anthropic API keys, send a GET request to /v2/gen-ai/anthropic/keys.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Anthropic API Key — digitalocean.genai_create_anthropic_api_key
To create an Anthropic API key, send a POST request to /v2/gen-ai/anthropic/keys.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateAnthropicAPIKeyInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Anthropic API Key — digitalocean.genai_get_anthropic_api_key
To retrieve details of an Anthropic API key, send a GET request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Anthropic API Key — digitalocean.genai_update_anthropic_api_key
To update an Anthropic API key, send a PUT request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID | |
body |
— | Optional | $ref: "#/definitions/apiUpdateAnthropicAPIKeyInputPublic" |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Anthropic API Key — digitalocean.genai_delete_anthropic_api_key
To delete an Anthropic API key, send a DELETE request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List agents by Anthropic key — digitalocean.genai_list_agents_by_anthropic_key
List Agents by Anthropic Key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique ID of Anthropic key | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Custom Models — digitalocean.genai_list_custom_models
To list custom models, send a GET request to /v2/gen-ai/custom_models.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number for pagination. | |
query.per_page |
integer | Optional | Number of items per page. | |
query.status |
string | Optional | Filter by model status. | enum: ["STATUS_UNSPECIFIED","STATUS_IMPORTING","STATUS_READY","STATUS_FAILED","STATUS_DELETED"]; default: "STATUS_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Import Custom Model — digitalocean.genai_import_custom_model
To import a custom model, send a POST request to /v2/gen-ai/custom_models/import.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiImportCustomModelInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Model — digitalocean.genai_get_custom_model
To retrieve details of a custom model, send a GET request to /v2/gen-ai/custom_models/{uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | UUID of the custom model to retrieve |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Custom Model — digitalocean.genai_delete_custom_model
To delete a custom model, send a DELETE request to /v2/genai/custom_models/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | UUID of the custom model to delete |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Custom Model Metadata — digitalocean.genai_update_custom_model_metadata
To update custom model metadata, send a PATCH request to /v2/gen-ai/custom_models/{uuid}/metadata.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | UUID of the custom model to update | |
body |
— | Optional | $ref: "#/definitions/apiUpdateCustomModelMetadataInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Evaluation Datasets — digitalocean.genai_list_evaluation_datasets
To list evaluation datasets, send a GET request to /v2/gen-ai/evaluation_datasets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.dataset_type |
string | Optional | Filter by evaluation dataset type. | enum: ["EVALUATION_DATASET_TYPE_UNKNOWN","EVALUATION_DATASET_TYPE_MODEL"]; default: "EVALUATION_DATASET_TYPE_UNKNOWN" |
query.dataset_paradigm |
— | Optional | Filter by evaluation dataset paradigm (row/content shape). | $ref: "#/definitions/apiEvaluationDatasetParadigm" |
query.has_ground_truth |
boolean | Optional | Filter by whether the dataset includes ground-truth values. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Evaluation Dataset — digitalocean.genai_create_evaluation_dataset
To create an evaluation dataset, send a POST request to /v2/gen-ai/evaluation_datasets.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateEvaluationDatasetInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Presigned URLs for Evaluation Dataset File Upload — digitalocean.genai_create_evaluation_dataset_file_upload_presigned_urls
To create presigned URLs for evaluation dataset file upload, send a POST request to /v2/gen-ai/evaluation_datasets/file_upload_presigned_urls.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateDataSourceFileUploadPresignedUrlsInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Evaluation Dataset — digitalocean.genai_delete_evaluation_dataset
To delete an evaluation dataset, send a DELETE request to /v2/genai/evaluation_datasets/{dataset_uuid}. This works for both model and agent evaluation datasets.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dataset_uuid |
string | Required | UUID of the evaluation dataset to delete. |
Full JSON Schema
Example input
{
"path": {
"dataset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Download URL for Evaluation Dataset — digitalocean.genai_get_evaluation_dataset_download_url
To get a presigned download URL for an evaluation dataset, send a GET request to /v2/genai/evaluation_datasets/{dataset_uuid}/download_url.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.dataset_uuid |
string | Required | UUID of the evaluation dataset. |
Full JSON Schema
Example input
{
"path": {
"dataset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Evaluation Metrics — digitalocean.genai_list_evaluation_metrics
To list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Custom Evaluation Metric — digitalocean.genai_create_custom_evaluation_metric
To create a custom LLM-as-judge metric for model evaluation, send a POST request to /v2/gen-ai/custom_evaluation_metrics.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateCustomEvaluationMetricInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Custom Evaluation Metric — digitalocean.genai_update_custom_evaluation_metric
To update a custom metric (issuing a new metric UUID), send a PUT request to /v2/gen-ai/custom_evaluation_metrics/{metric_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.metric_uuid |
string | Required | UUID of the custom metric to update. | |
body |
— | Optional | $ref: "#/definitions/apiUpdateCustomEvaluationMetricInputPublic" |
Full JSON Schema
Example input
{
"path": {
"metric_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Custom Evaluation Metric — digitalocean.genai_delete_custom_evaluation_metric
To soft-delete a custom model evaluation metric, send a DELETE request to /v2/gen-ai/custom_evaluation_metrics/{metric_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.metric_uuid |
string | Required | UUID of the custom metric to delete. |
Full JSON Schema
Example input
{
"path": {
"metric_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Run an Evaluation Test Case — digitalocean.genai_run_evaluation_test_case
To run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiRunEvaluationTestCaseInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Information About an Existing Evaluation Run — digitalocean.genai_get_evaluation_run
To retrive information about an existing evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.evaluation_run_uuid |
string | Required | Evaluation run UUID. |
Full JSON Schema
Example input
{
"path": {
"evaluation_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Results of an Evaluation Run — digitalocean.genai_get_evaluation_run_results
To retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.evaluation_run_uuid |
string | Required | Evaluation run UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"evaluation_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Results of an Evaluation Run Prompt — digitalocean.genai_get_evaluation_run_prompt_results
To retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.evaluation_run_uuid |
string | Required | Evaluation run UUID. | |
path.prompt_id |
integer | Required | Prompt ID to get results for. |
Full JSON Schema
Example input
{
"path": {
"evaluation_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"prompt_id": 1
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Evaluation Test Cases — digitalocean.genai_list_evaluation_test_cases
To list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Evaluation Test Case. — digitalocean.genai_create_evaluation_test_case
To create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateEvaluationTestCaseInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Evaluation Runs by Test Case — digitalocean.genai_list_evaluation_runs_by_test_case
To list all evaluation runs by test case, send a GET request to /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.evaluation_test_case_uuid |
string | Required | Evaluation run UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.evaluation_test_case_version |
integer | Optional | Version of the test case. |
Full JSON Schema
Example input
{
"path": {
"evaluation_test_case_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Information About an Existing Evaluation Test Case — digitalocean.genai_get_evaluation_test_case
To retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.test_case_uuid |
string | Required | The test case uuid to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.evaluation_test_case_version |
integer | Optional | Version of the test case. |
Full JSON Schema
Example input
{
"path": {
"test_case_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update an Evaluation Test Case. — digitalocean.genai_update_evaluation_test_case
To update an evaluation test-case send a PUT request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.test_case_uuid |
string | Required | Test-case UUID to update | |
body |
— | Optional | $ref: "#/definitions/apiUpdateEvaluationTestCaseInputPublic" |
Full JSON Schema
Example input
{
"path": {
"test_case_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Indexing Jobs for a Knowledge Base — digitalocean.genai_list_indexing_jobs
To list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Start Indexing Job for a Knowledge Base — digitalocean.genai_create_indexing_job
To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiStartKnowledgeBaseIndexingJobInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Data Sources for Indexing Job for a Knowledge Base — digitalocean.genai_list_indexing_job_data_sources
To list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.indexing_job_uuid |
string | Required | Uuid of the indexing job |
Full JSON Schema
Example input
{
"path": {
"indexing_job_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Signed URL for Indexing Job Details — digitalocean.genai_get_indexing_job_details_signed_url
To get a signed URL for indexing job details, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}/details_signed_url.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.indexing_job_uuid |
string | Required | The uuid of the indexing job |
Full JSON Schema
Example input
{
"path": {
"indexing_job_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Status of Indexing Job for a Knowledge Base — digitalocean.genai_get_indexing_job
To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Indexing job id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel Indexing Job for a Knowledge Base — digitalocean.genai_cancel_indexing_job
To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | A unique identifier for an indexing job. | |
body |
— | Optional | $ref: "#/definitions/apiCancelKnowledgeBaseIndexingJobInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Knowledge Bases — digitalocean.genai_list_knowledge_bases
To list all knowledge bases, send a GET request to /v2/gen-ai/knowledge_bases.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Knowledge Base — digitalocean.genai_create_knowledge_base
To create a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateKnowledgeBaseInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Presigned URLs for Data Source File Upload — digitalocean.genai_create_data_source_file_upload_presigned_urls
To create presigned URLs for knowledge base data source file upload, send a POST request to /v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateDataSourceFileUploadPresignedUrlsInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Data Sources for a Knowledge Base — digitalocean.genai_list_knowledge_base_data_sources
To list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | Knowledge base id | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Data Source to a Knowledge Base — digitalocean.genai_create_knowledge_base_data_source
To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | Knowledge base id | |
body |
— | Optional | $ref: "#/definitions/apiCreateKnowledgeBaseDataSourceInputPublic" |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Data Source options — digitalocean.genai_update_knowledge_base_data_source
To update a data source (e.g. chunking options), send a PUT request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | Knowledge Base ID (Path Parameter) | |
path.data_source_uuid |
string | Required | Data Source ID (Path Parameter) | |
body |
— | Optional | $ref: "#/definitions/apiUpdateKnowledgeBaseDataSourceInputPublic" |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
"data_source_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Data Source from a Knowledge Base — digitalocean.genai_delete_knowledge_base_data_source
To delete a data source from a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | Knowledge base id | |
path.data_source_uuid |
string | Required | Data source id |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"data_source_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Indexing Jobs for a Knowledge Base — digitalocean.genai_list_indexing_jobs_by_knowledge_base
To list latest 15 indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | Knowledge base uuid in string |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Information About an Existing Knowledge Base — digitalocean.genai_get_knowledge_base
To retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Knowledge base id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Knowledge Base — digitalocean.genai_update_knowledge_base
To update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Knowledge base id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateKnowledgeBaseInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Knowledge Base — digitalocean.genai_delete_knowledge_base
To delete a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Knowledge base id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Presigned URLs for Model Evaluation Dataset File Upload — digitalocean.genai_create_model_eval_dataset_upload_presigned_urls
To create presigned URLs for model evaluation dataset file upload, send a POST request to /v2/genai/model_evaluation/datasets/file_upload_presigned_urls.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateModelEvalDatasetUploadPresignedUrlsInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Evaluation Metrics — digitalocean.genai_list_model_evaluation_metrics
To list all available metrics for model evaluation, send a GET request to /v2/genai/model_evaluation_metrics.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Evaluation Presets — digitalocean.genai_list_model_evaluation_presets
To list all saved model evaluation presets, send a GET request to /v2/genai/model_evaluation_presets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Model Evaluation Preset — digitalocean.genai_get_model_evaluation_preset
To retrieve a saved model evaluation preset, send a GET request to /v2/genai/model_evaluation_presets/{eval_preset_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_preset_uuid |
string | Required | UUID of the evaluation preset. |
Full JSON Schema
Example input
{
"path": {
"eval_preset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Model Evaluation Preset — digitalocean.genai_delete_model_evaluation_preset
To delete a saved model evaluation preset, send a DELETE request to /v2/gen-ai/model_evaluation_presets/{eval_preset_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_preset_uuid |
string | Required | UUID of the evaluation preset to delete. |
Full JSON Schema
Example input
{
"path": {
"eval_preset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Evaluation Runs — digitalocean.genai_list_model_evaluation_runs
To list model evaluation runs, send a GET request to /v2/genai/model_evaluation_runs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.eval_preset_uuid |
string | Optional | UUID of the evaluation preset to filter by. | |
query.status |
string | Optional | Filter by evaluation run status. | enum: ["MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED","MODEL_EVALUATION_RUN_QUEUED","MODEL_EVALUATION_RUN_RUNNING_DATASET","MODEL_EVALUATION_RUN_EVALUATING_RESULTS","MODEL_EVALUATION_RUN_CANCELLING","MODEL_EVALUATION_RUN_CANCELLED","MODEL_EVALUATION_RUN_SUCCESSFUL","MODEL_EVALUATION_RUN_PARTIALLY_SUCCESSFUL","MODEL_EVALUATION_RUN_FAILED"]; default: "MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED" |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.statuses |
array | Optional | Filter by one or more statuses. Empty means no status filter. | |
query.statuses[] |
string | Optional | enum: ["MODEL_EVALUATION_RUN_STATUS_UNSPECIFIED","MODEL_EVALUATION_RUN_QUEUED","MODEL_EVALUATION_RUN_RUNNING_DATASET","MODEL_EVALUATION_RUN_EVALUATING_RESULTS","MODEL_EVALUATION_RUN_CANCELLING","MODEL_EVALUATION_RUN_CANCELLED","MODEL_EVALUATION_RUN_SUCCESSFUL","MODEL_EVALUATION_RUN_PARTIALLY_SUCCESSFUL","MODEL_EVALUATION_RUN_FAILED"] |
|
query.candidate_types |
array | Optional | Filter by one or more candidate model source types (serverless, dedicated, router). Empty means no candidate-type filter. | |
query.candidate_types[] |
string | Optional | enum: ["CANDIDATE_MODEL_SOURCE_SERVERLESS","CANDIDATE_MODEL_SOURCE_DEDICATED","CANDIDATE_MODEL_SOURCE_ROUTER"] |
|
query.search |
string | Optional | Free-text search across the eval run name, candidate model name and dataset name (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to creation date when unspecified. | enum: ["MODEL_EVALUATION_RUN_SORT_FIELD_UNSPECIFIED","MODEL_EVALUATION_RUN_SORT_FIELD_CREATED_AT","MODEL_EVALUATION_RUN_SORT_FIELD_STATUS"]; default: "MODEL_EVALUATION_RUN_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to descending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Model Evaluation Run — digitalocean.genai_create_model_evaluation_run
To create a model evaluation run, send a POST request to /v2/genai/model_evaluation_runs.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateModelEvaluationRunInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Model Evaluation Run — digitalocean.genai_get_model_evaluation_run
To retrieve a model evaluation run, send a GET request to /v2/genai/model_evaluation_runs/{eval_run_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_run_uuid |
string | Required | UUID of the evaluation run. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number for per-prompt results (defaults to 1). | |
query.per_page |
integer | Optional | Number of per-prompt results per page (defaults to 50). |
Full JSON Schema
Example input
{
"path": {
"eval_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Model Evaluation Run — digitalocean.genai_delete_model_evaluation_run
To delete a model evaluation run, send a DELETE request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}. The run must be in a terminal status (successful, partially_successful, failed, or cancelled). For runs still in progress, either wait for the run to finish or cancel it, then retry the delete once the run reaches a terminal status.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_run_uuid |
string | Required | UUID of the model evaluation run to delete. The run must be in a terminal status (successful, partially_successful, failed, or cancelled). For runs still in progress, either wait for the run to finish or cancel it, then retry the delete. |
Full JSON Schema
Example input
{
"path": {
"eval_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Model Evaluation Run — digitalocean.genai_update_model_evaluation_run
To update a model evaluation run's display name, send a PATCH request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_run_uuid |
string | Required | UUID of the model evaluation run to update. Returned by CreateModelEvaluationRun and listed via ListModelEvaluationRuns. |
|
body |
— | Optional | $ref: "#/definitions/apiUpdateModelEvaluationRunInputPublic" |
Full JSON Schema
Example input
{
"path": {
"eval_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel Model Evaluation Run — digitalocean.genai_cancel_model_evaluation_run
To cancel an in-progress model evaluation run, send a PUT request to /v2/gen-ai/model_evaluation_runs/{eval_run_uuid}/cancel.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_run_uuid |
string | Required | UUID of the model evaluation run to cancel. Returned by CreateModelEvaluationRun and listed via ListModelEvaluationRuns. The run must be in a non-terminal status (queued, running_dataset, or evaluating_results); already-terminal runs return an error. |
|
body |
— | Optional | $ref: "#/definitions/apiCancelModelEvaluationRunInputPublic" |
Full JSON Schema
Example input
{
"path": {
"eval_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Download URL for Model Evaluation Run Results — digitalocean.genai_get_model_evaluation_run_results_download_url
To get a presigned download URL for model evaluation run results (gzip-compressed JSON), send a GET request to /v2/genai/model_evaluation_runs/{eval_run_uuid}/results/download_url.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.eval_run_uuid |
string | Required | UUID of the evaluation run. |
Full JSON Schema
Example input
{
"path": {
"eval_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Available Models — digitalocean.genai_list_models
To list all models, send a GET request to /v2/gen-ai/models.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.usecases |
array | Optional | Include only models defined for the listed usecases. - MODEL_USECASE_UNKNOWN: The use case of the model is unknown - MODEL_USECASE_AGENT: The model maybe used in an agent - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails - MODEL_USECASE_REASONING: The model usecase for reasoning - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference | |
query.usecases[] |
string | Optional | enum: ["MODEL_USECASE_UNKNOWN","MODEL_USECASE_AGENT","MODEL_USECASE_FINETUNED","MODEL_USECASE_KNOWLEDGEBASE","MODEL_USECASE_GUARDRAIL","MODEL_USECASE_REASONING","MODEL_USECASE_SERVERLESS"] |
|
query.public_only |
boolean | Optional | Only include models that are publicly available. | |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model API Keys — digitalocean.genai_list_model_api_keys
To list all model API keys, send a GET request to /v2/gen-ai/models/api_keys.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update API Key for a Model — digitalocean.genai_update_model_api_key
To update a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID | |
body |
— | Optional | $ref: "#/definitions/apiUpdateModelAPIKeyInputPublic" |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete API Key for a Model — digitalocean.genai_delete_model_api_key
To delete an API key for a model, send a DELETE request to /v2/gen-ai/models/api_keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key for an agent. |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Regenerate API Key for a Model — digitalocean.genai_regenerate_model_api_key
To regenerate a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Catalog — digitalocean.genai_list_model_catalog
Returns all available models.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number for pagination. | |
query.limit |
integer | Optional | Deprecated. Use per_page instead. |
|
query.search |
string | Optional | Partial, case-insensitive match on the model's display name. | |
query.model_type |
array | Optional | Filter by model type. Multiple values use OR semantics. Accepted values: chat, embedding, image, reasoning, coding, audio, reranking. |
|
query.model_type[] |
string | Optional | ||
query.provider |
array | Optional | Filter by model creator/developer. Multiple values use OR semantics. Values are data-driven; use available_providers from the response to discover valid options. |
|
query.provider[] |
string | Optional | ||
query.availability |
array | Optional | Filter by deployment availability. Multiple values use OR semantics. Accepted values: serverless, dedicated. |
|
query.availability[] |
string | Optional | ||
query.badges |
array | Optional | Filter by badge. Multiple values use OR semantics. Accepted values: featured, new, preview. |
|
query.badges[] |
string | Optional | ||
query.sort_by |
string | Optional | Field to sort results by. Default is MODEL_CATALOG_SORT_BY_CREATED_AT. - MODEL_CATALOG_SORT_BY_CREATED_AT: Default: sort by creation date. - MODEL_CATALOG_SORT_BY_NAME: Sort by the model's display name (case-insensitive). - MODEL_CATALOG_SORT_BY_PRICE: Sort by input token price. |
enum: ["MODEL_CATALOG_SORT_BY_CREATED_AT","MODEL_CATALOG_SORT_BY_NAME","MODEL_CATALOG_SORT_BY_PRICE"]; default: "MODEL_CATALOG_SORT_BY_CREATED_AT" |
query.per_page |
integer | Optional | Number of items per page. Replaces the deprecated limit field. |
|
query.sort_direction |
string | Optional | Sort direction. Defaults to descending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
query.use_case |
string | Optional | Filter by pre-defined use case. When unspecified, no use-case filter is applied. Accepted values: MODEL_CATALOG_USE_CASE_CODING, MODEL_CATALOG_USE_CASE_AGENTS, MODEL_CATALOG_USE_CASE_AUDIO, MODEL_CATALOG_USE_CASE_IMAGE, MODEL_CATALOG_USE_CASE_EMBEDDING, MODEL_CATALOG_USE_CASE_VIDEO. - MODEL_CATALOG_USE_CASE_UNSPECIFIED: No use-case filter applied; return all models. - MODEL_CATALOG_USE_CASE_CODING: Coding-optimized models: model_type = coding, or usecases include coding, agentic_coding, or code_generation. - MODEL_CATALOG_USE_CASE_AGENTS: Agent-building models: usecases include tool_calling, agentic, agent_platform, agentic_workflows, or agentic_coding. - MODEL_CATALOG_USE_CASE_AUDIO: Audio models: model_type is audio, or usecases include audio, text_to_speech, or voice_cloning, or output modalities include audio. - MODEL_CATALOG_USE_CASE_IMAGE: Image models: model_type is image, or usecases include image_generation, text_to_image, or ideogram, or output modalities include image. - MODEL_CATALOG_USE_CASE_VIDEO: Video models: usecases include video_generation or text_to_video, or output modalities include video. - MODEL_CATALOG_USE_CASE_EMBEDDING: Embedding and reranking models: model_type is embedding or reranking, or usecases include vectorization or reranking. |
enum: ["MODEL_CATALOG_USE_CASE_UNSPECIFIED","MODEL_CATALOG_USE_CASE_CODING","MODEL_CATALOG_USE_CASE_AGENTS","MODEL_CATALOG_USE_CASE_AUDIO","MODEL_CATALOG_USE_CASE_IMAGE","MODEL_CATALOG_USE_CASE_VIDEO","MODEL_CATALOG_USE_CASE_EMBEDDING"]; default: "MODEL_CATALOG_USE_CASE_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Model Catalog Card — digitalocean.genai_get_model_catalog_card
Returns detailed information for a specific model in the catalog including capabilities, pricing, and code examples.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.model_id |
string | Optional | Model identifier used for API calls (e.g., "llama3.1-70b-instruct"). Alternative to UUID lookup. |
Full JSON Schema
Example input
{
"path": {
"id": "\"example string\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Routers — digitalocean.genai_list_model_routers
To list model routers, send a GET request to /v2/gen-ai/models/routers.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Model Router — digitalocean.genai_create_model_router
To create a model router, send a POST request to /v2/gen-ai/models/routers.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateModelRouterInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Router Presets — digitalocean.genai_list_model_router_presets
To list model router presets, send a GET request to /v2/gen-ai/models/routers/presets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Model Router Task Presets — digitalocean.genai_list_model_router_task_presets
To list model router task presets, send a GET request to /v2/gen-ai/models/routers/tasks/presets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Model Router — digitalocean.genai_get_model_router
To retrieve details of a model router, send a GET request to /v2/gen-ai/models/routers/{uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Model router id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Model Router — digitalocean.genai_update_model_router
To update a model router, send a PUT request to /v2/gen-ai/models/routers/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Model router id | |
body |
— | Optional | $ref: "#/definitions/apiUpdateModelRouterInputPublic" |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Model Router — digitalocean.genai_delete_model_router
To delete a model router, send a DELETE request to /v2/gen-ai/models/routers/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Model router id |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Oauth2 Dropbox Tokens — digitalocean.genai_create_oauth2_dropbox_tokens
To obtain the refresh token, needed for creation of data sources, send a GET request to /v2/gen-ai/oauth2/dropbox/tokens. Pass the code you obtrained from the oauth flow in the field 'code'
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiDropboxOauth2GetTokensInput" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Oauth2 URL — digitalocean.genai_get_oauth2_url
To generate an Oauth2-URL for use with your localhost, send a GET request to /v2/gen-ai/oauth2/url. Pass 'http://localhost:3000 as redirect_url
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.type |
string | Optional | Type "google" / "dropbox". | |
query.redirect_url |
string | Optional | The redirect url. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List OpenAI API Keys — digitalocean.genai_list_openai_api_keys
To list all OpenAI API keys, send a GET request to /v2/gen-ai/openai/keys.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create OpenAI API Key — digitalocean.genai_create_openai_api_key
To create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateOpenAIAPIKeyInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get OpenAI API Key — digitalocean.genai_get_openai_api_key
To retrieve details of an OpenAI API key, send a GET request to /v2/gen-ai/openai/keys/{api_key_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update OpenAI API Key — digitalocean.genai_update_openai_api_key
To update an OpenAI API key, send a PUT request to /v2/gen-ai/openai/keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID | |
body |
— | Optional | $ref: "#/definitions/apiUpdateOpenAIAPIKeyInputPublic" |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete OpenAI API Key — digitalocean.genai_delete_openai_api_key
To delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api_key_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.api_key_uuid |
string | Required | API key ID |
Full JSON Schema
Example input
{
"path": {
"api_key_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List agents by OpenAI key — digitalocean.genai_list_agents_by_openai_key
List Agents by OpenAI Key.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | Unique ID of OpenAI key | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Datacenter Regions — digitalocean.genai_list_datacenter_regions
To list all datacenter regions, send a GET request to /v2/gen-ai/regions.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.serves_inference |
boolean | Optional | Include datacenters that serve inference. | |
query.serves_batch |
boolean | Optional | Include datacenters that are capable of running batch jobs. |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Common Scenario & Goal Library — digitalocean.genai_list_scenario_library
To list the platform-curated Common Scenario & Goal Library, send a GET request to /v2/gen-ai/scenario_library.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.category |
string | Optional | Filter by category (exact match). Empty means no category filter. | |
query.search |
string | Optional | Free-text search across name, description, and goal_description (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to name when unspecified. - SCENARIO_LIBRARY_SORT_FIELD_NAME: Sort by customer-facing name (case-insensitive). Default. - SCENARIO_LIBRARY_SORT_FIELD_CREATED_AT: Sort by creation date. | enum: ["SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED","SCENARIO_LIBRARY_SORT_FIELD_NAME","SCENARIO_LIBRARY_SORT_FIELD_CREATED_AT"]; default: "SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to ascending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Scenario Set From Library — digitalocean.genai_create_scenario_set_from_library
To create a scenario set from a Common Scenario & Goal Library entry, send a POST request to /v2/gen-ai/scenario_library/{library_scenario_uuid}/create_scenario_set. The library scenarios are copied into a new scenario set owned by the calling team. The new set is ready to use when creating a simulation run.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.library_scenario_uuid |
string | Required | UUID of the library entry to copy. | |
body |
— | Optional | $ref: "#/definitions/apiCreateScenarioSetFromLibraryInputPublic" |
Full JSON Schema
Example input
{
"path": {
"library_scenario_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Scenarios In Library Entry — digitalocean.genai_list_scenario_library_scenarios
To list the scenarios inside a Common Scenario & Goal Library entry without creating a team-owned scenario set, send a GET request to /v2/gen-ai/scenario_library/{library_scenario_uuid}/scenarios.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.library_scenario_uuid |
string | Required | UUID of the library entry to read. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.search |
string | Optional | Free-text search across name, description, and user_persona (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to original file order when unspecified. - SCENARIO_SORT_FIELD_FILE_ORDER: Preserve original file order. Default. - SCENARIO_SORT_FIELD_NAME: Sort by scenario name (case-insensitive). Empty names sort last. - SCENARIO_SORT_FIELD_DESCRIPTION: Sort by scenario description (case-insensitive). | enum: ["SCENARIO_SORT_FIELD_UNSPECIFIED","SCENARIO_SORT_FIELD_FILE_ORDER","SCENARIO_SORT_FIELD_NAME","SCENARIO_SORT_FIELD_DESCRIPTION"]; default: "SCENARIO_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to ascending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{
"path": {
"library_scenario_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Scenario Sets — digitalocean.genai_list_scenario_sets
To list scenario sets, send a GET request to /v2/gen-ai/scenario_sets.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.statuses |
array | Optional | Filter by one or more statuses. Empty means no status filter. - SCENARIO_SET_STATUS_GENERATING: Generation is in progress. The scenarios are not ready yet. - SCENARIO_SET_STATUS_READY: The scenario set is ready to use. - SCENARIO_SET_STATUS_FAILED: Generation failed. The scenario set has no readable scenarios. - SCENARIO_SET_STATUS_CANCELLED: Generation was cancelled before completion. | |
query.statuses[] |
string | Optional | enum: ["SCENARIO_SET_STATUS_UNSPECIFIED","SCENARIO_SET_STATUS_GENERATING","SCENARIO_SET_STATUS_READY","SCENARIO_SET_STATUS_FAILED","SCENARIO_SET_STATUS_CANCELLED"] |
|
query.source_kinds |
array | Optional | Filter by one or more source kinds. Empty means no source-kind filter. - SCENARIO_SET_SOURCE_KIND_USER_UPLOAD: Created from uploaded or inline scenarios. - SCENARIO_SET_SOURCE_KIND_GOAL_GENERATED: Produced by goal-driven generation. - SCENARIO_SET_SOURCE_KIND_LIBRARY: Copied from a platform-curated library entry. - SCENARIO_SET_SOURCE_KIND_SIGNAL_GENERATED: Produced from a completed Signals export. | |
query.source_kinds[] |
string | Optional | enum: ["SCENARIO_SET_SOURCE_KIND_UNSPECIFIED","SCENARIO_SET_SOURCE_KIND_USER_UPLOAD","SCENARIO_SET_SOURCE_KIND_GOAL_GENERATED","SCENARIO_SET_SOURCE_KIND_LIBRARY","SCENARIO_SET_SOURCE_KIND_SIGNAL_GENERATED"] |
|
query.search |
string | Optional | Free-text search across name and description (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to creation date when unspecified. - SCENARIO_SET_SORT_FIELD_CREATED_AT: Sort by creation date. Default. - SCENARIO_SET_SORT_FIELD_NAME: Sort by customer-supplied name (case-insensitive). - SCENARIO_SET_SORT_FIELD_STATUS: Sort by status using lifecycle order (generating → ready → terminal). - SCENARIO_SET_SORT_FIELD_SCENARIO_COUNT: Sort by scenario_count. - SCENARIO_SET_SORT_FIELD_UPDATED_AT: Sort by last update date. | enum: ["SCENARIO_SET_SORT_FIELD_UNSPECIFIED","SCENARIO_SET_SORT_FIELD_CREATED_AT","SCENARIO_SET_SORT_FIELD_NAME","SCENARIO_SET_SORT_FIELD_STATUS","SCENARIO_SET_SORT_FIELD_SCENARIO_COUNT","SCENARIO_SET_SORT_FIELD_UPDATED_AT"]; default: "SCENARIO_SET_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to descending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Scenario Set — digitalocean.genai_create_scenario_set
To create a scenario set, send a POST request to /v2/gen-ai/scenario_sets. Provide exactly one of scenarios or file_upload_scenario_set. The set is created in the ready state.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateScenarioSetInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Presigned URLs for Scenario Set File Upload — digitalocean.genai_create_scenario_set_upload_presigned_urls
To create presigned URLs for uploading a scenario set file, send a POST request to /v2/gen-ai/scenario_sets/file_upload_presigned_urls. After uploading, pass the stored object in Create Scenario Set as file_upload_scenario_set.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateScenarioSetUploadPresignedUrlsInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Generate Scenario Set — digitalocean.genai_create_generated_scenario_set
To dispatch goal-driven scenario generation, send a POST request to /v2/gen-ai/scenario_sets/generate. The scenario set is returned in the generating state. Poll the retrieve scenario set endpoint until the set reaches a ready, failed, or cancelled status.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiGenerateScenarioSetInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Scenario Set — digitalocean.genai_get_scenario_set
To retrieve a scenario set, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set. |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Scenario Set — digitalocean.genai_update_scenario_set
To update a scenario set in place, send a PUT request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}. Provide a new name and/or replacement scenarios. At least one is required. Replacing contents keeps the same scenario set UUID, remints scenario UUIDs, and is rejected unless the set is ready and no simulation run references it. There is no file-upload path on update.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set to update. Returned by CreateScenarioSet and listed via ListScenarioSets. |
|
body |
— | Optional | $ref: "#/definitions/apiUpdateScenarioSetInputPublic" |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Scenario Set — digitalocean.genai_delete_scenario_set
To delete a scenario set, send a DELETE request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}. A scenario set that is referenced by a simulation run cannot be deleted.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set to delete. Returned by CreateScenarioSet and listed via ListScenarioSets. A set still referenced by a simulation run cannot be deleted. |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Scenario Set Download URL — digitalocean.genai_get_scenario_set_download_url
To retrieve a presigned download URL for a scenario set file, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/download_url.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set. |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Duplicate Scenario Set — digitalocean.genai_create_duplicate_scenario_set
To duplicate a scenario set, send a POST request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/duplicate. The source set must be ready. The new set is named {original name} duplicate and contains a copy of the source scenarios.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set to duplicate. | |
body |
— | Optional | $ref: "#/definitions/apiDuplicateScenarioSetInputPublic" |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Scenarios — digitalocean.genai_list_scenarios
To list the scenarios in a scenario set, send a GET request to /v2/gen-ai/scenario_sets/{scenario_set_uuid}/scenarios.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.scenario_set_uuid |
string | Required | UUID of the scenario set to read. | |
query |
object | Optional | additionalProperties: false |
|
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.search |
string | Optional | Free-text search across name, description, and user_persona (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to original file order when unspecified. - SCENARIO_SORT_FIELD_FILE_ORDER: Preserve original file order. Default. - SCENARIO_SORT_FIELD_NAME: Sort by scenario name (case-insensitive). Empty names sort last. - SCENARIO_SORT_FIELD_DESCRIPTION: Sort by scenario description (case-insensitive). | enum: ["SCENARIO_SORT_FIELD_UNSPECIFIED","SCENARIO_SORT_FIELD_FILE_ORDER","SCENARIO_SORT_FIELD_NAME","SCENARIO_SORT_FIELD_DESCRIPTION"]; default: "SCENARIO_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to ascending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{
"path": {
"scenario_set_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create scheduled indexing for knowledge base — digitalocean.genai_create_scheduled_indexing
To create scheduled indexing for a knowledge base, send a POST request to /v2/gen-ai/scheduled-indexing.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateScheduledIndexingInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Scheduled Indexing for Knowledge Base — digitalocean.genai_get_scheduled_indexing
Get Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.knowledge_base_uuid |
string | Required | UUID of the scheduled indexing entry |
Full JSON Schema
Example input
{
"path": {
"knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Scheduled Indexing — digitalocean.genai_delete_scheduled_indexing
Delete Scheduled Indexing for knowledge base, send a DELETE request to /v2/gen-ai/scheduled-indexing/{uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.uuid |
string | Required | UUID of the scheduled indexing |
Full JSON Schema
Example input
{
"path": {
"uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Simulation Runs — digitalocean.genai_list_simulation_runs
To list simulation runs, send a GET request to /v2/gen-ai/simulation_runs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.scenario_set_uuid |
string | Optional | Optional filter by scenario set. | |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.statuses |
array | Optional | Filter by one or more statuses. Empty means no status filter. - SIMULATION_RUN_STATUS_PENDING: Accepted and queued, not yet executing. - SIMULATION_RUN_STATUS_RUNNING: Episodes are executing. - SIMULATION_RUN_STATUS_SUCCEEDED: All episodes finished successfully. - SIMULATION_RUN_STATUS_FAILED: The run failed, for example because of a timeout or workflow error. - SIMULATION_RUN_STATUS_CANCELLED: The run was cancelled. - SIMULATION_RUN_STATUS_EVALUATING: Episodes finished and an attached evaluation is running. Only reachable when the create request included evaluation_config. When the evaluation reaches a terminal status, its outcome is reflected in the simulation run status. - SIMULATION_RUN_STATUS_PARTIALLY_SUCCESSFUL: The simulation or its attached evaluation completed with a mixture of successful and failed results. | |
query.statuses[] |
string | Optional | enum: ["SIMULATION_RUN_STATUS_UNSPECIFIED","SIMULATION_RUN_STATUS_PENDING","SIMULATION_RUN_STATUS_RUNNING","SIMULATION_RUN_STATUS_SUCCEEDED","SIMULATION_RUN_STATUS_FAILED","SIMULATION_RUN_STATUS_CANCELLED","SIMULATION_RUN_STATUS_EVALUATING","SIMULATION_RUN_STATUS_PARTIALLY_SUCCESSFUL"] |
|
query.search |
string | Optional | Free-text search across the run name and scenario set name (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to creation date when unspecified. - SIMULATION_RUN_SORT_FIELD_CREATED_AT: Sort by creation date. Default. - SIMULATION_RUN_SORT_FIELD_NAME: Sort by customer-supplied run name (case-insensitive). - SIMULATION_RUN_SORT_FIELD_STATUS: Sort by status using lifecycle order (pending → running → terminal). - SIMULATION_RUN_SORT_FIELD_UPDATED_AT: Sort by last update date. | enum: ["SIMULATION_RUN_SORT_FIELD_UNSPECIFIED","SIMULATION_RUN_SORT_FIELD_CREATED_AT","SIMULATION_RUN_SORT_FIELD_NAME","SIMULATION_RUN_SORT_FIELD_STATUS","SIMULATION_RUN_SORT_FIELD_UPDATED_AT"]; default: "SIMULATION_RUN_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to descending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Simulation Run — digitalocean.genai_create_simulation_run
To create a simulation run, send a POST request to /v2/gen-ai/simulation_runs. The scenario set must be ready. Judge and user simulator models are optional and use platform defaults when omitted. The run is returned in the pending state.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateSimulationRunInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Simulation Run — digitalocean.genai_get_simulation_run
To retrieve a simulation run, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the simulation run. |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Simulation Run — digitalocean.genai_update_simulation_run
To update a simulation run's display name, send a PUT request to /v2/gen-ai/simulation_runs/{run_uuid}. Only the name is mutable; run configuration and results are immutable.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the simulation run to update. Returned by CreateSimulationRun and listed via ListSimulationRuns. |
|
body |
— | Optional | $ref: "#/definitions/apiUpdateSimulationRunInputPublic" |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Simulation Run — digitalocean.genai_delete_simulation_run
To delete a simulation run, send a DELETE request to /v2/gen-ai/simulation_runs/{run_uuid}. The run must be in a terminal status (SIMULATION_RUN_STATUS_SUCCEEDED, SIMULATION_RUN_STATUS_PARTIALLY_SUCCESSFUL, SIMULATION_RUN_STATUS_FAILED, or SIMULATION_RUN_STATUS_CANCELLED). For runs still in progress, cancel the run first, then retry the delete.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the simulation run to delete. The run must be in a terminal status. For runs still in progress, cancel the run first, then retry the delete. |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel Simulation Run — digitalocean.genai_patch_cancel_simulation_run
To cancel an in-progress simulation run, send a PATCH request to /v2/gen-ai/simulation_runs/{run_uuid}/cancel.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the simulation run to cancel. Returned by CreateSimulationRun and listed via ListSimulationRuns. The run must be in a non-terminal status; already-terminal runs return an error. |
|
body |
— | Optional | $ref: "#/definitions/apiCancelSimulationRunInputPublic" |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Simulation Episodes — digitalocean.genai_list_simulation_episodes
To list the episodes within a simulation run, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the run whose episodes to list. | |
query |
object | Optional | additionalProperties: false |
|
query.scenario_uuid |
string | Optional | Optional filter by scenario. | |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. | |
query.statuses |
array | Optional | Filter by one or more statuses. Empty means no status filter. - SIMULATION_EPISODE_STATUS_RUNNING: The episode is executing and a trajectory is available to retrieve. - SIMULATION_EPISODE_STATUS_FINISHED: The episode reached a stop condition and produced a verdict. - SIMULATION_EPISODE_STATUS_FAILED: The episode failed because of a cancel, timeout, or error. - SIMULATION_EPISODE_STATUS_PREPARING: The episode is allocated but its trajectory is not available yet. | |
query.statuses[] |
string | Optional | enum: ["SIMULATION_EPISODE_STATUS_UNSPECIFIED","SIMULATION_EPISODE_STATUS_RUNNING","SIMULATION_EPISODE_STATUS_FINISHED","SIMULATION_EPISODE_STATUS_FAILED","SIMULATION_EPISODE_STATUS_PREPARING"] |
|
query.verdicts |
array | Optional | Filter by one or more verdicts. Empty means no verdict filter. - SIMULATION_EPISODE_VERDICT_SUCCESS: The candidate agent satisfied the scenario's stopping criteria. - SIMULATION_EPISODE_VERDICT_FAILURE: The candidate agent did not satisfy the stopping criteria. - SIMULATION_EPISODE_VERDICT_INCONCLUSIVE: No conclusive verdict (e.g. max_turns reached without the judge finishing). | |
query.verdicts[] |
string | Optional | enum: ["SIMULATION_EPISODE_VERDICT_UNSPECIFIED","SIMULATION_EPISODE_VERDICT_SUCCESS","SIMULATION_EPISODE_VERDICT_FAILURE","SIMULATION_EPISODE_VERDICT_INCONCLUSIVE"] |
|
query.search |
string | Optional | Free-text search across scenario_uuid and session_id (case-insensitive substring match). Empty means no search. | |
query.sort_by |
string | Optional | Field to sort by. Defaults to scenario ordering when unspecified. - SIMULATION_EPISODE_SORT_FIELD_SCENARIO: Sort by scenario_uuid then episode_index. Default. - SIMULATION_EPISODE_SORT_FIELD_CREATED_AT: Sort by creation date. - SIMULATION_EPISODE_SORT_FIELD_STATUS: Sort by episode status using lifecycle order. - SIMULATION_EPISODE_SORT_FIELD_VERDICT: Sort by verdict (nulls last). | enum: ["SIMULATION_EPISODE_SORT_FIELD_UNSPECIFIED","SIMULATION_EPISODE_SORT_FIELD_SCENARIO","SIMULATION_EPISODE_SORT_FIELD_CREATED_AT","SIMULATION_EPISODE_SORT_FIELD_STATUS","SIMULATION_EPISODE_SORT_FIELD_VERDICT"]; default: "SIMULATION_EPISODE_SORT_FIELD_UNSPECIFIED" |
query.sort_direction |
string | Optional | Sort direction. Defaults to ascending when unspecified. | enum: ["SORT_DIRECTION_UNSPECIFIED","SORT_DIRECTION_ASC","SORT_DIRECTION_DESC"]; default: "SORT_DIRECTION_UNSPECIFIED" |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Simulation Episode — digitalocean.genai_get_simulation_episode
To retrieve a single episode, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes/{episode_uuid}.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the run the episode belongs to. | |
path.episode_uuid |
string | Required | UUID of the episode. |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"episode_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Episode Trajectory — digitalocean.genai_get_simulation_episode_trajectory
To retrieve an episode's live trajectory, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes/{episode_uuid}/trajectory. Poll while the episode is running to watch turn-by-turn progress.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the run the episode belongs to. | |
path.episode_uuid |
string | Required | UUID of the episode. |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"episode_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve Episode Trajectory Download URL — digitalocean.genai_get_simulation_episode_trajectory_url
To retrieve a presigned download URL for an episode's trajectory, send a GET request to /v2/gen-ai/simulation_runs/{run_uuid}/episodes/{episode_uuid}/trajectory_url.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.run_uuid |
string | Required | UUID of the run the episode belongs to. | |
path.episode_uuid |
string | Required | UUID of the episode. |
Full JSON Schema
Example input
{
"path": {
"run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"episode_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Workspaces — digitalocean.genai_list_workspaces
To list all workspaces, send a GET request to /v2/gen-ai/workspaces.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
This tool has no input parameters.
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create a Workspace — digitalocean.genai_create_workspace
To create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
body |
— | Optional | $ref: "#/definitions/apiCreateWorkspaceInputPublic" |
Full JSON Schema
Example input
{}
At most 1 provider requests per invocation; timeout: 30 seconds.
Retrieve an Existing Workspace — digitalocean.genai_get_workspace
To retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace UUID. |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update a Workspace — digitalocean.genai_update_workspace
To update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace UUID. | |
body |
— | Optional | $ref: "#/definitions/apiUpdateWorkspaceInputPublic" |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete a Workspace — digitalocean.genai_delete_workspace
To delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace_uuid}.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace UUID. |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List agents by Workspace — digitalocean.genai_list_agents_by_workspace
To list all agents by a Workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace UUID. | |
query |
object | Optional | additionalProperties: false |
|
query.only_deployed |
boolean | Optional | Only list agents that are deployed. | |
query.page |
integer | Optional | Page number. | |
query.per_page |
integer | Optional | Items per page. |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Move Agents to a Workspace — digitalocean.genai_update_agents_workspace
To move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace uuid to move agents to | |
body |
— | Optional | $ref: "#/definitions/apiMoveAgentsToWorkspaceInputPublic" |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Evaluation Test Cases by Workspace — digitalocean.genai_list_evaluation_test_cases_by_workspace
To list all evaluation test cases by a workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.workspace_uuid |
string | Required | Workspace UUID. |
Full JSON Schema
Example input
{
"path": {
"workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.