You can find the reference of the Ubicloud API below. All the request and response bodies are in JSON format. Details of each endpoint with possible responses are shared. Note that, all the responses having status code 4xx
returns the JSON body in the following format.
Request Parameters
Type | Key | Value | Required |
---|---|---|---|
Body | login | ||
Body | password | Password |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
Invalid Request
Unauthorized
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Body | name | Name of the project |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | ps_name | Name of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | ps_name | Name of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | ps_id | ID of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | ps_name | Name of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
Conflict
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | ps_id | ID of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
Conflict
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | vm_name | Name of the virtual machine | |
Body | public_key | SSH public key | |
Body | size | Size of the VM ("standard-2" (default), "standard-4","standard-8","standard-16",) | |
Body | unix_user | Name of the unix user (default: "ubi") | |
Body | boot_image | Name of the boot image ("ubuntu-jammy" (default), "almalinux-9.1") | |
Body | enable_ip4 | Is IPv4 enabled (default: false) | |
Body | private_subnet_id | ID of an existing private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | vm_name | Name of the virtual machine |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | vm_id | ID of the virtual machine |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project in which private subnet will be created | |
Path | location_name | Name of the location in which private subnet will be created | |
Path | ps_name | Name of the virtual machine |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | vm_id | ID of the virtual machine |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the PostgreSQL database | |
Body | size | Size of the database ("standard-2" (default), "standard-4", "standard-8", "standard-16" ) | |
Body | ha_type | HA Type of the database ("none" (default), "sync", "async") |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_id | ID of the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Query | start_after | After which value page include items | |
Query | page_size | Number of items in a page (default: 10) | |
Query | order_column | On which column items are sorted (default: id) |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_id | ID of the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the existing PostgreSQL database | |
Body | name | Name of the PostgreSQL database to be created | |
Body | restore_target | Target restore time |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the existing PostgreSQL database | |
Body | name | Name of the PostgreSQL database to be created | |
Body | restore_target | Target restore time |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_name | Name of the PostgreSQL database | |
Body | password | New superuser password for the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | location_name | Name of the location | |
Path | pg_id | ID of the PostgreSQL database | |
Body | password | New superuser password for the PostgreSQL database |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Body | location_name | Name of the firewall | |
Body | description | Description of the firewall |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Body | firewall_id | ID of the firewall |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Body | firewall_id | ID of the firewall |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project in which virtual machines are created | |
Path | firewall_id | ID of the firewall | |
Body | private_subnet_id | ID of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project in which virtual machines are created | |
Path | firewall_id | ID of the firewall | |
Body | private_subnet_id | ID of the private subnet |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project in which virtual machines are created | |
Path | firewall_id | ID of the firewall | |
Body | cidr | CIDR of the firewall rule | |
Body | port_range | Port range of the firewall rule |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
InvalidRequest
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
keyRequest Parameters
Type | Key | Value | Required |
---|---|---|---|
Path | project_id | ID of the project | |
Path | firewall_id | ID of the firewall | |
Path | firewall_rule_id | ID of the firewall rule |
curl "api/login?login=username@gmail.com&password=samplepassword" -X POST -H "Content-Type: application/json" -i
Response
NoContent
NotAuthenticated
Unauthorized
ResourceNotFound
InvalidToken
authorization
key