id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_regions
List all regions supported by App Platform.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_regions
List all regions supported by App Platform.
200
null
{"regions": [{"slug": "ams", "label": "Amsterdam", "flag": "netherlands", "continent": "Europe", "data_centers": ["ams3"]}, {"slug": "nyc", "label": "New York", "flag": "usa", "continent": "North America", "data_centers": ["nyc1", "nyc3"], "default": true}, {"slug": "fra", "label": "Frankfurt", "flag": "germany", "cont...
{"properties": {"regions": {"items": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as th...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_regions
List all regions supported by App Platform.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47051b08-a6e6-4e97-ae9a-f57fb1467d80/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_tiers
List all app tiers.
200
null
{"tiers": [{"name": "Starter", "slug": "starter", "egress_bandwidth_bytes": "1073741824", "build_seconds": "6000"}, {"name": "Basic", "slug": "basic", "egress_bandwidth_bytes": "42949672960", "build_seconds": "24000"}, {"name": "Professional", "slug": "professional", "egress_bandwidth_bytes": "107374182400", "build_sec...
{"properties": {"tiers": {"items": {"properties": {"build_seconds": {"format": "int64", "title": "The amount of included build time in seconds", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "egress_bandwidth_bytes": {"format": "int64", "title": "The amount of included outbound ban...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47051b08-a6e6-4e97-ae9a-f57fb1467d80/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_tiers
List all app tiers.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47051b08-a6e6-4e97-ae9a-f57fb1467d80/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_tiers
List all app tiers.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47051b08-a6e6-4e97-ae9a-f57fb1467d80/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_tiers
List all app tiers.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/0/0
Digital Ocean
Digital Ocean Public API
null
apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
200
null
{"deployment": {"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 2, "routes...
{"properties": {"deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the de...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/1/0
Digital Ocean
Digital Ocean Public API
null
apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/2/0
Digital Ocean
Digital Ocean Public API
null
apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/3/0
Digital Ocean
Digital Ocean Public API
null
apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/4/0
Digital Ocean
Digital Ocean Public API
null
apps_revert_rollback
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the latest app spec prior to the rollback and unpins the app to resume new deployments.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/0/0
Digital Ocean
Digital Ocean Public API
null
apps_commit_rollback
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/1/0
Digital Ocean
Digital Ocean Public API
null
apps_commit_rollback
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/3/0
Digital Ocean
Digital Ocean Public API
null
apps_commit_rollback
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/4/0
Digital Ocean
Digital Ocean Public API
null
apps_commit_rollback
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
200
null
{"alerts": [{"id": "e552e1f9-c1b0-4e6d-8777-ad6f27767306", "spec": {"rule": "DEPLOYMENT_FAILED"}, "emails": ["sammy@digitalocean.com"], "phase": "ACTIVE", "progress": {"steps": [{"name": "alert-configure-insight-alert", "status": "SUCCESS", "started_at": "2020-07-28T18:00:00Z", "ended_at": "2020-07-28T18:00:00Z"}]}}, {...
{"properties": {"alerts": {"type": "array", "items": {"properties": {"id": {"title": "The ID of the alert", "type": "string"}, "component_name": {"title": "Name of component the alert belongs to", "type": "string"}, "spec": {"properties": {"rule": {"default": "UNSPECIFIED_RULE", "enum": ["UNSPECIFIED_RULE", "CPU_UTILIZ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/4/0
Digital Ocean
Digital Ocean Public API
null
apps_list_alerts
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
200
null
{"app_bandwidth_usage": [{"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", "bandwidth_bytes": "513668"}, {"app_id": "c2a93513-8d9b-4223-9d61-5e7272c81cf5", "bandwidth_bytes": "254847"}], "date": "2023-01-17T00:00:00Z"}
{"type": "object", "properties": {"app_bandwidth_usage": {"type": "array", "items": {"type": "object", "properties": {"app_id": {"type": "string", "description": "The ID of the app."}, "bandwidth_bytes": {"type": "string", "format": "uint64", "description": "The used bandwidth amount in bytes."}}, "description": "Bandw...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/4/0
Digital Ocean
Digital Ocean Public API
null
apps_list_metrics_bandwidth_daily
Retrieve daily bandwidth usage metrics for multiple apps.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
200
null
{"live_url": "https://logs-example/build.log", "url": "https://logs/build.log", "historic_logs": ["https://logs-example/archive/build.log"]}
{"properties": {"historic_urls": {"items": {"type": "string"}, "title": "A list of URLs to archived log files", "type": "array"}, "live_url": {"description": "A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available.", "type"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs_aggregate
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
200
Assigned to Droplet
{"reserved_ip": {"ip": "45.55.96.47", "droplet": {"id": 3164444, "name": "example.com", "memory": 1024, "vcpus": 1, "disk": 25, "locked": false, "status": "active", "kernel": null, "created_at": "2020-07-21T18:37:44Z", "features": ["backups", "private_networking", "ipv6"], "backup_ids": [53893572], "next_backup_window"...
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/3/1
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
200
Reserved to Region
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb",...
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/4/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_get
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/0/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_get_byId
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/1/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_get_byId
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
200
null
{"snapshot": {"id": "8fa70202-873f-11e6-8b68-000f533176b1", "name": "big-data-snapshot1475261774", "regions": ["nyc1"], "created_at": "2020-09-30T18:56:14Z", "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41", "resource_type": "volume", "min_disk_size": 10, "size_gigabytes": 10, "tags": ["aninterestingtag"]}}
{"properties": {"snapshot": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the snapshot."}}, "required": ["id"]}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human-readable name for the snapshot."}, "created_at": {"type"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/2/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_get_byId
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/3/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_get_byId
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/4/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_get_byId
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/1/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_delete_byId
To delete a volume snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/2/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_delete_byId
To delete a volume snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/3/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_delete_byId
To delete a volume snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/4/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_delete_byId
To delete a volume snapshot, send a DELETE request to /v2/snapshots/$SNAPSHOT_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0e945dd1-a857-4309-ab9d-0c17c3c40b81/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_add_forwardingRules
To add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code wil...
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0e945dd1-a857-4309-ab9d-0c17c3c40b81/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_add_forwardingRules
To add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code wil...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0e945dd1-a857-4309-ab9d-0c17c3c40b81/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_add_forwardingRules
To add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code wil...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0e945dd1-a857-4309-ab9d-0c17c3c40b81/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_add_forwardingRules
To add an additional forwarding rule to a load balancer instance, send a POST request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body of the request, there should be a forwarding_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code wil...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f0cada-562e-4425-9db8-f6ba785e4609/1/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no ret...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f0cada-562e-4425-9db8-f6ba785e4609/2/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no ret...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f0cada-562e-4425-9db8-f6ba785e4609/3/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no ret...
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f0cada-562e-4425-9db8-f6ba785e4609/4/0
Digital Ocean
Digital Ocean Public API
null
volumes_delete
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no ret...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
200
null
{"action": {"id": 72531856, "status": "completed", "type": "assign_ip", "started_at": "2015-11-12T17:51:03Z", "completed_at": "2015-11-12T17:51:14Z", "resource_id": 758604968, "resource_type": "reserved_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu...
{"properties": {"action": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"er...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/4/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_get
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute. To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the reg...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute. To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the reg...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute. To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the reg...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute. To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the reg...
202
Assigning to Droplet
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb",...
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/3/1
Digital Ocean
Digital Ocean Public API
null
reservedIPs_create
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region. * To create a new reserved IP assigned to a Droplet, send a POST request to /v2/reserved_ips with the droplet_id attribute. To create a new reserved IP reserved to a region, send a POST request to /v2/reserved_ips with the reg...
202
Reserving to Region
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb",...
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_update_alertPolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_update_alertPolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
200
null
{"policy": {"alerts": {"email": [], "slack": []}, "compare": "GreaterThan", "description": "CPU Alert", "enabled": true, "entities": [], "tags": [], "type": "v1/insights/droplet/load_1", "uuid": "78b3da62-27e5-49ba-ac70-5db0b5935c64", "value": 80, "window": "5m"}}
{"properties": {"policy": {"type": "object", "required": ["uuid", "type", "description", "compare", "value", "window", "entities", "tags", "alerts", "enabled"], "properties": {"alerts": {"type": "object", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_update_alertPolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_update_alertPolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/4/0
Digital Ocean
Digital Ocean Public API
null
monitoring_update_alertPolicy
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/0/0
Digital Ocean
Digital Ocean Public API
null
apps_cancel_deployment
Immediately cancel an in-progress deployment.
200
null
{"deployment": {"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 2, "routes...
{"properties": {"deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the de...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/1/0
Digital Ocean
Digital Ocean Public API
null
apps_cancel_deployment
Immediately cancel an in-progress deployment.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/2/0
Digital Ocean
Digital Ocean Public API
null
apps_cancel_deployment
Immediately cancel an in-progress deployment.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/3/0
Digital Ocean
Digital Ocean Public API
null
apps_cancel_deployment
Immediately cancel an in-progress deployment.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/4/0
Digital Ocean
Digital Ocean Public API
null
apps_cancel_deployment
Immediately cancel an in-progress deployment.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0dea565-1bb0-4793-b881-27c7a3696273/0/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_post_byTag
Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments. Only a sub-set of action types are supported: power_cycle power_on power_off shutdown enable_ipv6 enable_backups disable_backups snapshot
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0dea565-1bb0-4793-b881-27c7a3696273/1/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_post_byTag
Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments. Only a sub-set of action types are supported: power_cycle power_on power_off shutdown enable_ipv6 enable_backups disable_backups snapshot
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0dea565-1bb0-4793-b881-27c7a3696273/2/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_post_byTag
Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments. Only a sub-set of action types are supported: power_cycle power_on power_off shutdown enable_ipv6 enable_backups disable_backups snapshot
201
null
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}]}
{"properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"com...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0dea565-1bb0-4793-b881-27c7a3696273/3/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_post_byTag
Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments. Only a sub-set of action types are supported: power_cycle power_on power_off shutdown enable_ipv6 enable_backups disable_backups snapshot
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a51d5061-6690-418c-bd1f-48f1e1ad7424/0/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions. The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a51d5061-6690-418c-bd1f-48f1e1ad7424/1/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions. The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes.
200
null
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "...
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a51d5061-6690-418c-bd1f-48f1e1ad7424/2/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions. The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a51d5061-6690-418c-bd1f-48f1e1ad7424/3/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions. The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a51d5061-6690-418c-bd1f-48f1e1ad7424/4/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_list
To retrieve a list of all actions that have been executed for a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/actions. The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/0/0
Digital Ocean
Digital Ocean Public API
null
projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/1/0
Digital Ocean
Digital Ocean Public API
null
projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
200
null
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10...
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer",...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/2/0
Digital Ocean
Digital Ocean Public API
null
projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/3/0
Digital Ocean
Digital Ocean Public API
null
projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/4/0
Digital Ocean
Digital Ocean Public API
null
projects_patch_default
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_neighborsIds
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids. The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that ...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_neighborsIds
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids. The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that ...
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_neighborsIds
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids. The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that ...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/3/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_neighborsIds
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids. The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that ...
200
null
{"neighbor_ids": []}
{"type": "object", "properties": {"neighbor_ids": {"type": "array", "items": {"type": "array", "items": {"type": "integer"}}, "description": "An array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server."}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/4/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_neighborsIds
To retrieve a list of all Droplets that are co-located on the same physical hardware, send a GET request to /v2/reports/droplet_neighbors_ids. The results will be returned as a JSON object with a key of neighbor_ids. This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that ...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/41e3fb00-622c-4049-8f2f-6dec966a74bb/0/0
Digital Ocean
Digital Ocean Public API
null
projects_update
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/41e3fb00-622c-4049-8f2f-6dec966a74bb/1/0
Digital Ocean
Digital Ocean Public API
null
projects_update
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/41e3fb00-622c-4049-8f2f-6dec966a74bb/2/0
Digital Ocean
Digital Ocean Public API
null
projects_update
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/41e3fb00-622c-4049-8f2f-6dec966a74bb/3/0
Digital Ocean
Digital Ocean Public API
null
projects_update
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/41e3fb00-622c-4049-8f2f-6dec966a74bb/4/0
Digital Ocean
Digital Ocean Public API
null
projects_update
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
200
null
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10...
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer",...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_options
To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to /v2/kubernetes/options.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_options
To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to /v2/kubernetes/options.
200
null
{"options": {"regions": [{"name": "New York 1", "slug": "nyc1"}, {"name": "Singapore 1", "slug": "sgp1"}, {"name": "London 1", "slug": "lon1"}, {"name": "New York 3", "slug": "nyc3"}, {"name": "Amsterdam 3", "slug": "ams3"}, {"name": "Frankfurt 1", "slug": "fra1"}, {"name": "Toronto 1", "slug": "tor1"}, {"name": "San F...
{"type": "object", "properties": {"options": {"properties": {"regions": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "A DigitalOcean region where Kubernetes is available."}, "slug": {"type": "string", "description": "The identifier for a region for use when crea...