Authorizations
Path Parameters
Example:
Example:
Body
application/json
Response
Example:
Example:
Example:
API Documentation
Project
Firewall
GitHub
- GETReturn the list of GitHub installations in the project
- GETReturn information for a single GitHub installation
- GETReturn repositories for a single GitHub installation in the project
- GETReturn information for a single GitHub repository for an installation in the project
- GETReturn information for a all cache entries for a GitHub repository for an installation in the project
- DELDelete all cache entries for a GitHub repository for an installation in the project
- GETReturn information for a single cache entry for a GitHub repository for an installation in the project
- DELDelete a cache entry for a GitHub repository for an installation in the project
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
- GETGet kubeconfig.yaml of a specific KubernetesCluster in a location
- POSTChange number of nodes of a kubernetes nodepool
- POSTRename a kubernetes cluster
Load Balancer
- GETList Load Balancers in a specific 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
- POSTRename a load balancer
- POSTToggle the SSL certificate for a load balancer
Firewall Rule
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
- GETList backups for a specific Postgres database
- 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
- POSTRename a 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
- GETGet details of a specific Postgres database upgrade
- POSTUpgrade a Postgres database to the next major version
- 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
- POSTRename a private subnet
- GETList visible Private Subnets
Virtual Machine
Private Location
Create a new VM in a specific location of a project
Copy
Ask AI
curl --request POST \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"boot_image": "<string>",
"init_script": "<string>",
"enable_ip4": true,
"private_subnet_id": "<string>",
"public_key": "<string>",
"size": "<string>",
"storage_size": 123,
"gpu": "<string>",
"unix_user": "<string>"
}'Copy
Ask AI
{
"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>",
"firewalls": [
{
"description": "<string>",
"firewall_rules": [
{
"cidr": "<string>",
"id": "fraz0q3vbrpa7pkg7zbmah9csn",
"port_range": "<string>",
"description": "<string>"
}
],
"id": "fwfg7td83em22qfw9pq5xyfqb7",
"location": "<string>",
"name": "<string>"
}
],
"private_ipv4": "127.0.0.1",
"private_ipv6": "2606:4700:3108::ac42:2835",
"subnet": "<string>",
"gpu": "<string>"
}Virtual Machine
Create a new VM in a specific location of a project
POST
/
project
/
{project_id}
/
location
/
{location}
/
vm
/
{vm_reference}
Create a new VM in a specific location of a project
Copy
Ask AI
curl --request POST \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"boot_image": "<string>",
"init_script": "<string>",
"enable_ip4": true,
"private_subnet_id": "<string>",
"public_key": "<string>",
"size": "<string>",
"storage_size": 123,
"gpu": "<string>",
"unix_user": "<string>"
}'Copy
Ask AI
{
"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>",
"firewalls": [
{
"description": "<string>",
"firewall_rules": [
{
"cidr": "<string>",
"id": "fraz0q3vbrpa7pkg7zbmah9csn",
"port_range": "<string>",
"description": "<string>"
}
],
"id": "fwfg7td83em22qfw9pq5xyfqb7",
"location": "<string>",
"name": "<string>"
}
],
"private_ipv4": "127.0.0.1",
"private_ipv6": "2606:4700:3108::ac42:2835",
"subnet": "<string>",
"gpu": "<string>"
}⌘I