API

The Cloud API allows you to control your instances without the need to log in to the Ultipa Cloud dashboard.

API Overview

Base URL

The base URL for the Cloud API of both Graph Powerhouse and Graph Blaze instances is https://cloud.ultipa.com/open/dbaas/v1/cluster.

The base URL for the Cloud API of Manager instances is https://cloud.ultipa.com/open/dbaas/v1/manager.

API Keys

API keys are required to authenticate API requests.

Go to Accounts > API Keys in Ultipa Cloud to create or manage your keys. When creating a key, be sure to download and store it securely for future use.

Each API request must include an API key in the request header, using the key name api_key.

List Instances

HTTP Request

To list Graph Powerhouse and Graph Blaze instances, submit a GET request to the following endpoint:

http
https://cloud.ultipa.com/open/dbaas/v1/cluster/list

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

http
https://cloud.ultipa.com/open/dbaas/v1/manager/list

Request Header

Request Parameters

Request Example

HTTP Request
GET https://cloud.ultipa.com/open/dbaas/v1/cluster/list??page=1&size=20&instanceStateFilter=1&directions=desc&sorts=created_at&componentType=GRAPH_V5`
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Accept: application/json

Response Example

JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "page": 1,
        "size": 20,
        "totalPages": 1,
        "totalElements": 2,
        "list": [
            {
                "clusterId": "ultipa-abc123",
                "clusterState": "STOPPING",
                "name": "test2",
                "instanceList": [
                    {
                        "name": "xxxxxxxx_NAME_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Name server"
                    },
                    {
                        "name": "xxxxxxxx_META_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Meta server"
                    },
                    {
                        "name": "xxxxxxxx_SHARD_SERVER-1-1",
                        "instanceState": "STOPPING",
                        "type": "Shard server"
                    }
                ]
            },
            {
                "clusterId": "ultipa-abc456",
                "clusterState": "STOPPING",
                "name": "Graph Powerhouse 0",
                "instanceList": [
                    {
                        "name": "xxxxxxxxxxxx_NAME_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Name server"
                    },
                    {
                        "name": "xxxxxxxxxxxx_META_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Meta server"
                    },
                    {
                        "name": "xxxxxxxxxxxx_SHARD_SERVER-1-1",
                        "instanceState": "STOPPING",
                        "type": "Shard server"
                    }
                ]
            }
        ]
    }
}

View Instance State

HTTP Request

To view the state of Graph Powerhouse and Graph Blaze instances, submit a POST request to the following endpoint:

http
https://cloud.ultipa.com/open/dbaas/v1/cluster/state

To view the state of Manager instances, submit a POST request to the following endpoint:

http
https://cloud.ultipa.com/open/dbaas/v1/manager/state

Request Header

Request Body

JSON
{
    "clusterIds": ["ultipa-abc123", "ultipa-abc456"]
}

Request Example

HTTP Request
POST https://cloud.ultipa.com/open/dbaas/v1/cluster/state
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

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

Response Example

JSON
{
    "code": 200,
    "message": "success",
    "data": [
        {
            "clusterId": "ultipa-abc123",
            "clusterState": "STOPPING",
            "name": "test2",
            "instanceList": [
                {
                    "name": "xxxxxxxxxxxxxxxxx_NAME_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Name server"
                },
                {
                    "name": "xxxxxxxxxxxxxxxxx_META_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Meta server"
                },
                {
                    "name": "xxxxxxxxxxxxxxxxxs_SHARD_SERVER-1-1",
                    "instanceState": "STOPPING",
                    "type": "Shard server"
                }
            ]
        },
        {
            "clusterId": "ultipa-abc456",
            "clusterState": "STOPPING",
            "name": "Graph Powerhouse 0",
            "instanceList": [
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_NAME_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Name server"
                },
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_META_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Meta server"
                },
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_SHARD_SERVER-1-1",
                    "instanceState": "STOPPING",
                    "type": "Shard server"
                }
            ]
        }
    ]
}

Start an Instance

HTTP Request

To start a Graph Powerhouse or Graph Blaze instance, submit a POST request to the following endpoint:

http
https://cloud.ultipa.com/open/dbaas/v1/cluster/start

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

http
https://cloud.ultipa.com/open/dbaas/v1/manager/start

Request Header

Request Body

JSON
{
    "clusterId": "ultipa-abc123"
}

Request Example

HTTP Request
POST https://cloud.ultipa.com/open/dbaas/v1/cluster/start
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

{
    "clusterId": "ultipa-abc123"
}

Response Example

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

Stop a Cluster

HTTP Request

To stop a Graph Powerhouse or Graph Blaze instance, submit a POST request to the following endpoint:

http
https://cloud.ultipa.com/open/dbaas/v1/cluster/stop

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

http
https://cloud.ultipa.com/open/dbaas/v1/manager/stop

Request Header

Request Body

JSON
{
    "clusterId": "ultipa-abc123"
}

Request Example

HTTP Request
POST https://cloud.ultipa.com/open/dbaas/v1/cluster/stop
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

{
    "clusterId": "ultipa-abc123"
}

Response Example

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

Response Error Codes