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 deleted. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 deleted. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, the response code will be a 204, which means that the
action was successful with no returned body data. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, the response code will be a 204, which means that the
action was successful with no returned body data. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, the response code will be a 204, which means that the
action was successful with no returned body data. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, the response code will be a 204, which means that the
action was successful with no returned body data. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the snapshot was created."}, "regions": {"type": "array", "items": {"type": "string"}, "description": "An array of the regions that the snapshot is available in. The regions are represented by their identifying slug values."}, "min_disk_size": {"type": "integer", "description": "The minimum size in GB required for a volume or Droplet to use this snapshot."}, "size_gigabytes": {"type": "number", "format": "float", "description": "The billable size of the snapshot in gigabytes.", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}}, "required": ["name", "created_at", "regions", "min_disk_size", "size_gigabytes"]}, {"type": "object", "properties": {"resource_id": {"type": "string", "description": "The unique identifier for the resource that the snapshot originated from."}, "resource_type": {"type": "string", "enum": ["droplet", "volume"], "description": "The type of resource that the snapshot originated from."}, "tags": {"description": "An array of Tags the snapshot has been tagged with.", "type": ["array", "null"], "items": {"type": "string"}}}, "required": ["resource_id", "resource_type", "tags"]}]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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_port": 80, "certificate_id": "", "tls_passthrough": false}, {"entry_protocol": "https", "entry_port": 443, "target_protocol": "https", "target_port": 443, "certificate_id": "", "tls_passthrough": true}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "http_idle_timeout_seconds": 60, "firewall": {"deny": ["cidr:1.2.0.0/16", "ip:2.3.4.5"], "allow": ["ip:1.2.3.4", "cidr:2.3.4.0/24"]}}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, database, image, volume or volume_snapshot. resource_id is expected to be the ID of the resource as a string. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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"}, "volumes": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/volumes/3d80cb72-342b-4aaa-b92e-4e4abb24a933"}, "volume_snapshots": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/snapshots/1f6f46e8-6b60-11e9-be4e-0a58ac144519"}, "databases": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976"}}}], "links": {}, "meta": {"total": 1}} | {"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.\nTags have two attributes: a user defined `name` attribute and an embedded `resources` attribute with information about resources that have been tagged.", "properties": {"name": {"type": "string", "description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.\nThere is a limit of 255 characters per tag.\n\n**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.\n\nWhen working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named \"PROD\", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).\n\nTagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named \"PROD\", you can tag resources in the control panel by entering \"prod\". The tag will still display with its canonical capitalization, \"PROD\".\n", "pattern": "^[a-zA-Z0-9_\\-\\:]+$", "maxLength": 255}, "resources": {"type": "object", "description": "An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag.", "allOf": [{"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, {"properties": {"droplets": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "imgages": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volumes": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volume_snapshots": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "databases": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}}}]}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 not provided will be reset to its
default value. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 not provided will be reset to its
default value. | 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", "target_port": 80, "certificate_id": "", "tls_passthrough": false}, {"entry_protocol": "https", "entry_port": 443, "target_protocol": "https", "target_port": 443, "certificate_id": "", "tls_passthrough": true}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": true, "enable_backend_keepalive": true, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "http_idle_timeout_seconds": 60, "firewall": {"deny": ["cidr:1.2.0.0/16", "ip:2.3.4.5"], "allow": ["ip:1.2.3.4", "cidr:2.3.4.0/24"]}}} | {"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_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}} |
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 not provided will be reset to its
default value. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 not provided will be reset to its
default value. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 not provided will be reset to its
default value. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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\\\\\\\" contains invalid characters\\\""]} | {"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, including details to help resolve it when possible.", "type": "array", "items": {"type": "string"}}}, "required": ["error", "root_causes"]} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 and an embedded `resources` attribute with information about resources that have been tagged.", "properties": {"name": {"type": "string", "description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.\nThere is a limit of 255 characters per tag.\n\n**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.\n\nWhen working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named \"PROD\", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).\n\nTagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named \"PROD\", you can tag resources in the control panel by entering \"prod\". The tag will still display with its canonical capitalization, \"PROD\".\n", "pattern": "^[a-zA-Z0-9_\\-\\:]+$", "maxLength": 255}, "resources": {"type": "object", "description": "An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag.", "allOf": [{"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, {"properties": {"droplets": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "imgages": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volumes": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volume_snapshots": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "databases": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}}}]}}}}} |
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/7555620"}, "volumes": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/volumes/3d80cb72-342b-4aaa-b92e-4e4abb24a933"}, "volume_snapshots": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/snapshots/1f6f46e8-6b60-11e9-be4e-0a58ac144519"}, "databases": {"count": 1, "last_tagged_uri": "https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976"}}}}} | {"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 `name` attribute and an embedded `resources` attribute with information about resources that have been tagged.", "properties": {"name": {"type": "string", "description": "The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores.\nThere is a limit of 255 characters per tag.\n\n**Note:** Tag names are case stable, which means the capitalization you use when you first create a tag is canonical.\n\nWhen working with tags in the API, you must use the tag's canonical capitalization. For example, if you create a tag named \"PROD\", the URL to add that tag to a resource would be `https://api.digitalocean.com/v2/tags/PROD/resources` (not `/v2/tags/prod/resources`).\n\nTagged resources in the control panel will always display the canonical capitalization. For example, if you create a tag named \"PROD\", you can tag resources in the control panel by entering \"prod\". The tag will still display with its canonical capitalization, \"PROD\".\n", "pattern": "^[a-zA-Z0-9_\\-\\:]+$", "maxLength": 255}, "resources": {"type": "object", "description": "An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag.", "allOf": [{"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, {"properties": {"droplets": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "imgages": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volumes": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "volume_snapshots": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}, "databases": {"type": "object", "description": "Tagged Resource Statistics include metadata regarding the resource type that has been tagged.", "properties": {"count": {"description": "**Omitted**"}, "last_tagged_uri": {"description": "**Omitted**"}}}}}]}}}}} |
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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a Droplet | 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-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc3", "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}} | {"properties": {"action": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "status": {"type": "string", "description": "The current status of the action. This can be \"in-progress\", \"completed\", or \"errored\".", "enum": ["in-progress", "completed", "errored"], "default": "in-progress"}, "type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"transfer\" to represent the state of an image transfer action."}, "started_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was initiated."}, "completed_at": {"type": ["string", "null"], "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the action was completed."}, "resource_id": {"type": ["integer", "null"], "description": "A unique identifier for the resource that the action is associated with."}, "resource_type": {"type": "string", "description": "The type of resource that the action is associated with."}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "region_slug": {"allOf": [{"type": "string", "description": "A human-readable string that is used as a unique identifier for each region."}, {"type": ["string", "null"]}]}}}, {"type": "object", "properties": {"project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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 IP from a 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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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", "description": "The host name, alias, or service being defined by the record."}, "data": {"type": "string", "description": "Variable data depending on record type. For example, the \"data\" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates."}, "priority": {"type": ["integer", "null"], "description": "The priority for SRV and MX records."}, "port": {"type": ["integer", "null"], "description": "The port for SRV records."}, "ttl": {"type": "integer", "description": "This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."}, "weight": {"type": ["integer", "null"], "description": "The weight for SRV records."}, "flags": {"type": ["integer", "null"], "description": "An unsigned integer between 0-255 used for CAA records."}, "tag": {"type": ["string", "null"], "description": "The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""}}}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVRVENDQXFtZ0F3SUJBZ0lVRUZZWTdBWFZQS0Raam9jb1lpMk00Y0dvcU0wd0RRWUpLb1pJaHZjTkFRRU0KQlFBd09qRTRNRFlHQTFVRUF3d3ZOek0zT1RaaE1XRXRaamhrTUMwME9HSmpMV0V4Wm1NdFpqbGhNVFZsWXprdwpORGhsSUZCeWIycGxZM1FnUTBFd0hoY05NakF3TnpFM01UVTFNREEyV2hjTk16QXdOekUxTVRVMU1EQTJXakE2Ck1UZ3dOZ1lEVlFRRERDODNNemM1Tm1FeFlTMW1PR1F3TFRRNFltTXRZVEZtWXkxbU9XRXhOV1ZqT1RBME9HVWcKVUhKdmFtVmpkQ0JEUVRDQ0FhSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnR1BBRENDQVlvQ2dnR0JBTVdScXhycwpMZnpNdHZyUmxKVEw4MldYMVBLZkhKbitvYjNYcmVBY3FZd1dBUUp2Q3IycmhxSXZieVZzMGlaU0NzOHI4c3RGClljQ0R1bkxJNmUwTy9laERZYTBIT2RrMkFFRzE1ckVOVmNha2NSczcyQWlHVHNrdkNXS2VkUjFTUWswVWt0WCsKQUg4S1ExS3F5bzNtZ2Y2cVV1WUpzc3JNTXFselk3YTN1RVpEb2ZqTjN5Q3MvM21pTVJKcVcyNm1JV0IrUUlEbAo5YzdLRVF5MTZvdCtjeHVnd0lLMm9oZHMzaFY1bjBKMFVBM0I3QWRBdXY5aUl5L3JHaHlTNm5CNTdaWm9JZnAyCnFybXdOY0UrVjlIdXhQSGtRVjFOQjUwOFFudWZ4Z0E5VCtqU2VrdGVUbWFORkxqNjFXL3BtcndrTytOaWFXUTIKaGgzVXBKOEozY1BoNkErbHRnUmpSV2NEb2lsYVNwRVVpU09WemNNYVFvalZKYVJlNk9NbnZYc29NaSs3ZzdneApWcittQ0lUcGcvck9DaXpBWWQ2UFAxLzdYTjk1ZXNmU2tBQnM5c3hJakpjTUFqbDBYTEFzRmtGZVdyeHNIajlVCmJnaDNWYXdtcnpUeXhZT0RQcXV1cS9JcGlwc0RRT3Fpb2ZsUStkWEJJL3NUT0NNbVp6K0pNcG5HYXdJREFRQUIKb3o4d1BUQWRCZ05WSFE0RUZnUVVSekdDRlE3WEtUdHRDN3JzNS8ydFlQcExTZGN3RHdZRFZSMFRCQWd3QmdFQgovd0lCQURBTEJnTlZIUThFQkFNQ0FRWXdEUVlKS29aSWh2Y05BUUVNQlFBRGdnR0JBSWFKQ0dSVVNxUExtcmcvCmk3MW10b0NHUDdzeG1BVXVCek1oOEdrU25uaVdaZnZGMTRwSUtqTlkwbzVkWmpHKzZqK1VjalZtK0RIdGE1RjYKOWJPeEk5S0NFeEI1blBjRXpMWjNZYitNOTcrellxbm9zUm85S21DVFJBb2JrNTZ0WU1FS1h1aVJja2tkMm1yUQo4cGw2N2xxdThjM1V4c0dHZEZVT01wMkk3ZTNpdUdWVm5UR0ZWM3JQZUdaQ0J3WGVyUUQyY0F4UjkzS3BnWVZ2ClhUUzk5dnpSbm1HOHhhUm9EVy9FbEdXZ2xWd0Q5a1JrbXhUUkdoYTdDWVZCcjFQVWY2dVVFVjhmVFIxc1hFZnIKLytMR1JoSVVsSUhWT3l2Yzk3YnZYQURPbWF1MWZDVE5lWGtRdTNyZnZFSlBmaFlLeVIwT0V3eWVvdlhRNzl0LwpTV2ZGTjBreU1Pc1UrNVNIdHJKSEh1eWNWcU0yQlVVK083VjM1UnNwOU9MZGRZMFFVbTZldFpEVEhhSUhYYzRRCnl1Rm1OL1NhSFZtNE0wL3BTVlJQdVd6TmpxMnZyRllvSDRtbGhIZk95TUNJMjc2elE2aWhGNkdDSHlkOUJqajcKUm1UWGEyNHM3NWhmSi9YTDV2bnJSdEtpVHJlVHF6V21EOVhnUmNMQ0gyS1hJaVRtSWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="}} | {"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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/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, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.