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/21060171-2928-4746-b00b-2230658a9846/4/0
Digital Ocean
Digital Ocean Public API
null
images_update
To update an image, send a PUT request to /v2/images/$IMAGE_ID. Set the name attribute to the new value you would like to use. For custom images, the description and distribution attributes may also be updated.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9ca7715c-e79e-479a-97ff-750f3a97ebbe/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9ca7715c-e79e-479a-97ff-750f3a97ebbe/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9ca7715c-e79e-479a-97ff-750f3a97ebbe/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9ca7715c-e79e-479a-97ff-750f3a97ebbe/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
200
null
{"db": {"name": "alpha"}}
{"type": "object", "properties": {"db": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the database."}}, "required": ["name"]}}, "required": ["db"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9ca7715c-e79e-479a-97ff-750f3a97ebbe/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get
To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. Note: Database management is not supported for Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/64ce5e0c-cb8f-45aa-a934-b6da43f73640/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_get
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
200
null
{"check": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page check", "type": "ping", "target": "https://www.landingpage.com", "regions": ["us_east"], "enabled": true}}
{"type": "object", "properties": {"check": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the check."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/64ce5e0c-cb8f-45aa-a934-b6da43f73640/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_get
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/64ce5e0c-cb8f-45aa-a934-b6da43f73640/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_get
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/64ce5e0c-cb8f-45aa-a934-b6da43f73640/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_get
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/64ce5e0c-cb8f-45aa-a934-b6da43f73640/4/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_get
To show information about an existing check, send a GET request to /v2/uptime/checks/$CHECK_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aceb7dd6-e42f-4b95-9fc6-44656d0e9f0a/0/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_list
To list all of the keys in your account, send a GET request to /v2/account/keys. The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aceb7dd6-e42f-4b95-9fc6-44656d0e9f0a/1/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_list
To list all of the keys in your account, send a GET request to /v2/account/keys. The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aceb7dd6-e42f-4b95-9fc6-44656d0e9f0a/2/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_list
To list all of the keys in your account, send a GET request to /v2/account/keys. The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aceb7dd6-e42f-4b95-9fc6-44656d0e9f0a/3/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_list
To list all of the keys in your account, send a GET request to /v2/account/keys. The response will be a JSON object with a key set to ssh_keys. The value of this will be an array of ssh_key objects, each of which contains the standard ssh_key attributes.
200
null
{"ssh_keys": [{"id": 289794, "fingerprint": "3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45", "public_key": "ssh-rsa ANOTHEREXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V anotherexample", "name": "Other Public Key"}], "links": {}, "meta": {"total": 1...
{"allOf": [{"properties": {"ssh_keys": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet."}, "fingerprint": {"type": "string", "description": "A unique identifier tha...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"direction": "inbound", "host_id": "222651441", "interface": "private"}, "values": [[1634052360, "0.016600450090265357"], [1634052480, "0.015085955677299055"], [1634052600, "0.014941163855322308"], [1634052720, "0.016214285714285712"]]}]}}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "desc...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/1/1
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"direction": "inbound", "host_id": "222651441", "interface": "public"}, "values": [[1634052360, "0.016600450090265357"], [1634052480, "0.015085955677299055"], [1634052600, "0.014941163855322308"], [1634052720, "0.016214285714285712"]]}]}}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "desc...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/1/2
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"direction": "outbound", "host_id": "222651441", "interface": "private"}, "values": [[1634052360, "0.016600450090265357"], [1634052480, "0.015085955677299055"], [1634052600, "0.014941163855322308"], [1634052720, "0.016214285714285712"]]}]}}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "desc...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/1/3
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"direction": "outbound", "host_id": "222651441", "interface": "public"}, "values": [[1634052360, "0.016600450090265357"], [1634052480, "0.015085955677299055"], [1634052600, "0.014941163855322308"], [1634052720, "0.016214285714285712"]]}]}}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "desc...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/232068d2-7373-46cd-8c04-9c4bde267daa/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletBandwidthMetrics
To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traf...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d624612b-e309-41c8-a7dc-08f1e80edfc2/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryFreeMetrics
To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.
200
null
{"data": {"result": [{"metric": {}, "values": []}], "resultType": "matrix"}, "status": "success"}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "desc...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d624612b-e309-41c8-a7dc-08f1e80edfc2/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryFreeMetrics
To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d624612b-e309-41c8-a7dc-08f1e80edfc2/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryFreeMetrics
To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d624612b-e309-41c8-a7dc-08f1e80edfc2/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletMemoryFreeMetrics
To retrieve free memory metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/memory_free.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26c70678-c375-470e-96bf-1234305d8bc4/0/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID. The response will be a JSON object with a key called action. The value will be a Droplet action object.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26c70678-c375-470e-96bf-1234305d8bc4/1/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID. The response will be a JSON object with a key called action. The value will be a Droplet action object.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26c70678-c375-470e-96bf-1234305d8bc4/2/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID. The response will be a JSON object with a key called action. The value will be a Droplet action object.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26c70678-c375-470e-96bf-1234305d8bc4/3/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID. The response will be a JSON object with a key called action. The value will be a Droplet action object.
200
null
{"action": {"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": {"action": {"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\".", ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/26c70678-c375-470e-96bf-1234305d8bc4/4/0
Digital Ocean
Digital Ocean Public API
null
dropletActions_get
To retrieve a Droplet action, send a GET request to /v2/droplets/$DROPLET_ID/actions/$ACTION_ID. The response will be a JSON object with a key called action. The value will be a Droplet action object.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9b3d316f-42c1-4331-b284-f4510c76daf9/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_list
To list all of the firewalls available on your account, send a GET request to /v2/firewalls.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9b3d316f-42c1-4331-b284-f4510c76daf9/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_list
To list all of the firewalls available on your account, send a GET request to /v2/firewalls.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9b3d316f-42c1-4331-b284-f4510c76daf9/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_list
To list all of the firewalls available on your account, send a GET request to /v2/firewalls.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9b3d316f-42c1-4331-b284-f4510c76daf9/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_list
To list all of the firewalls available on your account, send a GET request to /v2/firewalls.
200
null
{"firewalls": [{"inbound_rules": [], "outbound_rules": []}], "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": ...
{"allOf": [{"type": "object", "properties": {"firewalls": {"type": "array", "items": {"type": "object", "allOf": [{"properties": {"id": {"type": "string", "description": "A unique ID that can be used to identify and reference a firewall."}, "status": {"type": "string", "description": "A status string indicating the cur...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/defb1362-a8ee-4d6a-aa7e-767099437374/0/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_create
To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/defb1362-a8ee-4d6a-aa7e-767099437374/1/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_create
To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
201
null
{"check": {"id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "name": "Landing page check", "type": "ping", "target": "https://www.landingpage.com", "regions": ["us_east"], "enabled": true}}
{"type": "object", "properties": {"check": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the check."}}}, {"type": "object", "properties": {"name": {"type": "string", "description": "A human...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/defb1362-a8ee-4d6a-aa7e-767099437374/2/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_create
To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/defb1362-a8ee-4d6a-aa7e-767099437374/3/0
Digital Ocean
Digital Ocean Public API
null
uptime_check_create
To create an Uptime check, send a POST request to /v2/uptime/checks specifying the attributes in the table below in the JSON body.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f1090238-e012-4b83-83d2-205798e0df71/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_onlineMigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f1090238-e012-4b83-83d2-205798e0df71/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_onlineMigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f1090238-e012-4b83-83d2-205798e0df71/2/0
Digital Ocean
Digital Ocean Public API
null
databases_update_onlineMigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
200
null
{"id": "77b28fc8-19ff-11eb-8c9c-c68e24557488", "status": "running", "created_at": "2020-10-29T15:57:38Z"}
{"type": "object", "properties": {"id": {"type": "string", "description": "The ID of the most recent migration."}, "status": {"type": "string", "description": "The current status of the migration.", "enum": ["running", "canceled", "error", "done"]}, "created_at": {"type": "string", "description": "The time the migratio...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f1090238-e012-4b83-83d2-205798e0df71/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_onlineMigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f1090238-e012-4b83-83d2-205798e0df71/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_onlineMigration
To start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5c69d3af-d7a9-4914-92ef-86e1ebc83d24/0/0
Digital Ocean
Digital Ocean Public API
null
actions_list
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
200
null
{"actions": [{"id": 36804636, "status": "in-progress", "type": "create", "started_at": "2020-11-14T16:29:21Z", "completed_at": "2020-11-14T16:30:06Z", "resource_id": 3164444, "resource_type": "droplet", "region": {}, "region_slug": "nyc3"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "...
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5c69d3af-d7a9-4914-92ef-86e1ebc83d24/1/0
Digital Ocean
Digital Ocean Public API
null
actions_list
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5c69d3af-d7a9-4914-92ef-86e1ebc83d24/2/0
Digital Ocean
Digital Ocean Public API
null
actions_list
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5c69d3af-d7a9-4914-92ef-86e1ebc83d24/3/0
Digital Ocean
Digital Ocean Public API
null
actions_list
This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/0/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/1/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
400
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/2/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
201
null
{"volume": {"id": "506f78a4-e098-11e5-ad9f-000f53306ae1", "region": {"name": "New York 1", "slug": "nyc1", "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...
{"properties": {"volume": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the block storage volume."}, "droplet_ids": {"type": ["array", "null"], "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets th...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/3/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/4/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863f5b24-49eb-4697-9289-5096513b2dce/5/0
Digital Ocean
Digital Ocean Public API
null
volumes_create
To create a new volume, send a POST request to /v2/volumes. Optionally, a filesystem_type attribute may be provided in order to automatically format the volume's filesystem. Pre-formatted volumes are automatically mounted when attached to Ubuntu, Debian, Fedora, Fedora Atomic, and CentOS Droplets created on or after Ap...
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/28eac2d5-2744-4a95-87c8-d75014514ed5/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
200
null
{"actions": [{"id": 72531856, "status": "completed", "type": "reserve_ip", "started_at": "2015-11-21T21:51:09Z", "completed_at": "2015-11-21T21:51:09Z", "resource_id": 758604197, "resource_type": "reserved_ip", "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2v...
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/28eac2d5-2744-4a95-87c8-d75014514ed5/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/28eac2d5-2744-4a95-87c8-d75014514ed5/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/28eac2d5-2744-4a95-87c8-d75014514ed5/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/28eac2d5-2744-4a95-87c8-d75014514ed5/4/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_list
To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8e5e5a32-648f-4c09-be62-1e600da6668e/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_delete
To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 status code with no body will be returned in response to a successful request. The default VPC for a region can not be deleted. Additionally, a VPC can only be deleted if it does not contain any member resources. Attempting to delete a region's default V...
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8e5e5a32-648f-4c09-be62-1e600da6668e/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_delete
To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 status code with no body will be returned in response to a successful request. The default VPC for a region can not be deleted. Additionally, a VPC can only be deleted if it does not contain any member resources. Attempting to delete a region's default V...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8e5e5a32-648f-4c09-be62-1e600da6668e/2/0
Digital Ocean
Digital Ocean Public API
null
vpcs_delete
To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 status code with no body will be returned in response to a successful request. The default VPC for a region can not be deleted. Additionally, a VPC can only be deleted if it does not contain any member resources. Attempting to delete a region's default V...
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8e5e5a32-648f-4c09-be62-1e600da6668e/3/0
Digital Ocean
Digital Ocean Public API
null
vpcs_delete
To delete a VPC, send a DELETE request to /v2/vpcs/$VPC_ID. A 204 status code with no body will be returned in response to a successful request. The default VPC for a region can not be deleted. Additionally, a VPC can only be deleted if it does not contain any member resources. Attempting to delete a region's default V...
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/951df366-4b94-4dfa-a3a5-ae3d98fdfe19/0/0
Digital Ocean
Digital Ocean Public API
null
domains_list
To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/951df366-4b94-4dfa-a3a5-ae3d98fdfe19/1/0
Digital Ocean
Digital Ocean Public API
null
domains_list
To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/951df366-4b94-4dfa-a3a5-ae3d98fdfe19/2/0
Digital Ocean
Digital Ocean Public API
null
domains_list
To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/951df366-4b94-4dfa-a3a5-ae3d98fdfe19/3/0
Digital Ocean
Digital Ocean Public API
null
domains_list
To retrieve a list of all of the domains in your account, send a GET request to /v2/domains.
200
null
{"domains": [{"name": "example.com", "ttl": 1800, "zone_file": "$ORIGIN example.com.\n$TTL 1800\nexample.com. IN SOA ns1.digitalocean.com. hostmaster.example.com. 1415982609 10800 3600 604800 1800\nexample.com. 1800 IN NS ns1.digitalocean.com.\nexample.com. 1800 IN NS ns2.digitalocean.com.\nexample.com. 1800 IN NS ns3....
{"allOf": [{"type": "object", "properties": {"domains": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name."}, "ip_address":...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a6c91521-61b5-431b-9b06-f73603ae1374/0/0
Digital Ocean
Digital Ocean Public API
null
regions_list
To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.
200
null
{"regions": [{"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-8v...
{"allOf": [{"type": "object", "properties": {"regions": {"type": "array", "items": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitte...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a6c91521-61b5-431b-9b06-f73603ae1374/1/0
Digital Ocean
Digital Ocean Public API
null
regions_list
To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a6c91521-61b5-431b-9b06-f73603ae1374/2/0
Digital Ocean
Digital Ocean Public API
null
regions_list
To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/a6c91521-61b5-431b-9b06-f73603ae1374/3/0
Digital Ocean
Digital Ocean Public API
null
regions_list
To list all of the regions that are available, send a GET request to /v2/regions. The response will be a JSON object with a key called regions. The value of this will be an array of region objects, each of which will contain the standard region attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeeee109-2bda-476e-b51c-824ba28f6068/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
200
null
{"vpc": {"name": "env.prod-vpc", "description": "VPC for production environment", "region": "nyc1", "ip_range": "10.10.10.0/24", "default": true, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "urn": "do:droplet:13457723", "created_at": "2020-03-13T19:20:47.442049222Z"}}
{"type": "object", "properties": {"vpc": {"type": "object", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+$", "description": "The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods."}, "description": {"type": "string"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeeee109-2bda-476e-b51c-824ba28f6068/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeeee109-2bda-476e-b51c-824ba28f6068/2/0
Digital Ocean
Digital Ocean Public API
null
vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeeee109-2bda-476e-b51c-824ba28f6068/3/0
Digital Ocean
Digital Ocean Public API
null
vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/aeeee109-2bda-476e-b51c-824ba28f6068/4/0
Digital Ocean
Digital Ocean Public API
null
vpcs_update
To update information about a VPC, send a PUT request to /v2/vpcs/$VPC_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68ed9c60-f710-4574-a523-30fbec424b52/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68ed9c60-f710-4574-a523-30fbec424b52/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68ed9c60-f710-4574-a523-30fbec424b52/2/0
Digital Ocean
Digital Ocean Public API
null
vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68ed9c60-f710-4574-a523-30fbec424b52/3/0
Digital Ocean
Digital Ocean Public API
null
vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/68ed9c60-f710-4574-a523-30fbec424b52/4/0
Digital Ocean
Digital Ocean Public API
null
vpcs_get
To show information about an existing VPC, send a GET request to /v2/vpcs/$VPC_ID.
200
null
{"vpc": {"name": "env.prod-vpc", "description": "VPC for production environment", "region": "nyc1", "ip_range": "10.10.10.0/24", "default": true, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "urn": "do:droplet:13457723", "created_at": "2020-03-13T19:20:47.442049222Z"}}
{"type": "object", "properties": {"vpc": {"type": "object", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+$", "description": "The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods."}, "description": {"type": "string"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d3c03c4-4ed8-4ffe-bad1-f3f9644c99ac/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_list
To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d3c03c4-4ed8-4ffe-bad1-f3f9644c99ac/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_list
To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d3c03c4-4ed8-4ffe-bad1-f3f9644c99ac/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_list
To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d3c03c4-4ed8-4ffe-bad1-f3f9644c99ac/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_list
To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.
200
null
{"reserved_ips": [{"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...
{"allOf": [{"type": "object", "properties": {"reserved_ips": {"type": "array", "items": {"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...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73b1b2b6-60cf-48a7-8eaf-62a2285458f6/0/0
Digital Ocean
Digital Ocean Public API
null
volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
200
null
{"volume": {"id": "506f78a4-e098-11e5-ad9f-000f53306ae1", "region": {"name": "New York 1", "slug": "nyc1", "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...
{"properties": {"volume": {"type": "object", "allOf": [{"type": "object", "properties": {"id": {"type": "string", "description": "The unique identifier for the block storage volume."}, "droplet_ids": {"type": ["array", "null"], "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets th...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73b1b2b6-60cf-48a7-8eaf-62a2285458f6/1/0
Digital Ocean
Digital Ocean Public API
null
volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73b1b2b6-60cf-48a7-8eaf-62a2285458f6/2/0
Digital Ocean
Digital Ocean Public API
null
volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73b1b2b6-60cf-48a7-8eaf-62a2285458f6/3/0
Digital Ocean
Digital Ocean Public API
null
volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/73b1b2b6-60cf-48a7-8eaf-62a2285458f6/4/0
Digital Ocean
Digital Ocean Public API
null
volumes_get
To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e22dde85-7786-4af4-bd83-bdb6690cab64/0/0
Digital Ocean
Digital Ocean Public API
null
domains_create
To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e22dde85-7786-4af4-bd83-bdb6690cab64/1/0
Digital Ocean
Digital Ocean Public API
null
domains_create
To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain.
201
null
{"domain": {"name": "example.com", "ttl": 1800, "zone_file": null}}
{"properties": {"domain": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name."}, "ip_address": {"type": "string", "description": "This optional attribu...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e22dde85-7786-4af4-bd83-bdb6690cab64/2/0
Digital Ocean
Digital Ocean Public API
null
domains_create
To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e22dde85-7786-4af4-bd83-bdb6690cab64/3/0
Digital Ocean
Digital Ocean Public API
null
domains_create
To create a new domain, send a POST request to /v2/domains. Set the "name" attribute to the domain name you are adding. Optionally, you may set the "ip_address" attribute, and an A record will be automatically created pointing to the apex domain.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aff86c3-3164-4511-895c-242fdae0de0f/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_delete
To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aff86c3-3164-4511-895c-242fdae0de0f/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_delete
To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aff86c3-3164-4511-895c-242fdae0de0f/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_delete
To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aff86c3-3164-4511-895c-242fdae0de0f/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_delete
To delete a load balancer instance, disassociating any Droplets assigned to it and removing it from your account, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ddb7bdd8-46bc-4cf9-9251-9c3082d1e0bd/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_create
To create a VPC, send a POST request to /v2/vpcs specifying the attributes in the table below in the JSON body. Note: If you do not currently have a VPC network in a specific datacenter region, the first one that you create will be set as the default for that region. The default VPC for a region cannot be changed or de...
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ddb7bdd8-46bc-4cf9-9251-9c3082d1e0bd/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_create
To create a VPC, send a POST request to /v2/vpcs specifying the attributes in the table below in the JSON body. Note: If you do not currently have a VPC network in a specific datacenter region, the first one that you create will be set as the default for that region. The default VPC for a region cannot be changed or de...
201
null
{"vpc": {"name": "env.prod-vpc", "description": "VPC for production environment", "region": "nyc1", "ip_range": "10.10.10.0/24", "default": true, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "urn": "do:droplet:13457723", "created_at": "2020-03-13T19:20:47.442049222Z"}}
{"type": "object", "properties": {"vpc": {"type": "object", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+$", "description": "The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods."}, "description": {"type": "string"...