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/22041601-dca5-426b-9735-7392cef446dd/3/0 | Digital Ocean | Digital Ocean Public API | null | volumes_delete_byName | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME®ion=nyc1.
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/22041601-dca5-426b-9735-7392cef446dd/4/0 | Digital Ocean | Digital Ocean Public API | null | volumes_delete_byName | Block storage volumes may also be deleted by name by sending a DELETE request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME®ion=nyc1.
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/e30348a2-90cc-47aa-a410-f1f8ecde7082/0/0 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID. | 200 | null | {"action": {"id": 72531856, "status": "completed", "type": "attach_volume", "started_at": "2020-11-12T17:51:03Z", "completed_at": "2020-11-12T17:51:14Z", "resource_type": "volume", "region": {"name": "New York 1", "slug": "nyc1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc1"}} | {"properties": {"action": {"type": "object", "allOf": [{"properties": {"type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"attach_volume\" to represent the state of a volume attach action."}, "resource_id": {"type": ["integer", "null"]}}}, {"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/e30348a2-90cc-47aa-a410-f1f8ecde7082/0/1 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/actions/$ACTION_ID. | 200 | null | {"action": {"id": 68212773, "status": "in-progress", "type": "detach_volume", "started_at": "2015-10-15T17:46:15Z", "completed_at": null, "resource_id": null, "resource_type": "backend", "region": {"name": "New York 1", "slug": "nyc1", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata"], "available": true}, "region_slug": "nyc1"}} | {"properties": {"action": {"type": "object", "allOf": [{"properties": {"type": {"type": "string", "description": "This is the type of action that the object represents. For example, this could be \"attach_volume\" to represent the state of a volume attach action."}, "resource_id": {"type": ["integer", "null"]}}}, {"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/e30348a2-90cc-47aa-a410-f1f8ecde7082/1/0 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/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/e30348a2-90cc-47aa-a410-f1f8ecde7082/2/0 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/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/e30348a2-90cc-47aa-a410-f1f8ecde7082/3/0 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/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/e30348a2-90cc-47aa-a410-f1f8ecde7082/4/0 | Digital Ocean | Digital Ocean Public API | null | volumeActions_get | To retrieve the status of a volume action, send a GET request to /v2/volumes/$VOLUME_ID/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/ff29407e-3046-4bd4-afb2-a8a9ecbf9d74/0/0 | Digital Ocean | Digital Ocean Public API | null | cdn_create_endpoint | To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl
attribute.
A custom subdomain may be configured by specifying the custom_domain and
certificate_id 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/ff29407e-3046-4bd4-afb2-a8a9ecbf9d74/1/0 | Digital Ocean | Digital Ocean Public API | null | cdn_create_endpoint | To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl
attribute.
A custom subdomain may be configured by specifying the custom_domain and
certificate_id 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/ff29407e-3046-4bd4-afb2-a8a9ecbf9d74/2/0 | Digital Ocean | Digital Ocean Public API | null | cdn_create_endpoint | To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl
attribute.
A custom subdomain may be configured by specifying the custom_domain and
certificate_id 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/ff29407e-3046-4bd4-afb2-a8a9ecbf9d74/3/0 | Digital Ocean | Digital Ocean Public API | null | cdn_create_endpoint | To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl
attribute.
A custom subdomain may be configured by specifying the custom_domain and
certificate_id attributes. | 201 | null | {"endpoint": {"id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "created_at": "2018-07-19T15:04:16Z", "ttl": 3600}} | {"properties": {"endpoint": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a CDN endpoint."}, "origin": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space."}, "endpoint": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) from which the CDN-backed content is served."}, "ttl": {"type": "integer", "enum": [60, 600, 3600, 86400, 604800], "default": 3600, "description": "The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded."}, "certificate_id": {"type": "string", "format": "uuid", "description": "The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided."}, "custom_domain": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created."}}, "required": ["origin"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/ff29407e-3046-4bd4-afb2-a8a9ecbf9d74/3/1 | Digital Ocean | Digital Ocean Public API | null | cdn_create_endpoint | To create a new CDN endpoint, send a POST request to /v2/cdn/endpoints. The
origin attribute must be set to the fully qualified domain name (FQDN) of a
DigitalOcean Space. Optionally, the TTL may be configured by setting the ttl
attribute.
A custom subdomain may be configured by specifying the custom_domain and
certificate_id attributes. | 201 | null | {"endpoint": {"id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "created_at": "2018-07-19T15:04:16Z", "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf", "custom_domain": "static.example.com", "ttl": 3600}} | {"properties": {"endpoint": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a CDN endpoint."}, "origin": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space."}, "endpoint": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) from which the CDN-backed content is served."}, "ttl": {"type": "integer", "enum": [60, 600, 3600, 86400, 604800], "default": 3600, "description": "The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded."}, "certificate_id": {"type": "string", "format": "uuid", "description": "The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided."}, "custom_domain": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created."}}, "required": ["origin"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/0/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/1/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/2/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 200 | Assigned to Droplet | {"floating_ip": {"ip": "45.55.96.47", "droplet": {"id": 3164444, "name": "example.com", "memory": 1024, "vcpus": 1, "disk": 25, "locked": false, "status": "active", "kernel": null, "created_at": "2020-07-21T18:37:44Z", "features": ["backups", "private_networking", "ipv6"], "backup_ids": [53893572], "next_backup_window": {"start": "2020-07-30T00:00:00Z", "end": "2020-07-30T23:00:00Z"}, "snapshot_ids": [67512819], "image": {"id": 63663980, "name": "20.04 (LTS) x64", "type": "base", "distribution": "Ubuntu", "slug": "ubuntu-20-04-x64", "public": true, "regions": ["ams2", "ams3", "blr1", "fra1", "lon1", "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "sgp1", "tor1"], "created_at": "2020-05-15T05:47:50Z", "min_disk_size": 20, "size_gigabytes": 2.36, "description": "", "tags": [], "status": "available", "error_message": ""}, "volume_ids": [], "size": {"slug": "s-1vcpu-1gb", "memory": 1024, "vcpus": 1, "disk": 25, "transfer": 1, "price_monthly": 5, "price_hourly": 0.00743999984115362, "regions": ["ams2", "ams3", "blr1", "fra1", "lon1", "nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "sgp1", "tor1"], "available": true, "description": "Basic"}, "size_slug": "s-1vcpu-1gb", "networks": {"v4": [{"ip_address": "10.128.192.124", "netmask": "255.255.0.0", "gateway": "nil", "type": "private"}, {"ip_address": "192.241.165.154", "netmask": "255.255.255.0", "gateway": "192.241.165.1", "type": "public"}], "v6": [{"ip_address": "2604:a880:0:1010::18a:a001", "netmask": 64, "gateway": "2604:a880:0:1010::1", "type": "public"}]}, "region": {"name": "New York 3", "slug": "nyc3", "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "tags": ["web", "env:prod"], "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"}, "region": {"name": "New York 3", "slug": "nyc3", "features": ["backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}} | {"type": "object", "properties": {"floating_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the floating IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the floating IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/2/1 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 200 | Reserved to Region | {"floating_ip": {"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}} | {"type": "object", "properties": {"floating_ip": {"type": "object", "properties": {"ip": {"type": "string", "format": "ipv4", "description": "The public IP address of the floating IP. It also serves as its identifier."}, "region": {"allOf": [{"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, {"type": "object", "description": "The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned."}]}, "droplet": {"description": "The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.", "anyOf": [{"title": "null", "type": ["object", "null"], "description": "If the floating IP is not assigned to a Droplet, the value will be null."}, {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}]}, "locked": {"type": "boolean", "description": "A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted."}, "project_id": {"type": "string", "format": "uuid", "description": "The UUID of the project to which the reserved IP currently belongs."}}}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/3/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/8141ff59-6bf2-47b7-8c16-20e12b7fb5b3/4/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_get | To show information about a floating IP, send a GET request to /v2/floating_ips/$FLOATING_IP_ADDR. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/4cf5e987-fce3-42b0-97ee-cb26bbe472fa/0/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_delete | To delete a floating IP and remove it from your account, send a DELETE request
to /v2/floating_ips/$FLOATING_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/4cf5e987-fce3-42b0-97ee-cb26bbe472fa/1/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_delete | To delete a floating IP and remove it from your account, send a DELETE request
to /v2/floating_ips/$FLOATING_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/4cf5e987-fce3-42b0-97ee-cb26bbe472fa/2/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_delete | To delete a floating IP and remove it from your account, send a DELETE request
to /v2/floating_ips/$FLOATING_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/4cf5e987-fce3-42b0-97ee-cb26bbe472fa/4/0 | Digital Ocean | Digital Ocean Public API | null | floatingIPs_delete | To delete a floating IP and remove it from your account, send a DELETE request
to /v2/floating_ips/$FLOATING_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/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/0/0 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_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/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/1/0 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_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/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/2/0 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_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/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/3/0 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_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/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/4/0 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_ID. | 200 | null | {"endpoint": {"id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "created_at": "2018-07-19T15:04:16Z", "ttl": 3600}} | {"properties": {"endpoint": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a CDN endpoint."}, "origin": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space."}, "endpoint": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) from which the CDN-backed content is served."}, "ttl": {"type": "integer", "enum": [60, 600, 3600, 86400, 604800], "default": 3600, "description": "The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded."}, "certificate_id": {"type": "string", "format": "uuid", "description": "The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided."}, "custom_domain": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created."}}, "required": ["origin"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e7b07966-6d8a-42ec-bdc3-c2cdacb55809/4/1 | Digital Ocean | Digital Ocean Public API | null | cdn_update_endpoints | To update the TTL, certificate ID, or the FQDN of the custom subdomain for
an existing CDN endpoint, send a PUT request to
/v2/cdn/endpoints/$ENDPOINT_ID. | 200 | null | {"endpoint": {"id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "created_at": "2018-07-19T15:04:16Z", "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf", "custom_domain": "static.example.com", "ttl": 3600}} | {"properties": {"endpoint": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a CDN endpoint."}, "origin": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space."}, "endpoint": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) from which the CDN-backed content is served."}, "ttl": {"type": "integer", "enum": [60, 600, 3600, 86400, 604800], "default": 3600, "description": "The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded."}, "certificate_id": {"type": "string", "format": "uuid", "description": "The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided."}, "custom_domain": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created."}}, "required": ["origin"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/2a7e816f-cf41-49a2-8930-b77360a5fb36/0/0 | Digital Ocean | Digital Ocean Public API | null | cdn_list_endpoints | To list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints. | 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/2a7e816f-cf41-49a2-8930-b77360a5fb36/1/0 | Digital Ocean | Digital Ocean Public API | null | cdn_list_endpoints | To list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints. | 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/2a7e816f-cf41-49a2-8930-b77360a5fb36/2/0 | Digital Ocean | Digital Ocean Public API | null | cdn_list_endpoints | To list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints. | 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/2a7e816f-cf41-49a2-8930-b77360a5fb36/3/0 | Digital Ocean | Digital Ocean Public API | null | cdn_list_endpoints | To list all of the CDN endpoints available on your account, send a GET request to /v2/cdn/endpoints. | 200 | null | {"endpoints": [{"id": "19f06b6a-3ace-4315-b086-499a0e521b76", "origin": "static-images.nyc3.digitaloceanspaces.com", "endpoint": "static-images.nyc3.cdn.digitaloceanspaces.com", "created_at": "2018-07-19T15:04:16Z", "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf", "custom_domain": "static.example.com", "ttl": 3600}], "links": {}, "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"endpoints": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a CDN endpoint."}, "origin": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN. This is currently restricted to a Space."}, "endpoint": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) from which the CDN-backed content is served."}, "ttl": {"type": "integer", "enum": [60, 600, 3600, 86400, 604800], "default": 3600, "description": "The amount of time the content is cached by the CDN's edge servers in seconds. TTL must be one of 60, 600, 3600, 86400, or 604800. Defaults to 3600 (one hour) when excluded."}, "certificate_id": {"type": "string", "format": "uuid", "description": "The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided."}, "custom_domain": {"type": "string", "format": "hostname", "description": "The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created."}}, "required": ["origin"]}}}}, {"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/02da2b3e-9769-4aac-8d25-a4bebc44e6d0/0/0 | Digital Ocean | Digital Ocean Public API | null | volumeSnapshots_list | To retrieve the snapshots that have been created from a volume, send a GET 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/02da2b3e-9769-4aac-8d25-a4bebc44e6d0/1/0 | Digital Ocean | Digital Ocean Public API | null | volumeSnapshots_list | To retrieve the snapshots that have been created from a volume, send a GET 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/02da2b3e-9769-4aac-8d25-a4bebc44e6d0/2/0 | Digital Ocean | Digital Ocean Public API | null | volumeSnapshots_list | To retrieve the snapshots that have been created from a volume, send a GET 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/02da2b3e-9769-4aac-8d25-a4bebc44e6d0/3/0 | Digital Ocean | Digital Ocean Public API | null | volumeSnapshots_list | To retrieve the snapshots that have been created from a volume, send a GET request to /v2/volumes/$VOLUME_ID/snapshots. | 200 | null | {"snapshots": [{"id": "8eb4d51a-873f-11e6-96bf-000f53315a41", "name": "big-data-snapshot1475261752", "regions": ["nyc1"], "created_at": "2020-09-30T18:56:12Z", "resource_id": "82a48a18-873f-11e6-96bf-000f53315a41", "resource_type": "volume", "min_disk_size": 10, "size_gigabytes": 0, "tags": null}], "links": {}, "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"snapshots": {"type": "array", "items": {"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"]}]}}}}, {"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/02da2b3e-9769-4aac-8d25-a4bebc44e6d0/4/0 | Digital Ocean | Digital Ocean Public API | null | volumeSnapshots_list | To retrieve the snapshots that have been created from a volume, send a GET 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/6c03bb44-a8dd-46cf-8d98-64c64f100d03/0/0 | Digital Ocean | Digital Ocean Public API | null | vpcs_list | To list all of the VPCs on your account, send a GET request to /v2/vpcs. | 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/6c03bb44-a8dd-46cf-8d98-64c64f100d03/1/0 | Digital Ocean | Digital Ocean Public API | null | vpcs_list | To list all of the VPCs on your account, send a GET request to /v2/vpcs. | 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/6c03bb44-a8dd-46cf-8d98-64c64f100d03/2/0 | Digital Ocean | Digital Ocean Public API | null | vpcs_list | To list all of the VPCs on your account, send a GET request to /v2/vpcs. | 200 | null | {"vpcs": [{"name": "env.prod-vpc", "description": "VPC for production environment", "region": "nyc1", "ip_range": "10.10.10.0/24", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "urn": "do:vpc:5a4981aa-9653-4bd1-bef5-d6bff52042e4", "default": false, "created_at": "2020-03-13T19:20:47.442049222Z"}, {"id": "e0fe0f4d-596a-465e-a902-571ce57b79fa", "urn": "do:vpc:e0fe0f4d-596a-465e-a902-571ce57b79fa", "name": "default-nyc1", "description": "", "region": "nyc1", "ip_range": "10.102.0.0/20", "created_at": "2020-03-13T19:29:20Z", "default": true}, {"id": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", "urn": "do:vpc:d455e75d-4858-4eec-8c95-da2f0a5f93a7", "name": "default-nyc3", "description": "", "region": "nyc3", "ip_range": "10.100.0.0/20", "created_at": "2019-11-19T22:19:35Z", "default": true}], "links": {}, "meta": {"total": 3}} | {"allOf": [{"type": "object", "properties": {"vpcs": {"type": "array", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+$", "description": "The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods."}, "description": {"type": "string", "maxLength": 255, "description": "A free-form text field for describing the VPC's purpose. It may be a maximum of 255 characters."}}}, {"type": "object", "properties": {"region": {"type": "string", "description": "The slug identifier for the region where the VPC will be created."}, "ip_range": {"type": "string", "description": "The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account and must be in range of private addresses as defined in RFC1918. It may not be smaller than `/28` nor larger than `/16`. If no IP range is specified, a `/20` network range is generated that won't conflict with other VPC networks in your account."}}}, {"type": "object", "properties": {"default": {"type": "boolean", "description": "A boolean value indicating whether or not the VPC is the default network for the region. All applicable resources are placed into the default VPC network unless otherwise specified during their creation. The `default` field cannot be unset from `true`. If you want to set a new default VPC network, update the `default` field of another VPC network in the same region. The previous network's `default` field will be set to `false` when a new default VPC has been defined."}}}, {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference the VPC."}, "urn": {"type": "string", "pattern": "^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.*", "description": "The uniform resource name (URN) for the resource in the format do:resource_type:resource_id."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format."}}}]}}}}, {"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/6c03bb44-a8dd-46cf-8d98-64c64f100d03/3/0 | Digital Ocean | Digital Ocean Public API | null | vpcs_list | To list all of the VPCs on your account, send a GET request to /v2/vpcs. | 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/6c03bb44-a8dd-46cf-8d98-64c64f100d03/4/0 | Digital Ocean | Digital Ocean Public API | null | vpcs_list | To list all of the VPCs on your account, send a GET request to /v2/vpcs. | 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/e89a6344-a1de-4845-b42d-1ea1bde4a167/0/0 | Digital Ocean | Digital Ocean Public API | null | account_get | To show information about the current user account, send a GET request to /v2/account. | 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/e89a6344-a1de-4845-b42d-1ea1bde4a167/1/0 | Digital Ocean | Digital Ocean Public API | null | account_get | To show information about the current user account, send a GET request to /v2/account. | 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/e89a6344-a1de-4845-b42d-1ea1bde4a167/2/0 | Digital Ocean | Digital Ocean Public API | null | account_get | To show information about the current user account, send a GET request to /v2/account. | 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/e89a6344-a1de-4845-b42d-1ea1bde4a167/3/0 | Digital Ocean | Digital Ocean Public API | null | account_get | To show information about the current user account, send a GET request to /v2/account. | 200 | null | {"account": {"droplet_limit": 25, "floating_ip_limit": 5, "email": "[email protected]", "uuid": "b6fr89dbf6d9156cace5f3c78dc9851d957381ef", "email_verified": false, "status": "active", "status_message": " ", "team": {"uuid": "5df3e3004a17e242b7c20ca6c9fc25b701a47ece", "name": "My Team"}}} | {"properties": {"account": {"type": "object", "properties": {"droplet_limit": {"description": "The total number of Droplets current user or team may have active at one time.", "type": "integer"}, "floating_ip_limit": {"description": "The total number of Floating IPs the current user or team may have.", "type": "integer"}, "email": {"description": "The email address used by the current user to register for DigitalOcean.", "type": "string"}, "uuid": {"description": "The unique universal identifier for the current user.", "type": "string"}, "email_verified": {"description": "If true, the user has verified their account via email. False otherwise.", "type": "boolean", "default": false}, "status": {"description": "This value is one of \"active\", \"warning\" or \"locked\".", "type": "string", "enum": ["active", "warning", "locked"], "default": "active"}, "status_message": {"description": "A human-readable message giving more details about the status of the account.", "type": "string"}, "team": {"type": "object", "description": "When authorized in a team context, includes information about the current team.", "properties": {"uuid": {"description": "The unique universal identifier for the current team.", "type": "string"}, "name": {"description": "The name for the current team.", "type": "string"}}}}, "required": ["droplet_limit", "floating_ip_limit", "email", "uuid", "email_verified", "status", "status_message"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/373259b7-47b4-44b3-8a3b-c66ac1cc7804/0/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_update | To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use. | 200 | null | {"ssh_key": {"id": 512189, "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa", "public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example", "name": "My SSH Public Key"}} | {"properties": {"ssh_key": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet."}, "fingerprint": {"type": "string", "description": "A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account."}, "public_key": {"description": "The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation.", "type": "string"}, "name": {"type": "string", "description": "A human-readable display name for this key, used to easily identify the SSH keys when they are displayed."}}, "required": ["public_key", "name"]}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/373259b7-47b4-44b3-8a3b-c66ac1cc7804/1/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_update | To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use. | 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/373259b7-47b4-44b3-8a3b-c66ac1cc7804/2/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_update | To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use. | 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/373259b7-47b4-44b3-8a3b-c66ac1cc7804/3/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_update | To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use. | 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/373259b7-47b4-44b3-8a3b-c66ac1cc7804/4/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_update | To update the name of an SSH key, send a PUT request to either /v2/account/keys/$SSH_KEY_ID or /v2/account/keys/$SSH_KEY_FINGERPRINT. Set the name attribute to the new name you want to use. | 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/4bb3e0f3-c4d6-4766-82c8-13d07928a368/1/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_delete | To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | 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/4bb3e0f3-c4d6-4766-82c8-13d07928a368/2/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_delete | To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | 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/4bb3e0f3-c4d6-4766-82c8-13d07928a368/3/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_delete | To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | 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/4bb3e0f3-c4d6-4766-82c8-13d07928a368/4/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_delete | To destroy a public SSH key that you have in your account, send a DELETE request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT.
A 204 status will be returned, indicating that the action was successful and that the response body is empty. | 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/2b317ea7-0145-4c01-82d4-84d8ce23714b/0/0 | Digital Ocean | Digital Ocean Public API | null | oneClicks_install_kubernetes | To install a Kubernetes 1-Click application on a cluster, send a POST request to
/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body
parameter in order to specify which 1-Click application(s) to install. To list all available
1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes. | 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/2b317ea7-0145-4c01-82d4-84d8ce23714b/1/0 | Digital Ocean | Digital Ocean Public API | null | oneClicks_install_kubernetes | To install a Kubernetes 1-Click application on a cluster, send a POST request to
/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body
parameter in order to specify which 1-Click application(s) to install. To list all available
1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes. | 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/2b317ea7-0145-4c01-82d4-84d8ce23714b/2/0 | Digital Ocean | Digital Ocean Public API | null | oneClicks_install_kubernetes | To install a Kubernetes 1-Click application on a cluster, send a POST request to
/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body
parameter in order to specify which 1-Click application(s) to install. To list all available
1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes. | 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/2b317ea7-0145-4c01-82d4-84d8ce23714b/3/0 | Digital Ocean | Digital Ocean Public API | null | oneClicks_install_kubernetes | To install a Kubernetes 1-Click application on a cluster, send a POST request to
/v2/1-clicks/kubernetes. The addon_slugs and cluster_uuid must be provided as body
parameter in order to specify which 1-Click application(s) to install. To list all available
1-Click Kubernetes applications, send a request to /v2/1-clicks?type=kubernetes. | 200 | null | {"message": "Successfully kicked off addon job."} | {"type": "object", "properties": {"message": {"type": "string", "description": "A message about the result of the request."}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b3f447d3-0ef2-4c0b-b479-9a2f6e25ab6d/0/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_backups | To retrieve any backups associated with a Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/backups.
You will get back a JSON object that has a backups key. This will be set to
an array of backup objects, each of which contain the standard
Droplet backup 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/b3f447d3-0ef2-4c0b-b479-9a2f6e25ab6d/1/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_backups | To retrieve any backups associated with a Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/backups.
You will get back a JSON object that has a backups key. This will be set to
an array of backup objects, each of which contain the standard
Droplet backup attributes. | 200 | null | {"backups": [{"id": 6372321, "name": "web-01-1595954862243", "created_at": "2020-07-28T16:47:44Z", "regions": [], "min_disk_size": 25, "size_gigabytes": 2.34, "type": "snapshot"}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "next": "https://api.digitalocean.com/v2/images?page=2", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"backups": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "integer", "description": "The unique identifier for the snapshot or backup."}}, "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": {"type": {"type": "string", "enum": ["snapshot", "backup"], "description": "Describes the kind of image. It may be one of `snapshot` or `backup`. This specifies whether an image is a user-generated Droplet snapshot or automatically created Droplet backup."}}, "required": ["type"]}]}}}}, {"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/b3f447d3-0ef2-4c0b-b479-9a2f6e25ab6d/2/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_backups | To retrieve any backups associated with a Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/backups.
You will get back a JSON object that has a backups key. This will be set to
an array of backup objects, each of which contain the standard
Droplet backup 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/b3f447d3-0ef2-4c0b-b479-9a2f6e25ab6d/3/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_backups | To retrieve any backups associated with a Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/backups.
You will get back a JSON object that has a backups key. This will be set to
an array of backup objects, each of which contain the standard
Droplet backup 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/b3f447d3-0ef2-4c0b-b479-9a2f6e25ab6d/4/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_backups | To retrieve any backups associated with a Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/backups.
You will get back a JSON object that has a backups key. This will be set to
an array of backup objects, each of which contain the standard
Droplet backup 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/fdf9771a-26eb-4865-ba5d-05e4e3929050/0/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_kernels | To retrieve a list of all kernels available to a Droplet, send a GET request
to /v2/droplets/$DROPLET_ID/kernels
The response will be a JSON object that has a key called kernels. This will
be set to an array of kernel objects, each of which contain the standard
kernel 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/fdf9771a-26eb-4865-ba5d-05e4e3929050/1/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_kernels | To retrieve a list of all kernels available to a Droplet, send a GET request
to /v2/droplets/$DROPLET_ID/kernels
The response will be a JSON object that has a key called kernels. This will
be set to an array of kernel objects, each of which contain the standard
kernel 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/fdf9771a-26eb-4865-ba5d-05e4e3929050/2/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_kernels | To retrieve a list of all kernels available to a Droplet, send a GET request
to /v2/droplets/$DROPLET_ID/kernels
The response will be a JSON object that has a key called kernels. This will
be set to an array of kernel objects, each of which contain the standard
kernel attributes. | 200 | null | {"kernels": [], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "next": "https://api.digitalocean.com/v2/images?page=2", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"kernels": {"type": "array", "items": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}}}}, {"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/fdf9771a-26eb-4865-ba5d-05e4e3929050/3/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_kernels | To retrieve a list of all kernels available to a Droplet, send a GET request
to /v2/droplets/$DROPLET_ID/kernels
The response will be a JSON object that has a key called kernels. This will
be set to an array of kernel objects, each of which contain the standard
kernel 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/fdf9771a-26eb-4865-ba5d-05e4e3929050/4/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_kernels | To retrieve a list of all kernels available to a Droplet, send a GET request
to /v2/droplets/$DROPLET_ID/kernels
The response will be a JSON object that has a key called kernels. This will
be set to an array of kernel objects, each of which contain the standard
kernel 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/97880b18-2ed0-4c55-a2fa-611e613d40f2/0/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_tags | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the
request, there should be a tags attribute containing a list of tag names.
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/97880b18-2ed0-4c55-a2fa-611e613d40f2/1/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_tags | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the
request, there should be a tags attribute containing a list of tag names.
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. | 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/97880b18-2ed0-4c55-a2fa-611e613d40f2/2/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_tags | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the
request, there should be a tags attribute containing a list of tag names.
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/97880b18-2ed0-4c55-a2fa-611e613d40f2/3/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_tags | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the
request, there should be a tags attribute containing a list of tag names.
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/97880b18-2ed0-4c55-a2fa-611e613d40f2/4/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_tags | To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the
request, there should be a tags attribute containing a list of tag names.
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/73b56237-86fc-4e16-95e5-e6e3e2877601/0/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_add_tags | To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the request,
there should be a tags attribute containing a list of tag names.
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/73b56237-86fc-4e16-95e5-e6e3e2877601/1/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_add_tags | To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the request,
there should be a tags attribute containing a list of tag names.
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/73b56237-86fc-4e16-95e5-e6e3e2877601/3/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_add_tags | To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the request,
there should be a tags attribute containing a list of tag names.
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/73b56237-86fc-4e16-95e5-e6e3e2877601/4/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_add_tags | To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the request,
there should be a tags attribute containing a list of tag names.
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. | 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/73b56237-86fc-4e16-95e5-e6e3e2877601/5/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_add_tags | To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags. In the body of the request,
there should be a tags attribute containing a list of tag names.
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/c1b43411-1c07-4986-a91f-13f1265b8f5f/0/0 | Digital Ocean | Digital Ocean Public API | null | droplets_get_DestroyAssociatedResourcesStatus | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint. | 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/c1b43411-1c07-4986-a91f-13f1265b8f5f/1/0 | Digital Ocean | Digital Ocean Public API | null | droplets_get_DestroyAssociatedResourcesStatus | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint. | 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/c1b43411-1c07-4986-a91f-13f1265b8f5f/2/0 | Digital Ocean | Digital Ocean Public API | null | droplets_get_DestroyAssociatedResourcesStatus | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint. | 200 | null | {"droplet": {"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}, "resources": {"reserved_ips": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}], "floating_ips": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}], "snapshots": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}], "volumes": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}], "volume_snapshots": [{"id": "61486916", "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", "destroyed_at": "2020-04-01T18:11:49Z", "error_message": " "}]}, "completed_at": "2020-04-01T18:11:49Z", "failures": 0} | {"type": "object", "description": "An objects containing information about a resources scheduled for deletion.", "properties": {"droplet": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}, "resources": {"type": "object", "description": "An object containing additional information about resource related to a Droplet requested to be destroyed.", "properties": {"reserved_ips": {"type": "array", "items": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}}, "floating_ips": {"type": "array", "items": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}}, "snapshots": {"type": "array", "items": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}}, "volumes": {"type": "array", "items": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}}, "volume_snapshots": {"type": "array", "items": {"type": "object", "description": "An object containing information about a resource scheduled for deletion.", "properties": {"id": {"type": "string", "description": "The unique identifier for the resource scheduled for deletion."}, "name": {"type": "string", "description": "The name of the resource scheduled for deletion."}, "destroyed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the resource was destroyed if the request was successful."}, "error_message": {"type": "string", "description": "A string indicating that the resource was not successfully destroyed and providing additional information."}}}}}}, "completed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format indicating when the requested action was completed."}, "failures": {"type": "integer", "description": "A count of the associated resources that failed to be destroyed, if any."}}} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/c1b43411-1c07-4986-a91f-13f1265b8f5f/3/0 | Digital Ocean | Digital Ocean Public API | null | droplets_get_DestroyAssociatedResourcesStatus | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint. | 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/c1b43411-1c07-4986-a91f-13f1265b8f5f/4/0 | Digital Ocean | Digital Ocean Public API | null | droplets_get_DestroyAssociatedResourcesStatus | To check on the status of a request to destroy a Droplet with its associated
resources, send a GET request to the
/v2/droplets/$DROPLET_ID/destroy_with_associated_resources/status endpoint. | 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/1dfa8ba1-b940-447b-bb97-b43c61c3dea4/0/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_droplets | To remove a Droplet from a firewall, send a DELETE request to
/v2/firewalls/$FIREWALL_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/1dfa8ba1-b940-447b-bb97-b43c61c3dea4/1/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_droplets | To remove a Droplet from a firewall, send a DELETE request to
/v2/firewalls/$FIREWALL_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/1dfa8ba1-b940-447b-bb97-b43c61c3dea4/2/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_droplets | To remove a Droplet from a firewall, send a DELETE request to
/v2/firewalls/$FIREWALL_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/1dfa8ba1-b940-447b-bb97-b43c61c3dea4/3/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_droplets | To remove a Droplet from a firewall, send a DELETE request to
/v2/firewalls/$FIREWALL_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/1dfa8ba1-b940-447b-bb97-b43c61c3dea4/4/0 | Digital Ocean | Digital Ocean Public API | null | firewalls_delete_droplets | To remove a Droplet from a firewall, send a DELETE request to
/v2/firewalls/$FIREWALL_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. | 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/199f9e2d-b5d9-488c-af91-04dd6e709f50/0/0 | Digital Ocean | Digital Ocean Public API | null | droplets_destroy_byTag | To delete all Droplets assigned to a specific tag, include the tag_name
query parameter set to the name of the tag in your DELETE request. For
example, /v2/droplets?tag_name=$TAG_NAME.
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/199f9e2d-b5d9-488c-af91-04dd6e709f50/1/0 | Digital Ocean | Digital Ocean Public API | null | droplets_destroy_byTag | To delete all Droplets assigned to a specific tag, include the tag_name
query parameter set to the name of the tag in your DELETE request. For
example, /v2/droplets?tag_name=$TAG_NAME.
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/199f9e2d-b5d9-488c-af91-04dd6e709f50/3/0 | Digital Ocean | Digital Ocean Public API | null | droplets_destroy_byTag | To delete all Droplets assigned to a specific tag, include the tag_name
query parameter set to the name of the tag in your DELETE request. For
example, /v2/droplets?tag_name=$TAG_NAME.
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/199f9e2d-b5d9-488c-af91-04dd6e709f50/4/0 | Digital Ocean | Digital Ocean Public API | null | droplets_destroy_byTag | To delete all Droplets assigned to a specific tag, include the tag_name
query parameter set to the name of the tag in your DELETE request. For
example, /v2/droplets?tag_name=$TAG_NAME.
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/dd9a0d17-9492-4677-a067-62104b746526/0/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_neighbors | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account. | 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/dd9a0d17-9492-4677-a067-62104b746526/1/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_neighbors | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account. | 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/dd9a0d17-9492-4677-a067-62104b746526/2/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_neighbors | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account. | 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/dd9a0d17-9492-4677-a067-62104b746526/3/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_neighbors | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account. | 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/dd9a0d17-9492-4677-a067-62104b746526/4/0 | Digital Ocean | Digital Ocean Public API | null | droplets_list_neighbors | To retrieve a list of any "neighbors" (i.e. Droplets that are co-located on
the same physical hardware) for a specific Droplet, send a GET request to
/v2/droplets/$DROPLET_ID/neighbors.
The results will be returned as a JSON object with a key of droplets. This
will be set to an array containing objects representing any other Droplets
that share the same physical hardware. An empty array indicates that the
Droplet is not co-located any other Droplets associated with your account. | 200 | null | {"droplets": [{"id": 3164444, "name": "example.com", "memory": 1024, "vcpus": 1, "disk": 25, "locked": true, "status": "new", "kernel": {}, "created_at": "2020-07-21T18:37:44Z", "features": [], "backup_ids": [], "next_backup_window": {}, "snapshot_ids": [], "image": {}, "volume_ids": [], "size": {}, "size_slug": "s-1vcpu-1gb", "networks": {}, "region": {}, "tags": [], "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"}]} | {"allOf": [{"type": "object", "properties": {"droplets": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation."}, "name": {"type": "string", "description": "The human-readable name set for the Droplet instance."}, "memory": {"type": "integer", "multipleOf": 8, "description": "Memory of the Droplet in megabytes."}, "vcpus": {"type": "integer", "description": "The number of virtual CPUs."}, "disk": {"type": "integer", "description": "The size of the Droplet's disk in gigabytes."}, "locked": {"type": "boolean", "description": "A boolean value indicating whether the Droplet has been locked, preventing actions by users."}, "status": {"type": "string", "enum": ["new", "active", "off", "archive"], "description": "A status string indicating the state of the Droplet instance. This may be \"new\", \"active\", \"off\", or \"archive\"."}, "kernel": {"type": ["object", "null"], "description": "**Note**: All Droplets created after March 2017 use internal kernels by default.\nThese Droplets will have this attribute set to `null`.\n\nThe current [kernel](https://www.digitalocean.com/docs/droplets/how-to/kernel/)\nfor Droplets with externally managed kernels. This will initially be set to\nthe kernel of the base image when the Droplet is created.\n", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "version": {"description": "**Omitted**"}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Droplet was created."}, "features": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of features enabled on this Droplet."}, "backup_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation."}, "next_backup_window": {"type": ["object", "null"], "description": "The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.", "properties": {"start": {"description": "**Omitted**"}, "end": {"description": "**Omitted**"}}}, "snapshot_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of snapshot IDs of any snapshots created from the Droplet instance."}, "image": {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "type": {"description": "**Omitted**"}, "distribution": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "public": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "created_at": {"description": "**Omitted**"}, "min_disk_size": {"description": "**Omitted**"}, "size_gigabytes": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}, "error_message": {"description": "**Omitted**"}}}, "volume_ids": {"type": "array", "items": {"description": "**Omitted**"}, "description": "A flat array including the unique identifier for each Block Storage volume attached to the Droplet."}, "size": {"type": "object", "properties": {"slug": {"description": "**Omitted**"}, "memory": {"description": "**Omitted**"}, "vcpus": {"description": "**Omitted**"}, "disk": {"description": "**Omitted**"}, "transfer": {"description": "**Omitted**"}, "price_monthly": {"description": "**Omitted**"}, "price_hourly": {"description": "**Omitted**"}, "regions": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "description": {"description": "**Omitted**"}}, "required": ["available", "disk", "memory", "price_hourly", "price_monthly", "regions", "slug", "transfer", "vcpus", "description"]}, "size_slug": {"type": "string", "description": "The unique slug identifier for the size of this Droplet."}, "networks": {"type": "object", "description": "The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.", "properties": {"v4": {"description": "**Omitted**"}, "v6": {"description": "**Omitted**"}}}, "region": {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}, "tags": {"type": "array", "items": {"description": "**Omitted**"}, "description": "An array of Tags the Droplet has been tagged with."}, "vpc_uuid": {"type": "string", "description": "A string specifying the UUID of the VPC to which the Droplet is assigned."}}, "required": ["id", "name", "memory", "vcpus", "disk", "locked", "status", "created_at", "features", "backup_ids", "next_backup_window", "snapshot_ids", "image", "volume_ids", "size", "size_slug", "networks", "region", "tags"]}}}}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e3e2b239-927e-4e6c-8867-fedbed52970d/0/0 | Digital Ocean | Digital Ocean Public API | null | sshKeys_create | To add a new SSH public key to your DigitalOcean account, send a POST request to /v2/account/keys. Set the name attribute to the name you wish to use and the public_key attribute to the full public key you are adding. | 201 | null | {"ssh_key": {"id": 512189, "fingerprint": "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa", "public_key": "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example", "name": "My SSH Public Key"}} | {"properties": {"ssh_key": {"type": "object", "properties": {"id": {"type": "integer", "description": "A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet."}, "fingerprint": {"type": "string", "description": "A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account."}, "public_key": {"description": "The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation.", "type": "string"}, "name": {"type": "string", "description": "A human-readable display name for this key, used to easily identify the SSH keys when they are displayed."}}, "required": ["public_key", "name"]}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.