Change Password

Please enter the password.
Please enter the password. Between 8-64 characters. Not identical to your email address. Contain at least 3 of: uppercase, lowercase, numbers, and special characters.
Please enter the password.
Submit

Change Nickname

Current Nickname:
Submit

Apply New License

License Detail

Please complete this required field.

  • Ultipa Graph V4

Standalone

Please complete this required field.

Please complete this required field.

The MAC address of the server you want to deploy.

Please complete this required field.

Please complete this required field.

Cancel
Apply
ID
Product
Status
Cores
Applied Validity Period(days)
Effective Date
Excpired Date
Mac Address
Apply Comment
Review Comment
Close
Profile
  • Full Name:
  • Phone:
  • Company:
  • Company Email:
  • Country:
  • Language:
Change Password
Apply

You have no license application record.

Apply
Certificate Issued at Valid until Serial No. File
Serial No. Valid until File

Not having one? Apply now! >>>

Product Created On ID Amount (USD) Invoice
Product Created On ID Amount (USD) Invoice

No Invoice

Search

      API

      Overview

      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

      On Accounts, scroll down to API Keys 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

      Key
      Type
      Default
      Required
      Description
      api_key String / Yes Your Ultipa Cloud API key

      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
      
      Key
      Type
      Default
      Required
      Description
      instanceStateFilter Int32 1 No Filter instances by their states: 1 for My Instances, 2 for Active (Running) Instances, 3 for Stopped Instances, 4 for Terminated Instances
      search String / No Specify instance ID or name
      page Int32 1 No Filter page number in the response body
      size Int32 999 No Set the size (items per page) in the returned page of the response body

      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

      Key
      Type
      Default
      Required
      Description
      api_key String / Yes Your Ultipa Cloud API key

      Request Body

      {
          "instanceIds": ["ultipa-abc123", "ultipa-abc456"]
      }
      
      Key
      Type
      Default
      Required
      Description
      instanceIds []String / Yes Specify instances by their IDs

      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

      Key
      Type
      Default
      Required
      Description
      api_key String / Yes Your Ultipa Cloud API key

      Request Body

      {
          "instanceId": "ultipa-abc123"
      }
      
      Key
      Type
      Default
      Required
      Description
      instanceId String / Yes Specify the instance by its ID

      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

      Key
      Type
      Default
      Required
      Description
      api_key String / Yes Your Ultipa Cloud API key

      Request Body

      {
          "instanceId": "ultipa-abc123"
      }
      
      Key
      Type
      Default
      Required
      Description
      instanceId String / Yes Specify the instance by its ID

      Response Body

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

      Response Error Codes

      Code
      Message
      Description
      403 Forbidden The given API key does not have permission to perform the request
      405 Operation not allowed The current state of the instance does not allow the request
      408 Login to this account is banned. If you have any questions, please email [email protected] Your account has been banned
      409 The account has been canceled Your account has been canceled
      1217 The instance does not exist The specified instance does not exist
      1301 Unable to verify identity You did not provide an API key in the request, or the key is null
      1302 Key is invalid or has been revoked The API key does not exist or is invalid
      1303 Key requests are frequent, please try again later. The number of requests has exceeded the API request limit
      Please complete the following information to download this book
      *
      公司名称不能为空
      *
      公司邮箱必须填写
      *
      你的名字必须填写
      *
      你的电话必须填写