# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, all
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.digitalocean.com
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will st
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/1-clicks | List 1-Click Applications To list all available 1-Click applications, send a GET request to `/v2/1-clicks`. Th |
POST | /v2/1-clicks/kubernetes | Install Kubernetes 1-Click Applications To install a Kubernetes 1-Click application on a cluster, send a POST |
GET | /v2/account | Get User Information To show information about the current user account, send a GET request to `/v2/account`. |
GET | /v2/account/keys | List All SSH Keys To list all of the keys in your account, send a GET request to `/v2/account/keys`. The respo |
POST | /v2/account/keys | Create a New SSH Key To add a new SSH public key to your DigitalOcean account, send a POST request to `/v2/acc |
GET | /v2/account/keys/{ssh_key_identifier} | Retrieve an Existing SSH Key To get information about a key, send a GET request to `/v2/account/keys/$KEY_ID` |
PUT | /v2/account/keys/{ssh_key_identifier} | Update an SSH Key's Name To update the name of an SSH key, send a PUT request to either `/v2/account/keys/$SSH |
DELETE | /v2/account/keys/{ssh_key_identifier} | Delete an SSH Key To destroy a public SSH key that you have in your account, send a DELETE request to `/v2/acc |
GET | /v2/actions | List All Actions This will be the entire list of actions taken on your account, so it will be quite large. As |
GET | /v2/actions/{action_id} | Retrieve an Existing Action To retrieve a specific action object, send a GET request to `/v2/actions/$ACTION_I |
GET | /v2/apps | List All Apps List all apps on your account. Information about the current active deployment as well as any in |
POST | /v2/apps | Create a New App Create a new app by submitting an app specification. For documentation on app specifications |
POST | /v2/apps/metrics/bandwidth_daily | Retrieve Multiple Apps' Daily Bandwidth Metrics Retrieve daily bandwidth usage metrics for multiple apps. Apps |
POST | /v2/apps/propose | Propose an App Spec To propose and validate a spec for a new or existing app, send a POST request to the `/v2/ |
GET | /v2/apps/regions | List App Regions List all regions supported by App Platform. Apps |
GET | /v2/apps/tiers | List App Tiers List all app tiers. Apps |
GET | /v2/apps/tiers/instance_sizes | List Instance Sizes List all instance sizes for `service`, `worker`, and `job` components. Apps |
GET | /v2/apps/tiers/instance_sizes/{slug} | Retrieve an Instance Size Retrieve information about a specific instance size for `service`, `worker`, and `jo |
GET | /v2/apps/tiers/{slug} | Retrieve an App Tier Retrieve information about a specific app tier. Apps |
GET | /v2/apps/{app_id}/alerts | List all app alerts List alerts associated to the app and any components. This includes configuration informat |
POST | /v2/apps/{app_id}/alerts/{alert_id}/destinations | Update destinations for alerts Updates the emails and slack webhook destinations for app alerts. Emails must b |
GET | /v2/apps/{app_id}/components/{component_name}/logs | Retrieve Active Deployment Logs Retrieve the logs of the active deployment if one exists. The response will in |
GET | /v2/apps/{app_id}/deployments | List App Deployments List all deployments of an app. Apps |
POST | /v2/apps/{app_id}/deployments | Create an App Deployment Creating an app deployment will pull the latest changes from your repository and sche |
GET | /v2/apps/{app_id}/deployments/{deployment_id} | Retrieve an App Deployment Retrieve information about an app deployment. Apps |
POST | /v2/apps/{app_id}/deployments/{deployment_id}/cancel | Cancel a Deployment Immediately cancel an in-progress deployment. Apps |
GET | /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs | Retrieve Deployment Logs Retrieve the logs of a past, in-progress, or active deployment. The response will inc |
GET | /v2/apps/{app_id}/deployments/{deployment_id}/logs | Retrieve Aggregate Deployment Logs Retrieve the logs of a past, in-progress, or active deployment. If a compon |
GET | /v2/apps/{app_id}/logs | Retrieve Active Deployment Aggregate Logs Retrieve the logs of the active deployment if one exists. The respon |
GET | /v2/apps/{app_id}/metrics/bandwidth_daily | Retrieve App Daily Bandwidth Metrics Retrieve daily bandwidth usage metrics for a single app. Apps |
POST | /v2/apps/{app_id}/rollback | Rollback App Rollback an app to a previous deployment. A new deployment will be created to perform the rollbac |
POST | /v2/apps/{app_id}/rollback/commit | Commit App Rollback Commit an app rollback. This action permanently applies the rollback and unpins the app to |
POST | /v2/apps/{app_id}/rollback/revert | Revert App Rollback Revert an app rollback. This action reverts the active rollback by creating a new deployme |
POST | /v2/apps/{app_id}/rollback/validate | Validate App Rollback Check whether an app can be rolled back to a specific deployment. This endpoint can also |
GET | /v2/apps/{id} | Retrieve an Existing App Retrieve details about an existing app by either its ID or name. To retrieve an app b |
PUT | /v2/apps/{id} | Update an App Update an existing app by submitting a new app specification. For documentation on app specifica |
DELETE | /v2/apps/{id} | Delete an App Delete an existing app. Once deleted, all active deployments will be permanently shut down and t |
GET | /v2/cdn/endpoints | List All CDN Endpoints To list all of the CDN endpoints available on your account, send a GET request to `/v2/ |
POST | /v2/cdn/endpoints | Create a New CDN Endpoint To create a new CDN endpoint, send a POST request to `/v2/cdn/endpoints`. The origin |
GET | /v2/cdn/endpoints/{cdn_id} | Retrieve an Existing CDN Endpoint To show information about an existing CDN endpoint, send a GET request to `/ |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/digitalocean/openapi/main/specification/DigitalOcean-pub
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.