API Documentation
Project
Firewall
- GETReturn the list of firewalls in the project
- GETReturn the list of firewalls in the project and location
- GETGet details of a specific firewall
- POSTCreate a new firewall
- DELDelete a specific firewall
- PATCHUpdate a firewall
- POSTAttach a subnet to firewall
- POSTDetach a subnet from firewall
- POSTRename a 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
Get metrics for a specific Postgres Database in a location
Copy
Ask AI
curl --request GET \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/metrics \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"metrics": [
{
"name": "CPU Usage",
"unit": "percent",
"series": [
{
"labels": {
"server": "pv9z3a26qkyy4qcxrhzg5f1bs8"
},
"values": [
[
123
]
]
}
],
"key": "cpu_usage",
"description": "CPU usage of the Postgres database"
}
]
}Postgres Database
Get metrics for a specific Postgres Database in a location
GET
/
project
/
{project_id}
/
location
/
{location}
/
postgres
/
{postgres_database_reference}
/
metrics
Get metrics for a specific Postgres Database in a location
Copy
Ask AI
curl --request GET \
--url https://api.ubicloud.com/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/metrics \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"metrics": [
{
"name": "CPU Usage",
"unit": "percent",
"series": [
{
"labels": {
"server": "pv9z3a26qkyy4qcxrhzg5f1bs8"
},
"values": [
[
123
]
]
}
],
"key": "cpu_usage",
"description": "CPU usage of the Postgres database"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Ubicloud location/region
Example:
"eu-central-h1"
Postgres database ID or name Resource ID or name
ID of the project
Example:
"pjkkmx0f2vke4h36nk9cm8v8q0"
Query Parameters
Start time for metrics query (rfc3339 format)
Example:
"2025-05-12T11:57:24+00:00"
End time for metrics query (rfc3339 format)
Example:
"2025-05-12T11:27:24+00:00"
Key of the specific metric to retrieve
Example:
"cpu_usage"
Response
Metrics data for a Postgres Database
Show child attributes
Show child attributes
Name of the metric
Example:
"CPU Usage"
Unit of measurement for the metric
Example:
"percent"
Show child attributes
Show child attributes
Array of timestamp-value pairs
Required array length:
2 elementsUnix timestamp
Key of the metric
Example:
"cpu_usage"
Description of the metric
Example:
"CPU usage of the Postgres database"
Partially update configuration for a specific Postgres DatabasePromote a specific Postgres Read Replica Database
⌘I