How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Digital Ocean Apps API

App Platform is a Platform-as-a-Service (PaaS) offering from DigitalOcean that allowsdevelopers to publish code directly to DigitalOcean servers without worrying about theunderlying infrastructure.Most API operations are centered around a few core object types. Following are thedefinitions of these types. These definitions will be omitted from the operation-specificdocumentation.For documentation on app specifications (`AppSpec` objects), please refer to the[product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/)).

Digital Ocean Apps API is one of 37 APIs that Digital Ocean publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 28 operations across 24 paths, and defines 106 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.digitalocean.com.

28 operations 24 paths 106 schemas 1 DELETE15 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.digitalocean.com/v2
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Digital Ocean Apps API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — OAuth Authentication In order to interact with the DigitalOcean API, you or your application must authenticate. The DigitalOcean API handles this through OAuth…

Paths & Operations 28

Across 24 paths, the API surfaces 28 operations — 1 DELETE, 15 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 28

App Platform is a Platform-as-a-Service (PaaS) offering from DigitalOcean that allows developers to publish code directly to DigitalOcean servers without worrying about the underl…

GET
/v2/apps
List All Apps
apps_list 3 params → 200401429500default
POST
/v2/apps
Create a New App
apps_create 2 params body → 200401429500default
DELETE
/v2/apps/{id}
Delete an App
apps_delete 1 param → 200401404429500default
GET
/v2/apps/{id}
Retrieve an Existing App
apps_get 2 params → 200401404429500default
PUT
/v2/apps/{id}
Update an App
apps_update 1 param body → 200401404429500default
POST
/v2/apps/{app_id}/restart
Restart an App
apps_restart 1 param body → 200401404429500default
GET
/v2/apps/{app_id}/components/{component_name}/logs
Retrieve Active Deployment Logs
apps_get_logs_active_deployment 5 params → 200401404429500default
GET
/v2/apps/{app_id}/components/{component_name}/exec
Retrieve Exec URL
apps_get_exec_active_deployment 2 params → 200401404429500default
GET
/v2/apps/{app_id}/deployments
List App Deployments
apps_list_deployments 3 params → 200401404429500default
POST
/v2/apps/{app_id}/deployments
Create an App Deployment
apps_create_deployment 1 param body → 200401404429500default
GET
/v2/apps/{app_id}/deployments/{deployment_id}
Retrieve an App Deployment
apps_get_deployment 2 params → 200401404429500default
POST
/v2/apps/{app_id}/deployments/{deployment_id}/cancel
Cancel a Deployment
apps_cancel_deployment 2 params → 200401404429500default
GET
/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs
Retrieve Deployment Logs
apps_get_logs 6 params → 200401404429500default
GET
/v2/apps/{app_id}/deployments/{deployment_id}/logs
Retrieve Aggregate Deployment Logs
apps_get_logs_aggregate 5 params → 200401404429500default
GET
/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec
Retrieve Exec URL for Deployment
apps_get_exec 3 params → 200401404429500default
GET
/v2/apps/{app_id}/logs
Retrieve Active Deployment Aggregate Logs
apps_get_logs_active_deployment_aggregate 4 params → 200401404429500default
GET
/v2/apps/tiers/instance_sizes
List Instance Sizes
apps_list_instanceSizes → 200401429500default
GET
/v2/apps/tiers/instance_sizes/{slug}
Retrieve an Instance Size
apps_get_instanceSize 1 param → 200401404429500default
GET
/v2/apps/regions
List App Regions
apps_list_regions → 200401429500default
POST
/v2/apps/propose
Propose an App Spec
apps_validate_appSpec body → 200401429500default
GET
/v2/apps/{app_id}/alerts
List all app alerts
apps_list_alerts 1 param → 200401404429500default
POST
/v2/apps/{app_id}/alerts/{alert_id}/destinations
Update destinations for alerts
apps_assign_alertDestinations 2 params body → 200401404429500default
POST
/v2/apps/{app_id}/rollback
Rollback App
apps_create_rollback 1 param body → 200401404429500default
POST
/v2/apps/{app_id}/rollback/validate
Validate App Rollback
apps_validate_rollback 1 param body → 200401404429500default
POST
/v2/apps/{app_id}/rollback/commit
Commit App Rollback
apps_commit_rollback 1 param → 200401404429500default
POST
/v2/apps/{app_id}/rollback/revert
Revert App Rollback
apps_revert_rollback 1 param → 200401404429500default
GET
/v2/apps/{app_id}/metrics/bandwidth_daily
Retrieve App Daily Bandwidth Metrics
apps_get_metrics_bandwidth_daily 2 params → 200401404429500default
POST
/v2/apps/metrics/bandwidth_daily
Retrieve Multiple Apps' Daily Bandwidth Metrics
apps_list_metrics_bandwidth_daily body → 200401404429500default

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are app (19 properties), apps_deployment (15 properties), apps_instance_size (14 properties), app_component_base (13 properties). Each schema is shown below with its type and property counts.

