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/ddb7bdd8-46bc-4cf9-9251-9c3082d1e0bd/2/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...
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/ddb7bdd8-46bc-4cf9-9251-9c3082d1e0bd/3/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...
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/38b3bf7c-6725-4313-a9d6-e62755a64334/0/0
Digital Ocean
Digital Ocean Public API
null
actions_get
To retrieve a specific action object, send a GET request to /v2/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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/38b3bf7c-6725-4313-a9d6-e62755a64334/1/0
Digital Ocean
Digital Ocean Public API
null
actions_get
To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.
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/38b3bf7c-6725-4313-a9d6-e62755a64334/2/0
Digital Ocean
Digital Ocean Public API
null
actions_get
To retrieve a specific action object, send a GET request to /v2/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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/38b3bf7c-6725-4313-a9d6-e62755a64334/3/0
Digital Ocean
Digital Ocean Public API
null
actions_get
To retrieve a specific action object, send a GET request to /v2/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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/38b3bf7c-6725-4313-a9d6-e62755a64334/4/0
Digital Ocean
Digital Ocean Public API
null
actions_get
To retrieve a specific action object, send a GET request to /v2/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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/63cd6b27-6b39-4424-97c1-927c79bab8c7/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_droplets
To remove a Droplet from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, ...
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/63cd6b27-6b39-4424-97c1-927c79bab8c7/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_droplets
To remove a Droplet from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, ...
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/63cd6b27-6b39-4424-97c1-927c79bab8c7/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_droplets
To remove a Droplet from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, ...
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/63cd6b27-6b39-4424-97c1-927c79bab8c7/4/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_remove_droplets
To remove a Droplet from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs. No response body will be sent back, but the response code will indicate success. Specifically, ...
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/dc905f5d-91c7-46fc-890d-a03211a17249/0/0
Digital Ocean
Digital Ocean Public API
null
domains_delete
To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.
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/dc905f5d-91c7-46fc-890d-a03211a17249/2/0
Digital Ocean
Digital Ocean Public API
null
domains_delete
To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.
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/dc905f5d-91c7-46fc-890d-a03211a17249/3/0
Digital Ocean
Digital Ocean Public API
null
domains_delete
To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.
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/dc905f5d-91c7-46fc-890d-a03211a17249/4/0
Digital Ocean
Digital Ocean Public API
null
domains_delete
To delete a domain, send a DELETE request to /v2/domains/$DOMAIN_NAME.
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/8ad56820-3f1b-4744-b373-2d3035f65db0/0/0
Digital Ocean
Digital Ocean Public API
null
tags_delete
A tag can be deleted by sending a DELETE request to /v2/tags/$TAG_NAME. Deleting a tag also untags all the resources that have previously been tagged by the Tag
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/8ad56820-3f1b-4744-b373-2d3035f65db0/2/0
Digital Ocean
Digital Ocean Public API
null
tags_delete
A tag can be deleted by sending a DELETE request to /v2/tags/$TAG_NAME. Deleting a tag also untags all the resources that have previously been tagged by the Tag
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/8ad56820-3f1b-4744-b373-2d3035f65db0/3/0
Digital Ocean
Digital Ocean Public API
null
tags_delete
A tag can be deleted by sending a DELETE request to /v2/tags/$TAG_NAME. Deleting a tag also untags all the resources that have previously been tagged by the Tag
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/8ad56820-3f1b-4744-b373-2d3035f65db0/4/0
Digital Ocean
Digital Ocean Public API
null
tags_delete
A tag can be deleted by sending a DELETE request to /v2/tags/$TAG_NAME. Deleting a tag also untags all the resources that have previously been tagged by the Tag
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/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/0/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
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/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/1/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
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/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/2/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
201
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"...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/3/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
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/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/4/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
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/8e20213f-6e9a-4122-8a0b-b6f8e7a5da83/5/0
Digital Ocean
Digital Ocean Public API
null
volumeSnapshots_create
To create a snapshot from a volume, sent a POST request to /v2/volumes/$VOLUME_ID/snapshots.
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/6c987d39-a5e0-4a23-8e13-d3fbed878689/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ips/$RESERVED_IP_ADDR. 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/6c987d39-a5e0-4a23-8e13-d3fbed878689/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ips/$RESERVED_IP_ADDR. 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/6c987d39-a5e0-4a23-8e13-d3fbed878689/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ips/$RESERVED_IP_ADDR. 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/6c987d39-a5e0-4a23-8e13-d3fbed878689/4/0
Digital Ocean
Digital Ocean Public API
null
reservedIPs_delete
To delete a reserved IP and remove it from your account, send a DELETE request to /v2/reserved_ips/$RESERVED_IP_ADDR. 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/318c1331-d58e-4cce-824e-364e3cbe98f8/1/0
Digital Ocean
Digital Ocean Public API
null
tags_assign_resources
Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet, 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/318c1331-d58e-4cce-824e-364e3cbe98f8/2/0
Digital Ocean
Digital Ocean Public API
null
tags_assign_resources
Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet, 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/318c1331-d58e-4cce-824e-364e3cbe98f8/3/0
Digital Ocean
Digital Ocean Public API
null
tags_assign_resources
Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet, 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/318c1331-d58e-4cce-824e-364e3cbe98f8/4/0
Digital Ocean
Digital Ocean Public API
null
tags_assign_resources
Resources can be tagged by sending a POST request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet, 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e3ad051c-6841-415e-8f62-e2359c550c6e/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_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/e3ad051c-6841-415e-8f62-e2359c550c6e/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_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/e3ad051c-6841-415e-8f62-e2359c550c6e/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_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/e3ad051c-6841-415e-8f62-e2359c550c6e/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_ID.
200
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "http", "entry_port": 80, "target_protocol": "http", "target_p...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e3ad051c-6841-415e-8f62-e2359c550c6e/4/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_get
To show information about a load balancer instance, send a GET request to /v2/load_balancers/$LOAD_BALANCER_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/731fd5ec-cd9d-43f1-9edc-c5c122e6bbfe/0/0
Digital Ocean
Digital Ocean Public API
null
tags_unassign_resources
Resources can be untagged by sending a DELETE request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet...
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/731fd5ec-cd9d-43f1-9edc-c5c122e6bbfe/2/0
Digital Ocean
Digital Ocean Public API
null
tags_unassign_resources
Resources can be untagged by sending a DELETE request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet...
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/731fd5ec-cd9d-43f1-9edc-c5c122e6bbfe/3/0
Digital Ocean
Digital Ocean Public API
null
tags_unassign_resources
Resources can be untagged by sending a DELETE request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet...
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/731fd5ec-cd9d-43f1-9edc-c5c122e6bbfe/4/0
Digital Ocean
Digital Ocean Public API
null
tags_unassign_resources
Resources can be untagged by sending a DELETE request to /v2/tags/$TAG_NAME/resources with an array of json objects containing resource_id and resource_type attributes. Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. resource_type is expected to be the string droplet...
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/7cbc4b28-dff5-428c-aa7b-dfe51f2fce53/0/0
Digital Ocean
Digital Ocean Public API
null
tags_list
To list all of your tags, you can send a GET request to /v2/tags.
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/7cbc4b28-dff5-428c-aa7b-dfe51f2fce53/1/0
Digital Ocean
Digital Ocean Public API
null
tags_list
To list all of your tags, you can send a GET request to /v2/tags.
200
null
{"tags": [{"name": "extra-awesome", "resources": {"count": 5, "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620", "droplets": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/droplets/3164444"}, "images": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620"},...
{"allOf": [{"type": "object", "properties": {"tags": {"type": "array", "items": {"type": "object", "description": "A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.\nT...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7cbc4b28-dff5-428c-aa7b-dfe51f2fce53/2/0
Digital Ocean
Digital Ocean Public API
null
tags_list
To list all of your tags, you can send a GET request to /v2/tags.
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/7cbc4b28-dff5-428c-aa7b-dfe51f2fce53/3/0
Digital Ocean
Digital Ocean Public API
null
tags_list
To list all of your tags, you can send a GET request to /v2/tags.
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/93a9b312-add9-41bf-b7dc-bad037bc4886/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_update
To update a load balancer's settings, send a PUT request to /v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a full representation of the load balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is ...
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/93a9b312-add9-41bf-b7dc-bad037bc4886/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_update
To update a load balancer's settings, send a PUT request to /v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a full representation of the load balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is ...
200
null
{"load_balancer": {"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "updated-example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "http", "entry_port": 80, "target_protocol": "http", "...
{"properties": {"load_balancer": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/93a9b312-add9-41bf-b7dc-bad037bc4886/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_update
To update a load balancer's settings, send a PUT request to /v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a full representation of the load balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is ...
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/93a9b312-add9-41bf-b7dc-bad037bc4886/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_update
To update a load balancer's settings, send a PUT request to /v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a full representation of the load balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is ...
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/93a9b312-add9-41bf-b7dc-bad037bc4886/4/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_update
To update a load balancer's settings, send a PUT request to /v2/load_balancers/$LOAD_BALANCER_ID. The request should contain a full representation of the load balancer including existing attributes. It may contain one of the droplets_ids or tag attributes as they are mutually exclusive. Note that any attribute that is ...
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/52d5e4a5-b4c7-400e-8a41-7fe095dde9bb/0/0
Digital Ocean
Digital Ocean Public API
null
tags_create
To create a tag you can send a POST request to /v2/tags with a name attribute.
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/52d5e4a5-b4c7-400e-8a41-7fe095dde9bb/1/0
Digital Ocean
Digital Ocean Public API
null
tags_create
To create a tag you can send a POST request to /v2/tags with a name attribute.
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/52d5e4a5-b4c7-400e-8a41-7fe095dde9bb/2/0
Digital Ocean
Digital Ocean Public API
null
tags_create
To create a tag you can send a POST request to /v2/tags with a name attribute.
400
null
{"error": "Error validating resource tag: \\\"tag-name \\\\\\\"\u0437\u0434\u043e\u0440\u043e\u0432\u043e\\\\\\\" contains invalid characters\\\"", "messages": null, "root_causes": ["rpc error: code = InvalidArgument desc = Error validating resource tag: \\\"tag-name \\\\\\\"\u0437\u0434\u043e\u0440\u043e\u0432\u043e\\...
{"type": "object", "properties": {"error": {"description": "A message providing information about the error.", "type": "string"}, "messages": {"description": "A list of error messages.", "type": ["array", "null"], "items": {"type": "string"}}, "root_causes": {"description": "A list of underlying causes for the error, i...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52d5e4a5-b4c7-400e-8a41-7fe095dde9bb/3/0
Digital Ocean
Digital Ocean Public API
null
tags_create
To create a tag you can send a POST request to /v2/tags with a name attribute.
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/52d5e4a5-b4c7-400e-8a41-7fe095dde9bb/4/0
Digital Ocean
Digital Ocean Public API
null
tags_create
To create a tag you can send a POST request to /v2/tags with a name attribute.
201
null
{"tag": {"name": "extra-awesome", "resources": {"count": 0, "droplets": {"count": 0}, "images": {"count": 0}, "volumes": {"count": 0}, "volume_snapshots": {"count": 0}, "databases": {"count": 0}}}}
{"properties": {"tag": {"type": "object", "description": "A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.\nTags have two attributes: a user defined `name` attribute ...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eface619-47ca-4cca-a0fe-fadd06fde9d9/0/0
Digital Ocean
Digital Ocean Public API
null
tags_get
To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.
200
null
{"tag": {"tag": {"name": "extra-awesome", "resources": {"count": 5, "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620", "droplets": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/droplets/3164444"}, "images": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555...
{"type": "object", "properties": {"tag": {"type": "object", "description": "A tag is a label that can be applied to a resource (currently Droplets, Images, Volumes, Volume Snapshots, and Database clusters) in order to better organize or facilitate the lookups and actions on it.\nTags have two attributes: a user defined...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/eface619-47ca-4cca-a0fe-fadd06fde9d9/1/0
Digital Ocean
Digital Ocean Public API
null
tags_get
To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.
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/eface619-47ca-4cca-a0fe-fadd06fde9d9/2/0
Digital Ocean
Digital Ocean Public API
null
tags_get
To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.
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/eface619-47ca-4cca-a0fe-fadd06fde9d9/3/0
Digital Ocean
Digital Ocean Public API
null
tags_get
To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.
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/eface619-47ca-4cca-a0fe-fadd06fde9d9/4/0
Digital Ocean
Digital Ocean Public API
null
tags_get
To retrieve an individual tag, you can send a GET request to /v2/tags/$TAG_NAME.
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/b9ec80ec-8bd1-43a2-8ac4-f5288b6c3f9d/0/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a reserved IP to a Droplet | unassign | Unassign a reserved...
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/b9ec80ec-8bd1-43a2-8ac4-f5288b6c3f9d/1/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a reserved IP to a Droplet | unassign | Unassign a reserved...
201
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...
{"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 \"er...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b9ec80ec-8bd1-43a2-8ac4-f5288b6c3f9d/2/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a reserved IP to a Droplet | unassign | Unassign a reserved...
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/b9ec80ec-8bd1-43a2-8ac4-f5288b6c3f9d/3/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a reserved IP to a Droplet | unassign | Unassign a reserved...
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/b9ec80ec-8bd1-43a2-8ac4-f5288b6c3f9d/4/0
Digital Ocean
Digital Ocean Public API
null
reservedIPsActions_post
To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types: | Action | Details |------------|-------- | assign | Assigns a reserved IP to a Droplet | unassign | Unassign a reserved...
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/275dd078-3441-4d5d-8806-77a36efa3697/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_maintenanceWindow
To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/275dd078-3441-4d5d-8806-77a36efa3697/2/0
Digital Ocean
Digital Ocean Public API
null
databases_update_maintenanceWindow
To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/275dd078-3441-4d5d-8806-77a36efa3697/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_maintenanceWindow
To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/275dd078-3441-4d5d-8806-77a36efa3697/4/0
Digital Ocean
Digital Ocean Public API
null
databases_update_maintenanceWindow
To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cca75a9b-8a44-486e-ae3a-7c27eb50287a/0/0
Digital Ocean
Digital Ocean Public API
null
databases_destroy_replica
To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cca75a9b-8a44-486e-ae3a-7c27eb50287a/1/0
Digital Ocean
Digital Ocean Public API
null
databases_destroy_replica
To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cca75a9b-8a44-486e-ae3a-7c27eb50287a/3/0
Digital Ocean
Digital Ocean Public API
null
databases_destroy_replica
To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/cca75a9b-8a44-486e-ae3a-7c27eb50287a/4/0
Digital Ocean
Digital Ocean Public API
null
databases_destroy_replica
To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. 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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/abe95777-e0f2-4a6d-beed-706bbca20a83/0/0
Digital Ocean
Digital Ocean Public API
null
domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records. The request must include all of the required fields for the domain record type being added. See the attribute table for details regarding record types and their respective required 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/abe95777-e0f2-4a6d-beed-706bbca20a83/1/0
Digital Ocean
Digital Ocean Public API
null
domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records. The request must include all of the required fields for the domain record type being added. See the attribute table for details regarding record types and their respective required 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/abe95777-e0f2-4a6d-beed-706bbca20a83/2/0
Digital Ocean
Digital Ocean Public API
null
domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records. The request must include all of the required fields for the domain record type being added. See the attribute table for details regarding record types and their respective required 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/abe95777-e0f2-4a6d-beed-706bbca20a83/3/0
Digital Ocean
Digital Ocean Public API
null
domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records. The request must include all of the required fields for the domain record type being added. See the attribute table for details regarding record types and their respective required 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/abe95777-e0f2-4a6d-beed-706bbca20a83/4/0
Digital Ocean
Digital Ocean Public API
null
domains_create_record
To create a new record to a domain, send a POST request to /v2/domains/$DOMAIN_NAME/records. The request must include all of the required fields for the domain record type being added. See the attribute table for details regarding record types and their respective required attributes.
201
null
{"domain_record": {"id": 28448433, "type": "A", "name": "www", "data": "162.10.66.0", "priority": null, "port": null, "ttl": 1800, "weight": null, "flags": null, "tag": null}}
{"properties": {"domain_record": {"type": "object", "required": ["type"], "properties": {"id": {"type": "integer", "description": "A unique identifier for each domain record."}, "type": {"type": "string", "description": "The type of the DNS record. For example: A, CNAME, TXT, ..."}, "name": {"type": "string", "descript...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0a826cc3-b317-4875-a0f0-de6b2e340435/1/0
Digital Ocean
Digital Ocean Public API
null
databases_patch_config
To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE_ID/config.
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/0a826cc3-b317-4875-a0f0-de6b2e340435/2/0
Digital Ocean
Digital Ocean Public API
null
databases_patch_config
To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE_ID/config.
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/0a826cc3-b317-4875-a0f0-de6b2e340435/3/0
Digital Ocean
Digital Ocean Public API
null
databases_patch_config
To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE_ID/config.
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/0a826cc3-b317-4875-a0f0-de6b2e340435/4/0
Digital Ocean
Digital Ocean Public API
null
databases_patch_config
To update the configuration for an existing database cluster, send a PATCH request to /v2/databases/$DATABASE_ID/config.
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/94ea19b5-ef7e-49f6-bea4-d277a51b3818/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca. The response will be a JSON object with a ca key. This will be set to an object containing the base64 encoding of the public key certificate.
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/94ea19b5-ef7e-49f6-bea4-d277a51b3818/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca. The response will be a JSON object with a ca key. This will be set to an object containing the base64 encoding of the public key certificate.
200
null
{"ca": {"certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVRVENDQXFtZ0F3SUJBZ0lVRUZZWTdBWFZQS0Raam9jb1lpMk00Y0dvcU0wd0RRWUpLb1pJaHZjTkFRRU0KQlFBd09qRTRNRFlHQTFVRUF3d3ZOek0zT1RaaE1XRXRaamhrTUMwME9HSmpMV0V4Wm1NdFpqbGhNVFZsWXprdwpORGhsSUZCeWIycGxZM1FnUTBFd0hoY05NakF3TnpFM01UVTFNREEyV2hjTk16QXdOekUxTVRVMU1EQTJXakE2...
{"type": "object", "properties": {"ca": {"type": "object", "properties": {"certificate": {"type": "string", "description": "base64 encoding of the certificate used to secure database connections"}}, "required": ["certificate"]}}, "required": ["ca"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/94ea19b5-ef7e-49f6-bea4-d277a51b3818/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca. The response will be a JSON object with a ca key. This will be set to an object containing the base64 encoding of the public key certificate.
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/94ea19b5-ef7e-49f6-bea4-d277a51b3818/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca. The response will be a JSON object with a ca key. This will be set to an object containing the base64 encoding of the public key certificate.
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/94ea19b5-ef7e-49f6-bea4-d277a51b3818/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get_ca
To retrieve the public certificate used to secure the connection to the database cluster send a GET request to /v2/databases/$DATABASE_ID/ca. The response will be a JSON object with a ca key. This will be set to an object containing the base64 encoding of the public key certificate.
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/255e32a1-5fe1-484f-8570-9c51d7ab4a84/0/0
Digital Ocean
Digital Ocean Public API
null
cdn_delete_endpoint
To delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/255e32a1-5fe1-484f-8570-9c51d7ab4a84/1/0
Digital Ocean
Digital Ocean Public API
null
cdn_delete_endpoint
To delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/255e32a1-5fe1-484f-8570-9c51d7ab4a84/2/0
Digital Ocean
Digital Ocean Public API
null
cdn_delete_endpoint
To delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/255e32a1-5fe1-484f-8570-9c51d7ab4a84/3/0
Digital Ocean
Digital Ocean Public API
null
cdn_delete_endpoint
To delete a specific CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_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,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/34ec6659-9d2e-451d-9e38-219d48a0b852/0/0
Digital Ocean
Digital Ocean Public API
null
databases_update_connectionPool
To update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
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/34ec6659-9d2e-451d-9e38-219d48a0b852/1/0
Digital Ocean
Digital Ocean Public API
null
databases_update_connectionPool
To update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
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/34ec6659-9d2e-451d-9e38-219d48a0b852/2/0
Digital Ocean
Digital Ocean Public API
null
databases_update_connectionPool
To update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
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/34ec6659-9d2e-451d-9e38-219d48a0b852/3/0
Digital Ocean
Digital Ocean Public API
null
databases_update_connectionPool
To update a connection pool for a PostgreSQL database cluster, send a PUT request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME.
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/306630b7-54b6-47a0-9b9e-61e774a95d42/0/0
Digital Ocean
Digital Ocean Public API
null
databases_delete
To delete a specific database, send a DELETE request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/306630b7-54b6-47a0-9b9e-61e774a95d42/2/0
Digital Ocean
Digital Ocean Public API
null
databases_delete
To delete a specific database, send a DELETE request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/306630b7-54b6-47a0-9b9e-61e774a95d42/3/0
Digital Ocean
Digital Ocean Public API
null
databases_delete
To delete a specific database, send a DELETE request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/306630b7-54b6-47a0-9b9e-61e774a95d42/4/0
Digital Ocean
Digital Ocean Public API
null
databases_delete
To delete a specific database, send a DELETE request to /v2/databases/$DATABASE_ID/dbs/$DB_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error,...