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/4448e0da-a714-4bfe-bd50-7709c23a3ecb/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_nodePool
To update the name of a node pool, edit the tags applied to it, or adjust its number of nodes, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID with the following attributes.
202
null
{"node_pool": {"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "renamed-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["production", "web-team", "front-end", "new-tag", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": true, "min_nodes": 3, "max_nodes": 6, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "adoring-newton-3niq", "status": {"state": "running"}, "droplet_id": "205545370", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "adoring-newton-3nim", "status": {"state": "running"}, "droplet_id": "205545371", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "adoring-newton-3ni7", "status": {"state": "running"}, "droplet_id": "205545372", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}}
{"properties": {"node_pool": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1702fc21-e84a-4fcb-ad34-2c12d54c34d4/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See here for details.
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/1702fc21-e84a-4fcb-ad34-2c12d54c34d4/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See here for details.
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/1702fc21-e84a-4fcb-ad34-2c12d54c34d4/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See here for details.
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/1702fc21-e84a-4fcb-ad34-2c12d54c34d4/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See here for details.
201
null
{"kubernetes_cluster": {"id": "bd5f5959-5e1e-4205-a714-a914373942af", "name": "prod-cluster-01", "region": "nyc1", "version": "1.18.6-do.0", "cluster_subnet": "10.244.0.0/16", "service_subnet": "10.245.0.0/16", "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "ipv4": "", "endpoint": "", "tags": ["k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af"], "node_pools": [{"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "worker-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": false, "min_nodes": 0, "max_nodes": 0, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}], "maintenance_policy": {"start_time": "00:00", "duration": "4h0m0s", "day": "any"}, "auto_upgrade": false, "status": {"state": "provisioning", "message": "provisioning"}, "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z", "surge_upgrade": false, "registry_enabled": false, "ha": false}}
{"properties": {"kubernetes_cluster": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a Kubernetes cluster."}, "name": {"type": "string", "description": "A human-readable name for a Kubernetes cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the Kubernetes cluster is located."}, "version": {"type": "string", "description": "The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. \"1.14\"), the latest version within it will be used (e.g. \"1.14.6-do.1\"); if set to \"latest\", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions."}, "cluster_subnet": {"type": "string", "format": "cidr", "description": "The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation."}, "service_subnet": {"type": "string", "description": "The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned."}, "ipv4": {"type": "string", "description": "The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)"}, "endpoint": {"type": "string", "description": "The base URL of the API server on the Kubernetes master node."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`."}, "node_pools": {"type": "array", "description": "An object specifying the details of the worker nodes available to the Kubernetes cluster.", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}, "maintenance_policy": {"type": ["object", "null"], "description": "An object specifying the maintenance window policy for the Kubernetes cluster.", "properties": {"start_time": {"type": "string", "description": "The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`)."}, "duration": {"type": "string", "description": "The duration of the maintenance window policy in human-readable format."}, "day": {"type": "string", "enum": ["any", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"], "description": "The day of the maintenance window policy. May be one of `monday` through `sunday`, or `any` to indicate an arbitrary week day."}}}, "auto_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window."}, "status": {"type": "object", "description": "An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster.", "properties": {"state": {"type": "string", "enum": ["running", "provisioning", "degraded", "error", "deleted", "upgrading", "deleting"], "description": "A string indicating the current status of the cluster."}, "message": {"type": "string", "description": "An optional message providing additional information about the current cluster state."}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated."}, "surge_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes."}, "ha": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled."}, "registry_enabled": {"type": "boolean", "description": "A read-only boolean value indicating if a container registry is integrated with the cluster."}}, "required": ["name", "region", "version", "node_pools"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/1702fc21-e84a-4fcb-ad34-2c12d54c34d4/3/1
Digital Ocean
Digital Ocean Public API
null
kubernetes_create_cluster
To create a new Kubernetes cluster, send a POST request to /v2/kubernetes/clusters. The request must contain at least one node pool with at least one worker. The request may contain a maintenance window policy describing a time period when disruptive maintenance tasks may be carried out. Omitting the policy implies that a window will be chosen automatically. See here for details.
201
null
{"kubernetes_clusters": {"id": "bd5f5959-5e1e-4205-a714-a914373942af", "name": "prod-cluster-01", "region": "nyc1", "version": "1.18.6-do.0", "cluster_subnet": "10.244.0.0/16", "service_subnet": "10.245.0.0/16", "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "ipv4": "", "endpoint": "", "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af"], "node_pools": [{"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "frontend-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["production", "web-team", "frontend", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": false, "min_nodes": 0, "max_nodes": 0, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}, {"id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", "name": "backend-pool", "size": "g-4vcpu-16gb", "count": 2, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": {"service": "backend", "priority": "high"}, "taints": [], "auto_scale": true, "min_nodes": 2, "max_nodes": 5, "nodes": [{"id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", "name": "", "status": {"state": "provisioning"}, "droplet_id": "", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}], "maintenance_policy": {"start_time": "12:00", "duration": "4h0m0s", "day": "any"}, "auto_upgrade": false, "status": {"state": "provisioning", "message": "provisioning"}, "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z", "surge_upgrade": false, "registry_enabled": false, "ha": false}}
{"properties": {"kubernetes_cluster": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a Kubernetes cluster."}, "name": {"type": "string", "description": "A human-readable name for a Kubernetes cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the Kubernetes cluster is located."}, "version": {"type": "string", "description": "The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. \"1.14\"), the latest version within it will be used (e.g. \"1.14.6-do.1\"); if set to \"latest\", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions."}, "cluster_subnet": {"type": "string", "format": "cidr", "description": "The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation."}, "service_subnet": {"type": "string", "description": "The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned."}, "ipv4": {"type": "string", "description": "The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)"}, "endpoint": {"type": "string", "description": "The base URL of the API server on the Kubernetes master node."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`."}, "node_pools": {"type": "array", "description": "An object specifying the details of the worker nodes available to the Kubernetes cluster.", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}, "maintenance_policy": {"type": ["object", "null"], "description": "An object specifying the maintenance window policy for the Kubernetes cluster.", "properties": {"start_time": {"type": "string", "description": "The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`)."}, "duration": {"type": "string", "description": "The duration of the maintenance window policy in human-readable format."}, "day": {"type": "string", "enum": ["any", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"], "description": "The day of the maintenance window policy. May be one of `monday` through `sunday`, or `any` to indicate an arbitrary week day."}}}, "auto_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window."}, "status": {"type": "object", "description": "An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster.", "properties": {"state": {"type": "string", "enum": ["running", "provisioning", "degraded", "error", "deleted", "upgrading", "deleting"], "description": "A string indicating the current status of the cluster."}, "message": {"type": "string", "description": "An optional message providing additional information about the current cluster state."}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated."}, "surge_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes."}, "ha": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled."}, "registry_enabled": {"type": "boolean", "description": "A read-only boolean value indicating if a container registry is integrated with the cluster."}}, "required": ["name", "region", "version", "node_pools"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e8b7db98-dfa9-411e-b157-ad0d2663f30e/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_clusters
To list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
200
null
{"kubernetes_clusters": [{"id": "bd5f5959-5e1e-4205-a714-a914373942af", "name": "prod-cluster-01", "region": "nyc1", "version": "1.18.6-do.0", "cluster_subnet": "10.244.0.0/16", "service_subnet": "10.245.0.0/16", "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "ipv4": "68.183.121.157", "endpoint": "https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com", "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af"], "node_pools": [{"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "frontend-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": false, "min_nodes": 0, "max_nodes": 0, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "adoring-newton-3niq", "status": {"state": "provisioning"}, "droplet_id": "205545370", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "adoring-newton-3nim", "status": {"state": "provisioning"}, "droplet_id": "205545371", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "adoring-newton-3ni7", "status": {"state": "provisioning"}, "droplet_id": "205545372", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}, {"id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", "name": "backend-pool", "size": "g-4vcpu-16gb", "count": 2, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": {"service": "backend", "priority": "high"}, "taints": [], "auto_scale": true, "min_nodes": 2, "max_nodes": 5, "nodes": [{"id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", "name": "affectionate-nightingale-3nif", "status": {"state": "provisioning"}, "droplet_id": "205545373", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", "name": "affectionate-nightingale-3niy", "status": {"state": "provisioning"}, "droplet_id": "205545374", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}], "maintenance_policy": {"start_time": "00:00", "duration": "4h0m0s", "day": "any"}, "auto_upgrade": false, "status": {"state": "provisioning", "message": "provisioning"}, "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z", "surge_upgrade": false, "registry_enabled": false, "ha": false}], "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"kubernetes_clusters": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a Kubernetes cluster."}, "name": {"type": "string", "description": "A human-readable name for a Kubernetes cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the Kubernetes cluster is located."}, "version": {"type": "string", "description": "The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. \"1.14\"), the latest version within it will be used (e.g. \"1.14.6-do.1\"); if set to \"latest\", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions."}, "cluster_subnet": {"type": "string", "format": "cidr", "description": "The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation."}, "service_subnet": {"type": "string", "description": "The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned."}, "ipv4": {"type": "string", "description": "The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)"}, "endpoint": {"type": "string", "description": "The base URL of the API server on the Kubernetes master node."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`."}, "node_pools": {"type": "array", "description": "An object specifying the details of the worker nodes available to the Kubernetes cluster.", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}, "maintenance_policy": {"type": ["object", "null"], "description": "An object specifying the maintenance window policy for the Kubernetes cluster.", "properties": {"start_time": {"type": "string", "description": "The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`)."}, "duration": {"type": "string", "description": "The duration of the maintenance window policy in human-readable format."}, "day": {"type": "string", "enum": ["any", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"], "description": "The day of the maintenance window policy. May be one of `monday` through `sunday`, or `any` to indicate an arbitrary week day."}}}, "auto_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window."}, "status": {"type": "object", "description": "An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster.", "properties": {"state": {"type": "string", "enum": ["running", "provisioning", "degraded", "error", "deleted", "upgrading", "deleting"], "description": "A string indicating the current status of the cluster."}, "message": {"type": "string", "description": "An optional message providing additional information about the current cluster state."}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated."}, "surge_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes."}, "ha": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled."}, "registry_enabled": {"type": "boolean", "description": "A read-only boolean value indicating if a container registry is integrated with the cluster."}}, "required": ["name", "region", "version", "node_pools"]}}}}, {"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/e8b7db98-dfa9-411e-b157-ad0d2663f30e/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_clusters
To list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e8b7db98-dfa9-411e-b157-ad0d2663f30e/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_clusters
To list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/e8b7db98-dfa9-411e-b157-ad0d2663f30e/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_clusters
To list all of the Kubernetes clusters on your account, send a GET request to /v2/kubernetes/clusters.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fdaadb8b-9087-4640-a218-32c763d619a0/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_destroy_associatedResourcesDangerous
To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous. A 204 status code with no body will be returned in response to a successful request.
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/fdaadb8b-9087-4640-a218-32c763d619a0/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_destroy_associatedResourcesDangerous
To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous. A 204 status code with no body will be returned in response to a successful request.
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/fdaadb8b-9087-4640-a218-32c763d619a0/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_destroy_associatedResourcesDangerous
To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous. A 204 status code with no body will be returned in response to a successful request.
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/fdaadb8b-9087-4640-a218-32c763d619a0/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_destroy_associatedResourcesDangerous
To delete a Kubernetes cluster with all of its associated resources, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources/dangerous. A 204 status code with no body will be returned in response to a successful request.
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/860d3566-636d-4565-b7a3-1660c9992e1b/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_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/860d3566-636d-4565-b7a3-1660c9992e1b/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID.
200
null
{"kubernetes_cluster": {"id": "bd5f5959-5e1e-4205-a714-a914373942af", "name": "prod-cluster-01", "region": "nyc1", "version": "1.18.6-do.0", "cluster_subnet": "10.244.0.0/16", "service_subnet": "10.245.0.0/16", "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "ipv4": "68.183.121.157", "endpoint": "https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com", "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af"], "node_pools": [{"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "frontend-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": false, "min_nodes": 0, "max_nodes": 0, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "adoring-newton-3niq", "status": {"state": "running"}, "droplet_id": "205545370", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "adoring-newton-3nim", "status": {"state": "running"}, "droplet_id": "205545371", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "adoring-newton-3ni7", "status": {"state": "running"}, "droplet_id": "205545372", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}, {"id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", "name": "backend-pool", "size": "g-4vcpu-16gb", "count": 2, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": {"service": "backend", "priority": "high"}, "taints": [], "auto_scale": true, "min_nodes": 2, "max_nodes": 5, "nodes": [{"id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", "name": "affectionate-nightingale-3nif", "status": {"state": "running"}, "droplet_id": "205545373", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", "name": "affectionate-nightingale-3niy", "status": {"state": "running"}, "droplet_id": "205545374", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}], "maintenance_policy": {"start_time": "00:00", "duration": "4h0m0s", "day": "any"}, "auto_upgrade": false, "status": {"state": "running"}, "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z", "surge_upgrade": false, "registry_enabled": false, "ha": false}}
{"properties": {"kubernetes_cluster": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a Kubernetes cluster."}, "name": {"type": "string", "description": "A human-readable name for a Kubernetes cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the Kubernetes cluster is located."}, "version": {"type": "string", "description": "The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. \"1.14\"), the latest version within it will be used (e.g. \"1.14.6-do.1\"); if set to \"latest\", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions."}, "cluster_subnet": {"type": "string", "format": "cidr", "description": "The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation."}, "service_subnet": {"type": "string", "description": "The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned."}, "ipv4": {"type": "string", "description": "The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)"}, "endpoint": {"type": "string", "description": "The base URL of the API server on the Kubernetes master node."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`."}, "node_pools": {"type": "array", "description": "An object specifying the details of the worker nodes available to the Kubernetes cluster.", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}, "maintenance_policy": {"type": ["object", "null"], "description": "An object specifying the maintenance window policy for the Kubernetes cluster.", "properties": {"start_time": {"type": "string", "description": "The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`)."}, "duration": {"type": "string", "description": "The duration of the maintenance window policy in human-readable format."}, "day": {"type": "string", "enum": ["any", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"], "description": "The day of the maintenance window policy. May be one of `monday` through `sunday`, or `any` to indicate an arbitrary week day."}}}, "auto_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window."}, "status": {"type": "object", "description": "An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster.", "properties": {"state": {"type": "string", "enum": ["running", "provisioning", "degraded", "error", "deleted", "upgrading", "deleting"], "description": "A string indicating the current status of the cluster."}, "message": {"type": "string", "description": "An optional message providing additional information about the current cluster state."}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated."}, "surge_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes."}, "ha": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled."}, "registry_enabled": {"type": "boolean", "description": "A read-only boolean value indicating if a container registry is integrated with the cluster."}}, "required": ["name", "region", "version", "node_pools"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/860d3566-636d-4565-b7a3-1660c9992e1b/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_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/860d3566-636d-4565-b7a3-1660c9992e1b/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_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/860d3566-636d-4565-b7a3-1660c9992e1b/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_cluster
To show information about an existing Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_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/82a3f3c6-4345-495e-bca7-26b99747ec03/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_availableUpgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/82a3f3c6-4345-495e-bca7-26b99747ec03/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_availableUpgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/82a3f3c6-4345-495e-bca7-26b99747ec03/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_availableUpgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
200
null
{"available_upgrade_versions": [{"slug": "1.16.13-do.0", "kubernetes_version": "1.16.13", "supported_features": []}]}
{"type": "object", "properties": {"available_upgrade_versions": {"type": ["array", "null"], "items": {"type": "object", "properties": {"slug": {"type": "string", "description": "The slug identifier for an available version of Kubernetes for use when creating or updating a cluster. The string contains both the upstream version of Kubernetes as well as the DigitalOcean revision."}, "kubernetes_version": {"type": "string", "description": "The upstream version string for the version of Kubernetes provided by a given slug."}, "supported_features": {"type": "array", "items": {"type": "string"}, "description": "The features available with the version of Kubernetes provided by a given slug."}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/82a3f3c6-4345-495e-bca7-26b99747ec03/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_availableUpgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/82a3f3c6-4345-495e-bca7-26b99747ec03/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_availableUpgrades
To determine whether a cluster can be upgraded, and the versions to which it can be upgraded, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/d883b3f4-4232-4d50-8fa4-227d106cf81e/0/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_summaryByUUID
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
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/d883b3f4-4232-4d50-8fa4-227d106cf81e/1/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_summaryByUUID
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
200
null
{"invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681", "billing_period": "2020-01", "amount": "27.13", "user_name": "Sammy Shark", "user_billing_address": {"address_line1": "101 Shark Row", "address_line2": " ", "city": "Atlantis", "region": "OC", "postal_code": "12345", "country_iso2_code": "US", "created_at": "2019-09-03T16:34:46.000+00:00", "updated_at": "2019-09-03T16:34:46.000+00:00"}, "user_company": "DigitalOcean", "user_email": "[email protected]", "product_charges": {"name": "Product usage charges", "amount": "12.34", "items": [{"amount": "10.00", "name": "Spaces Subscription", "count": "1"}]}, "overages": {"name": "Overages", "amount": "3.45"}, "taxes": {"name": "Overages", "amount": "3.45"}, "credits_and_adjustments": {"name": "Overages", "amount": "3.45"}}
{"type": "object", "properties": {"invoice_uuid": {"type": "string", "description": "UUID of the invoice"}, "billing_period": {"type": "string", "description": "Billing period of usage for which the invoice is issued, in `YYYY-MM` format."}, "amount": {"type": "string", "description": "Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview."}, "user_name": {"type": "string", "description": "Name of the DigitalOcean customer being invoiced."}, "user_billing_address": {"allOf": [{"description": "The billing address of the customer being invoiced."}, {"type": "object", "properties": {"address_line1": {"type": "string", "description": "Street address line 1"}, "address_line2": {"type": "string", "description": "Street address line 2"}, "city": {"type": "string", "description": "City"}, "region": {"type": "string", "description": "Region"}, "postal_code": {"type": "string", "description": "Postal code"}, "country_iso2_code": {"type": "string", "description": "Country (ISO2) code"}, "created_at": {"type": "string", "description": "Timestamp billing address was created"}, "updated_at": {"type": "string", "description": "Timestamp billing address was updated"}}}]}, "user_company": {"type": "string", "description": "Company of the DigitalOcean customer being invoiced, if set."}, "user_email": {"type": "string", "description": "Email of the DigitalOcean customer being invoiced."}, "product_charges": {"allOf": [{"description": "A summary of the product usage charges contributing to the invoice. This will include an amount, and grouped aggregates by resource type under the `items` key."}, {"type": "object", "properties": {"name": {"type": "string", "description": "Description of usage charges"}, "amount": {"type": "string", "description": "Total amount charged"}, "items": {"type": "array", "description": "List of amount, and grouped aggregates by resource type.", "items": {"type": "object", "properties": {"amount": {"type": "string", "description": "Amount of the charge"}, "name": {"type": "string", "description": "Description of the charge"}, "count": {"type": "string", "description": "Number of times the charge was applied"}}}}}}]}, "overages": {"allOf": [{"description": "A summary of the overages contributing to the invoice."}, {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the charge"}, "amount": {"type": "string", "description": "Total amount charged in USD"}}}]}, "taxes": {"allOf": [{"description": "A summary of the taxes contributing to the invoice."}, {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the charge"}, "amount": {"type": "string", "description": "Total amount charged in USD"}}}]}, "credits_and_adjustments": {"allOf": [{"description": "A summary of the credits and adjustments contributing to the invoice."}, {"type": "object", "properties": {"name": {"type": "string", "description": "Name of the charge"}, "amount": {"type": "string", "description": "Total amount charged in USD"}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d883b3f4-4232-4d50-8fa4-227d106cf81e/2/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_summaryByUUID
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
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/d883b3f4-4232-4d50-8fa4-227d106cf81e/3/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_summaryByUUID
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
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/d883b3f4-4232-4d50-8fa4-227d106cf81e/4/0
Digital Ocean
Digital Ocean Public API
null
invoices_get_summaryByUUID
To retrieve a summary for an invoice, send a GET request to /v2/customers/my/invoices/$INVOICE_UUID/summary.
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/ed705da6-a97c-4569-bb8c-a4cc59295b4c/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
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/ed705da6-a97c-4569-bb8c-a4cc59295b4c/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
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/ed705da6-a97c-4569-bb8c-a4cc59295b4c/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
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/ed705da6-a97c-4569-bb8c-a4cc59295b4c/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
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/ed705da6-a97c-4569-bb8c-a4cc59295b4c/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list_firewall_rules
To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.
200
null
{"rules": [{"uuid": "79f26d28-ea8a-41f2-8ad8-8cfcdd020095", "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "type": "droplet", "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61", "created_at": "2019-01-11T18:37:36Z"}]}
{"properties": {"rules": {"type": "array", "items": {"type": "object", "properties": {"uuid": {"type": "string", "pattern": "^$|[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}", "description": "A unique ID for the firewall rule itself."}, "cluster_uuid": {"type": "string", "pattern": "^$|[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}", "description": "A unique ID for the database cluster to which the rule is applied."}, "type": {"type": "string", "enum": ["droplet", "k8s", "ip_addr", "tag", "app"], "description": "The type of resource that the firewall rule allows to access the database cluster."}, "value": {"type": "string", "description": "The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the firewall rule was created."}}, "required": ["type", "value"]}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/afa04b03-a681-4d1d-bbf6-55135672b05e/0/0
Digital Ocean
Digital Ocean Public API
null
databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs. The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/afa04b03-a681-4d1d-bbf6-55135672b05e/1/0
Digital Ocean
Digital Ocean Public API
null
databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs. The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/afa04b03-a681-4d1d-bbf6-55135672b05e/2/0
Digital Ocean
Digital Ocean Public API
null
databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs. The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/afa04b03-a681-4d1d-bbf6-55135672b05e/3/0
Digital Ocean
Digital Ocean Public API
null
databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs. The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/afa04b03-a681-4d1d-bbf6-55135672b05e/4/0
Digital Ocean
Digital Ocean Public API
null
databases_list
To list all of the databases in a clusters, send a GET request to /v2/databases/$DATABASE_ID/dbs. The result will be a JSON object with a dbs key. This will be set to an array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
200
null
{"dbs": [{"name": "alpha"}]}
{"properties": {"dbs": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the database."}}, "required": ["name"]}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/fdaef3d6-63bd-4151-8a4d-dfee882f8689/0/0
Digital Ocean
Digital Ocean Public API
null
projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. 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/fdaef3d6-63bd-4151-8a4d-dfee882f8689/1/0
Digital Ocean
Digital Ocean Public API
null
projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. 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/fdaef3d6-63bd-4151-8a4d-dfee882f8689/2/0
Digital Ocean
Digital Ocean Public API
null
projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. 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/fdaef3d6-63bd-4151-8a4d-dfee882f8689/3/0
Digital Ocean
Digital Ocean Public API
null
projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. 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/fdaef3d6-63bd-4151-8a4d-dfee882f8689/4/0
Digital Ocean
Digital Ocean Public API
null
projects_delete
To delete a project, send a DELETE request to /v2/projects/$PROJECT_ID. To be deleted, a project must not have any resources assigned to it. Any existing resources must first be reassigned or destroyed, or you will receive a 412 error. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.
412
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID 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/863c7a4b-2904-423a-9feb-5031a4a6a6a7/0/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletFilesystemFreeMetrics
To retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_free.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/863c7a4b-2904-423a-9feb-5031a4a6a6a7/1/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletFilesystemFreeMetrics
To retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_free.
200
null
{"status": "success", "data": {"resultType": "matrix", "result": [{"metric": {"device": "/dev/vda1", "fstype": "ext4", "host_id": "222651441", "mountpoint": "/"}, "values": [[1635386880, "25832407040"], [1635387000, "25832407040"], [1635387120, "25832407040"]]}]}}
{"type": "object", "required": ["status", "data"], "properties": {"data": {"type": "object", "required": ["resultType", "result"], "properties": {"result": {"type": "array", "description": "Result of query.", "items": {"type": "object", "required": ["metric", "values"], "properties": {"metric": {"type": "object", "description": "An object containing the metric labels.", "additionalProperties": {"type": "string"}}, "values": {"type": "array", "items": {"type": "array", "items": {"oneOf": [{"description": "**Omitted**"}, {"description": "**Omitted**"}]}}}}}}, "resultType": {"type": "string", "enum": ["matrix"]}}}, "status": {"type": "string", "enum": ["success", "error"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/863c7a4b-2904-423a-9feb-5031a4a6a6a7/2/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletFilesystemFreeMetrics
To retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_free.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/863c7a4b-2904-423a-9feb-5031a4a6a6a7/3/0
Digital Ocean
Digital Ocean Public API
null
monitoring_get_dropletFilesystemFreeMetrics
To retrieve filesystem free metrics for a given droplet, send a GET request to /v2/monitoring/metrics/droplet/filesystem_free.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, 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/d710b7bb-4c31-4efc-9495-8f9330853893/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_nodePool
To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted.
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/d710b7bb-4c31-4efc-9495-8f9330853893/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_nodePool
To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted.
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/d710b7bb-4c31-4efc-9495-8f9330853893/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_nodePool
To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d710b7bb-4c31-4efc-9495-8f9330853893/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_delete_nodePool
To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80418dfd-c5c7-48ee-88e8-592bcff45406/0/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_connectionPool
To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80418dfd-c5c7-48ee-88e8-592bcff45406/1/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_connectionPool
To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80418dfd-c5c7-48ee-88e8-592bcff45406/3/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_connectionPool
To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/80418dfd-c5c7-48ee-88e8-592bcff45406/4/0
Digital Ocean
Digital Ocean Public API
null
databases_delete_connectionPool
To delete a specific connection pool for a PostgreSQL database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/pools/$POOL_NAME. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/d3f82c40-94c6-422d-a832-db4d7d96499c/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_upgrade_cluster
To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade. The body of the request must specify a version attribute. Available upgrade versions for a cluster can be fetched from /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/d3f82c40-94c6-422d-a832-db4d7d96499c/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_upgrade_cluster
To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade. The body of the request must specify a version attribute. Available upgrade versions for a cluster can be fetched from /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/d3f82c40-94c6-422d-a832-db4d7d96499c/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_upgrade_cluster
To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade. The body of the request must specify a version attribute. Available upgrade versions for a cluster can be fetched from /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/d3f82c40-94c6-422d-a832-db4d7d96499c/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_upgrade_cluster
To immediately upgrade a Kubernetes cluster to a newer patch release of Kubernetes, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrade. The body of the request must specify a version attribute. Available upgrade versions for a cluster can be fetched from /v2/kubernetes/clusters/$K8S_CLUSTER_ID/upgrades.
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/087aa153-bff9-434b-b443-f774727f4051/0/0
Digital Ocean
Digital Ocean Public API
null
projects_update_default
To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.
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/087aa153-bff9-434b-b443-f774727f4051/1/0
Digital Ocean
Digital Ocean Public API
null
projects_update_default
To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.
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/087aa153-bff9-434b-b443-f774727f4051/2/0
Digital Ocean
Digital Ocean Public API
null
projects_update_default
To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.
200
null
{"project": {"id": "4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679", "owner_uuid": "99525febec065ca37b2ffe4f852fd2b2581895e7", "owner_id": 258992, "name": "my-web-api", "description": "My website API", "purpose": "Service or API", "environment": "Development", "created_at": "2018-09-27T20:10:35Z", "updated_at": "2018-09-27T20:10:35Z", "is_default": true}}
{"properties": {"project": {"allOf": [{"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "The unique universal identifier of this project."}, "owner_uuid": {"type": "string", "description": "The unique universal identifier of the project owner."}, "owner_id": {"type": "integer", "description": "The integer id of the project owner."}, "name": {"type": "string", "maxLength": 175, "description": "The human-readable name for the project. The maximum length is 175 characters and the name must be unique."}, "description": {"type": "string", "maxLength": 255, "description": "The description of the project. The maximum length is 255 characters."}, "purpose": {"type": "string", "maxLength": 255, "description": "The purpose of the project. The maximum length is 255 characters. It can\nhave one of the following values:\n\n- Just trying out DigitalOcean\n- Class project / Educational purposes\n- Website or blog\n- Web Application\n- Service or API\n- Mobile Application\n- Machine learning / AI / Data processing\n- IoT\n- Operational / Developer tooling\n\nIf another value for purpose is specified, for example, \"your custom purpose\",\nyour purpose will be stored as `Other: your custom purpose`.\n"}, "environment": {"type": "string", "enum": ["Development", "Staging", "Production"], "description": "The environment of the project's resources."}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the project was updated."}}}, {"type": "object", "properties": {"is_default": {"type": "boolean", "description": "If true, all resources will be added to this project if no project is specified."}}}]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/087aa153-bff9-434b-b443-f774727f4051/3/0
Digital Ocean
Digital Ocean Public API
null
projects_update_default
To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.
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/087aa153-bff9-434b-b443-f774727f4051/4/0
Digital Ocean
Digital Ocean Public API
null
projects_update_default
To update you default project, send a PUT request to /v2/projects/default. All of the following attributes must be sent.
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/c7d3ceac-94a5-4fb4-9015-fa026ae0cff6/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_add_registry
To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.
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/c7d3ceac-94a5-4fb4-9015-fa026ae0cff6/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_add_registry
To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.
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/c7d3ceac-94a5-4fb4-9015-fa026ae0cff6/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_add_registry
To integrate the container registry with Kubernetes clusters, send a POST request to /v2/kubernetes/registry.
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/eee861cc-a3f7-4c2f-85f7-675d33b1a8f9/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_recycle_node_pool
The endpoint has been deprecated. Please use the DELETE /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID method instead.
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/eee861cc-a3f7-4c2f-85f7-675d33b1a8f9/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_recycle_node_pool
The endpoint has been deprecated. Please use the DELETE /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID method instead.
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/eee861cc-a3f7-4c2f-85f7-675d33b1a8f9/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_recycle_node_pool
The endpoint has been deprecated. Please use the DELETE /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID method instead.
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/eee861cc-a3f7-4c2f-85f7-675d33b1a8f9/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_recycle_node_pool
The endpoint has been deprecated. Please use the DELETE /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID method instead.
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/91b9fa04-443b-40c7-9fce-5b504236d8a1/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_clusterLintResults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.
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/91b9fa04-443b-40c7-9fce-5b504236d8a1/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_clusterLintResults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.
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/91b9fa04-443b-40c7-9fce-5b504236d8a1/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_clusterLintResults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.
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/91b9fa04-443b-40c7-9fce-5b504236d8a1/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_clusterLintResults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.
200
null
{"run_id": "50c2f44c-011d-493e-aee5-361a4a0d1844", "requested_at": "2019-10-30T05:34:07Z", "completed_at": "2019-10-30T05:34:11Z", "diagnostics": [{"check_name": "unused-config-map", "severity": "warning", "message": "Unused config map", "object": {"name": "foo", "kind": "config map", "namespace": "kube-system"}}]}
{"type": "object", "properties": {"run_id": {"type": "string", "description": "Id of the clusterlint run that can be used later to fetch the diagnostics."}, "requested_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was made."}, "completed_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the schedule clusterlint run request was completed."}, "diagnostics": {"description": "An array of diagnostics reporting potential problems for the given cluster.", "type": "array", "items": {"type": "object", "properties": {"check_name": {"type": "string", "description": "The clusterlint check that resulted in the diagnostic."}, "severity": {"type": "string", "description": "Can be one of error, warning or suggestion."}, "message": {"type": "string", "description": "Feedback about the object for users to fix."}, "object": {"type": "object", "description": "Metadata about the Kubernetes API object the diagnostic is reported on.", "properties": {"name": {"type": "string", "description": "Name of the object"}, "kind": {"type": "string", "description": "The kind of Kubernetes API object"}, "namespace": {"type": "string", "description": "The namespace the object resides in the cluster."}}}}}}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/91b9fa04-443b-40c7-9fce-5b504236d8a1/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_get_clusterLintResults
To request clusterlint diagnostics for your cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/clusterlint. If the run_id query parameter is provided, then the diagnostics for the specific run is fetched. By default, the latest results are shown. To find out how to address clusterlint feedback, please refer to the clusterlint check documentation.
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/fcf0d8ea-3418-433d-8541-528bee49fca8/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
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/fcf0d8ea-3418-433d-8541-528bee49fca8/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
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/fcf0d8ea-3418-433d-8541-528bee49fca8/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
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/fcf0d8ea-3418-433d-8541-528bee49fca8/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
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/fcf0d8ea-3418-433d-8541-528bee49fca8/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_update_cluster
To update a Kubernetes cluster, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID and specify one or more of the attributes below.
202
null
{"kubernetes_cluster": {"id": "bd5f5959-5e1e-4205-a714-a914373942af", "name": "prod-cluster-01", "region": "nyc1", "version": "1.18.6-do.0", "cluster_subnet": "10.244.0.0/16", "service_subnet": "10.245.0.0/16", "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b", "ipv4": "68.183.121.157", "endpoint": "https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com", "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af"], "node_pools": [{"id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "frontend-pool", "size": "s-1vcpu-2gb", "count": 3, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": null, "taints": [], "auto_scale": false, "min_nodes": 0, "max_nodes": 0, "nodes": [{"id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", "name": "adoring-newton-3niq", "status": {"state": "running"}, "droplet_id": "205545370", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", "name": "adoring-newton-3nim", "status": {"state": "running"}, "droplet_id": "205545371", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "e46e8d07-f58f-4ff1-9737-97246364400e", "name": "adoring-newton-3ni7", "status": {"state": "running"}, "droplet_id": "205545372", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}, {"id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", "name": "backend-pool", "size": "g-4vcpu-16gb", "count": 2, "tags": ["production", "web-team", "k8s", "k8s:bd5f5959-5e1e-4205-a714-a914373942af", "k8s:worker"], "labels": {"service": "backend", "priority": "high"}, "taints": [], "auto_scale": true, "min_nodes": 2, "max_nodes": 5, "nodes": [{"id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", "name": "affectionate-nightingale-3nif", "status": {"state": "running"}, "droplet_id": "205545373", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}, {"id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", "name": "affectionate-nightingale-3niy", "status": {"state": "running"}, "droplet_id": "205545374", "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z"}]}], "maintenance_policy": {"start_time": "00:00", "duration": "4h0m0s", "day": "any"}, "auto_upgrade": true, "status": {"state": "running"}, "created_at": "2018-11-15T16:00:11Z", "updated_at": "2018-11-15T16:00:11Z", "surge_upgrade": true, "registry_enabled": false, "ha": false}}
{"properties": {"kubernetes_cluster": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid", "description": "A unique ID that can be used to identify and reference a Kubernetes cluster."}, "name": {"type": "string", "description": "A human-readable name for a Kubernetes cluster."}, "region": {"type": "string", "description": "The slug identifier for the region where the Kubernetes cluster is located."}, "version": {"type": "string", "description": "The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. \"1.14\"), the latest version within it will be used (e.g. \"1.14.6-do.1\"); if set to \"latest\", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions."}, "cluster_subnet": {"type": "string", "format": "cidr", "description": "The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation."}, "service_subnet": {"type": "string", "description": "The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation."}, "vpc_uuid": {"type": "string", "format": "uuid", "description": "A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned."}, "ipv4": {"type": "string", "description": "The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)"}, "endpoint": {"type": "string", "description": "The base URL of the API server on the Kubernetes master node."}, "tags": {"type": "array", "items": {"type": "string"}, "description": "An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`."}, "node_pools": {"type": "array", "description": "An object specifying the details of the worker nodes available to the Kubernetes cluster.", "items": {"type": "object", "allOf": [{"type": "object", "properties": {"size": {"description": "**Omitted**"}}}, {"type": "object", "properties": {"id": {"description": "**Omitted**"}, "name": {"description": "**Omitted**"}, "count": {"description": "**Omitted**"}, "tags": {"description": "**Omitted**"}, "labels": {"description": "**Omitted**"}, "taints": {"description": "**Omitted**"}, "auto_scale": {"description": "**Omitted**"}, "min_nodes": {"description": "**Omitted**"}, "max_nodes": {"description": "**Omitted**"}, "nodes": {"description": "**Omitted**"}}}], "required": ["name", "size", "count"]}}, "maintenance_policy": {"type": ["object", "null"], "description": "An object specifying the maintenance window policy for the Kubernetes cluster.", "properties": {"start_time": {"type": "string", "description": "The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., `15:00`)."}, "duration": {"type": "string", "description": "The duration of the maintenance window policy in human-readable format."}, "day": {"type": "string", "enum": ["any", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"], "description": "The day of the maintenance window policy. May be one of `monday` through `sunday`, or `any` to indicate an arbitrary week day."}}}, "auto_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window."}, "status": {"type": "object", "description": "An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster.", "properties": {"state": {"type": "string", "enum": ["running", "provisioning", "degraded", "error", "deleted", "upgrading", "deleting"], "description": "A string indicating the current status of the cluster."}, "message": {"type": "string", "description": "An optional message providing additional information about the current cluster state."}}}, "created_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated."}, "surge_upgrade": {"type": "boolean", "default": false, "description": "A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes."}, "ha": {"type": "boolean", "default": false, "description": "A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled."}, "registry_enabled": {"type": "boolean", "description": "A read-only boolean value indicating if a container registry is integrated with the cluster."}}, "required": ["name", "region", "version", "node_pools"]}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/07cb1352-f0d5-41ad-9524-2d30ffecd6d8/0/0
Digital Ocean
Digital Ocean Public API
null
databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
200
null
{"sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES"}
{"type": "object", "properties": {"sql_mode": {"type": "string", "description": "A string specifying the configured SQL modes for the MySQL cluster."}}, "required": ["sql_mode"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/07cb1352-f0d5-41ad-9524-2d30ffecd6d8/1/0
Digital Ocean
Digital Ocean Public API
null
databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
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/07cb1352-f0d5-41ad-9524-2d30ffecd6d8/2/0
Digital Ocean
Digital Ocean Public API
null
databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
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/07cb1352-f0d5-41ad-9524-2d30ffecd6d8/3/0
Digital Ocean
Digital Ocean Public API
null
databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
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/07cb1352-f0d5-41ad-9524-2d30ffecd6d8/4/0
Digital Ocean
Digital Ocean Public API
null
databases_get_sql_mode
To retrieve the configured SQL modes for an existing MySQL cluster, send a GET request to /v2/databases/$DATABASE_ID/sql_mode. The response will be a JSON object with a sql_mode key. This will be set to a string representing the configured SQL modes.
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/b97cc48f-6b15-4e9a-bf52-2519a899be22/0/0
Digital Ocean
Digital Ocean Public API
null
apps_list_deployments
List all deployments of an app.
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/b97cc48f-6b15-4e9a-bf52-2519a899be22/1/0
Digital Ocean
Digital Ocean Public API
null
apps_list_deployments
List all deployments of an app.
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/b97cc48f-6b15-4e9a-bf52-2519a899be22/2/0
Digital Ocean
Digital Ocean Public API
null
apps_list_deployments
List all deployments of an app.
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/b97cc48f-6b15-4e9a-bf52-2519a899be22/3/0
Digital Ocean
Digital Ocean Public API
null
apps_list_deployments
List all deployments of an app.
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/b97cc48f-6b15-4e9a-bf52-2519a899be22/4/0
Digital Ocean
Digital Ocean Public API
null
apps_list_deployments
List all deployments of an app.
200
null
{"deployments": [{"id": "b6bdf840-2854-4f87-a36c-5f231c617c84", "spec": {"name": "sample-golang", "services": [{"name": "web", "github": {"repo": "digitalocean/sample-golang", "branch": "branch"}, "run_command": "bin/sample-golang", "environment_slug": "go", "instance_size_slug": "basic-xxs", "instance_count": 2, "routes": [{"path": "/"}]}], "region": "ams"}, "services": [{"name": "web", "source_commit_hash": "9a4df0b8e161e323bc3cdf1dc71878080fe144fa"}], "phase_last_updated_at": "0001-01-01T00:00:00Z", "created_at": "2020-07-28T18:00:00Z", "updated_at": "2020-07-28T18:00:00Z", "cause": "commit 9a4df0b pushed to github/digitalocean/sample-golang", "progress": {"pending_steps": 6, "total_steps": 6, "steps": [{"name": "build", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "component_name": "web", "message_base": "Building service"}]}]}, {"name": "deploy", "status": "PENDING", "steps": [{"name": "initialize", "status": "PENDING"}, {"name": "components", "status": "PENDING", "steps": [{"name": "web", "status": "PENDING", "steps": [{"name": "deploy", "status": "PENDING", "component_name": "web", "message_base": "Deploying service"}, {"name": "wait", "status": "PENDING", "component_name": "web", "message_base": "Waiting for service"}], "component_name": "web"}]}, {"name": "finalize", "status": "PENDING"}]}]}, "phase": "PENDING_BUILD", "tier_slug": "basic"}], "links": {"pages": {}}, "meta": {"total": 1}}
{"allOf": [{"type": "object", "properties": {"deployments": {"title": "A list of deployments", "type": "array", "items": {"properties": {"cause": {"title": "What caused this deployment to be created", "type": "string"}, "cloned_from": {"title": "The ID of a previous deployment that this deployment was cloned from", "type": "string"}, "created_at": {"format": "date-time", "title": "The creation time of the deployment", "type": "string"}, "id": {"title": "The ID of the deployment", "type": "string"}, "jobs": {"items": {"description": "**Omitted**"}, "title": "Job components that are part of this deployment", "type": "array"}, "functions": {"type": "array", "items": {"description": "**Omitted**"}, "title": "Functions components that are part of this deployment"}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING_BUILD", "BUILDING", "PENDING_DEPLOY", "DEPLOYING", "ACTIVE", "SUPERSEDED", "ERROR", "CANCELED"], "type": "string"}, "phase_last_updated_at": {"format": "date-time", "title": "When the deployment phase was last updated", "type": "string"}, "progress": {"properties": {"error_steps": {"description": "**Omitted**"}, "pending_steps": {"description": "**Omitted**"}, "running_steps": {"description": "**Omitted**"}, "steps": {"description": "**Omitted**"}, "success_steps": {"description": "**Omitted**"}, "summary_steps": {"description": "**Omitted**"}, "total_steps": {"description": "**Omitted**"}}, "type": "object"}, "services": {"items": {"description": "**Omitted**"}, "title": "Service components that are part of this deployment", "type": "array"}, "spec": {"title": "AppSpec", "type": "object", "description": "The desired configuration of an application.", "properties": {"name": {"description": "**Omitted**"}, "region": {"description": "**Omitted**"}, "domains": {"description": "**Omitted**"}, "services": {"description": "**Omitted**"}, "static_sites": {"description": "**Omitted**"}, "jobs": {"description": "**Omitted**"}, "workers": {"description": "**Omitted**"}, "functions": {"description": "**Omitted**"}, "databases": {"description": "**Omitted**"}}, "required": ["name"]}, "static_sites": {"items": {"description": "**Omitted**"}, "title": "Static Site components that are part of this deployment", "type": "array"}, "tier_slug": {"title": "The current pricing tier slug of the deployment", "type": "string"}, "updated_at": {"format": "date-time", "title": "When the deployment was last updated", "type": "string"}, "workers": {"items": {"description": "**Omitted**"}, "title": "Worker components that are part of this deployment", "type": "array"}}, "title": "An app deployment", "type": "object"}}}}, {"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/b95631ac-37c4-4a1a-b547-aa80ed44be59/0/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_associatedResources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
200
null
{"load_balancers": [{"id": "edb0478d-7436-11ea-86e6-0a58ac144b91", "name": "volume-001"}], "volumes": [{"id": "edb0478d-7436-11ea-86e6-0a58ac144b91", "name": "volume-001"}], "volume_snapshots": [{"id": "edb0478d-7436-11ea-86e6-0a58ac144b91", "name": "volume-001"}]}
{"type": "object", "description": "An object containing the IDs of resources associated with a Kubernetes cluster.", "properties": {"load_balancers": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "The ID of a resource associated with a Kubernetes cluster."}, "name": {"type": "string", "description": "The name of a resource associated with a Kubernetes cluster."}}}, "description": "A list of names and IDs for associated load balancers that can be destroyed along with the cluster."}, "volumes": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "The ID of a resource associated with a Kubernetes cluster."}, "name": {"type": "string", "description": "The name of a resource associated with a Kubernetes cluster."}}}, "description": "A list of names and IDs for associated volumes that can be destroyed along with the cluster."}, "volume_snapshots": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string", "description": "The ID of a resource associated with a Kubernetes cluster."}, "name": {"type": "string", "description": "The name of a resource associated with a Kubernetes cluster."}}}, "description": "A list of names and IDs for associated volume snapshots that can be destroyed along with the cluster."}}}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b95631ac-37c4-4a1a-b547-aa80ed44be59/1/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_associatedResources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
404
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b95631ac-37c4-4a1a-b547-aa80ed44be59/2/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_associatedResources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
401
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b95631ac-37c4-4a1a-b547-aa80ed44be59/3/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_associatedResources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
429
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/b95631ac-37c4-4a1a-b547-aa80ed44be59/4/0
Digital Ocean
Digital Ocean Public API
null
kubernetes_list_associatedResources
To list the associated billable resources that can be destroyed along with a cluster, send a GET request to the /v2/kubernetes/clusters/$K8S_CLUSTER_ID/destroy_with_associated_resources endpoint.
500
null
{"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"}
{"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]}
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/961cd0f2-859b-4baa-9945-365404e79676/0/0
Digital Ocean
Digital Ocean Public API
null
apps_assign_alertDestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app.
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/961cd0f2-859b-4baa-9945-365404e79676/1/0
Digital Ocean
Digital Ocean Public API
null
apps_assign_alertDestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app.
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/961cd0f2-859b-4baa-9945-365404e79676/2/0
Digital Ocean
Digital Ocean Public API
null
apps_assign_alertDestinations
Updates the emails and slack webhook destinations for app alerts. Emails must be associated to a user with access to the app.
200
null
{"alert": {"id": "e552e1f9-c1b0-4e6d-8777-ad6f27767306", "spec": {"rule": "DEPLOYMENT_FAILED"}, "emails": ["[email protected]"], "phase": "ACTIVE", "progress": {"steps": [{"name": "alert-configure-insight-alert", "status": "SUCCESS", "started_at": "2020-07-28T18:00:00Z", "ended_at": "2020-07-28T18:00:00Z"}]}}}
{"properties": {"alert": {"properties": {"id": {"title": "The ID of the alert", "type": "string"}, "component_name": {"title": "Name of component the alert belongs to", "type": "string"}, "spec": {"properties": {"rule": {"default": "UNSPECIFIED_RULE", "enum": ["UNSPECIFIED_RULE", "CPU_UTILIZATION", "MEM_UTILIZATION", "RESTART_COUNT", "DEPLOYMENT_FAILED", "DEPLOYMENT_LIVE", "DOMAIN_FAILED", "DOMAIN_LIVE", "FUNCTIONS_ACTIVATION_COUNT", "FUNCTIONS_AVERAGE_DURATION_MS", "FUNCTIONS_ERROR_RATE_PER_MINUTE", "FUNCTIONS_AVERAGE_WAIT_TIME_MS", "FUNCTIONS_ERROR_COUNT", "FUNCTIONS_GB_RATE_PER_SECOND"], "type": "string"}, "disabled": {"description": "Is the alert disabled?", "type": "boolean"}, "operator": {"default": "UNSPECIFIED_OPERATOR", "enum": ["UNSPECIFIED_OPERATOR", "GREATER_THAN", "LESS_THAN"], "type": "string"}, "value": {"description": "Threshold value for alert", "format": "float", "type": "number", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38}, "window": {"default": "UNSPECIFIED_WINDOW", "enum": ["UNSPECIFIED_WINDOW", "FIVE_MINUTES", "TEN_MINUTES", "THIRTY_MINUTES", "ONE_HOUR"], "type": "string"}}, "type": "object"}, "emails": {"title": "Emails for alerts to go to", "type": "array", "items": {"default": "", "type": "string"}}, "slack_webhooks": {"title": "Slack Webhooks to send alerts to", "type": "array", "items": {"properties": {"url": {"title": "URL of the Slack webhook", "type": "string"}, "channel": {"title": "Name of the Slack Webhook Channel", "type": "string"}}, "type": "object"}}, "phase": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "CONFIGURING", "ACTIVE", "ERROR"], "type": "string"}, "progress": {"properties": {"steps": {"title": "Steps of an alert's progress.", "type": "array", "items": {"properties": {"name": {"title": "The name of this step", "type": "string"}, "status": {"default": "UNKNOWN", "enum": ["UNKNOWN", "PENDING", "RUNNING", "ERROR", "SUCCESS"], "type": "string"}, "started_at": {"format": "date-time", "title": "The start time of this step", "type": "string"}, "ended_at": {"format": "date-time", "title": "The start time of this step", "type": "string"}, "reason": {"properties": {"code": {"description": "**Omitted**"}, "message": {"description": "**Omitted**"}}, "type": "object"}}, "type": "object"}}}, "type": "object"}}, "type": "object"}}, "type": "object"}