app_static_site_spec
1 required
app_log_destination_papertrail_spec
object
Papertrail configuration.
1 property 1 required
link_to_prev_page
object
1 property
app_alert
object
7 properties
app_alert_slack_webhook
object
2 properties
apps_instance_size
object
14 properties
app_alert_progress_step
object
5 properties
app_spec
object
The desired configuration of an application.
12 properties 1 required
apps_deployment_response
object
1 property
app_ingress_spec_rule
object
4 properties
apps_deployments_response
apps_git_source_spec
object
2 properties
app_service_spec_termination
object
2 properties
pagination
object
1 property
apps_deployment_progress_step_reason
object
2 properties
app_maintenance_spec
object
Specification to configure maintenance settings for the app, such as maintenance mode and archiving the app.
2 properties
app_log_destination_datadog_spec
object
DataDog configuration.
2 properties 1 required
app_ingress_spec_rule_string_match
object
The path to match on.
1 property 1 required
app_worker_spec_termination
object
1 property
backward_links
apps_create_deployment_request
object
1 property
app_log_destination_logtail_spec
object
Logtail configuration.
1 property 1 required
apps_gitlab_source_spec
object
3 properties
app_log_destination_open_search_spec_basic_auth
object
Configure Username and/or Password for Basic authentication.
2 properties
app_ingress_spec
object
Specification for app ingress configurations.
1 property
app_propose
object
2 properties 1 required
app_variable_definition
object
4 properties 1 required
apps_domain
object
7 properties
apps_get_instance_size_response
object
1 property
app_alert_spec
object
5 properties
app_job_spec
apps_list_regions_response
object
1 property
app_alert_spec_rule
string
app_log_destination_definition
object
5 properties 1 required
apps_domain_progress
object
1 property
apps_delete_app_response
object
1 property
apps_restart_request
object
1 property
apps_get_exec_response
object
1 property
apps_deployment_progress_step_status
string
apps_list_instance_sizes_response
object
2 properties
apps_create_app_request
object
2 properties 1 required
apps_dedicated_egress_ip
object
3 properties
app_rollback_validation_condition
object
3 properties
error
object
3 properties 2 required
app_response
object
1 property
app_alert_progress_step_status
string
apps_deployment_phase
string
app_alert_spec_window
string
apps_deployment_worker
object
2 properties
app_job_spec_termination
object
1 property
apps_alert_response
object
1 property
app_component_base
object
13 properties
app_database_spec
object
7 properties 1 required
app_egress_spec
object
Specification for app egress configurations.
1 property
app_functions_spec
object
11 properties 1 required
app
object
An application's configuration and status.
19 properties 1 required
apps_dedicated_egress_ip_status
string
app_worker_spec
1 required
apps_string_match
object
3 properties
apps_deployment_job
object
2 properties
app_ingress_spec_rule_routing_redirect
object
The redirect configuration for the rule. Only one of component or redirect may be set.
5 properties
app_alert_progress
object
1 property
apps_deployment_service
object
2 properties
meta_properties
object
Information about the response itself.
1 property
app_metrics_bandwidth_usage
object
2 properties
app_alert_progress_step_reason
object
2 properties
apps_cors_policy
object
6 properties
apps_bitbucket_source_spec
object
3 properties
apps_update_app_request
object
2 properties 1 required
link_to_next_page
object
1 property
app_propose_response
object
7 properties
apps_deployment
object
15 properties
app_alert_email
string
app_domain_validation
object
2 properties
app_component_instance_base
object
3 properties
app_service_spec
link_to_last_page
object
1 property
page_links
object
1 property
apps_deployment_static_site
object
2 properties
apps_deployment_functions
object
3 properties
app_metrics_bandwidth_usage_request
object
2 properties 1 required
apps_region
object
8 properties
apps_image_source_spec
object
7 properties
app_ingress_spec_rule_match
object
The match configuration for the rule.
1 property 1 required
apps_rollback_app_request
object
2 properties
forward_links
app_service_spec_health_check
object
7 properties
app_egress_type_spec
string
apps_deployment_progress
object
7 properties
app_alert_phase
string
instance_size_cpu_type
string
link_to_first_page
object
1 property
app_route_spec
object
2 properties
app_metrics_bandwidth_usage_details
object
Bandwidth usage for an app.
2 properties
apps_get_logs_response
object
2 properties
apps_list_alerts_response
object
1 property
meta
object
1 property 1 required
app_ingress_spec_rule_routing_component
object
The component to route to. Only one of component or redirect may be set.
3 properties 1 required
apps_deployment_progress_step
object
8 properties
app_log_destination_open_search_spec
object
OpenSearch configuration.
4 properties
apps_github_source_spec
object
3 properties
app_alert_spec_operator
string
apps_response
app_domain_spec
object
5 properties 1 required
apps_domain_phase
string
apps_assign_app_alert_destinations_request
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

digital-ocean-apps-api-openapi.yml Raw ↑

Other APIs Digital Ocean publishes across the network.

Digital Ocean 1-Click Applications API
Digital Ocean Account API
Digital Ocean Actions API
Digital Ocean Billing API
Digital Ocean Block Storage Actions API
Digital Ocean Block Storage API
Digital Ocean CDN Endpoints API
Digital Ocean Certificates API
Digital Ocean Container Registry API
Digital Ocean Databases API
Digital Ocean Domain Records API
Digital Ocean Domains API
Where this information came from

This is an independent, third-party profile of Digital Ocean Apps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.