API Documentation
Project
Firewall
- GETReturn the list of firewalls in the project
- POSTCreate a new firewall
- GETGet details of a specific firewall
- DELDelete a specific firewall
- GETReturn the list of firewalls in the project and location
- GETGet details of a specific firewall
- POSTCreate a new firewall
- DELDelete a specific firewall
- POSTAttach a subnet to firewall
- POSTDetach a subnet from firewall
Firewall Rule
Inference Api Key
Kubernetes Cluster
- GETList all KubernetesClusters created under the given project ID and visible to logged in user
- GETList KubernetesClusters in a specific location of a project
- GETGet details of a specific KubernetesCluster in a location
- POSTCreate a new KubernetesCluster in a specific location of a project
- DELDelete a specific KubernetesCluster
Load Balancer
- GETList Load Balancers in a specific project
- GETGet details of a specific Load Balancer
- POSTCreate a new Load Balancer in a project
- GETList Load Balancers in a specific location of a project
- GETGet details of a specific Load Balancer in a location
- POSTCreate a new Load Balancer in a specific location of a project
- DELDelete a specific Load Balancer
- PATCHUpdate a Load Balancer in a specific location of a project
- POSTAttach a VM to a Load Balancer in a specific location of a project
- POSTDetach a VM from a Load Balancer in a specific location of a project
Postgres Database
- GETList Postgres Databases in a specific location of a project
- GETGet details of a specific Postgres database in a location
- POSTCreate a new Postgres Database in a specific location of a project
- DELDelete a specific Postgres Database
- PATCHUpdate a Postgres Database in a specific location of a project
- GETDownload CA certificates for a specific Postgres Database in a location with name
- GETGet configuration for a specific Postgres Database
- POSTUpdate configuration for a specific Postgres Database
- PATCHPartially update configuration for a specific Postgres Database
- GETGet metrics for a specific Postgres Database in a location
- POSTPromote a specific Postgres Read Replica Database
- POSTCreate a read replica of the Postgres database
- POSTReset superuser password of the Postgres database
- POSTRestart a specific Postgres Database
- POSTRestore a new Postgres database in a specific location of a project
- POSTSet maintenance window for the Postgres database
- GETList visible Postgres Databases
Postgres Firewall Rule
Postgres Metric Destination
Private Subnet
- GETList Private Subnets in a specific location of a project
- GETGet details of a specific Private Subnet in a location
- POSTCreate a new Private Subnet in a specific location of a project
- DELDelete a specific Private Subnet
- POSTConnect private subnet to another private subnet
- POSTDisconnect private subnet from another private subnet
- GETList visible Private Subnets
Virtual Machine
Kubernetes Cluster
Create a new KubernetesCluster in a specific location of a project
POST
/
project
/
{project_id}
/
location
/
{location}
/
kubernetes-cluster
/
{kubernetes_cluster_reference}
Copy
Ask AI
curl --request POST \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/kubernetes-cluster/{kubernetes_cluster_reference} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"version": "<string>",
"worker_size": "<string>",
"cp_nodes": 123,
"worker_nodes": 123
}'
Copy
Ask AI
{
"cp_node_count": 123,
"cp_vms": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
],
"display_state": "<string>",
"id": "kcqxhqbg86sj0ng5e9ck5n191z",
"location": "eu-central-h1",
"name": "my-cluster-name",
"node_size": "<string>",
"nodepools": [
{
"kubernetes_cluster_id": "kcqxhqbg86sj0ng5e9ck5n191z",
"id": "knqxhqbg86sj0ng5e9ck5n191z",
"name": "my-nodepool-name",
"node_count": 123,
"node_size": "<string>",
"vms": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
]
}
],
"services_load_balancer_url": "<string>",
"version": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the project
Example:
"pjkkmx0f2vke4h36nk9cm8v8q0"
The Ubicloud location/region
Example:
"eu-central-h1"
Kubernetes cluster ID or name
Body
application/json
Response
200
application/json
A KubernetesCluster
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/kubernetes-cluster/{kubernetes_cluster_reference} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"version": "<string>",
"worker_size": "<string>",
"cp_nodes": 123,
"worker_nodes": 123
}'
Copy
Ask AI
{
"cp_node_count": 123,
"cp_vms": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
],
"display_state": "<string>",
"id": "kcqxhqbg86sj0ng5e9ck5n191z",
"location": "eu-central-h1",
"name": "my-cluster-name",
"node_size": "<string>",
"nodepools": [
{
"kubernetes_cluster_id": "kcqxhqbg86sj0ng5e9ck5n191z",
"id": "knqxhqbg86sj0ng5e9ck5n191z",
"name": "my-nodepool-name",
"node_count": 123,
"node_size": "<string>",
"vms": [
{
"id": "vmhfy8gff8c67hasb0eez2k1pd",
"ip4": "127.0.0.1",
"ip4_enabled": true,
"ip6": "2606:4700:3108::ac42:2835",
"location": "eu-central-h1",
"name": "my-vm-name",
"size": "<string>",
"state": "<string>",
"storage_size_gib": 123,
"unix_user": "<string>"
}
]
}
],
"services_load_balancer_url": "<string>",
"version": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.