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/961cd0f2-859b-4baa-9945-365404e79676/3/0
Digital Ocean
Digital Ocean Public API
null
apps_assign_alertDestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the 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/961cd0f2-859b-4baa-9945-365404e79676/4/0
Digital Ocean
Digital Ocean Public API
null
apps_assign_alertDestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the 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/623ca680-ec08-40c1-b545-1217c669ec5d/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_get
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/623ca680-ec08-40c1-b545-1217c669ec5d/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_get
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/623ca680-ec08-40c1-b545-1217c669ec5d/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_get
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/623ca680-ec08-40c1-b545-1217c669ec5d/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_get
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
200
null
{"alert": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page degraded performance", "type": "latency", "threshold": 300, "comparison": "greater_than", "notifications": {"email": [], "slack": []}, "period": "2m"}}
{"type": "object", "properties": {"alert": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the alert."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/623ca680-ec08-40c1-b545-1217c669ec5d/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_get
To show information about an existing alert, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/aebf135e-efb6-47e2-bd3c-e17c2ed92075/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_alerts_list
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
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/aebf135e-efb6-47e2-bd3c-e17c2ed92075/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_alerts_list
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
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/aebf135e-efb6-47e2-bd3c-e17c2ed92075/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_alerts_list
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
200
null
{"alerts": [{"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page degraded performance", "type": "latency", "threshold": 300, "comparison": "greater_than", "notifications": {"email": [], "slack": []}, "period": "2m"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "next": "...
{"allOf": [{"type": "object", "properties": {"alerts": {"type": "array", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the alert."}}}, {"type": "object", "properties": {"name": {"t...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aebf135e-efb6-47e2-bd3c-e17c2ed92075/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_alerts_list
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
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/aebf135e-efb6-47e2-bd3c-e17c2ed92075/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_alerts_list
To list all of the alerts for an Uptime check, send a GET request to /v2/uptime/checks/$CHECK_ID/alerts.
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/5873a9c8-17c0-406f-baca-1605d6dd5937/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_update
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/5873a9c8-17c0-406f-baca-1605d6dd5937/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_update
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/5873a9c8-17c0-406f-baca-1605d6dd5937/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_update
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_ID.
200
null
{"alert": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page degraded performance", "type": "latency", "threshold": 300, "comparison": "greater_than", "notifications": {"email": [], "slack": []}, "period": "2m"}}
{"type": "object", "properties": {"alert": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the alert."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5873a9c8-17c0-406f-baca-1605d6dd5937/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_update
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/5873a9c8-17c0-406f-baca-1605d6dd5937/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_update
To update the settings of an Uptime alert, send a PUT request to /v2/uptime/checks/$CHECK_ID/alerts/$ALERT_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/6b85d61c-1d2e-4bd3-91fd-4a4099e5941c/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_delete
To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 status code with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check.
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/6b85d61c-1d2e-4bd3-91fd-4a4099e5941c/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_delete
To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 status code with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check.
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/6b85d61c-1d2e-4bd3-91fd-4a4099e5941c/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_delete
To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 status code with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check.
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/6b85d61c-1d2e-4bd3-91fd-4a4099e5941c/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_delete
To delete an Uptime check, send a DELETE request to /v2/uptime/checks/$CHECK_ID. A 204 status code with no body will be returned in response to a successful request. Deleting a check will also delete alerts associated with the check.
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/ff26dd16-841b-4dfe-a785-d63fccc97d4a/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_state_get
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
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/ff26dd16-841b-4dfe-a785-d63fccc97d4a/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_state_get
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
200
null
{"state": {"regions": {"us_east": {"status": "DOWN", "status_changed_at": "2022-03-17T22:28:51Z", "thirty_day_uptime_percentage": 97.99}, "eu_west": {"status": "DOWN", "status_changed_at": "2022-03-17T22:28:51Z", "thirty_day_uptime_percentage": 97.99}}, "previous_outage": {"region": "us_east", "started_at": "2022-03-17...
{"type": "object", "properties": {"state": {"type": "object", "properties": {"regions": {"type": "object", "description": "A map of region to regional state", "properties": {"us_east": {"type": "object", "properties": {"status": {"type": "string", "enum": ["DOWN", "UP", "CHECKING"]}, "status_changed_at": {"type": "stri...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ff26dd16-841b-4dfe-a785-d63fccc97d4a/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_state_get
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
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/ff26dd16-841b-4dfe-a785-d63fccc97d4a/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_state_get
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
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/ff26dd16-841b-4dfe-a785-d63fccc97d4a/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_state_get
To show information about an existing check's state, send a GET request to /v2/uptime/checks/$CHECK_ID/state.
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/0ade9d38-e42c-4a8c-8c45-dce6071e54cf/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_create
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
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/0ade9d38-e42c-4a8c-8c45-dce6071e54cf/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_create
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
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/0ade9d38-e42c-4a8c-8c45-dce6071e54cf/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_create
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
201
null
{"alert": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page degraded performance", "type": "latency", "threshold": 300, "comparison": "greater_than", "notifications": {"email": [], "slack": []}, "period": "2m"}}
{"type": "object", "properties": {"alert": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the alert."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0ade9d38-e42c-4a8c-8c45-dce6071e54cf/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_create
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
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/0ade9d38-e42c-4a8c-8c45-dce6071e54cf/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_alert_create
To create an Uptime alert, send a POST request to /v2/uptime/checks/$CHECK_ID/alerts specifying the attributes in the table below in the JSON body.
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/8050ff78-72fa-4506-b929-cf433a546c94/0/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
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/8050ff78-72fa-4506-b929-cf433a546c94/1/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
200
null
{"resources": [{"urn": "do:droplet:13457723", "assigned_at": "2018-09-28T19:26:37Z", "links": {"self": "https://api.digitalocean.com/v2/droplets/13457723"}, "status": "ok"}, {"urn": "do:domain:example.com", "assigned_at": "2019-03-31T16:24:14Z", "links": {"self": "https://api.digitalocean.com/v2/domains/example.com"}, ...
{"allOf": [{"type": "object", "properties": {"resources": {"type": "array", "items": {"type": "object", "properties": {"urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "description": "The uniform resource name (URN) for the resource in the format ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8050ff78-72fa-4506-b929-cf433a546c94/2/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
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/8050ff78-72fa-4506-b929-cf433a546c94/3/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
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/8050ff78-72fa-4506-b929-cf433a546c94/4/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources_default
To list all your resources in your default project, send a GET request to /v2/projects/default/resources.
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/678b7663-d763-4d4b-9276-cf9e2d0b6f38/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_checks_list
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
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/678b7663-d763-4d4b-9276-cf9e2d0b6f38/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_checks_list
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
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/678b7663-d763-4d4b-9276-cf9e2d0b6f38/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_checks_list
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
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/678b7663-d763-4d4b-9276-cf9e2d0b6f38/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_checks_list
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
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/678b7663-d763-4d4b-9276-cf9e2d0b6f38/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_checks_list
To list all of the Uptime checks on your account, send a GET request to /v2/uptime/checks.
200
null
{"checks": [{"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page check", "type": "ping", "target": "https://www.landingpage.com", "regions": ["us_east"], "enabled": true}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "next": "https://api.digitalocean.com/v2/images?page=2...
{"allOf": [{"type": "object", "properties": {"checks": {"type": "array", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the check."}}}, {"type": "object", "properties": {"name": {"t...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3aab5a7e-b693-4402-9aeb-16e057a6ff66/0/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
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/3aab5a7e-b693-4402-9aeb-16e057a6ff66/1/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
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/3aab5a7e-b693-4402-9aeb-16e057a6ff66/2/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
200
null
{"resources": [{"urn": "do:droplet:13457723", "assigned_at": "2018-09-28T19:26:37Z", "links": {"self": "https://api.digitalocean.com/v2/droplets/13457723"}, "status": "ok"}, {"urn": "do:domain:example.com", "assigned_at": "2019-03-31T16:24:14Z", "links": {"self": "https://api.digitalocean.com/v2/domains/example.com"}, ...
{"allOf": [{"type": "object", "properties": {"resources": {"type": "array", "items": {"type": "object", "properties": {"urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "description": "The uniform resource name (URN) for the resource in the format ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3aab5a7e-b693-4402-9aeb-16e057a6ff66/3/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
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/3aab5a7e-b693-4402-9aeb-16e057a6ff66/4/0
Digital Ocean
Digital Ocean Public API
null
projects_list_resources
To list all your resources in a project, send a GET request to /v2/projects/$PROJECT_ID/resources.
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/ba4ac623-02a8-4dc6-9a89-f9f115cd367f/0/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
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/ba4ac623-02a8-4dc6-9a89-f9f115cd367f/1/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
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/ba4ac623-02a8-4dc6-9a89-f9f115cd367f/2/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
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/ba4ac623-02a8-4dc6-9a89-f9f115cd367f/3/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
200
null
{"resources": [{"urn": "do:droplet:13457723", "assigned_at": "2018-09-28T19:26:37Z", "links": {"self": "https://api.digitalocean.com/v2/droplets/13457723"}, "status": "ok"}, {"urn": "do:domain:example.com", "assigned_at": "2019-03-31T16:24:14Z", "links": {"self": "https://api.digitalocean.com/v2/domains/example.com"}, ...
{"type": "object", "properties": {"resources": {"type": "array", "items": {"type": "object", "properties": {"urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "description": "The uniform resource name (URN) for the resource in the format do:resource...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ba4ac623-02a8-4dc6-9a89-f9f115cd367f/4/0
Digital Ocean
Digital Ocean Public API
null
projects_assign_resources
To assign resources to a project, send a POST request to /v2/projects/$PROJECT_ID/resources.
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/b8cf969d-b770-4f91-b5e3-75daa0c3d9bb/0/0
Digital Ocean
Digital Ocean Public API
null
images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
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/b8cf969d-b770-4f91-b5e3-75daa0c3d9bb/1/0
Digital Ocean
Digital Ocean Public API
null
images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
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/b8cf969d-b770-4f91-b5e3-75daa0c3d9bb/2/0
Digital Ocean
Digital Ocean Public API
null
images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
200
null
{"image": {}}
{"type": "object", "properties": {"image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted*...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b8cf969d-b770-4f91-b5e3-75daa0c3d9bb/3/0
Digital Ocean
Digital Ocean Public API
null
images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
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/b8cf969d-b770-4f91-b5e3-75daa0c3d9bb/4/0
Digital Ocean
Digital Ocean Public API
null
images_get
To retrieve information about an image, send a GET request to /v2/images/$IDENTIFIER.
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/7a8e61c4-02ab-4795-a0a9-9e3cd01fdfac/0/0
Digital Ocean
Digital Ocean Public API
null
images_delete
To delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE_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/7a8e61c4-02ab-4795-a0a9-9e3cd01fdfac/1/0
Digital Ocean
Digital Ocean Public API
null
images_delete
To delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE_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/7a8e61c4-02ab-4795-a0a9-9e3cd01fdfac/2/0
Digital Ocean
Digital Ocean Public API
null
images_delete
To delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE_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/7a8e61c4-02ab-4795-a0a9-9e3cd01fdfac/3/0
Digital Ocean
Digital Ocean Public API
null
images_delete
To delete a snapshot or custom image, send a DELETE request to /v2/images/$IMAGE_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/80f8c704-948c-449a-ba66-efafdfbc3b0b/0/0
Digital Ocean
Digital Ocean Public API
null
images_create_custom
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB afte...
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/80f8c704-948c-449a-ba66-efafdfbc3b0b/1/0
Digital Ocean
Digital Ocean Public API
null
images_create_custom
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB afte...
202
null
{"image": {}}
{"properties": {"image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted**"}, "regions": {"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80f8c704-948c-449a-ba66-efafdfbc3b0b/2/0
Digital Ocean
Digital Ocean Public API
null
images_create_custom
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB afte...
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/80f8c704-948c-449a-ba66-efafdfbc3b0b/3/0
Digital Ocean
Digital Ocean Public API
null
images_create_custom
To create a new custom image, send a POST request to /v2/images. The body must contain a url attribute pointing to a Linux virtual machine image to be imported into DigitalOcean. The image must be in the raw, qcow2, vhdx, vdi, or vmdk format. It may be compressed using gzip or bzip2 and must be smaller than 100 GB afte...
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/616d112a-025e-4664-8566-5942f47e2746/0/0
Digital Ocean
Digital Ocean Public API
null
domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective 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/616d112a-025e-4664-8566-5942f47e2746/1/0
Digital Ocean
Digital Ocean Public API
null
domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective 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/616d112a-025e-4664-8566-5942f47e2746/2/0
Digital Ocean
Digital Ocean Public API
null
domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective 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/616d112a-025e-4664-8566-5942f47e2746/3/0
Digital Ocean
Digital Ocean Public API
null
domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective attributes.
200
null
{"domain_record": {"id": 3352896, "type": "A", "name": "blog", "data": "162.10.66.0", "priority": null, "port": null, "ttl": 1800, "weight": null, "flags": null, "tag": null}}
{"properties": {"domain_record": {"type": "object", "required": ["type"], "properties": {"id": {"type": "integer", "description": "A unique identifier for each domain record."}, "type": {"type": "string", "description": "The type of the DNS record. For example: A, CNAME, TXT, ..."}, "name": {"type": "string", "descript...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/616d112a-025e-4664-8566-5942f47e2746/4/0
Digital Ocean
Digital Ocean Public API
null
domains_patch_record
To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record. See the attribute table for details regarding record types and their respective 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/104d41e3-491c-463d-8745-45bf9578756a/0/0
Digital Ocean
Digital Ocean Public API
null
databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a databas...
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/104d41e3-491c-463d-8745-45bf9578756a/1/0
Digital Ocean
Digital Ocean Public API
null
databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a databas...
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/104d41e3-491c-463d-8745-45bf9578756a/2/0
Digital Ocean
Digital Ocean Public API
null
databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a databas...
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/104d41e3-491c-463d-8745-45bf9578756a/3/0
Digital Ocean
Digital Ocean Public API
null
databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a databas...
201
null
{"db": {"name": "alpha"}}
{"type": "object", "properties": {"db": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the database."}}, "required": ["name"]}}, "required": ["db"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/104d41e3-491c-463d-8745-45bf9578756a/4/0
Digital Ocean
Digital Ocean Public API
null
databases_add
To add a new database to an existing cluster, send a POST request to /v2/databases/$DATABASE_ID/dbs. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a databas...
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/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/0/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
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/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/1/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
200
null
{"valid": true}
{"type": "object", "properties": {"valid": {"type": "boolean", "description": "Indicates whether the app can be rolled back to the specified deployment."}, "error": {"allOf": [{"description": "Contains the failing condition that is causing the rollback to be invalid."}, {"type": "object", "properties": {"code": {"type"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/1/1
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
200
null
{"valid": true, "warnings": [{"code": "image_source_missing_digest", "components": ["docker-worker"], "message": "one or more components are missing an image digest and are not guaranteed rollback to the old version"}]}
{"type": "object", "properties": {"valid": {"type": "boolean", "description": "Indicates whether the app can be rolled back to the specified deployment."}, "error": {"allOf": [{"description": "Contains the failing condition that is causing the rollback to be invalid."}, {"type": "object", "properties": {"code": {"type"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/1/2
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
200
null
{"valid": false, "error": {"code": "incompatible_result", "message": "deployment result \"failed\" is unsuitable for rollback"}}
{"type": "object", "properties": {"valid": {"type": "boolean", "description": "Indicates whether the app can be rolled back to the specified deployment."}, "error": {"allOf": [{"description": "Contains the failing condition that is causing the rollback to be invalid."}, {"type": "object", "properties": {"code": {"type"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/2/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
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/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/3/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
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/9a5dbe09-16ce-402f-b97a-c52d3f97a27d/4/0
Digital Ocean
Digital Ocean Public API
null
apps_validate_rollback
Check whether an app can be rolled back to a specific deployment. This endpoint can also be used to check if there are any warnings or validation conditions that will cause the rollback to proceed under unideal circumstances. For example, if a component must be rebuilt as part of the rollback causing it to take longer ...
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/2cba0c37-a545-447c-b6bd-20666ca8759b/0/0
Digital Ocean
Digital Ocean Public API
null
domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.
200
null
{"domain_record": {"id": 3352896, "type": "A", "name": "blog", "data": "162.10.66.0", "priority": null, "port": null, "ttl": 1800, "weight": null, "flags": null, "tag": null}}
{"properties": {"domain_record": {"type": "object", "required": ["type"], "properties": {"id": {"type": "integer", "description": "A unique identifier for each domain record."}, "type": {"type": "string", "description": "The type of the DNS record. For example: A, CNAME, TXT, ..."}, "name": {"type": "string", "descript...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2cba0c37-a545-447c-b6bd-20666ca8759b/1/0
Digital Ocean
Digital Ocean Public API
null
domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_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/2cba0c37-a545-447c-b6bd-20666ca8759b/2/0
Digital Ocean
Digital Ocean Public API
null
domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_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/2cba0c37-a545-447c-b6bd-20666ca8759b/3/0
Digital Ocean
Digital Ocean Public API
null
domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_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/2cba0c37-a545-447c-b6bd-20666ca8759b/4/0
Digital Ocean
Digital Ocean Public API
null
domains_get_record
To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_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/3af681c7-68d7-4259-bf7e-f29da3649d4e/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users. Note: User management is not supported for Redis clusters. The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard databas...
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/3af681c7-68d7-4259-bf7e-f29da3649d4e/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users. Note: User management is not supported for Redis clusters. The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard databas...
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/3af681c7-68d7-4259-bf7e-f29da3649d4e/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users. Note: User management is not supported for Redis clusters. The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard databas...
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/3af681c7-68d7-4259-bf7e-f29da3649d4e/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users. Note: User management is not supported for Redis clusters. The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard databas...
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/3af681c7-68d7-4259-bf7e-f29da3649d4e/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list_users
To list all of the users for your database cluster, send a GET request to /v2/databases/$DATABASE_ID/users. Note: User management is not supported for Redis clusters. The result will be a JSON object with a users key. This will be set to an array of database user objects, each of which will contain the standard databas...
200
null
{"users": [{"name": "app-01", "role": "primary", "password": "jge5lfxtzhx42iff", "mysql_settings": {"auth_plugin": "mysql_native_password"}}]}
{"properties": {"users": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of a database user."}, "role": {"type": "string", "enum": ["primary", "normal"], "description": "A string representing the database user's role. The value will be either\n\"primary\"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ebef9a37-2ee1-4374-8e9c-8e76eab4b12d/0/0
Digital Ocean
Digital Ocean Public API
null
apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the 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/ebef9a37-2ee1-4374-8e9c-8e76eab4b12d/1/0
Digital Ocean
Digital Ocean Public API
null
apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the 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/ebef9a37-2ee1-4374-8e9c-8e76eab4b12d/2/0
Digital Ocean
Digital Ocean Public API
null
apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the 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/ebef9a37-2ee1-4374-8e9c-8e76eab4b12d/3/0
Digital Ocean
Digital Ocean Public API
null
apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the response.
200
null
{"app": {"id": "c2a93513-8d9b-4223-9d61-5e7272c81cf5", "owner_uuid": "a4e16f25-cdd1-4483-b246-d77f283c9209", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_siz...
{"properties": {"app": {"description": "An application's configuration and status.", "properties": {"active_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", "ty...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ebef9a37-2ee1-4374-8e9c-8e76eab4b12d/4/0
Digital Ocean
Digital Ocean Public API
null
apps_get
Retrieve details about an existing app by either its ID or name. To retrieve an app by its name, do not include an ID in the request path. Information about the current active deployment as well as any in progress ones will also be included in the 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/21060171-2928-4746-b00b-2230658a9846/0/0
Digital Ocean
Digital Ocean Public API
null
images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
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/21060171-2928-4746-b00b-2230658a9846/1/0
Digital Ocean
Digital Ocean Public API
null
images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
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/21060171-2928-4746-b00b-2230658a9846/2/0
Digital Ocean
Digital Ocean Public API
null
images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
200
null
{"image": {}}
{"type": "object", "properties": {"image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted*...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/21060171-2928-4746-b00b-2230658a9846/3/0
Digital Ocean
Digital Ocean Public API
null
images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
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,...