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/e3e2b239-927e-4e6c-8867-fedbed52970d/1/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.
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/e3e2b239-927e-4e6c-8867-fedbed52970d/2/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.
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/e3e2b239-927e-4e6c-8867-fedbed52970d/3/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.
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/9f8db004-a3d8-4c91-b546-bcad95a7176b/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9f8db004-a3d8-4c91-b546-bcad95a7176b/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9f8db004-a3d8-4c91-b546-bcad95a7176b/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/9f8db004-a3d8-4c91-b546-bcad95a7176b/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
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/9f8db004-a3d8-4c91-b546-bcad95a7176b/5/0
Digital Ocean
Digital Ocean Public API
null
firewalls_add_rules
To add additional access rules to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7909be49-cb4a-41be-8bdd-ed6ab2aa4fa5/0/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key attributes.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/7909be49-cb4a-41be-8bdd-ed6ab2aa4fa5/1/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key attributes.
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/7909be49-cb4a-41be-8bdd-ed6ab2aa4fa5/2/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key 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/7909be49-cb4a-41be-8bdd-ed6ab2aa4fa5/3/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key attributes.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/7909be49-cb4a-41be-8bdd-ed6ab2aa4fa5/4/0
Digital Ocean
Digital Ocean Public API
null
sshKeys_get
To get information about a key, send a GET request to /v2/account/keys/$KEY_ID or /v2/account/keys/$KEY_FINGERPRINT. The response will be a JSON object with the key ssh_key and value an ssh_key object which contains the standard ssh_key attributes.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/0/0
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/1/0
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/2/0
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/2/1
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/3/0
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/c6ee9001-95d6-45ae-8d31-1eb2a5c82cb6/4/0
Digital Ocean
Digital Ocean Public API
null
cdn_get_endpoint
To show information about an existing CDN endpoint, send a GET 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/0c6d7f64-2036-4e0d-945d-11851e4687ad/0/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute. To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute. Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0c6d7f64-2036-4e0d-945d-11851e4687ad/1/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute. To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute. Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.
202
Assigning to Droplet
{"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": true, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}, "links": {"droplets": [{"id": 213939433, "rel": "droplet", "href": "https://api.digitalocean.com/v2/droplets/213939433"}], "actions": [{"id": 1088924622, "rel": "assign_ip", "href": "https://api.digitalocean.com/v2/actions/1088924622"}]}}
{"type": "object", "properties": {"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."}}}, "links": {"type": "object", "properties": {"droplets": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}, "actions": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0c6d7f64-2036-4e0d-945d-11851e4687ad/1/1
Digital Ocean
Digital Ocean Public API
null
floatingIPs_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute. To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute. Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.
202
Reserving 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"}, "links": {}}
{"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."}}}, "links": {"type": "object", "properties": {"droplets": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}, "actions": {"type": "array", "items": {"type": "object", "description": "The linked actions can be used to check the status of a Droplet's create event.", "properties": {"id": {"type": "integer", "description": "A unique numeric ID that can be used to identify and reference an action."}, "rel": {"type": "string", "description": "A string specifying the type of the related action."}, "href": {"type": "string", "format": "uri", "description": "A URL that can be used to access the action."}}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0c6d7f64-2036-4e0d-945d-11851e4687ad/2/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute. To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute. Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/0c6d7f64-2036-4e0d-945d-11851e4687ad/3/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_create
On creation, a floating IP must be either assigned to a Droplet or reserved to a region. * To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute. To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute. Note: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d775fe1d-c31d-43cd-b067-3c8ed4ee4b23/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_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/d775fe1d-c31d-43cd-b067-3c8ed4ee4b23/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_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/d775fe1d-c31d-43cd-b067-3c8ed4ee4b23/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_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/d775fe1d-c31d-43cd-b067-3c8ed4ee4b23/3/0
Digital Ocean
Digital Ocean Public API
null
droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_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/d775fe1d-c31d-43cd-b067-3c8ed4ee4b23/4/0
Digital Ocean
Digital Ocean Public API
null
droplets_get
To show information about an individual Droplet, send a GET request to /v2/droplets/$DROPLET_ID.
200
null
{"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", "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", "type": "snapshot", "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": ["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"]}, "tags": ["web", "env:prod"], "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"}}
{"properties": {"droplet": {"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/bd43929e-5351-4f82-ae04-0e5dfb6d39b2/0/0
Digital Ocean
Digital Ocean Public API
null
volumeActions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/bd43929e-5351-4f82-ae04-0e5dfb6d39b2/1/0
Digital Ocean
Digital Ocean Public API
null
volumeActions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/bd43929e-5351-4f82-ae04-0e5dfb6d39b2/2/0
Digital Ocean
Digital Ocean Public API
null
volumeActions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/bd43929e-5351-4f82-ae04-0e5dfb6d39b2/3/0
Digital Ocean
Digital Ocean Public API
null
volumeActions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
200
null
{"actions": [{"id": 72531856, "status": "completed", "type": "attach_volume", "started_at": "2020-11-21T21:51:09Z", "completed_at": "2020-11-21T21:51:09Z", "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"}], "links": {}, "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"actions": {"type": "array", "items": {"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"]}]}}}]}}}}, {"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/bd43929e-5351-4f82-ae04-0e5dfb6d39b2/4/0
Digital Ocean
Digital Ocean Public API
null
volumeActions_list
To retrieve all actions that have been executed on a volume, send a GET request to /v2/volumes/$VOLUME_ID/actions.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/2633ffdb-f58e-440c-bdcf-03ca60467b1d/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall 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/2633ffdb-f58e-440c-bdcf-03ca60467b1d/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall 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/2633ffdb-f58e-440c-bdcf-03ca60467b1d/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall 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/2633ffdb-f58e-440c-bdcf-03ca60467b1d/3/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall 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/2633ffdb-f58e-440c-bdcf-03ca60467b1d/4/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_firewalls
To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall attributes.
200
null
{"firewalls": [{"inbound_rules": [], "outbound_rules": []}], "links": {"pages": {"last": "https://api.digitalocean.com/v2/images?page=2", "next": "https://api.digitalocean.com/v2/images?page=2", "first": "https://api.digitalocean.com/v2/images?page=1", "prev": "https://api.digitalocean.com/v2/images?page=1"}}, "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"firewalls": {"type": "array", "items": {"type": "object", "allOf": [{"properties": {"id": {"type": "string", "description": "A unique ID that can be used to identify and reference a firewall."}, "status": {"type": "string", "description": "A status string indicating the current state of the firewall. This can be \"waiting\", \"succeeded\", or \"failed\".", "enum": ["waiting", "succeeded", "failed"]}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall was created."}, "pending_changes": {"type": "array", "description": "An array of objects each containing the fields \"droplet_id\", \"removing\", and \"status\". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.", "items": {"type": "object", "properties": {"droplet_id": {"description": "**Omitted**"}, "removing": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}}}}, "name": {"type": "string", "description": "A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\.-]+$"}, "droplet_ids": {"type": ["array", "null"], "description": "An array containing the IDs of the Droplets assigned to the firewall.", "items": {"type": "integer"}}, "tags": {"allOf": [{"type": ["array", "null"], "items": {"description": "**Omitted**"}, "description": "A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags."}, {"description": "An array containing the names of the Tags assigned to the firewall."}]}}}, {"type": "object", "properties": {"inbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}, "outbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"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/2b67692f-2c9b-4765-b6ce-46fd7264e9f7/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy_retryWithAssociatedResources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content.
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/2b67692f-2c9b-4765-b6ce-46fd7264e9f7/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy_retryWithAssociatedResources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content.
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/2b67692f-2c9b-4765-b6ce-46fd7264e9f7/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy_retryWithAssociatedResources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content.
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/2b67692f-2c9b-4765-b6ce-46fd7264e9f7/3/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy_retryWithAssociatedResources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content.
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/2b67692f-2c9b-4765-b6ce-46fd7264e9f7/5/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy_retryWithAssociatedResources
If the status of a request to destroy a Droplet with its associated resources reported any errors, it can be retried by sending a POST request to the /v2/droplets/$DROPLET_ID/destroy_with_associated_resources/retry endpoint. Only one destroy can be active at a time per Droplet. If a retry is issued while another destroy is in progress for the Droplet a 409 status code will be returned. A successful response will include a 202 response code and no content.
409
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID 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/6cc5eb67-85e5-48e2-9236-69f8bd450713/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST 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/6cc5eb67-85e5-48e2-9236-69f8bd450713/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST 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/6cc5eb67-85e5-48e2-9236-69f8bd450713/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST 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/6cc5eb67-85e5-48e2-9236-69f8bd450713/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST 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/6cc5eb67-85e5-48e2-9236-69f8bd450713/5/0
Digital Ocean
Digital Ocean Public API
null
firewalls_assign_droplets
To assign a Droplet to a firewall, send a POST 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/08120c83-9ba6-49f1-941f-a8611aead867/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed. 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/08120c83-9ba6-49f1-941f-a8611aead867/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed. 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/08120c83-9ba6-49f1-941f-a8611aead867/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed. 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/08120c83-9ba6-49f1-941f-a8611aead867/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed. 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/08120c83-9ba6-49f1-941f-a8611aead867/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/rules. The body of the request may include an inbound_rules and/or outbound_rules attribute containing an array of rules to be removed. 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/510c8f23-d121-4a43-a54b-19e41e0c2908/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots. You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot 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/510c8f23-d121-4a43-a54b-19e41e0c2908/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots. You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot 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/510c8f23-d121-4a43-a54b-19e41e0c2908/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots. You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot 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/510c8f23-d121-4a43-a54b-19e41e0c2908/3/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots. You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot attributes.
200
null
{"snapshots": [{"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": {"snapshots": {"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/510c8f23-d121-4a43-a54b-19e41e0c2908/4/0
Digital Ocean
Digital Ocean Public API
null
droplets_list_snapshots
To retrieve the snapshots that have been created from a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/snapshots. You will get back a JSON object that has a snapshots key. This will be set to an array of snapshot objects, each of which contain the standard Droplet snapshot 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/d6c43fd5-2e19-431d-bb49-a9f9e578ddfe/0/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy
To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d6c43fd5-2e19-431d-bb49-a9f9e578ddfe/1/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy
To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d6c43fd5-2e19-431d-bb49-a9f9e578ddfe/2/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy
To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d6c43fd5-2e19-431d-bb49-a9f9e578ddfe/4/0
Digital Ocean
Digital Ocean Public API
null
droplets_destroy
To delete a Droplet, send a DELETE request to /v2/droplets/$DROPLET_ID. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/f934062f-0c66-4b3c-98be-3ce6733d6525/1/0
Digital Ocean
Digital Ocean Public API
null
cdn_purge_cache
To purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID/cache. The body of the request should include a files attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (*) to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged.
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/f934062f-0c66-4b3c-98be-3ce6733d6525/2/0
Digital Ocean
Digital Ocean Public API
null
cdn_purge_cache
To purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID/cache. The body of the request should include a files attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (*) to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged.
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/f934062f-0c66-4b3c-98be-3ce6733d6525/3/0
Digital Ocean
Digital Ocean Public API
null
cdn_purge_cache
To purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID/cache. The body of the request should include a files attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (*) to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged.
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/f934062f-0c66-4b3c-98be-3ce6733d6525/4/0
Digital Ocean
Digital Ocean Public API
null
cdn_purge_cache
To purge cached content from a CDN endpoint, send a DELETE request to /v2/cdn/endpoints/$ENDPOINT_ID/cache. The body of the request should include a files attribute containing a list of cached file paths to be purged. A path may be for a single file or may contain a wildcard (*) to recursively purge all files under a directory. When only a wildcard is provided, all cached files will be purged.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
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/b72379f1-0ec7-4fb7-9983-501023ae37d3/5/0
Digital Ocean
Digital Ocean Public API
null
firewalls_update
To update the configuration of an existing firewall, send a PUT request to /v2/firewalls/$FIREWALL_ID. The request should contain a full representation of the firewall including existing attributes. Note that any attributes that are not provided will be reset to their default values.
200
null
{"firewall": {"inbound_rules": [], "outbound_rules": []}}
{"properties": {"firewall": {"type": "object", "allOf": [{"properties": {"id": {"type": "string", "description": "A unique ID that can be used to identify and reference a firewall."}, "status": {"type": "string", "description": "A status string indicating the current state of the firewall. This can be \"waiting\", \"succeeded\", or \"failed\".", "enum": ["waiting", "succeeded", "failed"]}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall was created."}, "pending_changes": {"type": "array", "description": "An array of objects each containing the fields \"droplet_id\", \"removing\", and \"status\". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.", "items": {"type": "object", "properties": {"droplet_id": {"description": "**Omitted**"}, "removing": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}}}}, "name": {"type": "string", "description": "A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\.-]+$"}, "droplet_ids": {"type": ["array", "null"], "description": "An array containing the IDs of the Droplets assigned to the firewall.", "items": {"type": "integer"}}, "tags": {"allOf": [{"type": ["array", "null"], "items": {"description": "**Omitted**"}, "description": "A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags."}, {"description": "An array containing the names of the Tags assigned to the firewall."}]}}}, {"type": "object", "properties": {"inbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}, "outbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e02fc5e1-1f34-4ace-9a00-a7c2c9196fdc/0/0
Digital Ocean
Digital Ocean Public API
null
firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_ID.
200
null
{"firewall": {"inbound_rules": [], "outbound_rules": []}}
{"properties": {"firewall": {"type": "object", "allOf": [{"properties": {"id": {"type": "string", "description": "A unique ID that can be used to identify and reference a firewall."}, "status": {"type": "string", "description": "A status string indicating the current state of the firewall. This can be \"waiting\", \"succeeded\", or \"failed\".", "enum": ["waiting", "succeeded", "failed"]}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall was created."}, "pending_changes": {"type": "array", "description": "An array of objects each containing the fields \"droplet_id\", \"removing\", and \"status\". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.", "items": {"type": "object", "properties": {"droplet_id": {"description": "**Omitted**"}, "removing": {"description": "**Omitted**"}, "status": {"description": "**Omitted**"}}}}, "name": {"type": "string", "description": "A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\.-]+$"}, "droplet_ids": {"type": ["array", "null"], "description": "An array containing the IDs of the Droplets assigned to the firewall.", "items": {"type": "integer"}}, "tags": {"allOf": [{"type": ["array", "null"], "items": {"description": "**Omitted**"}, "description": "A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags."}, {"description": "An array containing the names of the Tags assigned to the firewall."}]}}}, {"type": "object", "properties": {"inbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}, "outbound_rules": {"type": ["array", "null"], "items": {"allOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e02fc5e1-1f34-4ace-9a00-a7c2c9196fdc/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_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/e02fc5e1-1f34-4ace-9a00-a7c2c9196fdc/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_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/e02fc5e1-1f34-4ace-9a00-a7c2c9196fdc/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_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/e02fc5e1-1f34-4ace-9a00-a7c2c9196fdc/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_get
To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_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/6d5a56df-ad34-4704-82bb-14d4922a79c1/0/0
Digital Ocean
Digital Ocean Public API
null
oneClicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet. The response will be a JSON object with a key called 1_clicks. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click.
200
null
{"1_clicks": [{"slug": "monitoring", "type": "kubernetes"}, {"slug": "wordpress-18-04", "type": "droplet"}]}
{"properties": {"1_clicks": {"type": "array", "items": {"type": "object", "properties": {"slug": {"title": "slug", "type": "string", "description": "The slug identifier for the 1-Click application."}, "type": {"title": "type", "type": "string", "description": "The type of the 1-Click application."}}, "required": ["slug", "type"]}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/6d5a56df-ad34-4704-82bb-14d4922a79c1/1/0
Digital Ocean
Digital Ocean Public API
null
oneClicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet. The response will be a JSON object with a key called 1_clicks. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click.
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/6d5a56df-ad34-4704-82bb-14d4922a79c1/2/0
Digital Ocean
Digital Ocean Public API
null
oneClicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet. The response will be a JSON object with a key called 1_clicks. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click.
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/6d5a56df-ad34-4704-82bb-14d4922a79c1/3/0
Digital Ocean
Digital Ocean Public API
null
oneClicks_list
To list all available 1-Click applications, send a GET request to /v2/1-clicks. The type may be provided as query paramater in order to restrict results to a certain type of 1-Click, for example: /v2/1-clicks?type=droplet. Current supported types are kubernetes and droplet. The response will be a JSON object with a key called 1_clicks. This will be set to an array of 1-Click application data, each of which will contain the the slug and type for the 1-Click.
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/515a243d-f965-44f5-b70a-878f54000c8c/1/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete
To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/515a243d-f965-44f5-b70a-878f54000c8c/2/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete
To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/515a243d-f965-44f5-b70a-878f54000c8c/3/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete
To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/515a243d-f965-44f5-b70a-878f54000c8c/4/0
Digital Ocean
Digital Ocean Public API
null
firewalls_delete
To delete a firewall send a DELETE request to /v2/firewalls/$FIREWALL_ID. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b5e29db4-da84-4b78-a500-276f08a685ce/0/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_list
To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.
200
null
{"load_balancers": [{"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6", "name": "example-lb-01", "ip": "104.131.186.241", "size": "lb-small", "algorithm": "round_robin", "status": "new", "created_at": "2017-02-01T22:22:58Z", "forwarding_rules": [{"entry_protocol": "http", "entry_port": 80, "target_protocol": "http", "target_port": 80, "certificate_id": "", "tls_passthrough": false}, {"entry_protocol": "https", "entry_port": 443, "target_protocol": "https", "target_port": 443, "certificate_id": "", "tls_passthrough": true}], "health_check": {"protocol": "http", "port": 80, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "none"}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "", "droplet_ids": [3164444, 3164445], "redirect_http_to_https": false, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "disable_lets_encrypt_dns_records": false, "firewall": {"deny": ["cidr:1.2.0.0/16", "ip:2.3.4.5"], "allow": ["ip:1.2.3.4", "cidr:2.3.4.0/24"]}}, {"id": "56775c3f-04ab-4fb3-a7ed-40ef9bc8eece", "name": "prod-web-lb-01", "ip": "45.55.125.24", "size": "lb-small", "algorithm": "round_robin", "status": "active", "created_at": "2020-09-08T18:58:04Z", "forwarding_rules": [{"entry_protocol": "https", "entry_port": 443, "target_protocol": "http", "target_port": 8080, "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf", "tls_passthrough": false}], "health_check": {"protocol": "https", "port": 443, "path": "/", "check_interval_seconds": 10, "response_timeout_seconds": 5, "healthy_threshold": 5, "unhealthy_threshold": 3}, "sticky_sessions": {"type": "cookies", "cookie_name": "DO-LB", "cookie_ttl_seconds": 300}, "region": {"name": "New York 3", "slug": "nyc3", "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192gb"], "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent"], "available": true}, "tag": "prod:web", "droplet_ids": [55806512, 55806515, 55806524], "redirect_http_to_https": true, "enable_proxy_protocol": false, "enable_backend_keepalive": false, "vpc_uuid": "587d698c-de84-11e8-80bc-3cfdfea9fcd1", "disable_lets_encrypt_dns_records": false, "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "http_idle_timeout_seconds": 60, "firewall": {"deny": ["cidr:1.2.0.0/16", "ip:2.3.4.5"], "allow": ["ip:1.2.3.4", "cidr:2.3.4.0/24"]}}], "links": {}, "meta": {"total": 2}}
{"allOf": [{"type": "object", "properties": {"load_balancers": {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a load balancer."}, "name": {"type": "string", "description": "A human-readable name for a load balancer instance."}, "project_id": {"type": "string", "description": "The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created."}, "ip": {"type": "string", "pattern": "^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "description": "An attribute containing the public-facing IP address of the load balancer."}, "size_unit": {"type": "integer", "default": 1, "minimum": 1, "maximum": 100, "description": "How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions."}, "size": {"type": "string", "enum": ["lb-small", "lb-medium", "lb-large"], "default": "lb-small", "description": "This field has been replaced by the `size_unit` field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.\n* `lb-small` = 1 node\n* `lb-medium` = 3 nodes\n* `lb-large` = 6 nodes\n\nYou can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation."}, "algorithm": {"type": "string", "enum": ["round_robin", "least_connections"], "default": "round_robin", "description": "This field has been deprecated. You can no longer specify an algorithm for load balancers."}, "status": {"type": "string", "enum": ["new", "active", "errored"], "description": "A status string indicating the current state of the load balancer. This can be `new`, `active`, or `errored`."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the load balancer was created."}, "forwarding_rules": {"type": "array", "minItems": 1, "items": {"type": "object", "description": "An object specifying a forwarding rule for a load balancer.", "properties": {"entry_protocol": {"description": "**Omitted**"}, "entry_port": {"description": "**Omitted**"}, "target_protocol": {"description": "**Omitted**"}, "target_port": {"description": "**Omitted**"}, "certificate_id": {"description": "**Omitted**"}, "tls_passthrough": {"description": "**Omitted**"}}, "required": ["entry_protocol", "entry_port", "target_protocol", "target_port"]}, "description": "An array of objects specifying the forwarding rules for a load balancer."}, "health_check": {"type": "object", "description": "An object specifying health check settings for the load balancer.", "properties": {"protocol": {"type": "string", "enum": ["http", "https", "tcp"], "default": "http", "description": "The protocol used for health checks sent to the backend Droplets. The possible values are `http`, `https`, or `tcp`."}, "port": {"type": "integer", "default": 80, "description": "An integer representing the port on the backend Droplets on which the health check will attempt a connection."}, "path": {"type": "string", "default": "/", "description": "The path on the backend Droplets to which the load balancer instance will send a request."}, "check_interval_seconds": {"type": "integer", "default": 10, "description": "The number of seconds between between two consecutive health checks."}, "response_timeout_seconds": {"type": "integer", "default": 5, "description": "The number of seconds the load balancer instance will wait for a response until marking a health check as failed."}, "unhealthy_threshold": {"type": "integer", "default": 5, "description": "The number of times a health check must fail for a backend Droplet to be marked \"unhealthy\" and be removed from the pool."}, "healthy_threshold": {"type": "integer", "default": 3, "description": "The number of times a health check must pass for a backend Droplet to be marked \"healthy\" and be re-added to the pool."}}}, "sticky_sessions": {"type": "object", "description": "An object specifying sticky sessions settings for the load balancer.", "properties": {"type": {"type": "string", "enum": ["cookies", "none"], "default": "none", "description": "An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are `cookies` or `none`."}, "cookie_name": {"type": "string", "description": "The name of the cookie sent to the client. This attribute is only returned when using `cookies` for the sticky sessions type."}, "cookie_ttl_seconds": {"type": "integer", "description": "The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using `cookies` for the sticky sessions type."}}}, "redirect_http_to_https": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443."}, "enable_proxy_protocol": {"type": "boolean", "default": false, "description": "A boolean value indicating whether PROXY Protocol is in use."}, "enable_backend_keepalive": {"type": "boolean", "default": false, "description": "A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets."}, "http_idle_timeout_seconds": {"type": "integer", "default": 60, "minimum": 30, "maximum": 600, "description": "An integer value which configures the idle timeout for HTTP requests to the target droplets."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the load balancer is assigned."}, "disable_lets_encrypt_dns_records": {"type": "boolean", "default": false, "description": "A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer."}, "firewall": {"type": "object", "description": "An object specifying allow and deny rules to control traffic to the load balancer.", "properties": {"deny": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}, "allow": {"type": "array", "items": {"description": "**Omitted**"}, "default": [], "description": "the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')"}}}}, "required": ["forwarding_rules"]}, {"type": "object", "properties": {"region": {"type": "object", "allOf": [{"description": "The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned."}, {"type": "object", "properties": {"name": {"description": "**Omitted**"}, "slug": {"description": "**Omitted**"}, "features": {"description": "**Omitted**"}, "available": {"description": "**Omitted**"}, "sizes": {"description": "**Omitted**"}}, "required": ["available", "features", "name", "sizes", "slug"]}]}}}, {"type": "object", "properties": {"droplet_ids": {"type": "array", "items": {"type": "integer"}, "description": "An array containing the IDs of the Droplets assigned to the load balancer."}}}, {"type": "object", "properties": {"tag": {"type": "string", "description": "The name of a Droplet tag corresponding to Droplets assigned to the load balancer."}}}]}}}}, {"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/b5e29db4-da84-4b78-a500-276f08a685ce/1/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_list
To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.
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/b5e29db4-da84-4b78-a500-276f08a685ce/2/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_list
To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.
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/b5e29db4-da84-4b78-a500-276f08a685ce/3/0
Digital Ocean
Digital Ocean Public API
null
loadBalancers_list
To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.
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/e12eb8b2-84b4-43a5-8eaa-ef95344412c0/0/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_list
To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e12eb8b2-84b4-43a5-8eaa-ef95344412c0/1/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_list
To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e12eb8b2-84b4-43a5-8eaa-ef95344412c0/2/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_list
To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/e12eb8b2-84b4-43a5-8eaa-ef95344412c0/3/0
Digital Ocean
Digital Ocean Public API
null
floatingIPs_list
To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.
200
null
{"floating_ips": [{"ip": "45.55.96.47", "droplet": null, "region": {"name": "New York 3", "slug": "nyc3", "features": ["private_networking", "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer"], "available": true, "sizes": ["s-1vcpu-1gb", "s-1vcpu-2gb", "s-1vcpu-3gb", "s-2vcpu-2gb", "s-3vcpu-1gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-6vcpu-16gb", "s-8vcpu-32gb", "s-12vcpu-48gb", "s-16vcpu-64gb", "s-20vcpu-96gb", "s-24vcpu-128gb", "s-32vcpu-192g"]}, "locked": false, "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"}], "links": {}, "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"floating_ips": {"type": "array", "items": {"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."}}}}}}, {"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/52cba14f-7103-4ae6-96a1-893764c84fec/0/0
Digital Ocean
Digital Ocean Public API
null
vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/52cba14f-7103-4ae6-96a1-893764c84fec/1/0
Digital Ocean
Digital Ocean Public API
null
vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/52cba14f-7103-4ae6-96a1-893764c84fec/2/0
Digital Ocean
Digital Ocean Public API
null
vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/52cba14f-7103-4ae6-96a1-893764c84fec/3/0
Digital Ocean
Digital Ocean Public API
null
vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
200
null
{"vpc": {"name": "env.prod-vpc", "description": "VPC for production environment", "region": "nyc1", "ip_range": "10.10.10.0/24", "default": true, "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "urn": "do:droplet:13457723", "created_at": "2020-03-13T19:20:47.442049222Z"}}
{"type": "object", "properties": {"vpc": {"type": "object", "allOf": [{"type": "object", "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+$", "description": "The name of the VPC. Must be unique and may only contain alphanumeric characters, dashes, and periods."}, "description": {"type": "string", "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."}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/52cba14f-7103-4ae6-96a1-893764c84fec/4/0
Digital Ocean
Digital Ocean Public API
null
vpcs_patch
To update a subset of information about a VPC, send a PATCH request to /v2/vpcs/$VPC_ID.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/37f01699-0bf2-46b0-b8f3-9b4162bcc1ca/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_regions
List all regions supported by App Platform.
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"]}