id
stringlengths 53
86
| api_name
stringlengths 2
76
| api_description
stringlengths 1
500
⌀ | api_score
float64 0
10
⌀ | endpoint_name
stringlengths 1
190
| endpoint_description
stringlengths 0
500
| response_status_code
int64 100
505
| response_summary
stringlengths 1
68
⌀ | response_json
stringlengths 6
50k
| response_json_schema
stringlengths 14
150k
|
|---|---|---|---|---|---|---|---|---|---|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_regions
|
List all regions supported by App Platform.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_regions
|
List all regions supported by App Platform.
| 200 | null |
{"regions": [{"slug": "ams", "label": "Amsterdam", "flag": "netherlands", "continent": "Europe", "data_centers": ["ams3"]}, {"slug": "nyc", "label": "New York", "flag": "usa", "continent": "North America", "data_centers": ["nyc1", "nyc3"], "default": true}, {"slug": "fra", "label": "Frankfurt", "flag": "germany", "continent": "Europe", "data_centers": ["fra1"]}, {"slug": "sfo", "label": "San Francisco", "flag": "usa", "continent": "North America", "data_centers": ["sfo3"]}, {"slug": "sgp", "label": "Singapore", "flag": "singapore", "continent": "Asia", "data_centers": ["sgp1"]}, {"slug": "blr", "label": "Bangalore", "flag": "india", "continent": "Asia", "data_centers": ["blr1"]}, {"slug": "tor", "label": "Toronto", "flag": "canada", "continent": "North America", "data_centers": ["tor1"]}, {"slug": "lon", "label": "London", "flag": "uk", "continent": "Europe", "data_centers": ["lon1"]}]}
|
{"properties": {"regions": {"items": {"properties": {"continent": {"title": "The continent that this region is in", "type": "string"}, "data_centers": {"items": {"type": "string"}, "title": "Data centers that are in this region", "type": "array"}, "default": {"description": "Whether or not the region is presented as 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"}, "type": "array"}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_regions
|
List all regions supported by App Platform.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/47051b08-a6e6-4e97-ae9a-f57fb1467d80/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_tiers
|
List all app tiers.
| 200 | null |
{"tiers": [{"name": "Starter", "slug": "starter", "egress_bandwidth_bytes": "1073741824", "build_seconds": "6000"}, {"name": "Basic", "slug": "basic", "egress_bandwidth_bytes": "42949672960", "build_seconds": "24000"}, {"name": "Professional", "slug": "professional", "egress_bandwidth_bytes": "107374182400", "build_seconds": "60000"}]}
|
{"properties": {"tiers": {"items": {"properties": {"build_seconds": {"format": "int64", "title": "The amount of included build time in seconds", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "egress_bandwidth_bytes": {"format": "int64", "title": "The amount of included outbound bandwidth in bytes", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "name": {"title": "A human-readable name of the tier", "type": "string"}, "slug": {"title": "The slug of the tier", "type": "string"}, "storage_bytes": {"format": "int64", "title": "The allotted disk space in bytes", "type": "string", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}, "type": "object"}, "type": "array"}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/47051b08-a6e6-4e97-ae9a-f57fb1467d80/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_tiers
|
List all app tiers.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/47051b08-a6e6-4e97-ae9a-f57fb1467d80/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_tiers
|
List all app tiers.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/47051b08-a6e6-4e97-ae9a-f57fb1467d80/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_tiers
|
List all app tiers.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_revert_rollback
|
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| 200 | null |
{"deployment": {"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 2, "routes": [{"path": "/"}]}], "region": "ams"}, "services": [{"name": "web", "source_commit_hash": "9a4df0b8e161e323bc3cdf1dc71878080fe144fa"}], "phase_last_updated_at": "0001-01-01T00:00:00Z", "created_at": "2020-07-28T18:00:00Z", "updated_at": "2020-07-28T18:00:00Z", "cause": "commit 9a4df0b pushed to github/digitalocean/sample-golang", "progress": {"pending_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "component_name": "web", "message_base": "Building service"}]}]}, {"name": "deploy", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "steps": [{"name": "deploy", "status": "PENDING", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "PENDING", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}]}, {"name": "finalize", "status": "PENDING"}]}]}, "phase": "PENDING_BUILD", "tier_slug": "basic"}}
|
{"properties": {"deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the 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"}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_revert_rollback
|
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_revert_rollback
|
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_revert_rollback
|
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a7addbe6-bb1d-47cd-a25c-92da2f90dfb2/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_revert_rollback
|
Revert an app rollback. This action reverts the active rollback by creating a new deployment from the
latest app spec prior to the rollback and unpins the app to resume new deployments.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_commit_rollback
|
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_commit_rollback
|
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_commit_rollback
|
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/fb7098c8-7605-4e55-b4bb-c2f6f7473efe/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_commit_rollback
|
Commit an app rollback. This action permanently applies the rollback and unpins the app to resume new deployments.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/81a23add-abbe-41c6-ba44-cfa807f52ba2/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_alerts
|
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/81a23add-abbe-41c6-ba44-cfa807f52ba2/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_alerts
|
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/81a23add-abbe-41c6-ba44-cfa807f52ba2/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_alerts
|
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/81a23add-abbe-41c6-ba44-cfa807f52ba2/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_alerts
|
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
| 200 | null |
{"alerts": [{"id": "e552e1f9-c1b0-4e6d-8777-ad6f27767306", "spec": {"rule": "DEPLOYMENT_FAILED"}, "emails": ["[email protected]"], "phase": "ACTIVE", "progress": {"steps": [{"name": "alert-configure-insight-alert", "status": "SUCCESS", "started_at": "2020-07-28T18:00:00Z", "ended_at": "2020-07-28T18:00:00Z"}]}}, {"id": "b58cc9d4-0702-4ffd-ab45-4c2a8d979527", "spec": {"rule": "CPU_UTILIZATION", "operator": "GREATER_THAN", "value": 85, "window": "FIVE_MINUTES"}, "emails": ["[email protected]"], "phase": "ACTIVE", "progress": {"steps": [{"name": "alert-configure-insight-alert", "status": "SUCCESS", "started_at": "2020-07-28T18:00:00Z", "ended_at": "2020-07-28T18:00:00Z"}]}}]}
|
{"properties": {"alerts": {"type": "array", "items": {"properties": {"id": {"title": "The ID of the alert", "type": "string"}, "component_name": {"title": "Name of component the alert belongs to", "type": "string"}, "spec": {"properties": {"rule": {"default": "UNSPECIFIED_RULE", "enum": ["UNSPECIFIED_RULE", "CPU_UTILIZATION", "MEM_UTILIZATION", "RESTART_COUNT", "DEPLOYMENT_FAILED", "DEPLOYMENT_LIVE", "DOMAIN_FAILED", "DOMAIN_LIVE", "FUNCTIONS_ACTIVATION_COUNT", "FUNCTIONS_AVERAGE_DURATION_MS", "FUNCTIONS_ERROR_RATE_PER_MINUTE", "FUNCTIONS_AVERAGE_WAIT_TIME_MS", "FUNCTIONS_ERROR_COUNT", "FUNCTIONS_GB_RATE_PER_SECOND"], "type": "string"}, "disabled": {"description": "Is the alert disabled?", "type": "boolean"}, "operator": {"default": "UNSPECIFIED_OPERATOR", "enum": ["UNSPECIFIED_OPERATOR", "GREATER_THAN", "LESS_THAN"], "type": "string"}, "value": {"description": "Threshold value for alert", "format": "float", "type": "number", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"default": "UNSPECIFIED_WINDOW", "enum": ["UNSPECIFIED_WINDOW", "FIVE_MINUTES", "TEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR"], "type": "string"}}, "type": "object"}, "emails": {"title": "Emails for alerts to go to", "type": "array", "items": {"default": "", "type": "string"}}, "slack_webhooks": {"title": "Slack Webhooks to send alerts to", "type": "array", "items": {"properties": {"url": {"title": "URL of the Slack webhook", "type": "string"}, "channel": {"title": "Name of the Slack Webhook Channel", "type": "string"}}, "type": "object"}}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"title": "Steps of an alert's progress.", "type": "array", "items": {"properties": {"name": {"title": "The name of this step", "type": "string"}, "status": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "RUNNING", "ERROR", "SUCCESS"], "type": "string"}, "started_at": {"format": "date-time", "title": "The start time of this step", "type": "string"}, "ended_at": {"format": "date-time", "title": "The start time of this step", "type": "string"}, "reason": {"properties": {"code": {"description": "**Omitted**"}, "message": {"description": "**Omitted**"}}, "type": "object"}}, "type": "object"}}}, "type": "object"}}, "type": "object"}}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/81a23add-abbe-41c6-ba44-cfa807f52ba2/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_alerts
|
List alerts associated to the app and any components. This includes configuration information about the alerts including emails, slack webhooks, and triggering events or conditions.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/b3b6e187-63ed-4da9-8120-a0a01f0014d2/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_metrics_bandwidth_daily
|
Retrieve daily bandwidth usage metrics for multiple apps.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/b3b6e187-63ed-4da9-8120-a0a01f0014d2/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_metrics_bandwidth_daily
|
Retrieve daily bandwidth usage metrics for multiple apps.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/b3b6e187-63ed-4da9-8120-a0a01f0014d2/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_metrics_bandwidth_daily
|
Retrieve daily bandwidth usage metrics for multiple apps.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/b3b6e187-63ed-4da9-8120-a0a01f0014d2/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_metrics_bandwidth_daily
|
Retrieve daily bandwidth usage metrics for multiple apps.
| 200 | null |
{"app_bandwidth_usage": [{"app_id": "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", "bandwidth_bytes": "513668"}, {"app_id": "c2a93513-8d9b-4223-9d61-5e7272c81cf5", "bandwidth_bytes": "254847"}], "date": "2023-01-17T00:00:00Z"}
|
{"type": "object", "properties": {"app_bandwidth_usage": {"type": "array", "items": {"type": "object", "properties": {"app_id": {"type": "string", "description": "The ID of the app."}, "bandwidth_bytes": {"type": "string", "format": "uint64", "description": "The used bandwidth amount in bytes."}}, "description": "Bandwidth usage for an app."}, "description": "A list of bandwidth usage details by app."}, "date": {"type": "string", "format": "date-time", "description": "The date for the metrics data."}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3b6e187-63ed-4da9-8120-a0a01f0014d2/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_list_metrics_bandwidth_daily
|
Retrieve daily bandwidth usage metrics for multiple apps.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/cfcd19c4-52af-4636-abe6-7b3386b27025/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_get_logs_aggregate
|
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/cfcd19c4-52af-4636-abe6-7b3386b27025/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_get_logs_aggregate
|
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
| 200 | null |
{"live_url": "https://logs-example/build.log", "url": "https://logs/build.log", "historic_logs": ["https://logs-example/archive/build.log"]}
|
{"properties": {"historic_urls": {"items": {"type": "string"}, "title": "A list of URLs to archived log files", "type": "array"}, "live_url": {"description": "A URL of the real-time live logs. This URL may use either the `https://` or `wss://` protocols and will keep pushing live logs as they become available.", "type": "string"}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cfcd19c4-52af-4636-abe6-7b3386b27025/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_get_logs_aggregate
|
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/cfcd19c4-52af-4636-abe6-7b3386b27025/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_get_logs_aggregate
|
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/cfcd19c4-52af-4636-abe6-7b3386b27025/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_get_logs_aggregate
|
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 200 |
Assigned to Droplet
|
{"reserved_ip": {"ip": "45.55.96.47", "droplet": {"id": 3164444, "name": "example.com", "memory": 1024, "vcpus": 1, "disk": 25, "locked": false, "status": "active", "kernel": null, "created_at": "2020-07-21T18:37:44Z", "features": ["backups", "private_networking", "ipv6"], "backup_ids": [53893572], "next_backup_window": {"start": "2020-07-30T00:00:00Z", "end": "2020-07-30T23:00:00Z"}, "snapshot_ids": [67512819], "image": {"id": 63663980, "name": "20.04 (LTS) x64", "type": "base", "distribution": "Ubuntu", "slug": "ubuntu-20-04-x64", "public": true, "regions": ["ams2", "ams3", "blr1", "fra1", "lon1", "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "sgp1", "tor1"], "created_at": "2020-05-15T05:47:50Z", "min_disk_size": 20, "size_gigabytes": 2.36, "description": "", "tags": [], "status": "available", "error_message": ""}, "volume_ids": [], "size": {"slug": "s-1vcpu-1gb", "memory": 1024, "vcpus": 1, "disk": 25, "transfer": 1, "price_monthly": 5, "price_hourly": 0.00743999984115362, "regions": ["ams2", "ams3", "blr1", "fra1", "lon1", "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "sgp1", "tor1"], "available": true, "description": "Basic"}, "size_slug": "s-1vcpu-1gb", "networks": {"v4": [{"ip_address": "10.128.192.124", "netmask": "255.255.0.0", "gateway": "nil", "type": "private"}, {"ip_address": "192.241.165.154", "netmask": "255.255.255.0", "gateway": "192.241.165.1", "type": "public"}], "v6": [{"ip_address": "2604:a880:0:1010::18a:a001", "netmask": 64, "gateway": "2604:a880:0:1010::1", "type": "public"}]}, "region": {"name": "New York 3", "slug": "nyc3", "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "tags": ["web", "env:prod"], "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"}, "region": {"name": "New York 3", "slug": "nyc3", "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}}
|
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the reserved IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "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**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/3/1
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 200 |
Reserved to Region
|
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}}
|
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the reserved IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "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**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/edaf85bc-3b92-48b6-a3a8-964cdc6aa4a8/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_get
|
To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_get_byId
|
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_get_byId
|
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
| 200 | null |
{"snapshot": {"id": "8fa70202-873f-11e6-8b68-000f533176b1", "name": "big-data-snapshot1475261774", "regions": ["nyc1"], "created_at": "2020-09-30T18:56:14Z", "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41", "resource_type": "volume", "min_disk_size": 10, "size_gigabytes": 10, "tags": ["aninterestingtag"]}}
|
{"properties": {"snapshot": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the snapshot."}}, "required": ["id"]}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human-readable name for the snapshot."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the snapshot was created."}, "regions": {"type": "array", "items": {"type": "string"}, "description": "An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values."}, "min_disk_size": {"type": "integer", "description": "The minimum size in GB required for a volume or Droplet to use this snapshot."}, "size_gigabytes": {"type": "number", "format": "float", "description": "The billable size of the snapshot in gigabytes.", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}}, "required": ["name", "created_at", "regions", "min_disk_size", "size_gigabytes"]}, {"type": "object", "properties": {"resource_id": {"type": "string", "description": "The unique identifier for the resource that the snapshot originated from."}, "resource_type": {"type": "string", "enum": ["droplet", "volume"], "description": "The type of resource that the snapshot originated from."}, "tags": {"description": "An array of Tags the snapshot has been tagged with.", "type": ["array", "null"], "items": {"type": "string"}}}, "required": ["resource_id", "resource_type", "tags"]}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_get_byId
|
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_get_byId
|
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a67b2271-1a1a-44bc-a99e-8a8466ca73e9/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_get_byId
|
To retrieve the details of a snapshot that has been created from a volume, send a GET request to /v2/volumes/snapshots/$SNAPSHOT_ID.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_delete_byId
|
To delete a volume snapshot, send a DELETE request to
/v2/snapshots/$SNAPSHOT_ID.
A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_delete_byId
|
To delete a volume snapshot, send a DELETE request to
/v2/snapshots/$SNAPSHOT_ID.
A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_delete_byId
|
To delete a volume snapshot, send a DELETE request to
/v2/snapshots/$SNAPSHOT_ID.
A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e64ade0a-4c3c-46df-aad2-878ba2ad3fe1/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumeSnapshots_delete_byId
|
To delete a volume snapshot, send a DELETE request to
/v2/snapshots/$SNAPSHOT_ID.
A status of 204 will be given. This indicates that the request was processed
successfully, but that no response body is needed.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/0e945dd1-a857-4309-ab9d-0c17c3c40b81/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
loadBalancers_add_forwardingRules
|
To add an additional forwarding rule to a load balancer instance, send a POST
request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body
of the request, there should be a forwarding_rules attribute containing an
array of rules to be added.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| 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/0e945dd1-a857-4309-ab9d-0c17c3c40b81/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
loadBalancers_add_forwardingRules
|
To add an additional forwarding rule to a load balancer instance, send a POST
request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body
of the request, there should be a forwarding_rules attribute containing an
array of rules to be added.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| 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/0e945dd1-a857-4309-ab9d-0c17c3c40b81/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
loadBalancers_add_forwardingRules
|
To add an additional forwarding rule to a load balancer instance, send a POST
request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body
of the request, there should be a forwarding_rules attribute containing an
array of rules to be added.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| 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/0e945dd1-a857-4309-ab9d-0c17c3c40b81/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
loadBalancers_add_forwardingRules
|
To add an additional forwarding rule to a load balancer instance, send a POST
request to /v2/load_balancers/$LOAD_BALANCER_ID/forwarding_rules. In the body
of the request, there should be a forwarding_rules attribute containing an
array of rules to be added.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
| 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/73f0cada-562e-4425-9db8-f6ba785e4609/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumes_delete
|
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
| 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/73f0cada-562e-4425-9db8-f6ba785e4609/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumes_delete
|
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
| 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/73f0cada-562e-4425-9db8-f6ba785e4609/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumes_delete
|
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
| 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/73f0cada-562e-4425-9db8-f6ba785e4609/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
volumes_delete
|
To delete a block storage volume, destroying all data and removing it from your account, send a DELETE request to /v2/volumes/$VOLUME_ID.
No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
| 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/582efc3c-c2ab-409b-a78d-877439fdf65a/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPsActions_get
|
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/582efc3c-c2ab-409b-a78d-877439fdf65a/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPsActions_get
|
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
| 200 | null |
{"action": {"id": 72531856, "status": "completed", "type": "assign_ip", "started_at": "2015-11-12T17:51:03Z", "completed_at": "2015-11-12T17:51:14Z", "resource_id": 758604968, "resource_type": "reserved_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc3", "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}}
|
{"properties": {"action": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}, {"type": "object", "properties": {"project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/582efc3c-c2ab-409b-a78d-877439fdf65a/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPsActions_get
|
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/582efc3c-c2ab-409b-a78d-877439fdf65a/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPsActions_get
|
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/582efc3c-c2ab-409b-a78d-877439fdf65a/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPsActions_get
|
To retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_create
|
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to /v2/reserved_ips with the droplet_id attribute.
To create a new reserved IP reserved to a region, send a POST request to
/v2/reserved_ips with the region attribute.
Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.
| 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/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_create
|
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to /v2/reserved_ips with the droplet_id attribute.
To create a new reserved IP reserved to a region, send a POST request to
/v2/reserved_ips with the region attribute.
Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.
| 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/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_create
|
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to /v2/reserved_ips with the droplet_id attribute.
To create a new reserved IP reserved to a region, send a POST request to
/v2/reserved_ips with the region attribute.
Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.
| 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/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_create
|
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to /v2/reserved_ips with the droplet_id attribute.
To create a new reserved IP reserved to a region, send a POST request to
/v2/reserved_ips with the region attribute.
Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.
| 202 |
Assigning to Droplet
|
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": true, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}, "links": {"droplets": [{"id": 213939433, "rel": "droplet", "href": "https://api.digitalocean.com/v2/droplets/213939433"}], "actions": [{"id": 1088924622, "rel": "assign_ip", "href": "https://api.digitalocean.com/v2/actions/1088924622"}]}}
|
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the reserved IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "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**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}, "links": {"type": "object", "properties": {"droplets": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}, "actions": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/3d496625-dd5a-48a1-a4f4-a0a464a6c4af/3/1
|
Digital Ocean
|
Digital Ocean Public API
| null |
reservedIPs_create
|
On creation, a reserved IP must be either assigned to a Droplet or reserved to a region.
* To create a new reserved IP assigned to a Droplet, send a POST
request to /v2/reserved_ips with the droplet_id attribute.
To create a new reserved IP reserved to a region, send a POST request to
/v2/reserved_ips with the region attribute.
Note: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds.
| 202 |
Reserving to Region
|
{"reserved_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}, "links": {}}
|
{"type": "object", "properties": {"reserved_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the reserved IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the reserved IP is reserved to. When you query a reserved IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the reserved IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "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**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the reserved IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}, "links": {"type": "object", "properties": {"droplets": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}, "actions": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_update_alertPolicy
|
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_update_alertPolicy
|
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
| 200 | null |
{"policy": {"alerts": {"email": [], "slack": []}, "compare": "GreaterThan", "description": "CPU Alert", "enabled": true, "entities": [], "tags": [], "type": "v1/insights/droplet/load_1", "uuid": "78b3da62-27e5-49ba-ac70-5db0b5935c64", "value": 80, "window": "5m"}}
|
{"properties": {"policy": {"type": "object", "required": ["uuid", "type", "description", "compare", "value", "window", "entities", "tags", "alerts", "enabled"], "properties": {"alerts": {"type": "object", "required": ["slack", "email"], "properties": {"email": {"description": "An email to notify on an alert trigger.", "type": "array", "items": {"type": "string"}}, "slack": {"type": "array", "description": "Slack integration details.", "items": {"type": "object", "required": ["url", "channel"], "properties": {"channel": {"description": "**Omitted**"}, "url": {"description": "**Omitted**"}}}}}}, "compare": {"type": "string", "enum": ["GreaterThan", "LessThan"]}, "description": {"type": "string"}, "enabled": {"type": "boolean"}, "entities": {"type": "array", "items": {"type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}, "type": {"type": "string", "enum": ["v1/insights/droplet/load_1", "v1/insights/droplet/load_5", "v1/insights/droplet/load_15", "v1/insights/droplet/memory_utilization_percent", "v1/insights/droplet/disk_utilization_percent", "v1/insights/droplet/cpu", "v1/insights/droplet/disk_read", "v1/insights/droplet/disk_write", "v1/insights/droplet/public_outbound_bandwidth", "v1/insights/droplet/public_inbound_bandwidth", "v1/insights/droplet/private_outbound_bandwidth", "v1/insights/droplet/private_inbound_bandwidth", "v1/insights/lbaas/avg_cpu_utilization_percent", "v1/insights/lbaas/connection_utilization_percent", "v1/insights/lbaas/droplet_health", "v1/insights/lbaas/tls_connections_per_second_utilization_percent", "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx", "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx", "v1/insights/lbaas/increase_in_http_error_rate_count_5xx", "v1/insights/lbaas/increase_in_http_error_rate_count_4xx", "v1/insights/lbaas/high_http_request_response_time", "v1/insights/lbaas/high_http_request_response_time_50p", "v1/insights/lbaas/high_http_request_response_time_95p", "v1/insights/lbaas/high_http_request_response_time_99p", "v1/dbaas/alerts/load_15_alerts", "v1/dbaas/alerts/memory_utilization_alerts", "v1/dbaas/alerts/disk_utilization_alerts", "v1/dbaas/alerts/cpu_alerts"]}, "uuid": {"type": "string"}, "value": {"type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"type": "string", "enum": ["5m", "10m", "30m", "1h"]}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_update_alertPolicy
|
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_update_alertPolicy
|
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d08bb05e-155e-44d6-a69b-2f40a8ff76b7/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
monitoring_update_alertPolicy
|
To update en existing policy, send a PUT request to v2/monitoring/alerts/{alert_uuid}.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d1bd273e-bc64-451b-b97b-96db550c40e6/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_cancel_deployment
|
Immediately cancel an in-progress deployment.
| 200 | null |
{"deployment": {"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 2, "routes": [{"path": "/"}]}], "region": "ams"}, "services": [{"name": "web", "source_commit_hash": "9a4df0b8e161e323bc3cdf1dc71878080fe144fa"}], "phase_last_updated_at": "0001-01-01T00:00:00Z", "created_at": "2020-07-28T18:00:00Z", "updated_at": "2020-07-28T18:00:00Z", "cause": "commit 9a4df0b pushed to github/digitalocean/sample-golang", "progress": {"pending_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "component_name": "web", "message_base": "Building service"}]}]}, {"name": "deploy", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "steps": [{"name": "deploy", "status": "PENDING", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "PENDING", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}]}, {"name": "finalize", "status": "PENDING"}]}]}, "phase": "PENDING_BUILD", "tier_slug": "basic"}}
|
{"properties": {"deployment": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the 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"}}, "type": "object"}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d1bd273e-bc64-451b-b97b-96db550c40e6/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_cancel_deployment
|
Immediately cancel an in-progress deployment.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d1bd273e-bc64-451b-b97b-96db550c40e6/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_cancel_deployment
|
Immediately cancel an in-progress deployment.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d1bd273e-bc64-451b-b97b-96db550c40e6/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_cancel_deployment
|
Immediately cancel an in-progress deployment.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d1bd273e-bc64-451b-b97b-96db550c40e6/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
apps_cancel_deployment
|
Immediately cancel an in-progress deployment.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/f0dea565-1bb0-4793-b881-27c7a3696273/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_post_byTag
|
Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with
the action arguments.
Only a sub-set of action types are supported:
power_cycle
power_on
power_off
shutdown
enable_ipv6
enable_backups
disable_backups
snapshot
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/f0dea565-1bb0-4793-b881-27c7a3696273/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_post_byTag
|
Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with
the action arguments.
Only a sub-set of action types are supported:
power_cycle
power_on
power_off
shutdown
enable_ipv6
enable_backups
disable_backups
snapshot
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/f0dea565-1bb0-4793-b881-27c7a3696273/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_post_byTag
|
Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with
the action arguments.
Only a sub-set of action types are supported:
power_cycle
power_on
power_off
shutdown
enable_ipv6
enable_backups
disable_backups
snapshot
| 201 | null |
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}]}
|
{"properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f0dea565-1bb0-4793-b881-27c7a3696273/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_post_byTag
|
Some actions can be performed in bulk on tagged Droplets. The actions can be
initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with
the action arguments.
Only a sub-set of action types are supported:
power_cycle
power_on
power_off
shutdown
enable_ipv6
enable_backups
disable_backups
snapshot
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a51d5061-6690-418c-bd1f-48f1e1ad7424/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_list
|
To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to /v2/droplets/$DROPLET_ID/actions.
The results will be returned as a JSON object with an actions key. This will
be set to an array filled with action objects containing the standard
action attributes.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a51d5061-6690-418c-bd1f-48f1e1ad7424/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_list
|
To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to /v2/droplets/$DROPLET_ID/actions.
The results will be returned as a JSON object with an actions key. This will
be set to an array filled with action objects containing the standard
action attributes.
| 200 | null |
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "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": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}}}}, {"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/a51d5061-6690-418c-bd1f-48f1e1ad7424/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_list
|
To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to /v2/droplets/$DROPLET_ID/actions.
The results will be returned as a JSON object with an actions key. This will
be set to an array filled with action objects containing the standard
action attributes.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a51d5061-6690-418c-bd1f-48f1e1ad7424/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_list
|
To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to /v2/droplets/$DROPLET_ID/actions.
The results will be returned as a JSON object with an actions key. This will
be set to an array filled with action objects containing the standard
action attributes.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/a51d5061-6690-418c-bd1f-48f1e1ad7424/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
dropletActions_list
|
To retrieve a list of all actions that have been executed for a Droplet, send
a GET request to /v2/droplets/$DROPLET_ID/actions.
The results will be returned as a JSON object with an actions key. This will
be set to an array filled with action objects containing the standard
action attributes.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/17959943-d1a2-4be4-8349-2c9ed8a95a60/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch_default
|
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/17959943-d1a2-4be4-8349-2c9ed8a95a60/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch_default
|
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
| 200 | null |
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z", "is_default": true}}
|
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_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."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/17959943-d1a2-4be4-8349-2c9ed8a95a60/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch_default
|
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/17959943-d1a2-4be4-8349-2c9ed8a95a60/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch_default
|
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/17959943-d1a2-4be4-8349-2c9ed8a95a60/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_patch_default
|
To update only specific attributes of your default project, send a PATCH request to /v2/projects/default. At least one of the following attributes needs to be sent.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/387391ae-e9ba-400e-a0c3-81bb5da1946a/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_neighborsIds
|
To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
The results will be returned as a JSON object with a key of neighbor_ids.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| 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/387391ae-e9ba-400e-a0c3-81bb5da1946a/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_neighborsIds
|
To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
The results will be returned as a JSON object with a key of neighbor_ids.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| 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/387391ae-e9ba-400e-a0c3-81bb5da1946a/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_neighborsIds
|
To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
The results will be returned as a JSON object with a key of neighbor_ids.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| 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/387391ae-e9ba-400e-a0c3-81bb5da1946a/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_neighborsIds
|
To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
The results will be returned as a JSON object with a key of neighbor_ids.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| 200 | null |
{"neighbor_ids": []}
|
{"type": "object", "properties": {"neighbor_ids": {"type": "array", "items": {"type": "array", "items": {"type": "integer"}}, "description": "An array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server."}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/387391ae-e9ba-400e-a0c3-81bb5da1946a/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
droplets_list_neighborsIds
|
To retrieve a list of all Droplets that are co-located on the same physical
hardware, send a GET request to /v2/reports/droplet_neighbors_ids.
The results will be returned as a JSON object with a key of neighbor_ids.
This will be set to an array of arrays. Each array will contain a set of
Droplet IDs for Droplets that share a physical server. An empty array
indicates that all Droplets associated with your account are located on
separate physical hardware.
| 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/41e3fb00-622c-4049-8f2f-6dec966a74bb/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_update
|
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/41e3fb00-622c-4049-8f2f-6dec966a74bb/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_update
|
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
| 429 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/41e3fb00-622c-4049-8f2f-6dec966a74bb/2/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_update
|
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
| 401 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/41e3fb00-622c-4049-8f2f-6dec966a74bb/3/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_update
|
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
| 404 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/41e3fb00-622c-4049-8f2f-6dec966a74bb/4/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
projects_update
|
To update a project, send a PUT request to /v2/projects/$PROJECT_ID. All of the following attributes must be sent.
| 200 | null |
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z", "is_default": true}}
|
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_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."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/0/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
kubernetes_list_options
|
To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to /v2/kubernetes/options.
| 500 | null |
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
|
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d79b2c9b-0720-4d52-b6bd-3247e1d799a1/1/0
|
Digital Ocean
|
Digital Ocean Public API
| null |
kubernetes_list_options
|
To list the versions of Kubernetes available for use, the regions that support Kubernetes, and the available node sizes, send a GET request to /v2/kubernetes/options.
| 200 | null |
{"options": {"regions": [{"name": "New York 1", "slug": "nyc1"}, {"name": "Singapore 1", "slug": "sgp1"}, {"name": "London 1", "slug": "lon1"}, {"name": "New York 3", "slug": "nyc3"}, {"name": "Amsterdam 3", "slug": "ams3"}, {"name": "Frankfurt 1", "slug": "fra1"}, {"name": "Toronto 1", "slug": "tor1"}, {"name": "San Francisco 2", "slug": "sfo2"}, {"name": "Bangalore 1", "slug": "blr1"}, {"name": "San Francisco 3", "slug": "sfo3"}], "versions": [{"slug": "1.18.8-do.0", "kubernetes_version": "1.18.8", "supported_features": ["cluster-autoscaler", "docr-integration", "token-authentication"]}, {"slug": "1.17.11-do.0", "kubernetes_version": "1.17.11", "supported_features": ["cluster-autoscaler", "docr-integration", "token-authentication"]}, {"slug": "1.16.14-do.0", "kubernetes_version": "1.16.14", "supported_features": ["cluster-autoscaler", "docr-integration", "token-authentication"]}], "sizes": [{"name": "s-1vcpu-2gb", "slug": "s-1vcpu-2gb"}, {"name": "s-2vcpu-2gb", "slug": "s-2vcpu-2gb"}, {"name": "s-1vcpu-3gb", "slug": "s-1vcpu-3gb"}, {"name": "s-2vcpu-4gb", "slug": "s-2vcpu-4gb"}, {"name": "s-4vcpu-8gb", "slug": "s-4vcpu-8gb"}, {"name": "c-2-4GiB", "slug": "c-2"}, {"name": "g-2vcpu-8gb", "slug": "g-2vcpu-8gb"}, {"name": "gd-2vcpu-8gb", "slug": "gd-2vcpu-8gb"}, {"name": "s-8vcpu-16gb", "slug": "s-8vcpu-16gb"}, {"name": "s-6vcpu-16gb", "slug": "s-6vcpu-16gb"}, {"name": "c-4-8GiB", "slug": "c-4"}, {"name": "m-2vcpu-16gb", "slug": "m-2vcpu-16gb"}, {"name": "m3-2vcpu-16gb", "slug": "m3-2vcpu-16gb"}, {"name": "g-4vcpu-16gb", "slug": "g-4vcpu-16gb"}, {"name": "gd-4vcpu-16gb", "slug": "gd-4vcpu-16gb"}, {"name": "m6-2vcpu-16gb", "slug": "m6-2vcpu-16gb"}, {"name": "s-8vcpu-32gb", "slug": "s-8vcpu-32gb"}, {"name": "c-8-16GiB", "slug": "c-8"}, {"name": "m-4vcpu-32gb", "slug": "m-4vcpu-32gb"}, {"name": "m3-4vcpu-32gb", "slug": "m3-4vcpu-32gb"}, {"name": "g-8vcpu-32gb", "slug": "g-8vcpu-32gb"}, {"name": "s-12vcpu-48gb", "slug": "s-12vcpu-48gb"}, {"name": "gd-8vcpu-32gb", "slug": "gd-8vcpu-32gb"}, {"name": "m6-4vcpu-32gb", "slug": "m6-4vcpu-32gb"}, {"name": "s-16vcpu-64gb", "slug": "s-16vcpu-64gb"}, {"name": "c-16", "slug": "c-16"}, {"name": "m-8vcpu-64gb", "slug": "m-8vcpu-64gb"}, {"name": "m3-8vcpu-64gb", "slug": "m3-8vcpu-64gb"}, {"name": "g-16vcpu-64gb", "slug": "g-16vcpu-64gb"}, {"name": "s-20vcpu-96gb", "slug": "s-20vcpu-96gb"}, {"name": "gd-16vcpu-64gb", "slug": "gd-16vcpu-64gb"}, {"name": "m6-8vcpu-64gb", "slug": "m6-8vcpu-64gb"}, {"name": "s-24vcpu-128gb", "slug": "s-24vcpu-128gb"}, {"name": "c-32-64GiB", "slug": "c-32"}, {"name": "m-16vcpu-128gb", "slug": "m-16vcpu-128gb"}, {"name": "m3-16vcpu-128gb", "slug": "m3-16vcpu-128gb"}, {"name": "g-32vcpu-128gb", "slug": "g-32vcpu-128gb"}, {"name": "s-32vcpu-192gb", "slug": "s-32vcpu-192gb"}, {"name": "gd-32vcpu-128gb", "slug": "gd-32vcpu-128gb"}, {"name": "m-24vcpu-192gb", "slug": "m-24vcpu-192gb"}, {"name": "m6-16vcpu-128gb", "slug": "m6-16vcpu-128gb"}, {"name": "g-40vcpu-160gb", "slug": "g-40vcpu-160gb"}, {"name": "gd-40vcpu-160gb", "slug": "gd-40vcpu-160gb"}, {"name": "m3-24vcpu-192gb", "slug": "m3-24vcpu-192gb"}, {"name": "m-32vcpu-256gb", "slug": "m-32vcpu-256gb"}, {"name": "m6-24vcpu-192gb", "slug": "m6-24vcpu-192gb"}, {"name": "m3-32vcpu-256gb", "slug": "m3-32vcpu-256gb"}, {"name": "m6-32vcpu-256gb", "slug": "m6-32vcpu-256gb"}]}}
|
{"type": "object", "properties": {"options": {"properties": {"regions": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "A DigitalOcean region where Kubernetes is available."}, "slug": {"type": "string", "description": "The identifier for a region for use when creating a new cluster."}}}}, "versions": {"type": "array", "items": {"type": "object", "properties": {"slug": {"type": "string", "description": "The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision."}, "kubernetes_version": {"type": "string", "description": "The upstream version string for the version of Kubernetes provided by a given slug."}, "supported_features": {"type": "array", "items": {"type": "string"}, "description": "The features available with the version of Kubernetes provided by a given slug."}}}}, "sizes": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "A Droplet size available for use in a Kubernetes node pool."}, "slug": {"type": "string", "description": "The identifier for a size for use when creating a new cluster."}}}}}}}}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.