Overview

The Ultipa Cloud API enables you to operate your Ultipa Cloud instances without the need to log in to Ultipa Cloud.

API

Base URL

The base URL of Ultipa Cloud API is https://cloud.ultipa.com/open/dbaas/v1/instance.

API Keys

After logging in to Ultipa Cloud, navigate to Accounts to create or manage your API Keys.

One API key should be included in each request header, with the key name as api_key.

Request limit

The API request limit is set to 80 requests per minute.

Requests

List Instances

HTTP Request

To list instances, submit a GET request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/instance/list

Request Header

Request Params

Example GET request with parameters:

https://cloud.ultipa.com/open/dbaas/v1/instance/list?instanceStateFilter=2&search=ultipa-abc123&page=1&size=1

Example Response Body

{
    "code": 200,
    "message": "success",
    "data": {
        "page": 1,
        "size": 2,
        "totalPages": 1,
        "totalElements": 2,
        "list": [
            {
                "instanceId": "ultipa-abc123",
                "instanceState": "STOPPED",
                "name": "Community"
            },
            {
                "instanceId": "ultipa-abc456",
                "instanceState": "RUNNING",
                "name": "Course Lab"
            }
        ]
    }
}

View Instance State

HTTP Request

To view instance states, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/instance/state

Request Header

Request Body

{
    "instanceIds": ["ultipa-abc123", "ultipa-abc456"]
}

Example Response Body

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "instanceId": "ultipa-abc123",
            "instanceState": "RUNNING",
            "name": "Course Lab"
        },
        {
            "instanceId": "ultipa-abc456",
            "instanceState": "STOPPED",
            "name": "Community"
        }
    ]
}

Start an Instance

HTTP Request

To start an instance, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/instance/start

Request Header

Request Body

{
    "instanceId": "ultipa-abc123"
}

Response Body

{
    "code": 200,
    "message": "success",
    "data": null
}

Stop an Instance

HTTP Request

To stop an instance, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/instance/stop

Request Header

Request Body

{
    "instanceId": "ultipa-abc123"
}

Response Body

{
    "code": 200,
    "message": "success",
    "data": null
}

Response Error Codes