Connectors

Cloud Infrastructure & DevOps

DigitalOcean

Cloud infrastructure: droplets, volumes, databases, DNS, and Kubernetes clusters
DigitalOcean API referenceAPI checked August 18, 2026
Signs in with
API token
Runs on
Cloud or On-Prem Worker
Operations
664
Ready-made triggers
0

Connect DigitalOcean

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for DigitalOcean and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Access tokenRequiredSecret
Agent hostOptionalThe agent endpoint host returned by DigitalOcean, such as abc123.agents.do-ai.run. Required for agent inference; the agent access key is sent only to this host.
Agent access keyRequiredSecretEndpoint-scoped access key created with the deployed DigitalOcean agent.

Use it in a flow

  1. Open a flow, open the node library and search for DigitalOcean.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

Operations

664 operations in 54 groups. Each one is a step you can add to a flow.

1 Click Application2
Install Kubernetes 1-Click ApplicationsoneClicks_install_kubernetesPOSTTo install a Kubernetes 1-Click application on a cluster, send a POST request to /v2/1-clicks/kubernetes.
List 1-Click ApplicationsoneClicks_listGETTo list all available 1-Click applications, send a GET request to /v2/1-clicks.
Account1
Get User Informationaccount_getGETTo show information about the current user account, send a GET request to /v2/account.
Action2
List All Actionsactions_listGETThis will be the entire list of actions taken on your account, so it will be quite large.
Retrieve an Existing Actionactions_getGETTo retrieve a specific action object, send a GET request to /v2/actions/$ACTION ID.
Add On8
Create/Provision a New Add-on Resourceaddons_createPOSTTo create an add-on resource, send a POST request to /v2/add-ons/saas with required parameters.
Delete/Deprovision an Add-on Resourceaddons_deleteDELETETo delete an add-on resource, send a DELETE request to /v2/add-ons/saas/{resource uuid} with the UUID of the resource to delete.
Get details on an Add-On Resourceaddons_getGETTo fetch details of a specific Add-On Resource, send a GET request to /v2/add-ons/saas/{resource uuid}.
Get Metadata for an Add-On Applicationaddons_get_app_metadataGETTo find out what metadata is required for a specific add-on, send a GET request to /v2/add-ons/apps/{app slug}/metadata.
List all Add-On Resourcesaddons_listGETTo fetch all Add-On Resources under your team, send a GET request to /v2/add-ons/saas.
List Available Add-On Applicationsaddons_get_appGETTo fetch details of all available Add-On Applications, send a GET request to /v2/add-ons/apps.
Update the name for an Add-On Resourceaddons_patchPATCHTo change the name of an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource uuid}.
Update the plan for an Add-On Resourceaddons_patch_planPATCHTo change the plan associated with an Add-On Resource, send a PATCH request to /v2/add-ons/saas/{resource uuid}/plan.
Agent Inference2
Create a model response for the given chat conversationagentInference_create_chat_completionPOSTCreates a model response for the given chat conversation via a customer-provisioned agent endpoint.
Create a model response for the given chat conversation (stream)agentInference_create_chat_completionStreamPOSTCreates a model response for the given chat conversation via a customer-provisioned agent endpoint.
App38
Cancel a Deploymentapps_cancel_deploymentPOSTImmediately cancel an in-progress deployment.
Cancel an Eventapps_cancel_eventPOSTCancel an in-progress autoscaling event.
Cancel Job Invocationapps_cancel_job_invocationPOSTCancel a specific job invocation for an app.
Commit App Rollbackapps_commit_rollbackPOSTCommit an app rollback.
Create a New Appapps_createPOSTCreate a new app by submitting an app specification.
Create an App Deploymentapps_create_deploymentPOSTCreating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
Delete an Appapps_deleteDELETEDelete an existing app.
Get an Eventapps_get_eventGETGet a single event for an app.
Get Job Invocationsapps_get_job_invocationGETGet a specific job invocation for an app.
List all app alertsapps_list_alertsGETList alerts associated to the app and any components.
List All Appsapps_listGETList all apps on your account.
List App Deploymentsapps_list_deploymentsGETList all deployments of an app.
List App Eventsapps_list_eventsGETList all events for an app, including deployments and autoscaling events.
List App Regionsapps_list_regionsGETList all regions supported by App Platform.
List Instance Sizesapps_list_instanceSizesGETList all instance sizes for service, worker, and job components.
List Job Invocationsapps_list_job_invocationsGETList all job invocations for an app.
Propose an App Specapps_validate_appSpecPOSTTo propose and validate a spec for a new or existing app, send a POST request to the /v2/apps/propose endpoint.
Restart an Appapps_restartPOSTPerform a rolling restart of all or specific components in an app.
Retrieve Active Deployment Aggregate Logsapps_get_logs_active_deployment_aggregateGETRetrieve the logs of the active deployment if one exists.
Retrieve Active Deployment Logsapps_get_logs_active_deploymentGETRetrieve the logs of the active deployment if one exists.
Retrieve Aggregate Deployment Logsapps_get_logs_aggregateGETRetrieve the logs of a past, in-progress, or active deployment.
Retrieve an App Deploymentapps_get_deploymentGETRetrieve information about an app deployment.
Retrieve an Existing Appapps_getGETRetrieve details about an existing app by either its ID or name.
Retrieve an Instance Sizeapps_get_instanceSizeGETRetrieve information about a specific instance size for service, worker, and job components.
Retrieve App Daily Bandwidth Metricsapps_get_metrics_bandwidth_dailyGETRetrieve daily bandwidth usage metrics for a single app.
Retrieve App Healthapps_get_healthGETRetrieve information like health status, cpu and memory utilization of app components.
Retrieve App Instancesapps_get_instancesGETRetrieve the list of running instances for a given application, including instance names and component types.
Retrieve Deployment Logsapps_get_logsGETRetrieve the logs of a past, in-progress, or active deployment.
Retrieve Event Logsapps_get_event_logsGETRetrieve the logs of an autoscaling event for an app.
Retrieve Exec URLapps_get_exec_active_deploymentGETReturns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists.
Retrieve Exec URL for Deploymentapps_get_execGETReturns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists.
Retrieve Job Invocation Logsapps_get_job_invocation_logsGETRetrieve the logs of a past, in-progress, or active deployment.
Retrieve Multiple Apps' Daily Bandwidth Metricsapps_list_metrics_bandwidth_dailyPOSTRetrieve daily bandwidth usage metrics for multiple apps.
Revert App Rollbackapps_revert_rollbackPOSTRevert an app rollback.
Rollback Appapps_create_rollbackPOSTRollback an app to a previous deployment.
Update an Appapps_updatePUTUpdate an existing app by submitting a new app specification.
Update destinations for alertsapps_assign_alertDestinationsPOSTUpdates the emails and slack webhook destinations for app alerts.
Validate App Rollbackapps_validate_rollbackPOSTCheck whether an app can be rolled back to a specific deployment.
Batch Inference7
Cancel a Batch Inference Jobinference_cancel_batchPOSTRequests cancellation of a batch job.
Create a Batch Inference Input Fileinference_create_batch_filePOSTCreates a file record and returns a file id plus a short-lived presigned PUT URL (typically valid for ~15 minutes).
Create a Batch Inference Jobinference_create_batchPOSTSubmits a batch job against a previously uploaded JSONL input file.
Get Batch Inference Results Download Linksinference_get_batch_resultsGETReturns short-lived presigned download URLs for the output (and optional error sidecar) of a completed batch job.
List Batch Inference Jobsinference_list_batchesGETReturns a cursor-paginated list of batch jobs, ordered newest first.
Retrieve a Batch Inference Jobinference_get_batchGETReturns the current state of a batch job.
Upload a Batch Inference Input Fileinference_upload_batch_filePUTUploads the raw JSONL bytes to the presigned upload url returned by POST /v1/batches/files.
Billing8
Get Customer Balancebalance_getGETTo retrieve the balances on a customer's account, send a GET request to /v2/customers/my/balance.
List All Invoicesinvoices_listGETTo retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
List Billing HistorybillingHistory_listGETTo retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing history.
List Billing InsightsbillingInsights_listGETThis 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.
Retrieve an Invoice by UUIDinvoices_get_byUUIDGETTo retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE UUID.
Retrieve an Invoice CSV by UUIDinvoices_get_csvByUUIDGETTo retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE UUID/csv.
Retrieve an Invoice PDF by UUIDinvoices_get_pdfByUUIDGETTo retrieve a PDF for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE UUID/pdf.
Retrieve an Invoice Summary by UUIDinvoices_get_summaryByUUIDGETTo retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE UUID/summary.
Block Storage9
Create a New Block Storage Volumevolumes_createPOSTTo create a new volume, send a POST request to /v2/volumes.
Create Snapshot from a VolumevolumeSnapshots_createPOSTTo create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME ID/snapshots.
Delete a Block Storage Volumevolumes_deleteDELETETo delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME ID.
Delete a Block Storage Volume by Namevolumes_delete_byNameDELETEBlock 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...
Delete a Volume SnapshotvolumeSnapshots_delete_byIdDELETETo delete a volume snapshot, send a DELETE request to /v2/volumes/snapshots/$VOLUME SNAPSHOT ID.
List All Block Storage Volumesvolumes_listGETTo list all of the block storage volumes available on your account, send a GET request to /v2/volumes.
List Snapshots for a VolumevolumeSnapshots_listGETTo retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME ID/snapshots.
Retrieve an Existing Block Storage Volumevolumes_getGETTo show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME ID.
Retrieve an Existing Volume SnapshotvolumeSnapshots_get_byIdGETTo retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$VOLUME SNAPSHOT ID.
Block Storage Action4
Initiate A Block Storage Action By Volume IdvolumeActions_post_byIdPOSTTo initiate an action on a block storage volume by Id, send a POST request to ~/v2/volumes/$VOLUME ID/actions.
Initiate A Block Storage Action By Volume NamevolumeActions_postPOSTTo initiate an action on a block storage volume by Name, send a POST request to ~/v2/volumes/actions.
List All Actions for a VolumevolumeActions_listGETTo retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME ID/actions.
Retrieve an Existing Volume ActionvolumeActions_getGETTo retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME ID/actions/$ACTION ID.
BYOIP Prefix6
Create a BYOIP PrefixbyoipPrefixes_createPOSTTo create a BYOIP prefix, send a POST request to /v2/byoip prefixes.
Delete a BYOIP PrefixbyoipPrefixes_deleteDELETETo delete a BYOIP prefix and remove it from your account, send a DELETE request to /v2/byoip prefixes/$byoip prefix uuid.
Get a BYOIP PrefixbyoipPrefixes_getGETTo get a BYOIP prefix, send a GET request to /v2/byoip prefixes/$byoip prefix uuid.
List BYOIP Prefix ResourcesbyoipPrefixes_list_resourcesGETTo list resources associated with BYOIP prefixes, send a GET request to /v2/byoip prefixes/{byoip prefix uuid}/ips.
List BYOIP PrefixesbyoipPrefixes_listGETTo list all BYOIP prefixes, send a GET request to /v2/byoip prefixes.
Update a BYOIP PrefixbyoipPrefixes_patchPATCHTo update a BYOIP prefix, send a PATCH request to /v2/byoip prefixes/$byoip prefix uuid.
CDN Endpoint6
Create a New CDN Endpointcdn_create_endpointPOSTTo create a new CDN endpoint, send a POST request to /v2/cdn/endpoints.
Delete a CDN Endpointcdn_delete_endpointDELETETo delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT ID.
List All CDN Endpointscdn_list_endpointsGETTo list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints.
Purge the Cache for an Existing CDN Endpointcdn_purge_cacheDELETETo purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT ID/cache.
Retrieve an Existing CDN Endpointcdn_get_endpointGETTo show information about an existing CDN endpoint, send a GET request to /v2/cdn/endpoints/$ENDPOINT ID.
Update a CDN Endpointcdn_update_endpointsPUTTo 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.
Certificate4
Create a New Certificatecertificates_createPOSTTo upload new SSL certificate which you have previously generated, send a POST request to /v2/certificates.
Delete a Certificatecertificates_deleteDELETETo delete a specific certificate, send a DELETE request to /v2/certificates/$CERTIFICATE ID.
List All Certificatescertificates_listGETTo list all of the certificates available on your account, send a GET request to /v2/certificates.
Retrieve an Existing Certificatecertificates_getGETTo show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE ID.
Container Registry37
Create Container Registryregistries_createPOSTTo create your container registry, send a POST request to /v2/registries.
Create Container Registryregistry_createPOSTNote: This endpoint is deprecated.
Delete Container Registryregistry_deleteDELETENote: This endpoint is deprecated.
Delete Container Registry By Nameregistries_deleteDELETETo delete your container registry, destroying all container image data stored in it, send a DELETE request to /v2/registries/{registry name}.
Delete Container Registry Repositoryregistries_delete_repositoryDELETETo delete a container repository including all of its tags, send a DELETE request to /v2/registries/$REGISTRY NAME/repositories/$REPOSITORY NAME.
Delete Container Registry Repository Manifestregistries_delete_repositoryManifestDELETETo 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.
Delete Container Registry Repository Manifestregistry_delete_repositoryManifestDELETENote: This endpoint is deprecated.
Delete Container Registry Repository Tagregistries_delete_repositoryTagDELETETo 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.
Delete Container Registry Repository Tagregistry_delete_repositoryTagDELETENote: This endpoint is deprecated.
Get a Container Registry By Nameregistries_getGETTo get information about any container registry in your account, send a GET request to /v2/registries/{registry name}.
Get Active Garbage Collectionregistries_get_garbageCollectionGETTo get information about the currently-active garbage collection for a registry, send a GET request to /v2/registry/$REGISTRY NAME/garbage-collection.
Get Active Garbage Collectionregistry_get_garbageCollectionGETNote: This endpoint is deprecated.
Get Container Registry Informationregistry_getGETNote: This endpoint is deprecated.
Get Docker Credentials By Registry Nameregistries_get_dockerCredentialsGETIn order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication.
Get Docker Credentials for Container Registryregistry_get_dockerCredentialsGETNote: This endpoint is deprecated.
Get Subscriptionregistry_get_subscriptionGETNote: This endpoint is deprecated.
Get Subscription Informationregistries_get_subscriptionGETA subscription is automatically created when you configure your container registry.
List All Container Registriesregistries_listGETTo get information about any container registry in your account, send a GET request to /v2/registries/.
List All Container Registry Repositoriesregistry_list_repositoriesGETNote: This endpoint is deprecated.
List All Container Registry Repositories (V2)registries_list_repositoriesV2GETTo list all repositories in your container registry, send a GET request to /v2/registries/$REGISTRY NAME/repositoriesV2.
List All Container Registry Repositories (V2)registry_list_repositoriesV2GETNote: This endpoint is deprecated.
List All Container Registry Repository Manifestsregistries_list_repositoryManifestsGETTo list all manifests in your container registry repository, send a GET request to /v2/registries/$REGISTRY NAME/repositories/$REPOSITORY NAME/digests.
List All Container Registry Repository Manifestsregistry_list_repositoryManifestsGETNote: This endpoint is deprecated.
List All Container Registry Repository Tagsregistries_list_repositoryTagsGETTo list all tags in one of your container registry's repository, send a GET request to /v2/registries/$REGISTRY NAME/repositories/$REPOSITORY NAME/tags.
List All Container Registry Repository Tagsregistry_list_repositoryTagsGETNote: This endpoint is deprecated.
List Garbage Collectionsregistries_list_garbageCollectionsGETTo get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY NAME/garbage-collections.
List Garbage Collectionsregistry_list_garbageCollectionsGETNote: This endpoint is deprecated.
List Registry Options (Subscription Tiers and Available Regions)registries_get_optionsGETThis endpoint serves to provide additional information as to which option values are available when creating a container registry.
List Registry Options (Subscription Tiers and Available Regions)registry_get_optionsGETNote: This endpoint is deprecated and may be removed in a future version.
Start Garbage Collectionregistries_run_garbageCollectionPOSTGarbage collection enables users to clear out unreferenced blobs (layer & manifest data) after deleting one or more manifests from a repository.
Start Garbage Collectionregistry_run_garbageCollectionPOSTNote: This endpoint is deprecated.
Update Garbage Collectionregistries_update_garbageCollectionPUTTo 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...
Update Garbage Collectionregistry_update_garbageCollectionPUTNote: This endpoint is deprecated.
Update Subscription Tierregistries_update_subscriptionPOSTAfter creating your registry, you can switch to a different subscription tier to better suit your needs.
Update Subscription Tierregistry_update_subscriptionPOSTNote: This endpoint is deprecated.
Validate a Container Registry Nameregistries_validate_namePOSTTo validate that a container registry name is available for use, send a POST request to /v2/registries/validate-name.
Validate a Container Registry Nameregistry_validate_namePOSTNote: This endpoint is deprecated.
Database71
Add a Database Userdatabases_add_userPOSTTo add a new database user, send a POST request to /v2/databases/$DATABASE ID/users with the desired username.
Add a New Connection Pool (PostgreSQL)databases_add_connectionPoolPOSTFor PostgreSQL database clusters, connection pools can be used to allow a database to share its idle connections.
Add a New Databasedatabases_addPOSTTo add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE ID/dbs.
Configure a Database Cluster's Maintenance Windowdatabases_update_maintenanceWindowPUTTo configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE ID/maintenance.
Configure Autoscale Settings for a Database Clusterdatabases_update_autoscalePUTTo configure autoscale settings for an existing database cluster, send a PUT request to /v2/databases/$DATABASE ID/autoscale, specifying the autoscale configuration.
Configure the Eviction Policy for a Caching or Valkey Clusterdatabases_update_evictionPolicyPUTTo 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.
Create a New Database Clusterdatabases_create_clusterPOSTTo create a database cluster, send a POST request to /v2/databases.
Create a Read-only Replicadatabases_create_replicaPOSTTo 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...
Create Logsink for a Database Clusterdatabases_create_logsinkPOSTTo create logsink for a database cluster, send a POST request to /v2/databases/$DATABASE ID/logsink.
Create Schema Registry for Kafka Clusterdatabases_create_kafka_schemaPOSTTo create a Kafka schema for a database cluster, send a POST request to /v2/databases/$DATABASE ID/schema-registry.
Create Topic for a Kafka Clusterdatabases_create_kafka_topicPOSTTo create a topic attached to a Kafka cluster, send a POST request to /v2/databases/$DATABASE ID/topics.
Delete a Connection Pool (PostgreSQL)databases_delete_connectionPoolDELETETo delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE ID/pools/$POOL NAME.
Delete a Databasedatabases_deleteDELETETo delete a specific database, send a DELETE request to /v2/databases/$DATABASE ID/dbs/$DB NAME.
Delete a Kafka Schema by Subject Namedatabases_delete_kafka_schemaDELETETo delete a specific schema by subject name for a Kafka cluster, send a DELETE request to /v2/databases/$DATABASE ID/schema-registry/$SUBJECT NAME.
Delete Index for OpenSearch Clusterdatabases_delete_opensearch_indexDELETETo delete a single index within OpenSearch cluster, send a DELETE request to /v2/databases/$DATABASE ID/indexes/$INDEX NAME.
Delete Logsink for a Database Clusterdatabases_delete_logsinkDELETETo delete a logsink for a database cluster, send a DELETE request to /v2/databases/$DATABASE ID/logsink/$LOGSINK ID.
Delete Topic for a Kafka Clusterdatabases_delete_kafka_topicDELETETo delete a single topic within a Kafka cluster, send a DELETE request to /v2/databases/$DATABASE ID/topics/$TOPIC NAME.
Destroy a Database Clusterdatabases_destroy_clusterDELETETo destroy a specific database, send a DELETE request to /v2/databases/$DATABASE ID.
Destroy a Read-only Replicadatabases_destroy_replicaDELETETo destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE ID/replicas/$REPLICA NAME.
Get a Kafka Schema by Subject Namedatabases_get_kafka_schemaGETTo get a specific schema by subject name for a Kafka cluster, send a GET request to /v2/databases/$DATABASE ID/schema-registry/$SUBJECT NAME.
Get Kafka Schema by Subject Versiondatabases_get_kafka_schema_versionGETTo 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.
Get Logsink for a Database Clusterdatabases_get_logsinkGETTo get a logsink for a database cluster, send a GET request to /v2/databases/$DATABASE ID/logsink/$LOGSINK ID.
Get Topic for a Kafka Clusterdatabases_get_kafka_topicGETTo 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.
List All Database Clustersdatabases_list_clustersGETTo list all of the database clusters available on your account, send a GET request to /v2/databases.
List all Database Usersdatabases_list_usersGETTo list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE ID/users.
List All Databasesdatabases_listGETTo list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE ID/dbs.
List all Events Logsdatabases_list_events_logsGETTo list all of the cluster events, send a GET request to /v2/databases/$DATABASE ID/events.
List All Read-only Replicasdatabases_list_replicasGETTo list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE ID/replicas.
List Backups for a Database Clusterdatabases_list_backupsGETTo list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE ID/backups.
List Connection Pools (PostgreSQL)databases_list_connectionPoolsGETTo list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE ID/pools.
List Database Optionsdatabases_list_optionsGETTo list all of the options available for the offered database engines, send a GET request to /v2/databases/options.
List Firewall Rules (Trusted Sources) for a Database Clusterdatabases_list_firewall_rulesGETTo 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.
List Indexes for a OpenSearch Clusterdatabases_list_opeasearch_indexesGETTo list all of a OpenSearch cluster's indexes, send a GET request to /v2/databases/$DATABASE ID/indexes.
List Logsinks for a Database Clusterdatabases_list_logsinkGETTo list logsinks for a database cluster, send a GET request to /v2/databases/$DATABASE ID/logsink.
List Schemas for Kafka Clusterdatabases_list_kafka_schemasGETTo list all schemas for a Kafka cluster, send a GET request to /v2/databases/$DATABASE ID/schema-registry.
List Topics for a Kafka Clusterdatabases_list_kafka_topicsGETTo list all of a Kafka cluster's topics, send a GET request to /v2/databases/$DATABASE ID/topics.
Migrate a Database Cluster to a New Regiondatabases_update_regionPUTTo migrate a database cluster to a new region, send a PUT request to /v2/databases/$DATABASE ID/migrate.
Promote a Read-only Replica to become a Primary Clusterdatabases_promote_replicaPUTTo promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE ID/replicas/$REPLICA NAME/promote.
Remove a Database Userdatabases_delete_userDELETETo remove a specific database user, send a DELETE request to /v2/databases/$DATABASE ID/users/$USERNAME.
Reset a Database User's Password or Authentication Methoddatabases_reset_authPOSTTo reset the password for a database user, send a POST request to /v2/databases/$DATABASE ID/users/$USERNAME/reset auth.
Resize a Database Clusterdatabases_update_clusterSizePUTTo resize a database cluster, send a PUT request to /v2/databases/$DATABASE ID/resize.
Retrieve an Existing Databasedatabases_getGETTo show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE ID/dbs/$DB NAME.
Retrieve an Existing Database Clusterdatabases_get_clusterGETTo show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE ID.
Retrieve an Existing Database Cluster Configurationdatabases_get_configGETShows configuration parameters for an existing database cluster by sending a GET request to /v2/databases/$DATABASE ID/config.
Retrieve an Existing Database Userdatabases_get_userGETTo show information about an existing database user, send a GET request to /v2/databases/$DATABASE ID/users/$USERNAME.
Retrieve an Existing Read-only Replicadatabases_get_replicaGETTo show information about an existing database replica, send a GET request to /v2/databases/$DATABASE ID/replicas/$REPLICA NAME.
Retrieve Autoscale Configuration for a Database Clusterdatabases_get_autoscaleGETTo retrieve the autoscale configuration for an existing database cluster, send a GET request to /v2/databases/$DATABASE ID/autoscale.
Retrieve Database Clusters' Metrics Endpoint Credentialsdatabases_get_cluster_metrics_credentialsGETTo show the credentials for all database clusters' metrics endpoints, send a GET request to /v2/databases/metrics/credentials.
Retrieve DO Settings for a Database Clusterdatabases_get_do_settingsGETTo retrieve the DigitalOcean-specific settings for a database cluster, send a GET request to /v2/databases/$DATABASE ID/do settings.
Retrieve Existing Connection Pool (PostgreSQL)databases_get_connectionPoolGETTo show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE ID/pools/$POOL NAME.
Retrieve Schema Registry Configuration for a kafka Clusterdatabases_get_kafka_schema_configGETTo retrieve the Schema Registry configuration for a Kafka cluster, send a GET request to /v2/databases/$DATABASE ID/schema-registry/config.
Retrieve Schema Registry Configuration for a Subject of kafkadatabases_get_kafka_schema_subject_configGETTo 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.
Retrieve the Eviction Policy for a Caching or Valkey Clusterdatabases_get_evictionPolicyGETTo retrieve the configured eviction policy for an existing Caching or Valkey cluster, send a GET request to /v2/databases/$DATABASE ID/eviction policy.
Retrieve the Public Certificatedatabases_get_caGETTo retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE ID/ca.
Retrieve the SQL Modes for a MySQL Clusterdatabases_get_sql_modeGETTo retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE ID/sql mode.
Retrieve the Status of an Online Migrationdatabases_get_migrationStatusGETTo retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE ID/online-migration.
Start an Online Migrationdatabases_update_onlineMigrationPUTTo start an online migration, send a PUT request to /v2/databases/$DATABASE ID/online-migration endpoint.
Start Database Maintenancedatabases_install_updatePUTTo start the installation of updates for a database cluster, send a PUT request to /v2/databases/$DATABASE ID/install update.
Stop an Online Migrationdatabases_delete_onlineMigrationDELETETo stop an online migration, send a DELETE request to /v2/databases/$DATABASE ID/online-migration/$MIGRATION ID.
Update a Database Userdatabases_update_userPUTTo update an existing database user, send a PUT request to /v2/databases/$DATABASE ID/users/$USERNAME with the desired settings.
Update Connection Pools (PostgreSQL)databases_update_connectionPoolPUTTo update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE ID/pools/$POOL NAME.
Update Database Clusters' Metrics Endpoint Credentialsdatabases_update_cluster_metrics_credentialsPUTTo update the credentials for all database clusters' metrics endpoints, send a PUT request to /v2/databases/metrics/credentials.
Update DO Settings for a Database Clusterdatabases_update_do_settingsPUTTo update the DigitalOcean-specific settings for a database cluster, send a PUT request to /v2/databases/$DATABASE ID/do settings.
Update Firewall Rules (Trusted Sources) for a Databasedatabases_update_firewall_rulesPUTTo 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...
Update Logsink for a Database Clusterdatabases_update_logsinkPUTTo update a logsink for a database cluster, send a PUT request to /v2/databases/$DATABASE ID/logsink/$LOGSINK ID.
Update Schema Registry Configuration for a kafka Clusterdatabases_update_kafka_schema_configPUTTo update the Schema Registry configuration for a Kafka cluster, send a PUT request to /v2/databases/$DATABASE ID/schema-registry/config.
Update Schema Registry Configuration for a Subject of kafkadatabases_update_kafka_schema_subject_configPUTTo 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.
Update SQL Mode for a Clusterdatabases_update_sql_modePUTTo configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE ID/sql mode specifying the desired modes.
Update the Database Configuration for an Existing Databasedatabases_patch_configPATCHTo update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE ID/config.
Update Topic for a Kafka Clusterdatabases_update_kafka_topicPUTTo update a topic attached to a Kafka cluster, send a PUT request to /v2/databases/$DATABASE ID/topics/$TOPIC NAME.
Upgrade Major Version for a Databasedatabases_update_major_versionPUTTo upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE ID/upgrade, specifying the target version.
Dedicated Inference13
Create a Dedicated InferencededicatedInferences_createPOSTCreate a new Dedicated Inference for your team.
Create a Dedicated Inference TokendedicatedInferences_create_tokensPOSTCreate a new access token for a Dedicated Inference instance.
Delete a Dedicated InferencededicatedInferences_deleteDELETEDelete an existing Dedicated Inference.
Get a Dedicated InferencededicatedInferences_getGETRetrieve an existing Dedicated Inference by ID.
Get a Dedicated Inference AcceleratordedicatedInferences_get_acceleratorGETRetrieve a single accelerator by ID for a Dedicated Inference instance.
Get Dedicated Inference CA CertificatededicatedInferences_get_caGETGet the CA certificate for a Dedicated Inference instance (base64-encoded).
Get Dedicated Inference GPU Model ConfigdedicatedInferences_get_gpu_model_configGETGet supported GPU and model configurations for Dedicated Inference.
List Dedicated Inference AcceleratorsdedicatedInferences_list_acceleratorsGETList all accelerators (GPUs) in use by a Dedicated Inference instance.
List Dedicated Inference SizesdedicatedInferences_list_sizesGETGet available Dedicated Inference sizes and pricing for supported GPUs.
List Dedicated Inference TokensdedicatedInferences_list_tokensGETList all access tokens for a Dedicated Inference instance.
List Dedicated InferencesdedicatedInferences_listGETList all Dedicated Inference instances for your team.
Revoke a Dedicated Inference TokendedicatedInferences_delete_tokensDELETERevoke (delete) an access token for a Dedicated Inference instance.
Update a Dedicated InferencededicatedInferences_patchPATCHUpdate an existing Dedicated Inference.
Domain4
Create a New Domaindomains_createPOSTTo create a new domain, send a POST request to /v2/domains.
Delete a Domaindomains_deleteDELETETo delete a domain, send a DELETE request to /v2/domains/$DOMAIN NAME.
List All Domainsdomains_listGETTo retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
Retrieve an Existing Domaindomains_getGETTo get details about a specific domain, send a GET request to /v2/domains/$DOMAIN NAME.
Domain Record6
Create a New Domain Recorddomains_create_recordPOSTTo create a new record to a domain, send a POST request to /v2/domains/$DOMAIN NAME/records.
Delete a Domain Recorddomains_delete_recordDELETETo delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN NAME/records/$DOMAIN RECORD ID.
List All Domain Recordsdomains_list_recordsGETTo get a listing of all records configured for a domain, send a GET request to /v2/domains/$DOMAIN NAME/records.
Retrieve an Existing Domain Recorddomains_get_recordGETTo retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN NAME/records/$RECORD ID.
Update a Domain Recorddomains_patch_recordPATCHTo update an existing record, send a PATCH request to /v2/domains/$DOMAIN NAME/records/$DOMAIN RECORD ID.
Update a Domain Recorddomains_update_recordPUTTo update an existing record, send a PUT request to /v2/domains/$DOMAIN NAME/records/$DOMAIN RECORD ID.
Droplet19
Check Status of a Droplet Destroy with Associated Resourcesdroplets_get_DestroyAssociatedResourcesStatusGETTo 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.
Create a New Dropletdroplets_createPOSTTo create a new Droplet, send a POST request to /v2/droplets setting the required attributes.
Delete an Existing Dropletdroplets_destroyDELETETo delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET ID.
Deleting Droplets by Tagdroplets_destroy_byTagDELETETo 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.
Destroy a Droplet and All of its Associated Resourcesdroplets_destroy_withAssociatedResourcesDangerousDELETETo 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.
List All Available Kernels for a Dropletdroplets_list_kernelsGETTo retrieve a list of all kernels available to a Droplet, send a GET request to /v2/droplets/$DROPLET ID/kernels
List All Droplet Neighborsdroplets_list_neighborsIdsGETTo 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.
List All Dropletsdroplets_listGETTo list all Droplets in your account, send a GET request to /v2/droplets.
List all Firewalls Applied to a Dropletdroplets_list_firewallsGETTo retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET ID/firewalls
List Associated Resources for a Dropletdroplets_list_associatedResourcesGETTo 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.
List Backup Policies for All Existing Dropletsdroplets_list_backup_policiesGETTo list information about the backup policies for all Droplets in the account, send a GET request to /v2/droplets/backups/policies.
List Backups for a Dropletdroplets_list_backupsGETTo retrieve any backups associated with a Droplet, send a GET request to /v2/droplets/$DROPLET ID/backups.
List Neighbors for a Dropletdroplets_list_neighborsGETTo 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.
List Snapshots for a Dropletdroplets_list_snapshotsGETTo retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET ID/snapshots.
List Supported Droplet Backup Policiesdroplets_list_supported_backup_policiesGETTo retrieve a list of all supported Droplet backup policies, send a GET request to /v2/droplets/backups/supported policies.
Retrieve an Existing Dropletdroplets_getGETTo show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET ID.
Retrieve the Backup Policy for an Existing Dropletdroplets_get_backup_policyGETTo show information about an individual Droplet's backup policy, send a GET request to /v2/droplets/$DROPLET ID/backups/policy.
Retry a Droplet Destroy with Associated Resources Requestdroplets_destroy_retryWithAssociatedResourcesPOSTIf 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...
Selectively Destroy a Droplet and its Associated Resourcesdroplets_destroy_withAssociatedResourcesSelectiveDELETETo 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.
Droplet Action4
Acting on Tagged DropletsdropletActions_post_byTagPOSTSome actions can be performed in bulk on tagged Droplets.
Initiate a Droplet ActiondropletActions_postPOSTTo initiate an action on a Droplet send a POST request to /v2/droplets/$DROPLET ID/actions.
List Actions for a DropletdropletActions_listGETTo retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET ID/actions.
Retrieve a Droplet ActiondropletActions_getGETTo retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET ID/actions/$ACTION ID.
Droplet Autoscale Pool8
Create a New Autoscale Poolautoscalepools_createPOSTTo create a new autoscale pool, send a POST request to /v2/droplets/autoscale setting the required attributes.
Delete autoscale poolautoscalepools_deleteDELETETo destroy an autoscale pool, send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE POOL ID endpoint.
Delete autoscale pool and resourcesautoscalepools_delete_dangerousDELETETo destroy an autoscale pool and its associated resources (Droplets), send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE POOL ID/dangerous endpoint.
List All Autoscale Poolsautoscalepools_listGETTo list all autoscale pools in your team, send a GET request to /v2/droplets/autoscale.
List history eventsautoscalepools_list_historyGETTo list all of the scaling history events of an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE POOL ID/history.
List membersautoscalepools_list_membersGETTo list the Droplets in an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE POOL ID/members.
Retrieve an Existing Autoscale Poolautoscalepools_getGETTo show information about an individual autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE POOL ID.
Update Autoscale Poolautoscalepools_updatePUTTo update the configuration of an existing autoscale pool, send a PUT request to /v2/droplets/autoscale/$AUTOSCALE POOL ID.
Firewall11
Add Droplets to a Firewallfirewalls_assign_dropletsPOSTTo assign a Droplet to a firewall, send a POST request to /v2/firewalls/$FIREWALL ID/droplets.
Add Rules to a Firewallfirewalls_add_rulesPOSTTo add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL ID/rules.
Add Tags to a Firewallfirewalls_add_tagsPOSTTo assign a tag representing a group of Droplets to a firewall, send a POST request to /v2/firewalls/$FIREWALL ID/tags.
Create a New Firewallfirewalls_createPOSTTo create a new firewall, send a POST request to /v2/firewalls.
Delete a Firewallfirewalls_deleteDELETETo delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL ID.
List All Firewallsfirewalls_listGETTo list all of the firewalls available on your account, send a GET request to /v2/firewalls.
Remove Droplets from a Firewallfirewalls_delete_dropletsDELETETo remove a Droplet from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL ID/droplets.
Remove Rules from a Firewallfirewalls_delete_rulesDELETETo remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL ID/rules.
Remove Tags from a Firewallfirewalls_delete_tagsDELETETo remove a tag representing a group of Droplets from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL ID/tags.
Retrieve an Existing Firewallfirewalls_getGETTo show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL ID.
Update a Firewallfirewalls_updatePUTTo update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL ID.
Floating IP4
Create a New Floating IPfloatingIPs_createPOSTOn creation, a floating IP must be either assigned to a Droplet or reserved to a region.
Delete a Floating IPfloatingIPs_deleteDELETETo delete a floating IP and remove it from your account, send a DELETE request to /v2/floating ips/$FLOATING IP ADDR.
List All Floating IPsfloatingIPs_listGETTo list all of the floating IPs available on your account, send a GET request to /v2/floating ips.
Retrieve an Existing Floating IPfloatingIPs_getGETTo show information about a floating IP, send a GET request to /v2/floating ips/$FLOATING IP ADDR.
Floating IP Action3
Initiate a Floating IP ActionfloatingIPsAction_postPOSTTo initiate an action on a floating IP send a POST request to /v2/floating ips/$FLOATING IP/actions.
List All Actions for a Floating IPfloatingIPsAction_listGETTo retrieve all actions that have been executed on a floating IP, send a GET request to /v2/floating ips/$FLOATING IP/actions.
Retrieve an Existing Floating IP ActionfloatingIPsAction_getGETTo retrieve the status of a floating IP action, send a GET request to /v2/floating ips/$FLOATING IP/actions/$ACTION ID.
Function13
Create a Namespace Access KeyfunctionsAccessKey_createPOSTCreates a new access key for a serverless functions namespace.
Create Namespacefunctions_create_namespacePOSTCreates a new serverless functions namespace in the desired region and associates it with the provided label.
Create Triggerfunctions_create_triggerPOSTCreates a new trigger for a given function in a namespace.
Delete a Namespace Access KeyfunctionsAccessKey_deleteDELETEDeletes an access key for a serverless functions namespace.
Delete Namespacefunctions_delete_namespaceDELETEDeletes the given namespace.
Delete Triggerfunctions_delete_triggerDELETEDeletes the given trigger.
Get Namespacefunctions_get_namespaceGETGets the namespace details for the given namespace UUID.
Get Triggerfunctions_get_triggerGETGets the trigger details.
List Namespace Access KeysfunctionsAccessKey_listGETLists all access keys for a serverless functions namespace.
List Namespacesfunctions_list_namespacesGETReturns a list of namespaces associated with the current user.
List Triggersfunctions_list_triggersGETReturns a list of triggers associated with the current user and namespace.
Update a Namespace Access KeyfunctionsAccessKey_updatePUTUpdates the name of an access key for a serverless functions namespace.
Update Triggerfunctions_update_triggerPUTUpdates the details of the given trigger.
GradientAI Platform119
Add Agent Route to an Agentgenai_attach_agentPOSTTo add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent agent uuid}/child agents/{child agent uuid}.
Add Data Source to a Knowledge Basegenai_create_knowledge_base_data_sourcePOSTTo add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge bases/{knowledge base uuid}/data sources.
Add Function Route to an Agentgenai_attach_agent_functionPOSTTo create a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent uuid}/functions.
Attach Guardrails to an Agentgenai_attach_agent_guardrailsPOSTTo attach guardrails to an agent, send a POST request to /v2/gen-ai/agents/{agent uuid}/guardrails.
Attach Knowledge Base to an Agentgenai_attach_knowledge_basePOSTTo attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent uuid}/knowledge bases/{knowledge base uuid}
Attach Knowledge Bases to an Agentgenai_attach_knowledge_basesPOSTTo attach knowledge bases to an agent, send a POST request to /v2/gen-ai/agents/{agent uuid}/knowledge bases
Cancel Indexing Job for a Knowledge Basegenai_cancel_indexing_jobPUTTo cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing jobs/{uuid}/cancel.
Cancel Model Evaluation Rungenai_cancel_model_evaluation_runPUTTo cancel an in-progress model evaluation run, send a PUT request to /v2/gen-ai/model evaluation runs/{eval run uuid}/cancel.
Create a Knowledge Basegenai_create_knowledge_basePOSTTo create a knowledge base, send a POST request to /v2/gen-ai/knowledge bases.
Create a Model API Keygenai_create_model_api_keyPOSTNote: This endpoint is deprecated and has been retired.
Create a Model Routergenai_create_model_routerPOSTTo create a model router, send a POST request to /v2/gen-ai/models/routers.
Create a Workspacegenai_create_workspacePOSTTo create a new workspace, send a POST request to /v2/gen-ai/workspaces.
Create an Agentgenai_create_agentPOSTTo create a new agent, send a POST request to /v2/gen-ai/agents.
Create an Agent API Keygenai_create_agent_api_keyPOSTTo create an agent API key, send a POST request to /v2/gen-ai/agents/{agent uuid}/api keys.
Create Anthropic API Keygenai_create_anthropic_api_keyPOSTTo create an Anthropic API key, send a POST request to /v2/gen-ai/anthropic/keys.
Create Custom Evaluation Metricgenai_create_custom_evaluation_metricPOSTTo create a custom LLM-as-judge metric for model evaluation, send a POST request to /v2/gen-ai/custom evaluation metrics.
Create Evaluation Datasetgenai_create_evaluation_datasetPOSTTo create an evaluation dataset, send a POST request to /v2/gen-ai/evaluation datasets.
Create Evaluation Test Case.genai_create_evaluation_test_casePOSTTo create an evaluation test-case send a POST request to /v2/gen-ai/evaluation test cases.
Create Model Evaluation Rungenai_create_model_evaluation_runPOSTTo create a model evaluation run, send a POST request to /v2/genai/model evaluation runs.
Create OpenAI API Keygenai_create_openai_api_keyPOSTTo create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.
Create Presigned URLs for Data Source File Uploadgenai_create_data_source_file_upload_presigned_urlsPOSTTo 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.
Create Presigned URLs for Evaluation Dataset File Uploadgenai_create_evaluation_dataset_file_upload_presigned_urlsPOSTTo create presigned URLs for evaluation dataset file upload, send a POST request to /v2/gen-ai/evaluation datasets/file upload presigned urls.
Create Presigned URLs for Model Evaluation Dataset File Uploadgenai_create_model_eval_dataset_upload_presigned_urlsPOSTTo create presigned URLs for model evaluation dataset file upload, send a POST request to /v2/genai/model evaluation/datasets/file upload presigned urls.
Create scheduled indexing for knowledge basegenai_create_scheduled_indexingPOSTTo create scheduled indexing for a knowledge base, send a POST request to /v2/gen-ai/scheduled-indexing.
Delete a Data Source from a Knowledge Basegenai_delete_knowledge_base_data_sourceDELETETo 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}.
Delete a Knowledge Basegenai_delete_knowledge_baseDELETETo delete a knowledge base, send a DELETE request to /v2/gen-ai/knowledge bases/{uuid}.
Delete a Model Routergenai_delete_model_routerDELETETo delete a model router, send a DELETE request to /v2/gen-ai/models/routers/{uuid}.
Delete a Workspacegenai_delete_workspaceDELETETo delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace uuid}.
Delete Agent Route for an Agentgenai_detach_agentDELETETo 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}.
Delete an Agentgenai_delete_agentDELETETo delete an agent, send a DELETE request to /v2/gen-ai/agents/{uuid}.
Delete Anthropic API Keygenai_delete_anthropic_api_keyDELETETo delete an Anthropic API key, send a DELETE request to /v2/gen-ai/anthropic/keys/{api key uuid}.
Delete API Key for a Modelgenai_delete_model_api_keyDELETETo delete an API key for a model, send a DELETE request to /v2/gen-ai/models/api keys/{api key uuid}.
Delete API Key for an Agentgenai_delete_agent_api_keyDELETETo delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent uuid}/api keys/{api key uuid}.
Delete Custom Evaluation Metricgenai_delete_custom_evaluation_metricDELETETo soft-delete a custom model evaluation metric, send a DELETE request to /v2/gen-ai/custom evaluation metrics/{metric uuid}.
Delete Custom Modelgenai_delete_custom_modelDELETETo delete a custom model, send a DELETE request to /v2/genai/custom models/{uuid}.
Delete Evaluation Datasetgenai_delete_evaluation_datasetDELETETo delete an evaluation dataset, send a DELETE request to /v2/genai/evaluation datasets/{dataset uuid}.
Delete Function Route for an Agentgenai_detach_agent_functionDELETETo delete a function route from an agent, send a DELETE request to /v2/gen-ai/agents/{agent uuid}/functions/{function uuid}.
Delete Model Evaluation Presetgenai_delete_model_evaluation_presetDELETETo delete a saved model evaluation preset, send a DELETE request to /v2/gen-ai/model evaluation presets/{eval preset uuid}.
Delete Model Evaluation Rungenai_delete_model_evaluation_runDELETETo delete a model evaluation run, send a DELETE request to /v2/gen-ai/model evaluation runs/{eval run uuid}.
Delete OpenAI API Keygenai_delete_openai_api_keyDELETETo delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api key uuid}.
Delete Scheduled Indexinggenai_delete_scheduled_indexingDELETEDelete Scheduled Indexing for knowledge base, send a DELETE request to /v2/gen-ai/scheduled-indexing/{uuid}.
Detach a Guardrail from an Agentgenai_detach_agent_guardrailDELETETo detach a guardrail from an agent, send a DELETE request to /v2/gen-ai/agents/{agent uuid}/guardrails/{guardrail uuid}.
Detach Knowledge Base from an Agentgenai_detach_knowledge_baseDELETETo detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent uuid}/knowledge bases/{knowledge base uuid}.
Get Agent Usagegenai_get_agent_usageGETTo get agent usage, send a GET request to /v2/gen-ai/agents/{uuid}/usage.
Get Anthropic API Keygenai_get_anthropic_api_keyGETTo retrieve details of an Anthropic API key, send a GET request to /v2/gen-ai/anthropic/keys/{api key uuid}.
Get Custom Modelgenai_get_custom_modelGETTo retrieve details of a custom model, send a GET request to /v2/gen-ai/custom models/{uuid}.
Get Download URL for Evaluation Datasetgenai_get_evaluation_dataset_download_urlGETTo get a presigned download URL for an evaluation dataset, send a GET request to /v2/genai/evaluation datasets/{dataset uuid}/download url.
Get Download URL for Model Evaluation Run Resultsgenai_get_model_evaluation_run_results_download_urlGETTo 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.
Get Model Catalog Cardgenai_get_model_catalog_cardGETReturns detailed information for a specific model in the catalog including capabilities, pricing, and code examples.
Get Oauth2 Dropbox Tokensgenai_create_oauth2_dropbox_tokensPOSTTo obtain the refresh token, needed for creation of data sources, send a GET request to /v2/gen-ai/oauth2/dropbox/tokens.
Get Oauth2 URLgenai_get_oauth2_urlGET
Get OpenAI API Keygenai_get_openai_api_keyGETTo retrieve details of an OpenAI API key, send a GET request to /v2/gen-ai/openai/keys/{api key uuid}.
Get Scheduled Indexing for Knowledge Basegenai_get_scheduled_indexingGETGet Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge base uuid}.
Get Signed URL for Indexing Job Detailsgenai_get_indexing_job_details_signed_urlGETTo get a signed URL for indexing job details, send a GET request to /v2/gen-ai/indexing jobs/{uuid}/details signed url.
Import Custom Modelgenai_import_custom_modelPOSTTo import a custom model, send a POST request to /v2/gen-ai/custom models/import.
List Agent API Keysgenai_list_agent_api_keysGETTo list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent uuid}/api keys.
List Agent Versionsgenai_list_agent_versionsGETTo list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.
List Agentsgenai_list_agentsGETTo list all agents, send a GET request to /v2/gen-ai/agents.
List agents by Anthropic keygenai_list_agents_by_anthropic_keyGETList Agents by Anthropic Key.
List agents by OpenAI keygenai_list_agents_by_openai_keyGETList Agents by OpenAI Key.
List agents by Workspacegenai_list_agents_by_workspaceGETTo list all agents by a Workspace, send a GET request to /v2/gen-ai/workspaces/{workspace uuid}/agents.
List Anthropic API Keysgenai_list_anthropic_api_keysGETTo list all Anthropic API keys, send a GET request to /v2/gen-ai/anthropic/keys.
List Available Modelsgenai_list_modelsGETTo list all models, send a GET request to /v2/gen-ai/models.
List Custom Modelsgenai_list_custom_modelsGETTo list custom models, send a GET request to /v2/gen-ai/custom models.
List Data Sources for a Knowledge Basegenai_list_knowledge_base_data_sourcesGETTo list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge bases/{knowledge base uuid}/data sources.
List Data Sources for Indexing Job for a Knowledge Basegenai_list_indexing_job_data_sourcesGETTo list all datasources for an indexing job, send a GET request to /v2/gen-ai/indexing jobs/{indexing job uuid}/data sources.
List Datacenter Regionsgenai_list_datacenter_regionsGETTo list all datacenter regions, send a GET request to /v2/gen-ai/regions.
List Evaluation Datasetsgenai_list_evaluation_datasetsGETTo list evaluation datasets, send a GET request to /v2/gen-ai/evaluation datasets.
List Evaluation Metricsgenai_list_evaluation_metricsGETTo list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation metrics.
List Evaluation Runs by Test Casegenai_list_evaluation_runs_by_test_caseGETTo list all evaluation runs by test case, send a GET request to /v2/gen-ai/evaluation test cases/{evaluation test case uuid}/evaluation runs.
List Evaluation Test Casesgenai_list_evaluation_test_casesGETTo list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation test cases.
List Evaluation Test Cases by Workspacegenai_list_evaluation_test_cases_by_workspaceGETTo list all evaluation test cases by a workspace, send a GET request to /v2/gen-ai/workspaces/{workspace uuid}/evaluation test cases.
List Indexing Jobs for a Knowledge Basegenai_list_indexing_jobsGETTo list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing jobs.
List Indexing Jobs for a Knowledge Basegenai_list_indexing_jobs_by_knowledge_baseGETTo list latest 15 indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/knowledge bases/{knowledge base uuid}/indexing jobs.
List Knowledge Basesgenai_list_knowledge_basesGETTo list all knowledge bases, send a GET request to /v2/gen-ai/knowledge bases.
List Model API Keysgenai_list_model_api_keysGETTo list all model API keys, send a GET request to /v2/gen-ai/models/api keys.
List Model Cataloggenai_list_model_catalogGETReturns all available models.
List Model Evaluation Metricsgenai_list_model_evaluation_metricsGETTo list all available metrics for model evaluation, send a GET request to /v2/genai/model evaluation metrics.
List Model Evaluation Presetsgenai_list_model_evaluation_presetsGETTo list all saved model evaluation presets, send a GET request to /v2/genai/model evaluation presets.
List Model Evaluation Runsgenai_list_model_evaluation_runsGETTo list model evaluation runs, send a GET request to /v2/genai/model evaluation runs.
List Model Router Presetsgenai_list_model_router_presetsGETTo list model router presets, send a GET request to /v2/gen-ai/models/routers/presets.
List Model Router Task Presetsgenai_list_model_router_task_presetsGETTo list model router task presets, send a GET request to /v2/gen-ai/models/routers/tasks/presets.
List Model Routersgenai_list_model_routersGETTo list model routers, send a GET request to /v2/gen-ai/models/routers.
List OpenAI API Keysgenai_list_openai_api_keysGETTo list all OpenAI API keys, send a GET request to /v2/gen-ai/openai/keys.
List Workspacesgenai_list_workspacesGETTo list all workspaces, send a GET request to /v2/gen-ai/workspaces.
Move Agents to a Workspacegenai_update_agents_workspacePUTTo move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace uuid}/agents.
Regenerate API Key for a Modelgenai_regenerate_model_api_keyPUTTo regenerate a model API key, send a PUT request to /v2/gen-ai/models/api keys/{api key uuid}/regenerate.
Regenerate API Key for an Agentgenai_regenerate_agent_api_keyPUTTo regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent uuid}/api keys/{api key uuid}/regenerate.
Retrieve an Existing Agentgenai_get_agentGETTo retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}.
Retrieve an Existing Model Routergenai_get_model_routerGETTo retrieve details of a model router, send a GET request to /v2/gen-ai/models/routers/{uuid}.
Retrieve an Existing Workspacegenai_get_workspaceGETTo retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace uuid}.
Retrieve Information About an Existing Evaluation Rungenai_get_evaluation_runGETTo retrive information about an existing evaluation run, send a GET request to /v2/gen-ai/evaluation runs/{evaluation run uuid}.
Retrieve Information About an Existing Evaluation Test Casegenai_get_evaluation_test_caseGETTo retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation test case/{test case uuid}.
Retrieve Information About an Existing Knowledge Basegenai_get_knowledge_baseGETTo retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge bases/{uuid}.
Retrieve Model Evaluation Presetgenai_get_model_evaluation_presetGETTo retrieve a saved model evaluation preset, send a GET request to /v2/genai/model evaluation presets/{eval preset uuid}.
Retrieve Model Evaluation Rungenai_get_model_evaluation_runGETTo retrieve a model evaluation run, send a GET request to /v2/genai/model evaluation runs/{eval run uuid}.
Retrieve Results of an Evaluation Rungenai_get_evaluation_run_resultsGETTo retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation runs/{evaluation run uuid}/results.
Retrieve Results of an Evaluation Run Promptgenai_get_evaluation_run_prompt_resultsGETTo retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation runs/{evaluation run uuid}/results/{prompt id}.
Retrieve Status of Indexing Job for a Knowledge Basegenai_get_indexing_jobGETTo get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing jobs/{uuid}.
Rollback to Agent Versiongenai_rollback_to_agent_versionPUTTo update to a specific agent version, send a PUT request to /v2/gen-ai/agents/{uuid}/versions.
Run an Evaluation Test Casegenai_run_evaluation_test_casePOSTTo run an evaluation test case, send a POST request to /v2/gen-ai/evaluation runs.
Start Indexing Job for a Knowledge Basegenai_create_indexing_jobPOSTTo start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing jobs.
Update a Knowledge Basegenai_update_knowledge_basePUTTo update a knowledge base, send a PUT request to /v2/gen-ai/knowledge bases/{uuid}.
Update a Model Routergenai_update_model_routerPUTTo update a model router, send a PUT request to /v2/gen-ai/models/routers/{uuid}.
Update a Workspacegenai_update_workspacePUTTo update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace uuid}.
Update Agent Route for an Agentgenai_update_attached_agentPUTTo update an agent route for an agent, send a PUT request to /v2/gen-ai/agents/{parent agent uuid}/child agents/{child agent uuid}.
Update Agent Statusgenai_update_agent_deployment_visibilityPUTCheck whether an agent is public or private.
Update an Agentgenai_update_agentPUTTo update an agent, send a PUT request to /v2/gen-ai/agents/{uuid}.
Update an Evaluation Test Case.genai_update_evaluation_test_casePUTTo update an evaluation test-case send a PUT request to /v2/gen-ai/evaluation test cases/{test case uuid}.
Update Anthropic API Keygenai_update_anthropic_api_keyPUTTo update an Anthropic API key, send a PUT request to /v2/gen-ai/anthropic/keys/{api key uuid}.
Update API Key for a Modelgenai_update_model_api_keyPUTTo update a model API key, send a PUT request to /v2/gen-ai/models/api keys/{api key uuid}.
Update API Key for an Agentgenai_update_agent_api_keyPUTTo update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent uuid}/api keys/{api key uuid}.
Update Custom Evaluation Metricgenai_update_custom_evaluation_metricPUTTo update a custom metric (issuing a new metric UUID), send a PUT request to /v2/gen-ai/custom evaluation metrics/{metric uuid}.
Update Custom Model Metadatagenai_update_custom_model_metadataPATCHTo update custom model metadata, send a PATCH request to /v2/gen-ai/custom models/{uuid}/metadata.
Update Data Source optionsgenai_update_knowledge_base_data_sourcePUTTo 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}.
Update Function Route for an Agentgenai_update_agent_functionPUTTo update the function route, send a PUT request to /v2/gen-ai/agents/{agent uuid}/functions/{function uuid}.
Update Model Evaluation Rungenai_update_model_evaluation_runPATCHTo update a model evaluation run's display name, send a PATCH request to /v2/gen-ai/model evaluation runs/{eval run uuid}.
Update OpenAI API Keygenai_update_openai_api_keyPUTTo update an OpenAI API key, send a PUT request to /v2/gen-ai/openai/keys/{api key uuid}.
View Agent Routesgenai_get_agent_childrenGETTo view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child agents.
Image9
Accept an Image Account Transferimages_post_account_transfer_acceptPOSTTo accept an account transfer for an image, send a POST request to /v2/images/$IMAGE ID/account transfer/accept.
Cancel an Image Account Transferimages_post_account_transfer_cancelPOSTTo cancel an account transfer for an image, send a POST request to /v2/images/$IMAGE ID/account transfer/cancel.
Create a Custom Imageimages_create_customPOSTTo create a new custom image, send a POST request to /v2/images.
Decline an Image Account Transferimages_post_account_transfer_declinePOSTTo decline an account transfer for an image, send a POST request to /v2/images/$IMAGE ID/account transfer/decline.
Delete an Imageimages_deleteDELETETo delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE ID.
Initiate an Image Account Transferimages_post_account_transfer_createPOSTTo initiate an account transfer for an image, send a POST request to /v2/images/$IMAGE ID/account transfer.
List All Imagesimages_listGETTo list all of the images available on your account, send a GET request to /v2/images.
Retrieve an Existing Imageimages_getGETTo retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
Update an Imageimages_updatePUTTo update an image, send a PUT request to /v2/images/$IMAGE ID.
Image Action3
Initiate an Image ActionimageActions_postPOSTThe following actions are available on an Image.
List All Actions for an ImageimageActions_listGETTo retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE ID/actions.
Retrieve an Existing ActionimageActions_getGETTo retrieve the status of an image action, send a GET request to /v2/images/$IMAGE ID/actions/$IMAGE ACTION ID.
Kubernete28
Add a Node Pool to a Kubernetes Clusterkubernetes_add_nodePoolPOSTTo add an additional node pool to a Kubernetes clusters, send a POST request to /v2/kubernetes/clusters/$K8S CLUSTER ID/node pools with the following attributes.
Add Container Registries to Kubernetes Clusterskubernetes_add_registriesPOSTTo integrate the container registries with Kubernetes clusters, send a POST request to /v2/kubernetes/registries.
Add Container Registry to Kubernetes Clusterskubernetes_add_registryPOSTTo integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.
Create a New Kubernetes Clusterkubernetes_create_clusterPOSTTo create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters.
Delete a Cluster and All of its Associated Resources (Dangerous)kubernetes_destroy_associatedResourcesDangerousDELETETo 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.
Delete a Kubernetes Clusterkubernetes_delete_clusterDELETETo delete a Kubernetes cluster and all services deployed to it, send a DELETE request to /v2/kubernetes/clusters/$K8S CLUSTER ID.
Delete a Node in a Kubernetes Clusterkubernetes_delete_nodeDELETETo 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.
Delete a Node Pool in a Kubernetes Clusterkubernetes_delete_nodePoolDELETETo delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S CLUSTER ID/node pools/$NODE POOL ID.
Fetch Clusterlint Diagnostics for a Kubernetes Clusterkubernetes_get_clusterLintResultsGETTo request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S CLUSTER ID/clusterlint.
Fetch Status Messages for a Kubernetes Clusterkubernetes_get_status_messagesGETTo retrieve status messages for a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S CLUSTER ID/status messages.
List All Kubernetes Clusterskubernetes_list_clustersGETTo list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
List All Node Pools in a Kubernetes Clusterskubernetes_list_nodePoolsGETTo list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S CLUSTER ID/node pools.
List Associated Resources for Cluster Deletionkubernetes_list_associatedResourcesGETTo 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...
List Available Regions, Node Sizes, and Versions of Kuberneteskubernetes_list_optionsGETTo 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.
Recycle a Kubernetes Node Poolkubernetes_recycle_node_poolPOSTThe endpoint has been deprecated.
Remove Container Registries from Kubernetes Clusterskubernetes_remove_registriesDELETETo remove the container registries from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registries.
Remove Container Registry from Kubernetes Clusterskubernetes_remove_registryDELETETo remove the container registry from Kubernetes clusters, send a DELETE request to /v2/kubernetes/registry.
Retrieve a Node Pool for a Kubernetes Clusterkubernetes_get_nodePoolGETTo 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.
Retrieve an Existing Kubernetes Clusterkubernetes_get_clusterGETTo show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S CLUSTER ID.
Retrieve Available Upgrades for an Existing Kubernetes Clusterkubernetes_get_availableUpgradesGETTo 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.
Retrieve Credentials for a Kubernetes Clusterkubernetes_get_credentialsGETThis endpoint returns a JSON object .
Retrieve the kubeconfig for a Kubernetes Clusterkubernetes_get_kubeconfigGETThis endpoint returns a kubeconfig file in YAML format.
Retrieve User Information for a Kubernetes Clusterkubernetes_get_clusterUserGETTo show information the user associated with a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S CLUSTER ID/user.
Run Clusterlint Checks on a Kubernetes Clusterkubernetes_run_clusterLintPOSTClusterlint helps operators conform to Kubernetes best practices around resources, security and reliability to avoid common problems while operating or upgrading the clusters.
Selectively Delete a Cluster and its Associated Resourceskubernetes_destroy_associatedResourcesSelectiveDELETETo 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.
Update a Kubernetes Clusterkubernetes_update_clusterPUTTo update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S CLUSTER ID and specify one or more of the attributes below.
Update a Node Pool in a Kubernetes Clusterkubernetes_update_nodePoolPUTTo 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...
Upgrade a Kubernetes Clusterkubernetes_upgrade_clusterPOSTTo immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S CLUSTER ID/upgrade.
Load Balancer10
Add Droplets to a Load BalancerloadBalancers_add_dropletsPOSTTo assign a Droplet to a load balancer instance, send a POST request to /v2/load balancers/$LOAD BALANCER ID/droplets.
Add Forwarding Rules to a Load BalancerloadBalancers_add_forwardingRulesPOSTTo add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load balancers/$LOAD BALANCER ID/forwarding rules.
Create a New Load BalancerloadBalancers_createPOSTTo create a new load balancer instance, send a POST request to /v2/load balancers.
Delete a Global Load Balancer CDN CacheloadBalancers_delete_cacheDELETETo delete a Global load balancer CDN cache, send a DELETE request to /v2/load balancers/$LOAD BALANCER ID/cache.
Delete a Load BalancerloadBalancers_deleteDELETETo 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.
List All Load BalancersloadBalancers_listGETTo list all of the load balancer instances on your account, send a GET request to /v2/load balancers.
Remove Droplets from a Load BalancerloadBalancers_remove_dropletsDELETETo remove a Droplet from a load balancer instance, send a DELETE request to /v2/load balancers/$LOAD BALANCER ID/droplets.
Remove Forwarding Rules from a Load BalancerloadBalancers_remove_forwardingRulesDELETETo remove forwarding rules from a load balancer instance, send a DELETE request to /v2/load balancers/$LOAD BALANCER ID/forwarding rules.
Retrieve an Existing Load BalancerloadBalancers_getGETTo show information about a load balancer instance, send a GET request to /v2/load balancers/$LOAD BALANCER ID.
Update a Load BalancerloadBalancers_updatePUTTo update a load balancer's settings, send a PUT request to /v2/load balancers/$LOAD BALANCER ID.
Monitoring72
Create Alert Policymonitoring_create_alertPolicyPOSTTo create a new alert, send a POST request to /v2/monitoring/alerts.
Create Logging Destinationmonitoring_create_destinationPOSTTo create a new destination, send a POST request to /v2/monitoring/sinks/destinations.
Create Sinkmonitoring_create_sinkPOSTTo create a new sink, send a POST request to /v2/monitoring/sinks.
Delete an Alert Policymonitoring_delete_alertPolicyDELETETo delete an alert policy, send a DELETE request to /v2/monitoring/alerts/{alert uuid}
Delete Logging Destinationmonitoring_delete_destinationDELETETo delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination uuid}.
Delete Sinkmonitoring_delete_sinkDELETETo delete a sink, send a DELETE request to /v2/monitoring/sinks/${sink uuid}.
Get App CPU Percentage Metricsmonitoring_get_appCPUPercentageMetricsGETTo retrieve cpu percentage metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/cpu percentage.
Get App Memory Percentage Metricsmonitoring_get_appMemoryPercentageMetricsGETTo retrieve memory percentage metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/memory percentage.
Get App Restart Count Metricsmonitoring_get_appRestartCountMetrics_ymlGETTo retrieve restart count metrics for a given app, send a GET request to /v2/monitoring/metrics/apps/restart count.
Get Database MySQL CPU Usage Metricsmonitoring_get_database_mysql_cpu_usageGETRetrieve CPU usage (percent) for a MySQL cluster.
Get Database MySQL Disk Usage Metricsmonitoring_get_database_mysql_disk_usageGETRetrieve disk usage (percent) for a MySQL cluster.
Get Database MySQL Index vs Sequential Reads Metricsmonitoring_get_database_mysql_index_vs_sequential_readsGETRetrieve index vs sequential reads ratio (percent) for a MySQL service - i.e. percentage of reads using an index.
Get Database MySQL Load Average Metricsmonitoring_get_database_mysql_loadGETRetrieve load metrics for a MySQL cluster.
Get Database MySQL Memory Usage Metricsmonitoring_get_database_mysql_memory_usageGETRetrieve memory usage (percent) for a MySQL cluster.
Get Database MySQL Operations Throughput Metricsmonitoring_get_database_mysql_op_ratesGETRetrieve operations rate (per second) for a MySQL service.
Get Database MySQL Schema Latency Metricsmonitoring_get_database_mysql_schema_latencyGETRetrieve table I/O latency (seconds) for a schema.
Get Database MySQL Schema Throughput Metricsmonitoring_get_database_mysql_schema_throughputGETRetrieve table I/O throughput (rows per second) for a schema.
Get Database MySQL Threads Active Metricsmonitoring_get_database_mysql_threads_activeGETRetrieve active (running) threads for a MySQL service.
Get Database MySQL Threads Connected Metricsmonitoring_get_database_mysql_threads_connectedGETRetrieve current threads connected for a MySQL service (gauge).
Get Database MySQL Threads Created Rate Metricsmonitoring_get_database_mysql_threads_created_rateGETRetrieve threads created rate for a MySQL service (per second).
Get Droplet Autoscale Pool Current Average CPU utilizationmonitoring_get_droplet_autoscale_current_cpu_utilization_ymlGETTo 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.
Get Droplet Autoscale Pool Current Average Memory utilizationmonitoring_get_droplet_autoscale_current_memory_utilizationGETTo 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.
Get Droplet Autoscale Pool Current Sizemonitoring_get_droplet_autoscale_current_instancesGETTo retrieve the current size for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet autoscale/current instances.
Get Droplet Autoscale Pool Target Average CPU utilizationmonitoring_get_droplet_autoscale_target_cpu_utilizationGETTo 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.
Get Droplet Autoscale Pool Target Average Memory utilizationmonitoring_get_droplet_autoscale_target_memory_utilizationGETTo 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.
Get Droplet Autoscale Pool Target Sizemonitoring_get_droplet_autoscale_target_instancesGETTo retrieve the target size for a given Droplet Autoscale Pool, send a GET request to /v2/monitoring/metrics/droplet autoscale/target instances.
Get Droplet Available Memory Metricsmonitoring_get_dropletMemoryAvailableMetricsGETTo retrieve available memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory available.
Get Droplet Bandwidth Metricsmonitoring_get_dropletBandwidthMetricsGETTo retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth.
Get Droplet Cached Memory Metricsmonitoring_get_dropletMemoryCachedMetricsGETTo retrieve cached memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory cached.
Get Droplet CPU Metricsmonitoring_get_DropletCpuMetricsGETTo retrieve CPU metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/cpu.
Get Droplet Filesystem Free Metricsmonitoring_get_dropletFilesystemFreeMetricsGETTo retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem free.
Get Droplet Filesystem Size Metricsmonitoring_get_dropletFilesystemSizeMetricsGETTo retrieve filesystem size metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem size.
Get Droplet Free Memory Metricsmonitoring_get_dropletMemoryFreeMetricsGETTo retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory free.
Get Droplet Load1 Metricsmonitoring_get_dropletLoad1MetricsGETTo retrieve 1 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load 1.
Get Droplet Load15 Metricsmonitoring_get_dropletLoad15MetricsGETTo retrieve 15 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load 15.
Get Droplet Load5 Metricsmonitoring_get_dropletLoad5MetricsGETTo retrieve 5 minute load average metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/load 5.
Get Droplet Total Memory Metricsmonitoring_get_dropletMemoryTotalMetricsGETTo retrieve total memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory total.
Get Load Balancer Droplets 50th Percentile HTTP Response Timemonitoring_get_lb_droplets_http_response_time_50pGETTo 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.
Get Load Balancer Droplets 50th Percentile HTTP Sessionmonitoring_get_lb_droplets_http_session_duration_50pGETTo 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...
Get Load Balancer Droplets 95th Percentile HTTP Response Timemonitoring_get_lb_droplets_http_response_time_95pGETTo 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.
Get Load Balancer Droplets 95th Percentile HTTP Sessionmonitoring_get_lb_droplets_http_session_duration_95pGETTo 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...
Get Load Balancer Droplets 99th Percentile HTTP Response Timemonitoring_get_lb_droplets_http_response_time_99pGETTo 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.
Get Load Balancer Droplets Active Connections Metricsmonitoring_get_lb_droplets_connectionsGETTo retrieve Droplets active connections for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/droplets connections.
Get Load Balancer Droplets Average HTTP Response Time Metricsmonitoring_get_lb_droplets_http_response_time_avgGETTo 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.
Get Load Balancer Droplets Average HTTP Session Duration Metricsmonitoring_get_lb_droplets_http_session_duration_avgGETTo 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.
Get Load Balancer Droplets Downtime Status Metricsmonitoring_get_lb_droplets_downtimeGETTo retrieve Droplets downtime status for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/droplets downtime.
Get Load Balancer Droplets Health Check Status Metricsmonitoring_get_lb_droplets_health_checksGETTo retrieve Droplets health check status for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/droplets health checks.
Get Load Balancer Droplets HTTP Rate Of Response Code Metricsmonitoring_get_lb_droplets_http_responsesGETTo 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.
Get Load Balancer Droplets Queue Size Metricsmonitoring_get_lb_droplets_queue_sizeGETTo retrieve Droplets queue size for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/droplets queue size.
Get Load Balancer Frontend Average Percentage CPU Utilizationmonitoring_get_lb_frontend_cpu_utilizationGETTo retrieve frontend average percentage CPU utilization for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/frontend cpu utilization.
Get Load Balancer Frontend Closed TLS Connections For Exceededmonitoring_get_lb_frontend_tls_connections_exceeding_rate_limitGETTo 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...
Get Load Balancer Frontend Current TLS Connections Rate Metricsmonitoring_get_lb_frontend_tls_connections_currentGETTo 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.
Get Load Balancer Frontend Firewall Dropped Bytes Metricsmonitoring_get_lb_frontend_firewall_dropped_bytesGETTo retrieve firewall dropped bytes for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/frontend firewall dropped bytes.
Get Load Balancer Frontend Firewall Dropped Packets Metricsmonitoring_get_lb_frontend_firewall_dropped_packetsGETTo 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.
Get Load Balancer Frontend HTTP Rate Of Response Code Metricsmonitoring_get_lb_frontend_http_responsesGETTo 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.
Get Load Balancer Frontend HTTP Requests Metricsmonitoring_get_lb_frontend_http_requests_per_secondGETTo 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.
Get Load Balancer Frontend HTTP Throughput Metricsmonitoring_get_lb_frontend_network_throughput_httpGETTo 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.
Get Load Balancer Frontend Max Connections Limit Metricsmonitoring_get_lb_frontend_connections_limitGETTo retrieve frontend max connections limit for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/frontend connections limit.
Get Load Balancer Frontend Max TLS Connections Limit Metricsmonitoring_get_lb_frontend_tls_connections_limitGETTo 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.
Get Load Balancer Frontend TCP Throughput Metricsmonitoring_get_lb_frontend_network_throughput_tcpGETTo 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.
Get Load Balancer Frontend Total Current Active Connectionsmonitoring_get_lb_frontend_connections_currentGETTo retrieve frontend total current active connections for a given load balancer, send a GET request to /v2/monitoring/metrics/load balancer/frontend connections current.
Get Load Balancer Frontend UDP Throughput Metricsmonitoring_get_lb_frontend_network_throughput_udpGETTo 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.
Get Logging Destinationmonitoring_get_destinationGETTo get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination uuid}.
Get Network Load Balancer Frontend TCP Throughput Metricsmonitoring_get_lb_frontend_nlb_tcp_network_throughputGETTo 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.
Get Network Load Balancer Frontend UDP Throughput Metricsmonitoring_get_lb_frontend_nlb_udp_network_throughputGETTo 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.
Get Sinkmonitoring_get_sinkGETTo get the details of a sink (resources and destination), send a GET request to /v2/monitoring/sinks/${sink uuid}.
List Alert Policiesmonitoring_list_alertPolicyGETReturns all alert policies that are configured for the given account.
List Logging Destinationsmonitoring_list_destinationsGETTo list all logging destinations, send a GET request to /v2/monitoring/sinks/destinations.
Lists all sinksmonitoring_list_sinksGETTo list all sinks, send a GET request to /v2/monitoring/sinks.
Retrieve an Existing Alert Policymonitoring_get_alertPolicyGETTo retrieve a given alert policy, send a GET request to /v2/monitoring/alerts/{alert uuid}
Update an Alert Policymonitoring_update_alertPolicyPUTTo update en existing policy, send a PUT request to v2/monitoring/alerts/{alert uuid}.
Update Logging Destinationmonitoring_update_destinationPOSTTo update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination uuid}.
NFS11
Create a new NFS sharenfs_createPOSTTo create a new NFS share, send a POST request to /v2/nfs.
Create an NFS access pointnfs_create_access_pointPOSTTo create a new access point on an NFS share, send a POST request to /v2/nfs/shares/{share id}/access points.
Delete an NFS access pointnfs_delete_access_pointDELETETo delete an NFS access point, send a DELETE request to /v2/nfs/access points/{access point id}.
Delete an NFS sharenfs_deleteDELETETo delete an NFS share, send a DELETE request to /v2/nfs/{nfs id}?region=${region}.
Delete an NFS snapshotnfs_delete_snapshotDELETETo delete an NFS snapshot, send a DELETE request to /v2/nfs/snapshots/{nfs snapshot id}?region=${region}.
Get an NFS access pointnfs_get_access_pointGETTo get an NFS access point, send a GET request to /v2/nfs/access points/{access point id}.
Get an NFS sharenfs_getGETTo get an NFS share, send a GET request to /v2/nfs/{nfs id}?region=${region}.
Get an NFS snapshot by IDnfs_get_snapshotGETTo get an NFS snapshot, send a GET request to /v2/nfs/snapshots/{nfs snapshot id}?region=${region}.
List NFS access points for a sharenfs_list_access_pointsGETTo list access points for an NFS share, send a GET request to /v2/nfs/shares/{share id}/access points.
List NFS shares per regionnfs_listGETTo list NFS shares, send a GET request to /v2/nfs?region=${region}.
List NFS snapshots per regionnfs_list_snapshotGETTo list all NFS snapshots, send a GET request to /v2/nfs/snapshots?region=${region}&share id={share id}.
NFS Action1
Initiate an NFS actionnfs_create_actionPOSTTo execute an action (such as resize) on a specified NFS share, send a POST request to /v2/nfs/{nfs id}/actions.
Organizations2
Create a Team in an Organizationorganizations_create_teamPOSTTo create a new team within an organization, send a POST request to /v2/organizations/team.
List Teams in an Organizationorganizations_list_teamsGETTo list all teams in an organization, send a GET request to /v2/organizations/teams.
Partner Network Connect9
Create a new partner attachmentpartnerAttachments_createPOSTTo create a new partner attachment, send a POST request to /v2/partner network connect/attachments with a JSON object containing the required configuration details.
Delete an existing partner attachmentpartnerAttachments_deleteDELETETo delete an existing partner attachment, send a DELETE request to /v2/partner network connect/attachments/{pa id}.
Get current BGP auth key for the partner attachmentpartnerAttachments_get_bgp_auth_keyGETTo 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.
Get the current service key for the partner attachmentpartnerAttachments_get_service_keyGETTo get the current service key for a partner attachment, send a GET request to /v2/partner network connect/attachments/{pa id}/service key.
List all partner attachmentspartnerAttachments_listGETTo list all of the Partner Attachments on your account, send a GET request to /v2/partner network connect/attachments.
List remote routes for a partner attachmentpartnerAttachments_list_remote_routesGETTo list all remote routes associated with a partner attachment, send a GET request to /v2/partner network connect/attachments/{pa id}/remote routes.
Regenerate the service key for the partner attachmentpartnerAttachments_create_service_keyPOSTThis operation generates a new service key for the specified partner attachment.
Retrieve an existing partner attachmentpartnerAttachments_getGETTo get the details of a partner attachment, send a GET request to /v2/partner network connect/attachments/{pa id}.
Update an existing partner attachmentpartnerAttachments_patchPATCHTo 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.
Project9
Create a Projectprojects_createPOSTTo create a project, send a POST request to /v2/projects.
Delete an Existing Projectprojects_deleteDELETETo delete a project, send a DELETE request to /v2/projects/$PROJECT ID.
List All Projectsprojects_listGETTo list all your projects, send a GET request to /v2/projects.
Patch a Projectprojects_patchPATCHTo update only specific attributes of a project, send a PATCH request to /v2/projects/$PROJECT ID.
Patch the Default Projectprojects_patch_defaultPATCHTo update only specific attributes of your default project, send a PATCH request to /v2/projects/default.
Retrieve an Existing Projectprojects_getGETTo get a project, send a GET request to /v2/projects/$PROJECT ID.
Retrieve the Default Projectprojects_get_defaultGETTo get your default project, send a GET request to /v2/projects/default.
Update a Projectprojects_updatePUTTo update a project, send a PUT request to /v2/projects/$PROJECT ID.
Update the Default Projectprojects_update_defaultPUTTo update you default project, send a PUT request to /v2/projects/default.
Project Resource4
Assign Resources to a Projectprojects_assign_resourcesPOSTTo assign resources to a project, send a POST request to /v2/projects/$PROJECT ID/resources.
Assign Resources to Default Projectprojects_assign_resources_defaultPOSTTo assign resources to your default project, send a POST request to /v2/projects/default/resources.
List Default Project Resourcesprojects_list_resources_defaultGETTo list all your resources in your default project, send a GET request to /v2/projects/default/resources.
List Project Resourcesprojects_list_resourcesGETTo list all your resources in a project, send a GET request to /v2/projects/$PROJECT ID/resources.
Region1
List All Data Center Regionsregions_listGETTo list all of the regions that are available, send a GET request to /v2/regions.
Reserved IP4
Create a New Reserved IPreservedIPs_createPOSTOn creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
Delete a Reserved IPreservedIPs_deleteDELETETo delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved ips/$RESERVED IP ADDR.
List All Reserved IPsreservedIPs_listGETTo list all of the reserved IPs available on your account, send a GET request to /v2/reserved ips.
Retrieve an Existing Reserved IPreservedIPs_getGETTo show information about a reserved IP, send a GET request to /v2/reserved ips/$RESERVED IP ADDR.
Reserved IP Action3
Initiate a Reserved IP ActionreservedIPsActions_postPOSTTo initiate an action on a reserved IP send a POST request to /v2/reserved ips/$RESERVED IP/actions.
List All Actions for a Reserved IPreservedIPsActions_listGETTo retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved ips/$RESERVED IP/actions.
Retrieve an Existing Reserved IP ActionreservedIPsActions_getGETTo retrieve the status of a reserved IP action, send a GET request to /v2/reserved ips/$RESERVED IP/actions/$ACTION ID.
Reserved IPv64
Create a New Reserved IPv6reservedIPv6_createPOSTOn creation, a reserved IPv6 must be reserved to a region.
Delete a Reserved IPv6reservedIPv6_deleteDELETETo delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved ipv6/$RESERVED IPV6.
List All Reserved IPv6sreservedIPv6_listGETTo list all of the reserved IPv6s available on your account, send a GET request to /v2/reserved ipv6.
Retrieve an Existing Reserved IPv6reservedIPv6_getGETTo show information about a reserved IPv6, send a GET request to /v2/reserved ipv6/$RESERVED IPV6.
Reserved IPv6 Action1
Initiate a Reserved IPv6 ActionreservedIPv6Actions_postPOSTTo initiate an action on a reserved IPv6 send a POST request to /v2/reserved ipv6/$RESERVED IPV6/actions.
Security10
Create Scansecurity_create_scanPOSTTo create a CSPM scan, send a POST request to /v2/security/scans.
Create Scan Rulesecurity_create_scan_rulePOSTTo mark a scan finding as a false positive, send a POST request to /v2/security/scans/rules to create a new scan rule.
Create Suppressionsecurity_create_suppressionPOSTTo suppress scan findings, send a POST request to /v2/security/settings/suppressions.
Delete Suppressionsecurity_delete_suppressionDELETETo remove a suppression, send a DELETE request to /v2/security/settings/suppressions/{suppression uuid}.
Get Latest Scansecurity_get_latest_scanGETTo get the latest CSPM scan, send a GET request to /v2/security/scans/latest.
Get Scansecurity_get_scanGETTo get a CSPM scan by ID, send a GET request to /v2/security/scans/{scan id}.
List Finding Affected Resourcessecurity_list_scan_finding_affected_resourcesGETTo get affected resources for a scan finding, send a GET request to /v2/security/scans/{scan id}/findings/{finding uuid}/affected resources.
List Scanssecurity_list_scansGETTo list all CSPM scans, send a GET request to /v2/security/scans.
List Settingssecurity_list_settingsGETTo list CSPM scan settings, send a GET request to /v2/security/settings.
Update Plansecurity_update_settings_planPUTTo update CSPM plan coverage, send a PUT request to /v2/security/settings/plan.
Serverless Inference11
Create a model response for the given chat conversationinference_create_chat_completionPOSTCreates a model response for the given chat conversation.
Create a model response for the given chat conversation (stream)inference_create_chat_completionStreamPOSTCreates a model response for the given chat conversation.
Create embeddinginference_create_embeddingPOSTCreate vector embeddings for one or more text inputs.
Create the next assistant messageinference_create_messagesPOSTSend a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.
Create the next assistant message (stream)inference_create_messagesStreamPOSTSend a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.
Generate Image, Audio, or Text-to-Speech Using fal Modelsinference_create_async_invokePOSTGenerate Image, Audio, or Text-to-Speech Using fal Models.
Generate images from text promptsinference_create_imagePOSTCreates a high-quality image from a text prompt using GPT-IMAGE-1, the latest image generation model with automatic prompt optimization and enhanced visual capabilities.
Generate images from text prompts (stream)inference_create_imageStreamPOSTCreates a high-quality image from a text prompt using GPT-IMAGE-1, the latest image generation model with automatic prompt optimization and enhanced visual capabilities.
List available modelsinference_list_modelsGETLists the currently available models, and provides basic information about each one such as the owner and availability.
Send Prompt to a Model Using the Responses APIinference_create_responsePOSTGenerate text responses from text prompts.
Send Prompt to a Model Using the Responses API (stream)inference_create_responseStreamPOSTGenerate text responses from text prompts.
Size1
List All Droplet Sizessizes_listGETTo list all of available Droplet sizes, send a GET request to /v2/sizes.
Snapshot3
Delete a Snapshotsnapshots_deleteDELETEBoth Droplet and volume snapshots are managed through the /v2/snapshots/ endpoint.
List All Snapshotssnapshots_listGETTo list all of the snapshots available on your account, send a GET request to /v2/snapshots.
Retrieve an Existing Snapshotsnapshots_getGETTo retrieve information about a snapshot, send a GET request to /v2/snapshots/$SNAPSHOT ID.
Spaces Key6
Create a New Spaces Access KeyspacesKey_createPOSTTo create a new Spaces Access Key, send a POST request to /v2/spaces/keys.
Delete a Spaces Access KeyspacesKey_deleteDELETETo delete a Spaces Access Key, send a DELETE request to /v2/spaces/keys/$ACCESS KEY.
Get a Spaces Access KeyspacesKey_getGETTo get a Spaces Access Key, send a GET request to /v2/spaces/keys/$ACCESS KEY.
List Spaces Access KeysspacesKey_listGETTo list Spaces Access Key, send a GET request to /v2/spaces/keys.
Update Spaces Access KeysspacesKey_patchPATCHTo update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS KEY.
Update Spaces Access KeysspacesKey_updatePUTTo update Spaces Access Key, send a PUT or PATCH request to /v2/spaces/keys/$ACCESS KEY.
SSH Key5
Create a New SSH KeysshKeys_createPOSTTo add a new SSH public key to your DigitalOcean account, send a POST request to /v2/account/keys.
Delete an SSH KeysshKeys_deleteDELETETo 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.
List All SSH KeyssshKeys_listGETTo list all of the keys in your account, send a GET request to /v2/account/keys.
Retrieve an Existing SSH KeysshKeys_getGETTo get information about a key, send a GET request to /v2/account/keys/$KEY ID or /v2/account/keys/$KEY FINGERPRINT.
Update an SSH Key's NamesshKeys_updatePUTTo 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.
Tag6
Create a New Tagtags_createPOSTTo create a tag you can send a POST request to /v2/tags with a name attribute.
Delete a Tagtags_deleteDELETEA tag can be deleted by sending a DELETE request to /v2/tags/$TAG NAME.
List All Tagstags_listGETTo list all of your tags, you can send a GET request to /v2/tags.
Retrieve a Tagtags_getGETTo retrieve an individual tag, you can send a GET request to /v2/tags/$TAG NAME.
Tag a Resourcetags_assign_resourcesPOSTResources can be tagged by sending a POST request to /v2/tags/$TAG NAME/resources with an array of json objects containing resource id and resource type attributes.
Untag a Resourcetags_unassign_resourcesDELETEResources can be untagged by sending a DELETE request to /v2/tags/$TAG NAME/resources with an array of json objects containing resource id and resource type attributes.
Uptime11
Create a New Alertuptime_create_alertPOSTTo 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.
Create a New Checkuptime_create_checkPOSTTo create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
Delete a Checkuptime_delete_checkDELETETo delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK ID.
Delete an Alertuptime_delete_alertDELETETo delete an Uptime alert, send a DELETE request to /v2/uptime/checks/$CHECK ID/alerts/$ALERT ID.
List All Alertsuptime_list_alertsGETTo list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK ID/alerts.
List All Checksuptime_list_checksGETTo list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
Retrieve an Existing Alertuptime_get_alertGETTo show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK ID/alerts/$ALERT ID.
Retrieve an Existing Checkuptime_get_checkGETTo show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK ID.
Retrieve Check Stateuptime_get_checkStateGETTo show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK ID/state.
Update a Checkuptime_update_checkPUTTo update the settings of an Uptime check, send a PUT request to /v2/uptime/checks/$CHECK ID.
Update an Alertuptime_update_alertPUTTo update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK ID/alerts/$ALERT ID.
Vector Database11
Create a New Vector DatabasevectorDatabases_createPOSTTo create a vector database, send a POST request to /v2/vector-databases.
Delete a Vector DatabasevectorDatabases_deleteDELETETo delete a vector database, send a DELETE request to /v2/vector-databases/{id}.
List All Vector DatabasesvectorDatabases_listGETTo list all of the vector databases on your account, send a GET request to /v2/vector-databases.
List Backups for a Vector DatabasevectorDatabases_list_backupsGETTo list the available backups for a vector database, send a GET request to /v2/vector-databases/{id}/backups.
Resize a Vector DatabasevectorDatabases_post_resizePOSTTo resize a vector database, send a POST request to /v2/vector-databases/{id}/resize.
Restore a Vector Database from a BackupvectorDatabases_post_restore_backupPOSTTo restore a vector database from a backup, send a POST request to /v2/vector-databases/{id}/backups/{backup id}/restore.
Retrieve Admin Credentials for a Vector DatabasevectorDatabases_get_credentialsGETTo retrieve the admin credentials for a vector database, send a GET request to /v2/vector-databases/{id}/credentials.
Retrieve an Existing Vector DatabasevectorDatabases_getGETTo show information about an existing vector database, send a GET request to /v2/vector-databases/{id}.
Retrieve the Status of a RestorevectorDatabases_get_restore_statusGETTo check the status of a restore operation, send a GET request to /v2/vector-databases/{id}/backups/{backup id}/restore.
Update a Vector DatabasevectorDatabases_updatePUTTo update an existing vector database, send a PUT request to /v2/vector-databases/{id}.
Update Tags on a Vector DatabasevectorDatabases_update_tagsPUTTo update the tags on a vector database, send a PUT request to /v2/vector-databases/{id}/tags.
VPC10
Create a New VPCvpcs_createPOSTTo create a VPC, send a POST request to /v2/vpcs specifying the attributes in the table below in the JSON body.
Create a Peering with a VPCvpcs_create_peeringsPOSTTo create a new VPC peering for a given VPC, send a POST request to /v2/vpcs/$VPC ID/peerings.
Delete a VPCvpcs_deleteDELETETo delete a VPC, send a DELETE request to /v2/vpcs/$VPC ID.
List All VPCsvpcs_listGETTo list all of the VPCs on your account, send a GET request to /v2/vpcs.
List the Member Resources of a VPCvpcs_list_membersGETTo list all of the resources that are members of a VPC, send a GET request to /v2/vpcs/$VPC ID/members.
List the Peerings of a VPCvpcs_list_peeringsGETTo list all of a VPC's peerings, send a GET request to /v2/vpcs/$VPC ID/peerings.
Partially Update a VPCvpcs_patchPATCHTo update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC ID.
Retrieve an Existing VPCvpcs_getGETTo show information about an existing VPC, send a GET request to /v2/vpcs/$VPC ID.
Update a VPCvpcs_updatePUTTo update information about a VPC, send a PUT request to /v2/vpcs/$VPC ID.
Update a VPC Peeringvpcs_patch_peeringsPATCHTo 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.
VPC NAT Gateway5
Create a New VPC NAT Gatewayvpcnatgateways_createPOSTTo create a new VPC NAT gateway, send a POST request to /v2/vpc nat gateways setting the required attributes.
Delete VPC NAT Gatewayvpcnatgateways_deleteDELETETo destroy a VPC NAT Gateway, send a DELETE request to the /v2/vpc nat gateways/$VPC NAT GATEWAY ID endpoint.
List All VPC NAT Gatewaysvpcnatgateways_listGETTo list all VPC NAT gateways in your team, send a GET request to /v2/vpc nat gateways.
Retrieve an Existing VPC NAT Gatewayvpcnatgateways_getGETTo show information about an individual VPC NAT gateway, send a GET request to /v2/vpc nat gateways/$VPC NAT GATEWAY ID.
Update VPC NAT Gatewayvpcnatgateways_updatePUTTo update the configuration of an existing VPC NAT Gateway, send a PUT request to /v2/vpc nat gateways/$VPC NAT GATEWAY ID.
VPC Peering5
Create a New VPC PeeringvpcPeerings_createPOSTTo 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.
Delete a VPC peeringvpcPeerings_deleteDELETETo delete a VPC peering, send a DELETE request to /v2/vpc peerings/$VPC PEERING ID.
List All VPC PeeringsvpcPeerings_listGETTo list all of the VPC peerings on your account, send a GET request to /v2/vpc peerings.
Retrieve an Existing VPC PeeringvpcPeerings_getGETTo show information about an existing VPC Peering, send a GET request to /v2/vpc peerings/$VPC PEERING ID.
Update a VPC peeringvpcPeerings_patchPATCHTo 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.