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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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-friendly display name."}, "type": {"type": "string", "enum": ["latency", "down", "down_global", "ssl_expiry"], "description": "The type of alert."}, "threshold": {"type": "integer", "description": "The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type."}, "comparison": {"type": "string", "description": "The comparison operator used against the alert's threshold.", "enum": ["greater_than", "less_than"]}, "notifications": {"type": "object", "description": "The notification settings for a trigger alert.", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"description": "**Omitted**"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"description": "**Omitted**"}}}}, "period": {"type": "string", "description": "Period of time the threshold must be exceeded to trigger the alert.", "enum": ["2m", "3m", "5m", "10m", "15m", "30m", "1h"]}}}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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": "https://api.digitalocean.com/v2/images?page=2", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}} | {"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": {"type": "string", "description": "A human-friendly display name."}, "type": {"type": "string", "enum": ["latency", "down", "down_global", "ssl_expiry"], "description": "The type of alert."}, "threshold": {"type": "integer", "description": "The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type."}, "comparison": {"type": "string", "description": "The comparison operator used against the alert's threshold.", "enum": ["greater_than", "less_than"]}, "notifications": {"type": "object", "description": "The notification settings for a trigger alert.", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"description": "**Omitted**"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"description": "**Omitted**"}}}}, "period": {"type": "string", "description": "Period of time the threshold must be exceeded to trigger the alert.", "enum": ["2m", "3m", "5m", "10m", "15m", "30m", "1h"]}}}]}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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-friendly display name."}, "type": {"type": "string", "enum": ["latency", "down", "down_global", "ssl_expiry"], "description": "The type of alert."}, "threshold": {"type": "integer", "description": "The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type."}, "comparison": {"type": "string", "description": "The comparison operator used against the alert's threshold.", "enum": ["greater_than", "less_than"]}, "notifications": {"type": "object", "description": "The notification settings for a trigger alert.", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"description": "**Omitted**"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"description": "**Omitted**"}}}}, "period": {"type": "string", "description": "Period of time the threshold must be exceeded to trigger the alert.", "enum": ["2m", "3m", "5m", "10m", "15m", "30m", "1h"]}}}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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-17T18:04:55Z", "ended_at": "2022-03-17T18:06:55Z", "duration_seconds": 120}}} | {"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": "string"}, "thirty_day_uptime_percentage": {"type": "number"}}}, "eu_west": {"type": "object", "properties": {"status": {"type": "string", "enum": ["DOWN", "UP", "CHECKING"]}, "status_changed_at": {"type": "string"}, "thirty_day_uptime_percentage": {"type": "number"}}}}}, "previous_outage": {"type": "object", "properties": {"region": {"type": "string"}, "started_at": {"type": "string"}, "ended_at": {"type": "string"}, "duration_seconds": {"type": "integer"}}}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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-friendly display name."}, "type": {"type": "string", "enum": ["latency", "down", "down_global", "ssl_expiry"], "description": "The type of alert."}, "threshold": {"type": "integer", "description": "The threshold at which the alert will enter a trigger state. The specific threshold is dependent on the alert type."}, "comparison": {"type": "string", "description": "The comparison operator used against the alert's threshold.", "enum": ["greater_than", "less_than"]}, "notifications": {"type": "object", "description": "The notification settings for a trigger alert.", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"description": "**Omitted**"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"description": "**Omitted**"}}}}, "period": {"type": "string", "description": "Period of time the threshold must be exceeded to trigger the alert.", "enum": ["2m", "3m", "5m", "10m", "15m", "30m", "1h"]}}}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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"}, "status": "ok"}], "links": {"pages": {"first": "https://api.digitalocean.com/v2/projects/4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679/resources?page=1", "last": "https://api.digitalocean.com/v2/projects/4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679/resources?page=1"}}, "meta": {"total": 2}} | {"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 do:resource_type:resource_id."}, "assigned_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "links": {"type": "object", "description": "The links object contains the `self` object, which contains the resource relationship.", "properties": {"self": {"type": "string", "format": "uri", "description": "A URI that can be used to retrieve the resource."}}}, "status": {"type": "string", "enum": ["ok", "not_found", "assigned", "already_assigned", "service_down"], "description": "The status of assigning and fetching the resources."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}} | {"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": {"type": "string", "description": "A human-friendly display name."}, "type": {"type": "string", "enum": ["ping", "http", "https"], "description": "The type of health check to perform."}, "target": {"type": "string", "format": "url", "description": "The endpoint to perform healthchecks on."}, "regions": {"type": "array", "items": {"type": "string", "enum": ["us_east", "us_west", "eu_west", "se_asia"]}, "description": "An array containing the selected regions to perform healthchecks from."}, "enabled": {"type": "boolean", "default": true, "description": "A boolean value indicating whether the check is enabled/disabled."}}}]}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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"}, "status": "ok"}], "links": {"pages": {"first": "https://api.digitalocean.com/v2/projects/4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679/resources?page=1", "last": "https://api.digitalocean.com/v2/projects/4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679/resources?page=1"}}, "meta": {"total": 2}} | {"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 do:resource_type:resource_id."}, "assigned_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "links": {"type": "object", "description": "The links object contains the `self` object, which contains the resource relationship.", "properties": {"self": {"type": "string", "format": "uri", "description": "A URI that can be used to retrieve the resource."}}}, "status": {"type": "string", "enum": ["ok", "not_found", "assigned", "already_assigned", "service_down"], "description": "The status of assigning and fetching the resources."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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"}, "status": "ok"}]} | {"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_type:resource_id."}, "assigned_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "links": {"type": "object", "description": "The links object contains the `self` object, which contains the resource relationship.", "properties": {"self": {"type": "string", "format": "uri", "description": "A URI that can be used to retrieve the resource."}}}, "status": {"type": "string", "enum": ["ok", "not_found", "assigned", "already_assigned", "service_down"], "description": "The status of assigning and fetching the resources."}}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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**"}, "regions": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}}, "required": ["image"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 after
being decompressed. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 after
being decompressed. | 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": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}}} |
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 after
being decompressed. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 after
being decompressed. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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", "description": "The host name, alias, or service being defined by the record."}, "data": {"type": "string", "description": "Variable data depending on record type. For example, the \"data\" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates."}, "priority": {"type": ["integer", "null"], "description": "The priority for SRV and MX records."}, "port": {"type": ["integer", "null"], "description": "The port for SRV records."}, "ttl": {"type": "integer", "description": "This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."}, "weight": {"type": ["integer", "null"], "description": "The weight for SRV records."}, "flags": {"type": ["integer", "null"], "description": "An unsigned integer between 0-255 used for CAA records."}, "tag": {"type": ["string", "null"], "description": "The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database. | 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 database. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 than usual. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 than usual. | 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": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}]}, "warnings": {"type": "array", "description": "Contains a list of warnings that may cause the rollback to run under unideal circumstances.", "items": {"type": "object", "properties": {"code": {"type": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}}}} |
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 than usual. | 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": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}]}, "warnings": {"type": "array", "description": "Contains a list of warnings that may cause the rollback to run under unideal circumstances.", "items": {"type": "object", "properties": {"code": {"type": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}}}} |
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 than usual. | 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": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}]}, "warnings": {"type": "array", "description": "Contains a list of warnings that may cause the rollback to run under unideal circumstances.", "items": {"type": "object", "properties": {"code": {"type": "string", "enum": ["incompatible_phase", "incompatible_result", "exceeded_revision_limit", "app_pinned", "database_config_conflict", "region_conflict", "static_site_requires_rebuild", "image_source_missing_digest"], "description": "A code identifier that represents the failing condition.\n\nFailing conditions:\n - `incompatible_phase` - indicates that the deployment's phase is not suitable for rollback.\n - `incompatible_result` - indicates that the deployment's result is not suitable for rollback.\n - `exceeded_revision_limit` - indicates that the app has exceeded the rollback revision limits for its tier.\n - `app_pinned` - indicates that there is already a rollback in progress and the app is pinned.\n - `database_config_conflict` - indicates that the deployment's database config is different than the current config.\n - `region_conflict` - indicates that the deployment's region differs from the current app region.\n \nWarning conditions:\n - `static_site_requires_rebuild` - indicates that the deployment contains at least one static site that will require a rebuild.\n - `image_source_missing_digest` - indicates that the deployment contains at least one component with an image source that is missing a digest.\n"}, "message": {"type": "string", "description": "A human-readable message describing the failing condition."}, "components": {"type": "array", "items": {"type": "string", "description": "If applicable, a list of components that are failing the condition."}}}}}}} |
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 than usual. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 than usual. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 than usual. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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", "description": "The host name, alias, or service being defined by the record."}, "data": {"type": "string", "description": "Variable data depending on record type. For example, the \"data\" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates."}, "priority": {"type": ["integer", "null"], "description": "The priority for SRV and MX records."}, "port": {"type": ["integer", "null"], "description": "The port for SRV records."}, "ttl": {"type": "integer", "description": "This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."}, "weight": {"type": ["integer", "null"], "description": "The weight for SRV records."}, "flags": {"type": ["integer", "null"], "description": "An unsigned integer between 0-255 used for CAA records."}, "tag": {"type": ["string", "null"], "description": "The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database user attributes.
For MySQL clusters, additional options will be contained in the mysql_settings object. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database user attributes.
For MySQL clusters, additional options will be contained in the mysql_settings object. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database user attributes.
For MySQL clusters, additional options will be contained in the mysql_settings object. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database user attributes.
For MySQL clusters, additional options will be contained in the mysql_settings object. | 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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 database user attributes.
For MySQL clusters, additional options will be contained in the mysql_settings object. | 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\" or \"normal\".\n"}, "password": {"type": "string", "description": "A randomly generated password for the database user."}, "mysql_settings": {"type": "object", "properties": {"auth_plugin": {"type": "string", "enum": ["mysql_native_password", "caching_sha2_password"], "description": "A string specifying the authentication method to be used for connections\nto the MySQL user account. The valid values are `mysql_native_password`\nor `caching_sha2_password`. If excluded when creating a new user, the\ndefault for the version of MySQL in use will be used. As of MySQL 8.0, the\ndefault is `caching_sha2_password`.\n"}}, "required": ["auth_plugin"]}}, "required": ["name"]}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "default_ingress": "https://sample-golang-zyhgn.ondigitalocean.app", "created_at": "2021-02-10T16:45:14Z", "updated_at": "2021-02-10T17:06:56Z", "active_deployment": {"id": "991dfa59-6a23-459f-86d6-67dfa2c6f1e3", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "ChiefMateStarbuck/sample-golang", "branch": "main"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "ams", "domains": [{"domain": "sample-golang.example.com", "zone": "example.com", "minimum_tls_version": "1.3"}]}, "services": [{"name": "web", "source_commit_hash": "db6936cb46047c576962962eed81ad52c21f35d7"}], "phase_last_updated_at": "2021-02-10T17:06:53Z", "created_at": "2021-02-10T17:05:30Z", "updated_at": "2021-02-10T17:06:53Z", "cause": "manual", "progress": {"success_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:05:35.572347485Z", "ended_at": "2021-02-10T17:05:36.093995229Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "component_name": "web", "message_base": "Building service"}], "started_at": "2021-02-10T17:05:36.094015928Z", "ended_at": "2021-02-10T17:06:19.461737040Z"}], "started_at": "2021-02-10T17:05:35.572287990Z", "ended_at": "2021-02-10T17:06:19.807834070Z"}, {"name": "deploy", "status": "SUCCESS", "steps": [{"name": "initialize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:25.143957508Z", "ended_at": "2021-02-10T17:06:26.120343872Z"}, {"name": "components", "status": "SUCCESS", "steps": [{"name": "web", "status": "SUCCESS", "steps": [{"name": "deploy", "status": "SUCCESS", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "SUCCESS", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}], "started_at": "2021-02-10T17:06:26.120385561Z", "ended_at": "2021-02-10T17:06:50.029695913Z"}, {"name": "finalize", "status": "SUCCESS", "started_at": "2021-02-10T17:06:50.348459495Z", "ended_at": "2021-02-10T17:06:53.404065961Z"}], "started_at": "2021-02-10T17:06:25.143932418Z", "ended_at": "2021-02-10T17:06:53.404104185Z"}]}, "phase": "ACTIVE", "tier_slug": "basic"}, "last_deployment_created_at": "2021-02-10T17:05:30Z", "live_url": "https://sample-golang-zyhgn.ondigitalocean.app", "pending_deployment": {"id": "3aa4d20e-5527-4c00-b496-601fbd22520a", "spec": {"name": "sample-php", "services": [{"name": "sample-php", "git": {"repo_clone_url": "https://github.com/digitalocean/sample-php.git", "branch": "main"}, "run_command": "heroku-php-apache2", "environment_slug": "php", "instance_size_slug": "basic-xxs", "instance_count": 1, "http_port": 8080, "routes": [{"path": "/"}]}], "region": "fra", "domains": [{"domain": "sample-php.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}]}}, "region": {"slug": "ams", "label": "Amsterdam", "flag": "netherlands", "continent": "Europe", "data_centers": ["ams3"]}, "tier_slug": "basic", "live_url_base": "https://sample-golang-zyhgn.ondigitalocean.app", "live_domain": "sample-golang-zyhgn.ondigitalocean.app", "project_id": "88b72d1a-b78a-4d9f-9090-b53c4399073f", "domains": [{"id": "e206c64e-a1a3-11ed-9e6e-9b7b6dc9a52b", "phase": "CONFIGURING", "spec": {"domain": "sample-golang.example.com", "type": "PRIMARY", "zone": "example.com", "minimum_tls_version": "1.3"}, "rotate_validation_records": false, "certificate_expires_at": "2024-01-29T23:59:59Z", "progress": {"steps": [{"ended_at": "0001-01-01T00:00:00Z", "name": "default-ingress-ready", "started_at": "2023-01-30T22:15:45.021896292Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-zone", "started_at": "2023-01-30T22:15:45.022017004Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:42:28.50752065Z", "name": "ensure-ns-records", "started_at": "2023-01-30T22:15:45.025567874Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-nameservers", "started_at": "2023-01-30T22:15:45.033591906Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-record", "started_at": "2023-01-30T22:15:45.156750604Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258626422Z", "name": "ensure-alias-record", "started_at": "2023-01-30T22:15:45.165933869Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.258808279Z", "name": "ensure-wildcard-record", "started_at": "2023-01-30T22:15:45.166093422Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "verify-cname", "started_at": "2023-01-30T22:15:45.166205559Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.475903785Z", "name": "ensure-ssl-txt-record-saved", "started_at": "2023-01-30T22:15:45.295237186Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476017236Z", "name": "ensure-ssl-txt-record", "started_at": "2023-01-30T22:15:45.295315291Z", "status": "SUCCESS"}, {"ended_at": "2023-01-30T15:43:30.476094058Z", "name": "ensure-renewal-email", "started_at": "2023-01-30T22:15:45.295374087Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-CA-authorization", "started_at": "2023-01-30T22:15:45.295428101Z", "status": "SUCCESS"}, {"ended_at": "0001-01-01T00:00:00Z", "name": "ensure-certificate", "started_at": "2023-01-30T22:15:45.978756406Z", "status": "RUNNING"}, {"ended_at": "0001-01-01T00:00:00", "name": "create-deployment", "started_at": "0001-01-01T00:00:00Z", "status": "PENDING"}, {"ended_at": "0001-01-01T00:00:00", "name": "configuration-alert", "started_at": "0001-01-01T00:00:00", "status": "PENDING"}]}}]}} | {"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", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "created_at": {"format": "date-time", "title": "The creation time of the app", "type": "string"}, "default_ingress": {"title": "The default hostname on which the app is accessible", "type": "string"}, "domains": {"items": {"properties": {"id": {"title": "The ID of the domain", "type": "string"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"description": "**Omitted**"}}, "type": "object"}, "spec": {"type": "object", "properties": {"domain": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "wildcard": {"description": "**Omitted**"}, "zone": {"description": "**Omitted**"}, "minimum_tls_version": {"description": "**Omitted**"}}, "required": ["domain"]}, "validations": {"title": "List of TXT validation records", "type": "array", "items": {"description": "**Omitted**"}}, "rotate_validation_records": {"title": "Validation values have changed and require manual intervention", "type": "boolean"}, "certificate_expires_at": {"title": "Current SSL certificate expiration time", "type": "string", "format": "date-time"}}, "type": "object"}, "title": "Contains all domains for the app", "type": "array"}, "id": {"title": "The ID of the application", "type": "string"}, "in_progress_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 deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}, "last_deployment_created_at": {"format": "date-time", "title": "The creation time of the last deployment", "type": "string"}, "live_domain": {"title": "The live domain of the app", "type": "string"}, "live_url": {"title": "The live URL of the app", "type": "string"}, "live_url_base": {"title": "The live URL base of the app, the URL excluding the path", "type": "string"}, "owner_uuid": {"title": "The ID of the account to which the application belongs", "type": "string"}, "pending_deployment": {"allOf": [{"description": "The most recent pending deployment. For CreateApp and UpdateApp transactions this is guaranteed to reflect the associated 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 deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}, "project_id": {"type": "string", "title": "The ID of the project the app is assigned to. This will be empty if there is a lookup failure."}, "region": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as the default.", "type": "boolean"}, "disabled": {"title": "Whether or not the region is open for new apps", "type": "boolean"}, "flag": {"title": "The flag of this region", "type": "string"}, "label": {"title": "A human-readable name of the region", "type": "string"}, "reason": {"title": "Reason that this region is not available", "type": "string"}, "slug": {"title": "The slug form of the region name", "type": "string"}}, "title": "Geographical information about an app origin", "type": "object"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "tier_slug": {"title": "The current pricing tier slug of the app", "type": "string"}, "updated_at": {"format": "date-time", "title": "Time of the app's last configuration update", "type": "string"}, "pinned_deployment": {"allOf": [{"description": "The deployment that the app is pinned to."}, {"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 deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}]}}, "required": ["spec"], "type": "object"}}, "type": "object"} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
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**"}, "regions": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}}, "required": ["image"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.