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/72022263-ecd6-4538-a675-32545d260e84/3/0
Digital Ocean
Digital Ocean Public API
null
sizes_list
To list all of available Droplet sizes, send a GET request to /v2/sizes. The response will be a JSON object with a key called sizes. The value of this will be an array of size objects each of which contain the standard size attributes.
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/29ee5e83-2070-4a25-95ae-5b7081aabfec/0/0
Digital Ocean
Digital Ocean Public API
null
apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed o...
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/29ee5e83-2070-4a25-95ae-5b7081aabfec/1/0
Digital Ocean
Digital Ocean Public API
null
apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed o...
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/29ee5e83-2070-4a25-95ae-5b7081aabfec/2/0
Digital Ocean
Digital Ocean Public API
null
apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed o...
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/29ee5e83-2070-4a25-95ae-5b7081aabfec/3/0
Digital Ocean
Digital Ocean Public API
null
apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed o...
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/29ee5e83-2070-4a25-95ae-5b7081aabfec/4/0
Digital Ocean
Digital Ocean Public API
null
apps_create_rollback
Rollback an app to a previous deployment. A new deployment will be created to perform the rollback. The app will be pinned to the rollback deployment preventing any new deployments from being created, either manually or through Auto Deploy on Push webhooks. To resume deployments, the rollback must be either committed o...
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/4535eae8-b9f9-481d-ab5a-510da6929df1/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_instanceSizes
List all instance sizes for service, worker, and job components.
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/4535eae8-b9f9-481d-ab5a-510da6929df1/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_instanceSizes
List all instance sizes for service, worker, and job components.
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/4535eae8-b9f9-481d-ab5a-510da6929df1/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_instanceSizes
List all instance sizes for service, worker, and job components.
200
null
{"instance_sizes": [{"name": "Basic XXS", "slug": "basic-xxs", "cpu_type": "SHARED", "cpus": "1", "memory_bytes": "536870912", "usd_per_month": "5.00", "usd_per_second": "0.000002066799", "tier_slug": "basic", "tier_upgrade_to": "professional-xs"}, {"name": "Basic XS", "slug": "basic-xs", "cpu_type": "SHARED", "cpus": ...
{"properties": {"discount_percent": {"format": "float", "type": "number", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "instance_sizes": {"items": {"properties": {"cpu_type": {"default": "UNSPECIFIED", "enum": ["UNSPECIFIED", "SHARED", "DEDICATED"], "title": "- SHARED: Shared vCPU cores\n - DED...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/4535eae8-b9f9-481d-ab5a-510da6929df1/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_instanceSizes
List all instance sizes for service, worker, and job components.
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/1dc693cc-3675-4eee-b602-30e8391a2d9c/0/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_csvByUUID
To retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/csv.
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/1dc693cc-3675-4eee-b602-30e8391a2d9c/1/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_csvByUUID
To retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/csv.
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/1dc693cc-3675-4eee-b602-30e8391a2d9c/3/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_csvByUUID
To retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/csv.
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/1dc693cc-3675-4eee-b602-30e8391a2d9c/4/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_csvByUUID
To retrieve a CSV for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/csv.
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/ce7ba372-317a-4dce-b313-34fafb653cdb/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_tier
Retrieve information about a specific app tier.
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/ce7ba372-317a-4dce-b313-34fafb653cdb/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_tier
Retrieve information about a specific app tier.
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/ce7ba372-317a-4dce-b313-34fafb653cdb/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_tier
Retrieve information about a specific app tier.
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/ce7ba372-317a-4dce-b313-34fafb653cdb/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_tier
Retrieve information about a specific app tier.
200
null
{"tier": {"name": "Basic", "slug": "basic", "egress_bandwidth_bytes": "42949672960", "build_seconds": "24000"}}
{"properties": {"tier": {"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 bandwidth in b...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ce7ba372-317a-4dce-b313-34fafb653cdb/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_tier
Retrieve information about a specific app tier.
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/8af37d8c-d894-4bb3-8105-2889f3f40c4d/0/0
Digital Ocean
Digital Ocean Public API
null
apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
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/8af37d8c-d894-4bb3-8105-2889f3f40c4d/1/0
Digital Ocean
Digital Ocean Public API
null
apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
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/8af37d8c-d894-4bb3-8105-2889f3f40c4d/2/0
Digital Ocean
Digital Ocean Public API
null
apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
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/8af37d8c-d894-4bb3-8105-2889f3f40c4d/3/0
Digital Ocean
Digital Ocean Public API
null
apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
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/8af37d8c-d894-4bb3-8105-2889f3f40c4d/4/0
Digital Ocean
Digital Ocean Public API
null
apps_create_deployment
Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.
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/7fd6891b-eb97-455a-992d-afc4599d7bcb/0/0
Digital Ocean
Digital Ocean Public API
null
invoices_list
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
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/7fd6891b-eb97-455a-992d-afc4599d7bcb/1/0
Digital Ocean
Digital Ocean Public API
null
invoices_list
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
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/7fd6891b-eb97-455a-992d-afc4599d7bcb/2/0
Digital Ocean
Digital Ocean Public API
null
invoices_list
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
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/7fd6891b-eb97-455a-992d-afc4599d7bcb/3/0
Digital Ocean
Digital Ocean Public API
null
invoices_list
To retrieve a list of all invoices, send a GET request to /v2/customers/my/invoices.
200
null
{"invoices": [{"invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681", "amount": "12.34", "invoice_period": "2019-12"}, {"invoice_uuid": "fdabb512-6faf-443c-ba2e-665452332a9e", "amount": "23.45", "invoice_period": "2019-11"}], "invoice_preview": {"invoice_uuid": "1afe95e6-0958-4eb0-8d9a-9c5060d3ef03", "amount": "34.56"...
{"allOf": [{"type": "object", "properties": {"invoices": {"type": "array", "items": {"type": "object", "description": "The invoice preview.", "properties": {"invoice_uuid": {"type": "string", "description": "The UUID of the invoice. The canonical reference for the invoice."}, "amount": {"type": "string", "description":...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c32d958d-8bc5-4bd9-b8f6-ef7c8a722fa3/0/0
Digital Ocean
Digital Ocean Public API
null
domains_delete_record
To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned.
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/c32d958d-8bc5-4bd9-b8f6-ef7c8a722fa3/2/0
Digital Ocean
Digital Ocean Public API
null
domains_delete_record
To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned.
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/c32d958d-8bc5-4bd9-b8f6-ef7c8a722fa3/3/0
Digital Ocean
Digital Ocean Public API
null
domains_delete_record
To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned.
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/c32d958d-8bc5-4bd9-b8f6-ef7c8a722fa3/4/0
Digital Ocean
Digital Ocean Public API
null
domains_delete_record
To delete a record for a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. The record will be deleted and the response status will be a 204. This indicates a successful request with no body returned.
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/ab26fb37-b067-4cd0-929b-d048e4e495b1/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_sql_mode
To configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE_ID/sql_mode specifying the desired modes. See the official MySQL 8 documentation for a full list of supported SQL modes. A successful request will receive a 204 No Content status code with no body in response.
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/ab26fb37-b067-4cd0-929b-d048e4e495b1/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_sql_mode
To configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE_ID/sql_mode specifying the desired modes. See the official MySQL 8 documentation for a full list of supported SQL modes. A successful request will receive a 204 No Content status code with no body in response.
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/ab26fb37-b067-4cd0-929b-d048e4e495b1/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_sql_mode
To configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE_ID/sql_mode specifying the desired modes. See the official MySQL 8 documentation for a full list of supported SQL modes. A successful request will receive a 204 No Content status code with no body in response.
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/ab26fb37-b067-4cd0-929b-d048e4e495b1/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_sql_mode
To configure the SQL modes for an existing MySQL cluster, send a PUT request to /v2/databases/$DATABASE_ID/sql_mode specifying the desired modes. See the official MySQL 8 documentation for a full list of supported SQL modes. A successful request will receive a 204 No Content status code with no body in response.
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/49162563-b32d-445a-8bfb-72a416716db0/0/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_byUUID
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_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/49162563-b32d-445a-8bfb-72a416716db0/1/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_byUUID
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_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/49162563-b32d-445a-8bfb-72a416716db0/2/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_byUUID
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID.
200
null
{"invoice_items": [{"product": "Kubernetes Clusters", "resource_uuid": "711157cb-37c8-4817-b371-44fa3504a39c", "group_description": "my-doks-cluster", "description": "a56e086a317d8410c8b4cfd1f4dc9f82", "amount": "12.34", "duration": "744", "duration_unit": "Hours", "start_time": "2020-01-01T00:00:00Z", "end_time": "202...
{"allOf": [{"type": "object", "properties": {"invoice_items": {"type": "array", "items": {"type": "object", "properties": {"product": {"type": "string", "description": "Name of the product being billed in the invoice item."}, "resource_uuid": {"type": "string", "description": "UUID of the resource billing in the invoic...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/49162563-b32d-445a-8bfb-72a416716db0/3/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_byUUID
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_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/49162563-b32d-445a-8bfb-72a416716db0/4/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_byUUID
To retrieve the invoice items for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_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/f096e72c-4c3f-4b86-aa07-a5ac879e6d5f/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
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/f096e72c-4c3f-4b86-aa07-a5ac879e6d5f/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
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/f096e72c-4c3f-4b86-aa07-a5ac879e6d5f/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
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/f096e72c-4c3f-4b86-aa07-a5ac879e6d5f/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
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/f096e72c-4c3f-4b86-aa07-a5ac879e6d5f/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get_logs
Retrieve the logs of a past, in-progress, or active deployment. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
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/3ecf062e-c36b-4882-b9db-edf21e792c08/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list_connectionPools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
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/3ecf062e-c36b-4882-b9db-edf21e792c08/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list_connectionPools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
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/3ecf062e-c36b-4882-b9db-edf21e792c08/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list_connectionPools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
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/3ecf062e-c36b-4882-b9db-edf21e792c08/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list_connectionPools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
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/3ecf062e-c36b-4882-b9db-edf21e792c08/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list_connectionPools
To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.
200
null
{"pools": [{"name": "backend-pool", "mode": "transaction", "size": 10, "db": "defaultdb", "user": "doadmin", "connection": {"uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "database": "defaultdb", "host": "backend-do-user-19081923-0.db.ondig...
{"type": "object", "properties": {"pools": {"type": "array", "description": "An array of connection pool objects.", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "A unique name for the connection pool. Must be between 3 and 60 characters."}, "mode": {"type": "string", "description...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/55bd0130-253d-4564-b43b-d11281e43ca8/1/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_pdfByUUID
To retrieve a PDF for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/pdf.
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/55bd0130-253d-4564-b43b-d11281e43ca8/2/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_pdfByUUID
To retrieve a PDF for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/pdf.
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/55bd0130-253d-4564-b43b-d11281e43ca8/3/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_pdfByUUID
To retrieve a PDF for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/pdf.
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/55bd0130-253d-4564-b43b-d11281e43ca8/4/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_pdfByUUID
To retrieve a PDF for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/pdf.
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/47834f70-b364-45d4-b761-a259970c4d26/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get_connectionPool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
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/47834f70-b364-45d4-b761-a259970c4d26/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get_connectionPool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
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/47834f70-b364-45d4-b761-a259970c4d26/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get_connectionPool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
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/47834f70-b364-45d4-b761-a259970c4d26/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get_connectionPool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
200
null
{"pool": {"name": "backend-pool", "mode": "transaction", "size": 10, "db": "defaultdb", "user": "doadmin", "connection": {"uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "database": "defaultdb", "host": "backend-do-user-19081923-0.db.ondigit...
{"type": "object", "properties": {"pool": {"type": "object", "properties": {"name": {"type": "string", "description": "A unique name for the connection pool. Must be between 3 and 60 characters."}, "mode": {"type": "string", "description": "The PGBouncer transaction mode for the connection pool. The allowed values are ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47834f70-b364-45d4-b761-a259970c4d26/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get_connectionPool
To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. The response will be a JSON object with a pool key.
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/fbefdc32-e334-4cd1-9877-a771b2b25cca/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_major_version
To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version. A successful request will receive a 204 No Content status code with no body in response.
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/fbefdc32-e334-4cd1-9877-a771b2b25cca/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_major_version
To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version. A successful request will receive a 204 No Content status code with no body in response.
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/fbefdc32-e334-4cd1-9877-a771b2b25cca/2/0
Digital Ocean
Digital Ocean Public API
null
databases_update_major_version
To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version. A successful request will receive a 204 No Content status code with no body in response.
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/fbefdc32-e334-4cd1-9877-a771b2b25cca/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_major_version
To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version. A successful request will receive a 204 No Content status code with no body in response.
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/6ac2398f-9c22-43c0-9ba5-c96ccb5a58f5/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of whic...
200
null
{"replicas": [{"id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "name": "read-nyc3-01", "region": "nyc3", "size": "db-s-2vcpu-4gb", "status": "creating", "tags": [], "created_at": "2019-01-11T18:37:36Z", "private_network_uuid": "9423cbad-9211-442f-820b-ef6915e99b5f", "connection": {"uri": "postgres://doadmin:wv78n3zpz42xe...
{"properties": {"replicas": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a database replica."}, "name": {"type": "string", "description": "The name to give the read-only replicating"}, "regi...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6ac2398f-9c22-43c0-9ba5-c96ccb5a58f5/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of whic...
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/6ac2398f-9c22-43c0-9ba5-c96ccb5a58f5/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of whic...
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/6ac2398f-9c22-43c0-9ba5-c96ccb5a58f5/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of whic...
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/6ac2398f-9c22-43c0-9ba5-c96ccb5a58f5/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list_replicas
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of whic...
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/de968c94-1b27-4f1f-bc94-9411530edfdb/1/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_user
To remove a specific database user, send a DELETE request to /v2/databases/$DATABASE_ID/users/$USERNAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: User management is not supported for Redis clusters.
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/de968c94-1b27-4f1f-bc94-9411530edfdb/2/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_user
To remove a specific database user, send a DELETE request to /v2/databases/$DATABASE_ID/users/$USERNAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: User management is not supported for Redis clusters.
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/de968c94-1b27-4f1f-bc94-9411530edfdb/3/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_user
To remove a specific database user, send a DELETE request to /v2/databases/$DATABASE_ID/users/$USERNAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: User management is not supported for Redis clusters.
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/de968c94-1b27-4f1f-bc94-9411530edfdb/4/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_user
To remove a specific database user, send a DELETE request to /v2/databases/$DATABASE_ID/users/$USERNAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: User management is not supported for Redis clusters.
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/d23ef0ae-3573-4246-b036-e9623dd6fc15/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica at...
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/d23ef0ae-3573-4246-b036-e9623dd6fc15/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica at...
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/d23ef0ae-3573-4246-b036-e9623dd6fc15/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica at...
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/d23ef0ae-3573-4246-b036-e9623dd6fc15/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica at...
200
null
{"replica": {"id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "name": "read-nyc3-01", "region": "nyc3", "size": "db-s-2vcpu-4gb", "status": "creating", "tags": [], "created_at": "2019-01-11T18:37:36Z", "private_network_uuid": "9423cbad-9211-442f-820b-ef6915e99b5f", "connection": {"uri": "postgres://doadmin:wv78n3zpz42xezd...
{"type": "object", "properties": {"replica": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a database replica."}, "name": {"type": "string", "description": "The name to give the read-only replicating"}, "region": {"typ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d23ef0ae-3573-4246-b036-e9623dd6fc15/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get_replica
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica at...
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/f522053f-aa3a-47d9-bb7a-22b3bd21a3ce/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Redis clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain th...
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/f522053f-aa3a-47d9-bb7a-22b3bd21a3ce/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Redis clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain th...
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/f522053f-aa3a-47d9-bb7a-22b3bd21a3ce/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Redis clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain th...
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/f522053f-aa3a-47d9-bb7a-22b3bd21a3ce/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Redis clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain th...
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/f522053f-aa3a-47d9-bb7a-22b3bd21a3ce/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list_backups
To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to /v2/databases/$DATABASE_ID/backups. Note: Backups are not supported for Redis clusters. The result will be a JSON object with a backups key. This will be set to an array of backup objects, each of which will contain th...
200
null
{"backups": [{"created_at": "2019-01-31T19:25:22Z", "size_gigabytes": 0.03364864}]}
{"type": "object", "properties": {"backups": {"type": "array", "items": {"type": "object", "properties": {"created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format at which the backup was created."}, "size_gigabytes": {"type": "number", "descript...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f971bb-b0da-4777-9dc0-c3f637381a19/0/0
Digital Ocean
Digital Ocean Public API
null
billingHistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
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/73f971bb-b0da-4777-9dc0-c3f637381a19/1/0
Digital Ocean
Digital Ocean Public API
null
billingHistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
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/73f971bb-b0da-4777-9dc0-c3f637381a19/2/0
Digital Ocean
Digital Ocean Public API
null
billingHistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
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/73f971bb-b0da-4777-9dc0-c3f637381a19/3/0
Digital Ocean
Digital Ocean Public API
null
billingHistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
200
null
{"billing_history": [{"description": "Invoice for May 2018", "amount": "12.34", "invoice_id": "123", "invoice_uuid": "example-uuid", "date": "2018-06-01T08:44:38Z", "type": "Invoice"}, {"description": "Payment (MC 2018)", "amount": "-12.34", "date": "2018-06-02T08:44:38Z", "type": "Payment"}], "links": {"pages": {"next...
{"allOf": [{"type": "object", "properties": {"billing_history": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string", "description": "Description of the billing history entry."}, "amount": {"type": "string", "description": "Amount of the billing history entry."}, "invoice_id": {...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73f971bb-b0da-4777-9dc0-c3f637381a19/4/0
Digital Ocean
Digital Ocean Public API
null
billingHistory_list
To retrieve a list of all billing history entries, send a GET request to /v2/customers/my/billing_history.
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/15632374-45d2-4acd-9094-2d51b90ab3f9/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_clusterSize
To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute 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/15632374-45d2-4acd-9094-2d51b90ab3f9/2/0
Digital Ocean
Digital Ocean Public API
null
databases_update_clusterSize
To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute 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/15632374-45d2-4acd-9094-2d51b90ab3f9/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_clusterSize
To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute 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/15632374-45d2-4acd-9094-2d51b90ab3f9/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_clusterSize
To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute 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/508301a5-b93d-4b29-898e-ff2e8d4ba93d/0/0
Digital Ocean
Digital Ocean Public API
null
registry_update_subscription
After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.
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/508301a5-b93d-4b29-898e-ff2e8d4ba93d/1/0
Digital Ocean
Digital Ocean Public API
null
registry_update_subscription
After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.
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/508301a5-b93d-4b29-898e-ff2e8d4ba93d/2/0
Digital Ocean
Digital Ocean Public API
null
registry_update_subscription
After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.
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/508301a5-b93d-4b29-898e-ff2e8d4ba93d/3/0
Digital Ocean
Digital Ocean Public API
null
registry_update_subscription
After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to /v2/registry/subscription.
200
null
{"subscription": {"tier": {"name": "Basic", "slug": "basic", "included_repositories": 5, "included_storage_bytes": 5368709120, "allow_storage_overage": true, "included_bandwidth_bytes": 5368709120, "monthly_price_in_cents": 500, "storage_overage_price_in_cents": 2}, "created_at": "2020-01-23T21:19:12Z", "updated_at": "...
{"properties": {"subscription": {"type": "object", "properties": {"tier": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the subscription tier."}, "slug": {"type": "string", "description": "The slug identifier of the subscription tier."}, "included_repositories": {"type": "inte...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aa899e0-c5be-46a7-8e55-d9b3e80373e4/0/0
Digital Ocean
Digital Ocean Public API
null
registry_list_garbageCollections
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
200
null
{"garbage_collections": [{"uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8", "registry_name": "example", "status": "requested", "created_at": "2020-10-30T21:03:24Z", "updated_at": "2020-10-30T21:03:44Z", "blobs_deleted": 42, "freed_bytes": 667}]}
{"type": "object", "properties": {"garbage_collections": {"type": "array", "items": {"type": "object", "properties": {"uuid": {"type": "string", "description": "A string specifying the UUID of the garbage collection."}, "registry_name": {"type": "string", "description": "The name of the container registry."}, "status":...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aa899e0-c5be-46a7-8e55-d9b3e80373e4/1/0
Digital Ocean
Digital Ocean Public API
null
registry_list_garbageCollections
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
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/7aa899e0-c5be-46a7-8e55-d9b3e80373e4/2/0
Digital Ocean
Digital Ocean Public API
null
registry_list_garbageCollections
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
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/7aa899e0-c5be-46a7-8e55-d9b3e80373e4/3/0
Digital Ocean
Digital Ocean Public API
null
registry_list_garbageCollections
To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections.
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,...