API docs by Redocly

DT-Cloud API Documentation (25.7.0)

Download OpenAPI specification:Download

Audit Logs

Audit logs listing.

Audit Log List

This endpoint is used to list audit logs.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
Array of objects

List of queries to implement (optional).

start
string <date-time>

Start date (optional).

end
string <date-time>

End date (optional).

size
required
integer <= 1000

Maximum number of records to return.

from
required
integer

Number of records to skip.

order
string
Enum: "asc" "desc"

Sort order.

Responses

Request samples

Content type
application/json
{
  • "queries": [
    ],
  • "start": "2025-01-01T00:00:00Z",
  • "end": "2025-01-23T23:59:59Z",
  • "size": 100,
  • "from": 0,
  • "order": "asc"
}

Response samples

Content type
application/json
{
  • "hits": [
    ],
  • "total": {
    }
}

Authentication

General authentication operations.

User Login

Login as a root user or an IAM user. For root login, only email and password are required. For IAM user login, email, password, and realm are required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
One of
email
required
string

User email address

password
required
string

User password

Responses

Request samples

Content type
application/json
Example
{
  • "email": "root@example.com",
  • "password": 123456
}

Response samples

Content type
application/json
{
  • "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8...",
  • "root": true
}

Authentication - Token

Operations related to tokens in authentication.

Refresh Authentication Token

This endpoint is used to refresh the authentication token using the refresh token provided in the header.

Authorizations:
x-auth-refresh-token

Responses

Check Authentication Token

It allows you to check the validity of your token.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Revoke Authentication Token

This endpoint is used to revoke an authentication token. The refresh token must be provided in the header as 'x-auth-refresh-token'.

Authorizations:
x-auth-refresh-token

Responses

Authentication - 2FA

Operations related to two-factor authentication (2FA).

Enforce Two-Factor Authentication (2FA)

Enables Two-Factor Authentication (2FA) enforcement for the user. Both token and secret are required for this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
token
required
string

The authentication token provided by the user.

secret
required
string

The 2FA secret key for the user.

Responses

Request samples

Content type
application/json
{
  • "token": "abc123def456",
  • "secret": "JBSWY3DPEHPK3PXP"
}

Check Two-Factor Authentication (2FA) Status

This endpoint is used to check if Two-Factor Authentication (2FA) is enabled for the user.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "status": "enabled",
  • "secret": "JBSWY3DPEHPK3PXP"
}

Retrieve 2FA Secret and QR Code URL

This endpoint provides the user's Two-Factor Authentication (2FA) secret key and a QR code URL for setup.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{}

Verify Two-Factor Authentication (2FA)

This endpoint verifies the user's Two-Factor Authentication (2FA) token and returns authentication tokens upon successful verification.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
token
required
string

The authentication token provided by the user.

Responses

Request samples

Content type
application/json
{
  • "token": "123456"
}

Response samples

Content type
application/json
{
  • "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8...",
  • "root": true
}

Enable Two-Factor Authentication (2FA)

This endpoint enables Two-Factor Authentication (2FA) for the user. Both token and secret are required in the request body.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
token
required
string

The authentication token provided by the user.

secret
required
string

The 2FA secret key for the user.

Responses

Request samples

Content type
application/json
{
  • "token": "123456",
  • "secret": "JBSWY3DPEHPK3PXP"
}

Response samples

Content type
application/json
{
  • "success": true
}

Disable Two-Factor Authentication (2FA)

This endpoint disables Two-Factor Authentication (2FA) for the user. A valid token must be provided in the request body.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
token
required
string

The authentication token used to disable 2FA.

Responses

Request samples

Content type
application/json
{
  • "token": "abc123def456"
}

Response samples

Content type
application/json
{
  • "success": true
}

Reset Password

This endpoint allows users to reset their password upon first login. A new password must be provided in the request body.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
password
required
string

The new password for the user.

Responses

Request samples

Content type
application/json
{
  • "password": "NewPassword123!"
}

Response samples

Content type
application/json
{
  • "success": true
}

Change Password

This endpoint allows a user to change their password. The request body must include both the current password (oldPassword) and the new password (password).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
oldPassword
required
string

The user's current password.

password
required
string

The new password to set.

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "currentPassword123",
  • "password": "newPassword456"
}

Response samples

Content type
application/json
{
  • "success": true
}

CMS - Billing

Manages billing operations within the CMS service. Only root users are authorized to perform these operations.

Get Currencies

Retrieves a list of available currencies.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "totalresults": 2,
  • "result": "success",
  • "currencies": [
    ]
}

Get Payment Methods

Retrieves a list of available payment methods.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "totalresults": 2,
  • "paymentmethods": {
    }
}

Capture Payment

Attempts to capture a payment on an unpaid credit card invoice.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
invoiceid
integer

The ID of the pending order.

cvv
string

The CVV Number for the card being attempted.

Responses

Request samples

Content type
application/json
{
  • "invoiceid": 123,
  • "cvv": "123"
}

Response samples

Content type
application/json
{
  • "result": "success"
}

Set Invoice Credit Card

Changes the credit card connected to an invoice to pay it with a different credit card.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
invoiceId
integer

The ID of the invoice.

paymethodId
integer

The ID of the new payment method.

Responses

Request samples

Content type
application/json
{
  • "invoiceId": 123,
  • "paymethodId": 456
}

Response samples

Content type
application/json
{
  • "result": "success"
}

Apply Promotion

Applies a promotion code discount amount to the basket.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
code
string

The promotion code to apply.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "code": "percentage",
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "discount": 130.28,
  • "newTotal": 1315.22
}

Get Tax Rate

Retrieves the current tax rate applied as a percentage.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "taxRate": 20
}

Add Order

Adds a new order with the specified details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
paymentmethod
string

The payment method to use.

pid
Array of integers

The product IDs to order.

Array of objects

Custom fields for the order.

Array of objects

Configuration options for the order.

promocode
string

The promotion code to apply.

Responses

Request samples

Content type
application/json
{
  • "paymentmethod": "lidio",
  • "pid": [
    ],
  • "customfields": [
    ],
  • "configoptions": [
    ],
  • "promocode": "percentage"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "orderid": 2786,
  • "productids": "2442,2443",
  • "serviceids": "2442,2443",
  • "addonids": "",
  • "domainids": "",
  • "invoiceid": 6013
}

Apply Credit

Applies a credit to an invoice.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
invoiceId
integer

The ID of the invoice.

amount
number

The amount of credit to apply.

Responses

Request samples

Content type
application/json
{
  • "invoiceId": 6570,
  • "amount": 0.01
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "invoiceid": 6570,
  • "amount": 0.01,
  • "invoicepaid": "false"
}

CMS - Client

Manages client operations within the CMS service. Only root users are authorized to perform these operations.

Get Client Details

Retrieves the details of a client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "userid": 0,
  • "client_id": 0,
  • "id": 0,
  • "owner_user_id": 0,
  • "uuid": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "fullname": "string",
  • "companyname": "string",
  • "email": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "fullstate": "string",
  • "state": "string",
  • "postcode": "string",
  • "countrycode": "string",
  • "country": "string",
  • "phonenumber": "string",
  • "tax_id": "string",
  • "email_preferences": {
    },
  • "statecode": "string",
  • "countryname": "string",
  • "phonecc": "string",
  • "phonenumberformatted": "string",
  • "telephoneNumber": "string",
  • "billingcid": 0,
  • "notes": "string",
  • "currency": 0,
  • "defaultgateway": "string",
  • "cctype": "string",
  • "cclastfour": "string",
  • "gatewayid": "string",
  • "groupid": 0,
  • "status": "string",
  • "credit": "string",
  • "taxexempt": true,
  • "latefeeoveride": true,
  • "overideduenotices": true,
  • "separateinvoices": true,
  • "disableautocc": true,
  • "emailoptout": true,
  • "marketing_emails_opt_in": true,
  • "overrideautoclose": true,
  • "allowSingleSignOn": 0,
  • "email_verified": true,
  • "language": "string",
  • "isOptedInToMarketingEmails": true,
  • "tax_state": "string",
  • "tax_countrycode": "string",
  • "lastlogin": "string",
  • "customfields1": "string",
  • "customfields": [
    ],
  • "customfields2": "string",
  • "customfields3": "string",
  • "customfields4": "string",
  • "customfields5": "string",
  • "customfields6": "string",
  • "customfields7": "string",
  • "currency_code": "string",
  • "users": {
    },
  • "warning": "string",
  • "client": {
    }
}

Update Client

Updates the details of an existing client. The customfields property is a Base64 encoded string that includes the custom fields in the format {"customfield[96]": "Individual" } when decoded.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
address1
string

Client's address line 1

address2
string

Client's address line 2

city
string

Client's city

state
string

Client's state

postcode
string

Client's postal code

country
string

Client's country

password
string

Client's password

currency
number

Client's currency

customfields
string

Base64 encoded string of custom fields

firstname
string

Client's first name

lastname
string

Client's last name

phonenumber
string

Client's phone number

isBillingDetailUpdate
boolean

Flag to indicate if the update is for billing details

Responses

Request samples

Content type
application/json
{
  • "address1": "address1",
  • "address2": "address2",
  • "city": "city",
  • "state": "state",
  • "postcode": "00000",
  • "country": "TR",
  • "password": "password",
  • "currency": 1,
  • "customfields": "ewogICAgICAgICJjdXN0b21maWVsZFs5Nl0iOiAiSW5kaXZpZHVhbCIKfQ==",
  • "firstname": "John",
  • "lastname": "Doe",
  • "phonenumber": "+90.555 555 55 55",
  • "isBillingDetailUpdate": false
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "clientid": "1"
}

Get Client Products

Retrieves the products of a client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
limitstart
integer

The offset for the returned log data (default: 0)

limitnum
integer

The number of records to return (default: 25)

serviceid
integer

The specific service id to obtain the details for

pid
integer

The specific product id to obtain the details for

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "clientid": "22",
  • "totalresults": 1,
  • "numreturned": 1,
  • "products": [
    ]
}

Get Pay Methods

Retrieves the credit cards of the user, referred to as pay methods.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
paymethodid
integer

The id of a specific Pay Method to retrieve.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "clientid": "22",
  • "paymethods": [
    ]
}

Add Pay Method

Adds a new pay method for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
type
string

The type of pay method.

description
string

A description for the pay method.

gateway_module_name
string

The gateway module name.

card_number
string

The card number.

card_expiry
string

The card expiry date.

card_issue_number
string

The card issue number.

set_as_default
boolean

Whether to set this pay method as default.

Responses

Request samples

Content type
application/json
{
  • "type": "CreditCard",
  • "description": "Personal Visa Card",
  • "gateway_module_name": "lidio",
  • "card_number": "4111111111111111",
  • "card_expiry": "12/25",
  • "card_issue_number": "123",
  • "set_as_default": true
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "paymethodid": 123
}

Delete Pay Method

Deletes a pay method for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
paymethodid
required
integer

The ID of the pay method to delete.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "paymethodid": 123
}

Update Pay Method

Updates the details of a specific pay method for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
paymethodid
required
integer

The ID of the pay method to update.

Request Body schema: application/json
required
card_expiry
string

The expiry date to update for a CreditCard or RemoteCreditCard Pay Method. Format ‘MMYY’ eg 0122. Optional. Only provide if you wish to make an update.

card_issue_number
string

The issue number to update for a CreditCard or RemoteCreditCard Pay Method. Required.

set_as_default
boolean

Should the new Pay Method be the client default.

description
string

Description of the credit card.

Responses

Request samples

Content type
application/json
{
  • "card_expiry": "string",
  • "card_issue_number": "string",
  • "set_as_default": true,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "clientid": "1",
  • "paymethodid": "1"
}

Get Invoices

Retrieves a list of invoices for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
limitstart
integer

The offset for the returned invoice data (default: 0)

limitnum
integer

The number of records to return (default: 25)

status
string

Find invoices for a specific status. Standard Invoice statuses plus Overdue

orderby
string
Enum: "id" "invoicenumber" "date" "duedate" "total" "status"

The field to sort results by. Accepted values are: id, invoicenumber, date, duedate, total, status

order
string
Enum: "asc" "desc"

Order sort attribute. Accepted values are: asc or desc.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "totalresults": 6,
  • "startnumber": 0,
  • "numreturned": 1,
  • "invoices": [
    ]
}

Get Invoice Details

Retrieves the details of a specific invoice.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
invoiceid
required
integer

The ID of the invoice.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "invoiceid": 110,
  • "invoicenum": "7",
  • "userid": 22,
  • "date": "2025-01-16",
  • "duedate": "2025-01-16",
  • "datepaid": "0000-00-00 00:00:00",
  • "lastcaptureattempt": "2025-02-19 09:00:09",
  • "subtotal": "737.39",
  • "credit": "0.00",
  • "tax": "147.48",
  • "tax2": "0.00",
  • "total": "884.87",
  • "balance": "884.87",
  • "taxrate": "20.000",
  • "taxrate2": "0.000",
  • "status": "Unpaid",
  • "paymentmethod": "lidio",
  • "notes": "",
  • "ccgateway": true,
  • "items": {
    },
  • "transactions": ""
}

Update Invoice

Updates the payment method of a specific invoice.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
invoiceid
required
string

The ID of the invoice to update.

Request Body schema: application/json
required
paymentmethod
string

The payment method of the invoice in system format. Valid values are: lidio or banktransfer.

Responses

Request samples

Content type
application/json
{
  • "paymentmethod": "lidio"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "invoiceid": "1"
}

Get Orders

Retrieves a list of orders for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
limitstart
integer

The offset for the returned order data (default: 0)

limitnum
integer

The number of records to return (default: 25)

id
integer

Find orders for a specific id

status
string

Find orders for a specific status

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "totalresults": 1,
  • "startnumber": 0,
  • "numreturned": 1,
  • "orders": [
    ]
}

Get Bank Accounts

Retrieves the bank account details like IBAN, SWIFT, etc.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get Client Custom Fields

Retrieves the custom fields for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "customFields": [
    ]
}

Get Credits

Retrieves the credits for the client.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "totalresults": 38,
  • "clientid": 498,
  • "credits": {
    }
}

CMS - Product

Manages product operations within the CMS service. Only root users are authorized to perform these operations.

Check Product Quota Upgradability

Determines whether a product's quotas can be upgraded or not.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
serviceId
required
string
Example: 12345

The service id of the product to check.

Responses

Response samples

Content type
application/json
{
  • "isQuotaUpgradable": false
}

Get CMS Product Services

Retrieves a list of CMS product services

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get SSD Pair Parameters

Retrieves a list of SSD pair parameters available in CMS.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Product Upgrade Details

Checks if a product is upgradeable to a new product.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
serviceId
required
string

The service id of the product to check.

Responses

Response samples

Content type
application/json
{
  • "isUpgradeable": true,
  • "upgradeDetails": {
    }
}

Get Products

Retrieves everything related to a product.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
pid
string

The ID of the product to query.

gid
required
integer

The group category ID of the product.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "products": [
    ]
}

Upgrade Product

Upgrades a product or its configuration options.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
serviceid
integer

The ID of the service to update.

paymentmethod
string

The upgrade payment method in system format (e.g. paypal).

newproductid
integer

The ID of the new product.

newproductbillingcycle
string

The new product's billing cycle.

calconly
boolean

Only calculate the upgrade amount.

promocode
string

The promotion code to apply to the upgrade.

object

Config options to include in the upgrade.

Responses

Request samples

Content type
application/json
{
  • "serviceid": 128,
  • "paymentmethod": "banktransfer",
  • "newproductid": 1,
  • "newproductbillingcycle": "monthly",
  • "calconly": true,
  • "promocode": "PROMO2023",
  • "configoptions": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "oldproductid": 3,
  • "oldproductname": "Light Compute Monthly",
  • "newproductid": 1,
  • "newproductname": "CCE Monthly (eu-se-1b)",
  • "daysuntilrenewal": -4,
  • "totaldays": 31,
  • "newproductbillingcycle": "monthly",
  • "price": "$-2.51 USD",
  • "upgradeinprogress": 0,
  • "invoiceid": 0
}

Check Product Cancellation

Checks if a product is eligible for cancellation.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
serviceId
required
string

The service id of the product to check.

Responses

Response samples

Content type
application/json
{
  • "isCancelable": true
}

Checks if the product has unpaid invoices or not.

Checks if the product has unpaid invoices or not, if it has, meaning either product or its quotas are not upgradable.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
serviceId
required
string

The service id of the product to check.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "isUpgradeable": true,
  • "message": ""
}

Get Product ID by Service ID

Retrieves the product ID associated with a given service ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
serviceId
required
string
Example: 12345

The service ID to retrieve the associated product ID.

Responses

Response samples

Content type
application/json
{
  • "productId": 449
}

Check Product Quota Upgradability

Determines whether a product's quotas can be upgraded or not.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
pid
required
integer
Example: 12345

The ID of the product to check.

Responses

Response samples

Content type
application/json
{
  • "isQuotaUpgradable": false
}

IAM - Group

Operations for managing user groups in the IAM system, including group creation, assignment, unassignment, and policy management.

Get IAM Groups

Retrieve a list of IAM groups with their details, including assigned users.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create IAM Group

Create a new IAM group by providing the group name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
groupName
required
string

Name of the group to be created.

Responses

Request samples

Content type
application/json
{
  • "groupName": "Admin Group"
}

Response samples

Content type
application/json
{
  • "success": true
}

Delete a group

This endpoint deletes a group based on the group name provided in the request body.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
groupName
required
string >= 3 characters

The name of the group to be deleted.

Responses

Request samples

Content type
application/json
{
  • "groupName": "Admins"
}

Response samples

Content type
application/json
{
  • "success": true
}

Get IAM Group Users

Retrieve a list of IAM group users with optional filtering by group name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
name
string
Example: name=Admin Group

Filter by group name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or Update Group Policy

Create or update a single or multiple group policies. The request body can either contain a single policy or an array of policies, but not both.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
One of
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "policy": {
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

Remove policy from group

This endpoint removes a specific policy from a group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
groupName
required
string >= 3 characters

The name of the group from which the policy will be removed.

route
required
string

The route associated with the policy.

id
required
string

The unique identifier of the policy to be removed.

method
required
string
Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "*"

The HTTP method associated with the policy.

Responses

Request samples

Content type
application/json
{
  • "groupName": "Admins",
  • "route": "/api/v1/resource",
  • "id": "policy123",
  • "method": "GET"
}

Response samples

Content type
application/json
{
  • "success": true
}

Assign user to groups

This endpoint assigns a user to one or more groups.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
normalUserId
required
integer

The ID of the user to be assigned to the groups.

groups
required
Array of strings

A list of groups to assign the user to.

Responses

Request samples

Content type
application/json
{
  • "normalUserId": 123,
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Unassign user from a group

This endpoint unassigns a user from a specific group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
normalUserId
required
integer

The ID of the user to be unassigned from the group.

groupName
required
string >= 3 characters

The name of the group to unassign the user from.

Responses

Request samples

Content type
application/json
{
  • "normalUserId": 123,
  • "groupName": "Admins"
}

Response samples

Content type
application/json
{
  • "success": true
}

Get not assigned groups for a user

This endpoint returns the groups that are not assigned to the user identified by the iamUserId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
iamUserId
required
integer
Example: 123

The ID of the user whose unassigned groups are to be fetched.

Responses

Response samples

Content type
application/json
[
  • "Developers"
]

IAM - Product

Manage and retrieve information related to products within the IAM system, including product-specific policies and access configurations.

List OpenStack Projects

Retrieve a list of OpenStack projects with their details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List OpenStack Resources for a Project

Retrieve a list of OpenStack resources associated with the specified project, filtered by an optional service type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
projectId
required
string
Example: project-12345

The unique ID of the OpenStack project.

query Parameters
service
string
Example: service=volumes

The type of service to filter the resources (e.g., "volumes", "networks").

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List VPS Projects

Retrieve a list of VPS projects with their details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List VPS Resources for a Project

Retrieve a list of VPS resources associated with the specified project, filtered by an optional service type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
projectId
required
string
Example: project-12345

The unique ID of the VPS project.

query Parameters
service
string
Example: service=vms

The type of service to filter the resources (e.g., "vms", "securityGroups").

Responses

Response samples

Content type
application/json
[
  • {
    }
]

IAM - Policy

Operations related to managing and retrieving IAM policies, including filtering by product, service, resource, and action.

Get policies based on query parameters

This endpoint retrieves policies based on the provided query parameters (product, service, resource, action).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
product
string
Example: product=CloudStorage

Filter policies by product.

service
string
Example: service=Compute

Filter policies by service.

resource
string
Example: resource=VM

Filter policies by resource.

action
string
Example: action=CREATE

Filter policies by action.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve details of a policy for a specific group

This endpoint retrieves the details of a policy for the given group, filtered by product, service, resource, and action.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
groupName
required
string

The name of the group for which the policy details are being retrieved

query Parameters
product
string

Filter policies by product

service
string

Filter policies by service

resource
string

Filter policies by resource

action
string

Filter policies by action

Responses

Response samples

Content type
application/json
[
  • {
    }
]

IAM - Project

Manage and retrieve information related to OpenStack projects, including project-specific resources and user assignments.

Retrieve IAM Projects

Fetches a list of IAM projects with their details, including name, ID, type, and server information.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Assigned Projects for a User

Fetches a list of projects assigned to a specific user, including details such as name, ID, type, and server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
userId
required
string

The unique identifier of the user whose assigned projects are being retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign a Project to a User

Assigns a specific project to a user by providing the user ID and project ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
userId
required
string

The unique identifier of the user.

projectId
required
string

The unique identifier of the project to assign.

Responses

Request samples

Content type
application/json
{
  • "userId": "12345",
  • "projectId": "67890"
}

Response samples

Content type
application/json
{
  • "success": true
}

Unassign a Project from a User

Removes the association between a specific project and a user by providing the user ID and project ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
userId
required
string

The unique identifier of the user.

projectId
required
string

The unique identifier of the project to unassign.

Responses

Request samples

Content type
application/json
{
  • "userId": "12345",
  • "projectId": "67890"
}

Response samples

Content type
application/json
{
  • "success": true
}

IAM - User

Manage user-related operations within the Identity and Access Management (IAM) system.

List IAM Users

Retrieve a list of IAM users with their details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Normal User Details

Retrieve detailed information about a specific normal user by their ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
normalUserId
required
string

The unique identifier of the normal user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "email": "string",
  • "status": "string",
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "mfa": true,
  • "createAt": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Register a New User

This operation creates a new IAM user.
Only root users are authorized to perform this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
username
required
string

The username of the new user.

password
required
string

The password for the new user.

email
required
string

The email address of the new user.

Responses

Request samples

Content type
application/json
{
  • "username": "johndoe",
  • "password": "P@ssw0rd!",
  • "email": "johndoe@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "userId": "12345"
}

Update User Status

This operation updates the status of an IAM user.
Only root users are authorized to perform this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
normalUserId
required
string
Example: 12345

The ID of the user whose status needs to be updated.

Request Body schema: application/json
required
status
required
string
Enum: "active" "inactive"

The new status of the user.

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "success": true
}

Delete IAM User

Deletes an IAM user based on the provided normalUserId.
Only root users are authorized to perform this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
normalUserId
required
string
Example: 12345

The ID of the user to be deleted.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Reset User Password

This operation resets the password of an IAM user.
Only root users are authorized to perform this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
userId
required
string

The ID of the user whose password needs to be reset.

password
required
string

The new password for the user.

Responses

Request samples

Content type
application/json
{
  • "userId": "12345",
  • "password": "NewPassword123!"
}

Response samples

Content type
application/json
{
  • "success": true
}

Disable 2FA for a User

Disables two-factor authentication (2FA) for a specific user based on the provided normalUserId.
Only root users are authorized to perform this request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
normalUserId
string

The ID of the user for whom 2FA will be disabled.

Responses

Request samples

Content type
application/json
{
  • "normalUserId": "12345"
}

Response samples

Content type
application/json
{
  • "success": true
}

List User Realms

Retrieves a list of user realms with their details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Realm Name

Updates the name of a realm. This operation is restricted to root users.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
realm
required
string

The new name of the realm.

Responses

Request samples

Content type
application/json
{
  • "realm": "Updated Realm Name"
}

Response samples

Content type
application/json
{
  • "success": true
}

Manage 2FA Enforcement for User Realm

This endpoint allows for managing the 2FA enforcement status for normal users in the user realm.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
enforce2fa
required
boolean

Whether to enforce 2FA for normal users in the realm.

Responses

Request samples

Content type
application/json
{
  • "enforce2fa": true
}

Response samples

Content type
application/json
{
  • "success": true
}

Update IP Whitelist Access Level

This endpoint allows root users to update the IP whitelist access level for users.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
ips
required
Array of strings non-empty

A list of IPs to whitelist.

accessLevel
required
string
Enum: "Only Root" "All Users" "Disable"

The access level for the IPs. Can be 'Only Root', 'All Users', or 'Disable'.

Responses

Request samples

Content type
application/json
{
  • "ips": [
    ],
  • "accessLevel": "Only Root"
}

Response samples

Content type
application/json
{
  • "success": true
}

Get IP Whitelist Information

This endpoint retrieves the current IP whitelist details, including the access level and the list of whitelisted IPs.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "accessLevel": "All Users",
  • "ips": [
    ]
}

API Keys

Management of API keys for user operations.

List API Keys

Retrieve a list of API keys

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate API Key

Create a new API key for the authenticated user. User ID is obtained from authentication context.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
description
string

Description for the API key.

expiresInDays
required
integer

Number of days until the API key expires.

Responses

Request samples

Content type
application/json
{
  • "description": "Key-example",
  • "expiresInDays": 365
}

Response samples

Content type
application/json
{
  • "key": "a1b2c3d4e5f6...",
  • "keyId": "xyz-123"
}

Update API Key

Update the description of an existing API key. User ID is obtained from authentication context.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
keyId
required
string
Example: xyz-123

Public identifier of the API key to update.

Request Body schema: application/json
required
description
required
string

New description for the API key.

Responses

Request samples

Content type
application/json
{
  • "description": "Updated key for production"
}

Response samples

Content type
application/json
{
  • "id": "key-456",
  • "keyId": "xyz-123",
  • "description": "Updated key for production",
  • "createdAt": "2025-01-01T12:00:00Z",
  • "expiredAt": "2025-12-31T23:59:59Z",
  • "revoked": false
}

Revoke API Key

Revoke an existing API key to prevent further use. User ID is obtained from authentication context.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
keyId
required
string
Example: xyz-123

Public identifier of the API key to revoke.

Responses

Response samples

Content type
application/json
{
  • "id": "key-456",
  • "keyId": "xyz-123",
  • "description": "Key for production",
  • "createdAt": "2025-01-01T12:00:00Z",
  • "expiredAt": "2025-12-31T23:59:59Z",
  • "revoked": true
}

Delete API Key

Permanently delete an existing API key

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
keyId
required
string
Example: xyz-123

Public identifier of the API key to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "key-456",
  • "keyId": "xyz-123",
  • "description": "Key for production",
  • "createdAt": "2025-01-01T12:00:00Z",
  • "expiredAt": "2025-12-31T23:59:59Z",
  • "revoked": true
}

OBS - Alert

Manages alert channels and email groups for OBS alerts.

Get OBS Alert Channels

Retrieves OBS alerts based on query parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

userUuid
required
string

The unique identifier of the user.

configId
string

The configuration ID to filter alerts.

config_type
string

The configuration type to filter alerts.

from_index
integer

The starting index for pagination.

max_items
integer

The maximum number of items to return.

sort_order
string
Enum: "asc" "desc"

The sorting order of results (ascending or descending).

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Alert Channel

Creates a new alert channel for OBS alerts.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
name
required
string

The name of the alert channel.

smtpId
required
string

The ID of the associated SMTP configuration.

email_config_id
Array of strings

Optional list of email configuration IDs.

Responses

Request samples

Content type
application/json
{
  • "name": "Critical Alerts",
  • "smtpId": "smtp-12345",
  • "email_config_id": [
    ]
}

Response samples

Content type
application/json
{
  • "config_id": "alert-channel-98765"
}

Get SMTP Channel

Retrieves the SMTP channel configuration for OBS alerts.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Email Group

Retrieves the email group configurations for OBS alerts.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

userUuid
required
string

The UUID of the user making the request.

configId
string

The ID of a specific email group configuration.

config_type
string

The type of the configuration (e.g., EMAIL_GROUP).

from_index
integer

The starting index for pagination.

max_items
integer

The maximum number of items to return.

sort_order
string
Enum: "asc" "desc"

The sorting order of the results.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Email Group

Creates a new email group for OBS alerts.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
emails
required
Array of strings <email> [ items <email > ]

List of email addresses in the group.

name
required
string

The name of the email group.

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "name": "Critical Alerts Group"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Alert Channel

Updates an existing alert channel configuration.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
configId
required
string

The unique identifier of the alert channel to update.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
required
object
name
required
string

The name of the alert channel.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "name": "Updated Critical Alerts"
}

Response samples

Content type
application/json
{
  • "config_id": "alert-channel-98765"
}

Delete Alert Channel or Email Group

Deletes an alert channel or email group by type and config ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
type
required
string

The type of the entity to delete (e.g., "alert" or "email-group").

configId
required
string

The unique identifier of the alert channel or email group to delete.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Email Group

Updates an existing email group for OBS alerts.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
configId
required
string

The unique identifier of the email group to be updated.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
required
object
name
required
string

The updated name of the email group.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "name": "Updated Critical Alerts Group"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

OBS - Alias

Manages log aliases for easier identification and organization.

Get OBS Alias Information

Retrieves OBS alias details, including replica count, status, health, and more.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Alias

Creates a new OBS alias with specified configuration.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
aliasName
required
string

The name of the alias to be created.

shardCount
required
integer

The number of shards for the alias.

replicaCount
required
integer

The number of replicas for the alias.

retentionDay
required
integer

The retention period in days for the alias.

Responses

Request samples

Content type
application/json
{
  • "aliasName": "log-alias-2",
  • "shardCount": 3,
  • "replicaCount": 2,
  • "retentionDay": 30
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Alias

Updates the configuration of an existing alias, including settings and retention period.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
Any of
aliasName
required
string

The name of the alias to be updated.

required
object
retentionDay
integer

The retention period in days for the alias.

Responses

Request samples

Content type
application/json
{
  • "aliasName": "log-alias-2",
  • "settings": {
    },
  • "retentionDay": 30
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Alias Details

Retrieves detailed information about a specific OBS alias.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
aliasName
required
string

The name of the OBS alias to retrieve details for.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "alias": {
    }
}

Delete Alias

Deletes a OBS alias by its name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
aliasName
required
string

The name of the alias to be deleted.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

Get Alias Indices

Retrieves index details for a given alias.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
aliasName
required
string

The name of the alias whose indices will be retrieved.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Alias Index Details

Retrieves detailed information about a specific index under a given alias.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
aliasName
required
string

The name of the alias.

indexName
required
string

The name of the index to retrieve details for.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

OBS - Monitor

Manages monitoring configurations for OBS, enabling real-time tracking and alerting of log data.

Get Alerts

Retrieves a list of alerts with filtering, sorting, and pagination options.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

sortOrder
string
Enum: "asc" "desc"

Sort order of the alerts.

size
string

Number of alerts to retrieve per page.

startIndex
string

Starting index for pagination.

severityLevel
string

Filter alerts by severity level.

alertState
string
Enum: "ALL" "ACTIVE" "ERROR" "ACKNOWLEDGED" "COMPLETED" "DELETED"

Filter alerts by state.

monitorId
string

Filter alerts by monitor ID.

uuid
string

Filter alerts by UUID.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Get Monitor Alerts

Retrieves monitoring alerts for a specific server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Get Alert Monitor Stats

Retrieves alert statistics for a specific monitor.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
monitorId
required
string

The ID of the monitor for which alert statistics are being retrieved.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Create a Monitor

Creates a new monitor with specified configurations.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
name
string

Name of the monitor.

enabled
boolean

Indicates whether the monitor is enabled.

object or object
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "schedule": {
    },
  • "inputs": [
    ],
  • "triggers": [
    ]
}

Update Monitor

Updates an existing OBS monitor with the specified configuration.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
monitorId
required
string

The ID of the monitor to update.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
enabled
boolean

Whether the monitor is enabled.

object or object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "schedule": {
    },
  • "triggers": [
    ]
}

Delete Monitor

Deletes a specified monitor by its ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
monitorId
required
string

The unique ID of the monitor to delete.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

Run Monitor

Executes a specified monitor with filtering and necessary parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
monitorId
required
string

The unique ID of the monitor to execute.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

OBS - Monitoring

Provides tools for monitoring OBS data and setting up alerts for system activity and performance metrics.

Search Monitoring Data

Searches monitoring data with specific query and aggregation options.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
index
required
string

The index to search within.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
from
integer >= 0
size
integer >= 1
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "from": 0,
  • "size": 1,
  • "query": {
    },
  • "aggregations": {
    }
}

Multi-search Monitoring Data

Performs multiple search queries on different indexes with filtering options.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
Array (non-empty)
index
string

The index to search within.

object

The search query.

from
integer

The starting point for pagination.

size
integer

The number of results to retrieve per page.

search_type
string

The type of search to perform (e.g., "query_then_fetch").

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Autocomplete Search for Monitoring Data

Provides an autocomplete feature for searching monitoring data based on a query.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
object non-empty
index
string

The index to search within.

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "index": "index-1"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": [
    ]
}

Execute Query for Monitoring Data

Executes a query for monitoring data based on the provided query type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
queryType
required
string

The type of query to execute (e.g., "search", "aggregate").

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
query
required
string

The query string to execute.

cursor
string

The cursor for paginated results.

fetch_size
number

The number of results to fetch per request.

Responses

Request samples

Content type
application/json
{
  • "query": "SELECT * FROM logs WHERE status='active'",
  • "cursor": "cursor-12345",
  • "fetch_size": 50
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": [
    ]
}

Preview Search Results for Monitoring

Executes a preview search for monitoring data using the specified alias name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
aliasName
required
string

The alias name for the search operation.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
One of
required
object
object
size
number

The number of results to fetch for preview.

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "aggregations": {
    },
  • "size": 10
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}

OBS - User

Manages user-related OBS configurations, tracking and auditing user activities within the system.

Get Agent Users

Retrieves a list of agent users with relevant information.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Agent User

Creates a new agent user with the provided details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
aliasname
required
string

The alias name of the user.

username
required
string

The username of the agent.

Responses

Request samples

Content type
application/json
{
  • "aliasname": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get User Servers

Retrieves a list of servers associated with users, including status and type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get User Products

Retrieves a list of active products associated with users.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "activeProducts": [
    ]
}

Get Agent User Details

Retrieves details for a specific agent user by their ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
agentUserId
required
number

The ID of the agent user to retrieve.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Agent User Password

Updates the password for a specific agent user by their ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
agentUserId
required
number

The ID of the agent user whose password is to be updated.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Request Body schema: application/json
required
newPassword
required
string

The new password to be set for the agent user.

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Agent User

Deletes a specific agent user by their ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
agentUserId
required
number

The ID of the agent user to be deleted.

query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get User Quotas

Retrieves the quotas for a specific user based on the server ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the OBS product. You can obtain valid product IDs by calling the OBS-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

CCE - Flavor

Used for CCE are resource configurations that define the hardware characteristics of virtual machines.

List Flavors

Retrieves a list of available flavors in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Load Balancer Flavors

Retrieves a list of available load balancer flavors in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CCE - Floating Ip

Manages floating IPs in the OpenStack CCE environment for flexible network configurations and high availability.

List Floating IPs

Retrieves a list of floating IPs in the OpenStack environment associated with a specific server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Floating IP

Creates a new floating IP in the OpenStack environment for a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
floating_network_id
string

The ID of the floating network to assign the floating IP.

port_id
string

The ID of the port to associate with the floating IP (optional).

subnet_id
string

The ID of the subnet for the floating IP (optional).

fixed_ip_address
string

The fixed IP address to assign (optional, must be a valid IP).

Responses

Request samples

Content type
application/json
{
  • "floating_network_id": "floating-network-67890",
  • "port_id": "port-98765",
  • "subnet_id": "subnet-54321",
  • "fixed_ip_address": "192.168.1.10"
}

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "status": "ACTIVE",
  • "description": "Public floating IP for web-server-01",
  • "tags": [
    ],
  • "tenant_id": "tenant-67890",
  • "created_at": "2025-01-28T12:00:00Z",
  • "updated_at": "2025-01-28T12:30:00Z",
  • "floating_network_id": "floating-network-67890",
  • "port_details": {
    },
  • "qos_policy_id": null
}

Get Floating IP Details

Retrieves detailed information about a specific floating IP in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
floatingId
required
string
Example: floatingip-12345

The unique identifier of the floating IP.

query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "status": "ACTIVE",
  • "description": "Public floating IP for web-server-01",
  • "tags": [
    ],
  • "tenant_id": "tenant-67890",
  • "created_at": "2025-01-28T12:00:00Z",
  • "updated_at": "2025-01-28T12:30:00Z",
  • "floating_network_id": "floating-network-67890",
  • "port_details": {
    },
  • "qos_policy_id": null
}

Update Floating IP

Updates the details of a specific floating IP in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
floatingId
required
string
Example: floatingip-12345

The unique identifier of the floating IP.

query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
port_id
string

The ID of the port to associate with the floating IP.

fixed_ip_address
string

The fixed IP address to associate with the floating IP.

Responses

Request samples

Content type
application/json
{
  • "port_id": "port-67890",
  • "fixed_ip_address": "192.168.1.10"
}

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "status": "ACTIVE",
  • "description": "Public floating IP for web-server-01",
  • "tags": [
    ],
  • "tenant_id": "tenant-67890",
  • "created_at": "2025-01-28T12:00:00Z",
  • "updated_at": "2025-01-28T12:30:00Z",
  • "floating_network_id": "floating-network-67890",
  • "port_details": {
    },
  • "qos_policy_id": null
}

Delete Floating IP

Deletes a specific floating IP from the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
floatingId
required
string
Example: floatingip-12345

The unique identifier of the floating IP to be deleted.

query Parameters
serverId
required
string
Example: serverId=server-12345

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - Images

Operations related to managing and manipulating images within the OpenStack environment.

List images

Retrieves a list of images in the OpenStack environment. Requires serverId as a mandatory query parameter. Optionally, visibility can be provided to filter results.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

visibility
string
Enum: "public" "private" "shared"

Filter images based on visibility type (optional).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new image

Creates a new image in the OpenStack environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The name of the image.

type
string
Enum: "linux" "windows"

The type of the image.

os_distro
string

The operating system distribution of the image.

min_disk
integer [ 1 .. 512 ]

The minimum disk size required for the image.

visibility
string
Enum: "public" "private" "shared" "community"

The visibility of the image (public, private, shared, community).

min_ram
integer

The minimum RAM required for the image.

protected
boolean

Whether the image is protected from being deleted.

tags
Array of strings

A list of tags to associate with the image.

Responses

Request samples

Content type
application/json
{
  • "name": "my-new-image",
  • "type": "linux",
  • "os_distro": "ubuntu",
  • "min_disk": 20,
  • "visibility": "public",
  • "min_ram": 2048,
  • "protected": true,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "image-12345"
}

Get image details

Retrieves the details of a specific image identified by imageId. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
imageId
required
string

The unique identifier of the image.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "image-12345",
  • "name": "Ubuntu 20.04",
  • "status": "active",
  • "size": 30,
  • "osType": "Linux",
  • "minVolumeSize": 20,
  • "type": "OS",
  • "visibility": "public",
  • "os_distro": "Ubuntu"
}

Get image versions

Retrieves the versions of images available. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an image

Updates an image's specified properties. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
imageId
required
string

The unique identifier of the image to update.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
value
string

The value to be updated.

path
string

The path to the field to be updated.

op
string

The operation to be performed (e.g., "add", "replace", "remove").

Responses

Request samples

Content type
application/json
{
  • "value": "new_value",
  • "path": "/properties/field_name",
  • "op": "replace"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Delete an image

Deletes an image from the OpenStack environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
imageId
required
string

The unique identifier of the image to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "status": "success"
}

Upload an image

Uploads an image to the OpenStack environment. The serverId query parameter is required, and the imageId body parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
imageId
string

The unique identifier of the image to upload.

Responses

Request samples

Content type
application/json
{
  • "imageId": "image-12345"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Download an image

Downloads an image from the OpenStack environment. The serverId query parameter is required, and the imageId body parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
imageId
string

The unique identifier of the image to download.

Responses

Request samples

Content type
application/json
{
  • "imageId": "image-12345"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Check image upload permission

Checks if the current server has permission to upload an image. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "imageUploadPermission": true
}

CCE - Kubernetes

Manages Kubernetes clusters and resources within the OpenStack environment.

List Kubernetes Clusters

Retrieves a list of Kubernetes clusters in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Kubernetes Cluster

Creates a new Kubernetes cluster in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
kubernetesVersion
string
Enum: "v1.23.5" "v1.22.2" "v1.24.3" "v1.25.7" "v1.26.11" "v1.27.8" "v1.28.4" "v1.29.3"

Kubernetes version for the cluster.

clusterName
string

Name of the Kubernetes cluster.

sshKey
string

SSH key for accessing the cluster nodes.

networkId
string

Network ID for the cluster.

networkSubnetId
string

Subnet ID associated with the network.

highAvailability
boolean

Enables high availability mode.

floatingIpEnabled
boolean

Enables floating IP for the cluster.

minionFloatingIpDisabled
boolean

Disables floating IP for worker nodes.

externalNetworkId
string

External network ID for the cluster.

masterFlavor
string
Enum: "medium" "large" "xlarge" "3xlarge" "c.medium" "4xlarge" "m.xlarge" "c.large" "2xlarge" "m.2xlarge" "m.medium" "c.3xlarge" "c.xlarge" "c.4xlarge" "m.large" "m.3xlarge" "m.small" "c.2xlarge"

Flavor type for master nodes.

workerFlavor
string
Enum: "small" "medium" "large" "xlarge" "3xlarge" "c.medium" "4xlarge" "m.xlarge" "c.large" "2xlarge" "m.2xlarge" "m.medium" "c.3xlarge" "c.xlarge" "c.4xlarge" "m.large" "m.3xlarge" "m.small" "c.2xlarge"

Flavor type for worker nodes.

storagePolicy
string

Storage policy for the cluster.

diskSize
integer [ 3 .. 8192 ]

Disk size for each node (in GB).

numberOfWorker
integer >= 1

Number of worker nodes.

maxNodeCount
integer >= 1

Maximum number of nodes for auto-scaling.

monitoring
boolean

Enables monitoring for the cluster.

autoScaling
boolean

Enables auto-scaling for worker nodes.

extraLabels
object

Additional labels for the cluster.

masterLbFloatingIpEnabled
boolean

Enables floating IP for the master load balancer.

Responses

Request samples

Content type
application/json
{
  • "kubernetesVersion": "v1.29.3",
  • "clusterName": "my-cluster",
  • "sshKey": "my-ssh-key",
  • "networkId": "net-123456",
  • "networkSubnetId": "subnet-654321",
  • "highAvailability": true,
  • "floatingIpEnabled": true,
  • "minionFloatingIpDisabled": false,
  • "externalNetworkId": "ext-net-789012",
  • "masterFlavor": "large",
  • "workerFlavor": "medium",
  • "storagePolicy": "fast-storage",
  • "diskSize": 50,
  • "numberOfWorker": 3,
  • "maxNodeCount": 10,
  • "monitoring": true,
  • "autoScaling": false,
  • "extraLabels": { },
  • "masterLbFloatingIpEnabled": true
}

Response samples

Content type
application/json
{
  • "uuid": "a1b2c3d4-e5f6-7890-1234-56789abcdef0"
}

Get Kubernetes Cluster Details

Retrieves details of a specific Kubernetes cluster in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "overview": {
    }
}

Delete Kubernetes Cluster

Deletes a specific Kubernetes cluster from OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Get Available Kubernetes Versions

Retrieves the list of available Kubernetes versions that can be used for cluster creation or upgrade in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upgrade Kubernetes Cluster

Upgrades an existing Kubernetes cluster to a new version in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster to be upgraded.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
targetVersion
string

The target Kubernetes version to upgrade to.

Responses

Request samples

Content type
application/json
{
  • "targetVersion": "v1.29.3"
}

Response samples

Content type
application/json
{
  • "uuid": "550e8400-e29b-41d4-a716-446655440000"
}

Generate Kubernetes Config YAML (POST)

Generates a Kubernetes configuration file in YAML format for the specified Kubernetes cluster.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

query Parameters
serverId
required
string

Unique identifier of the server.

Request Body schema: application/json
optional
configOptions
object

Additional configuration options for the YAML generation.

Responses

Request samples

Content type
application/json
{
  • "configOptions": {
    }
}

Response samples

Content type
application/json
{
  • "configYaml": "apiVersion: v1\nkind: Config\nclusters:\n- name: cluster1\n cluster:\n server: https://example.com\n"
}

CCE - Kubernetes - Node Group

Manages Kubernetes node groups within an OpenStack-based CCE environment.

Get Node Groups of a Kubernetes Cluster

Retrieves the node groups (masters and workers) of a specific Kubernetes cluster in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "groups": {
    }
}

Create a New Node Group

Adds a new node group to the specified Kubernetes cluster.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The name of the node group.

node_count
integer >= 1

The number of nodes in the node group.

flavor_id
string
Enum: "small" "medium" "large" "xlarge" "3xlarge" "c.medium" "4xlarge" "m.xlarge" "c.large" "2xlarge" "m.2xlarge" "m.medium" "c.3xlarge" "c.xlarge" "c.4xlarge" "m.large" "m.3xlarge" "m.small" "c.2xlarge"

The flavor ID for the node group.

minNodeCount
integer >= 1

Minimum number of nodes allowed in the group (for auto-scaling).

maxNodeCount
integer >= 1

Maximum number of nodes allowed in the group (for auto-scaling).

autoScaling
boolean

Whether auto-scaling is enabled for the node group.

object

Additional labels for the node group.

Responses

Request samples

Content type
application/json
{
  • "name": "worker-group-2",
  • "node_count": 3,
  • "flavor_id": "large",
  • "minNodeCount": 1,
  • "maxNodeCount": 5,
  • "autoScaling": true,
  • "extraLabels": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Resize Kubernetes Node Group

Resizes the specified node group in a Kubernetes cluster by adjusting the number of nodes.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The name of the node group to be resized.

node_count
integer >= 1

The new number of nodes in the node group.

nodes_to_remove
string

(Optional) Comma-separated list of node IDs to be removed.

Responses

Request samples

Content type
application/json
{
  • "name": "worker-group-1",
  • "node_count": 3,
  • "nodes_to_remove": "node-1,node-2"
}

Response samples

Content type
application/json
{
  • "uuid": "550e8400-e29b-41d4-a716-446655440000"
}

Update a Node Group

Updates the configuration of a specific node group in a Kubernetes cluster.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

nodeGroupId
required
string

Unique identifier of the node group.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
minNodeCount
integer >= 1

Minimum number of nodes allowed in the node group (for auto-scaling).

maxNodeCount
integer >= 1

Maximum number of nodes allowed in the node group (for auto-scaling).

nodeCount
integer >= 1

The desired number of nodes in the node group.

autoScaling
boolean

Whether auto-scaling is enabled for the node group.

Responses

Request samples

Content type
application/json
{
  • "minNodeCount": 1,
  • "maxNodeCount": 5,
  • "nodeCount": 3,
  • "autoScaling": true
}

Response samples

Content type
application/json
{
  • "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Delete NodeGroup from Kubernetes Cluster

Removes a specific NodeGroup from the specified Kubernetes cluster.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

nodeGroupId
required
string

Unique identifier of the NodeGroup to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Delete a Node from a Node Group

Deletes a node from a specific node group in a Kubernetes cluster.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
clusterId
required
string

Unique identifier of the Kubernetes cluster.

nodeGroupId
required
string

Unique identifier of the node group.

query Parameters
serverId
required
string

Unique identifier of the server.

Request Body schema: application/json
required
nodeId
string

Unique identifier of the node to be deleted from the node group.

Responses

Request samples

Content type
application/json
{
  • "nodeId": "node-12345"
}

Response samples

Content type
application/json
{
  • "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

CCE - Limits

Provides API endpoints to retrieve project-specific limits, such as resource quotas, available resources, and usage statistics for Kubernetes clusters in OpenStack.

Get OpenStack project limits

Returns the quota limits for a given OpenStack project. These limits specify the maximum resources available for compute, storage, and networking, including instances, volumes, floating IPs, security groups, and load balancers.

  • A value of -1 indicates an unlimited resource.
  • The serverId query parameter is required and is used to identify the specific server.
Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
projectId
required
string

The ID of the OpenStack project to retrieve limits for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "cores": 0,
  • "fixed_ips": 0,
  • "floating_ips": 0,
  • "injected_file_content_bytes": 0,
  • "injected_file_path_bytes": 0,
  • "injected_files": 0,
  • "instances": 0,
  • "key_pairs": 0,
  • "metadata_items": 0,
  • "ram": 0,
  • "security_group_rules": 0,
  • "security_groups": 0,
  • "server_group_members": 0,
  • "server_groups": 0,
  • "network": 0,
  • "subnet": 0,
  • "subnetpool": 0,
  • "port": 0,
  • "router": 0,
  • "volumes": 0,
  • "gigabytes": 0,
  • "backups": 0,
  • "backup_gigabytes": 0,
  • "volumes_NVME_SSD": 0,
  • "gigabytes_NVME_SSD": 0,
  • "snapshots_NVME_SSD": 0,
  • "load_balancer": 0,
  • "listener": 0,
  • "pool": 0,
  • "member": 0,
  • "health_monitor": 0,
  • "hard_limit": 0
}

CCE - LoadBalancer

This category includes API endpoints related to LoadBalancer management in the Cloud Container Engine (CCE). Load balancers distribute network traffic across multiple backend servers, ensuring high availability and scalability for applications running in the OpenStack Kubernetes environment.

Retrieve Load Balancers

Returns a list of Load Balancers associated with the specified serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Load Balancer

Creates a new Load Balancer in OpenStack with the specified configuration.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

Name of the Load Balancer.

description
string

Optional description of the Load Balancer.

vip_address
string

Virtual IP address for the Load Balancer.

vip_network_id
string

Network ID for the Load Balancer.

vip_subnet_id
string

Subnet ID for the Load Balancer.

vip_port_id
string

Port ID for the Load Balancer.

floatingIP
string

Floating IP assigned to the Load Balancer.

flavorId
required
string

Flavor ID for the Load Balancer.

external_network_id
string

External network ID.

networkType
required
string
Enum: "Virtual" "Physical"

Network type (Virtual or Physical).

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "vip_address": "string",
  • "vip_network_id": "string",
  • "vip_subnet_id": "string",
  • "vip_port_id": "string",
  • "floatingIP": "string",
  • "flavorId": "string",
  • "external_network_id": "string",
  • "networkType": "Virtual",
  • "listener": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string"
}

Get Load Balancer Details

Retrieves detailed information about a specific Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to retrieve details for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "floatingIp": "string",
  • "description": "string",
  • "balancingPools": [
    ],
  • "highAvailability": true,
  • "network": {
    },
  • "createdOn": "2019-08-24T14:15:22Z",
  • "membersState": { },
  • "membersTotal": 0,
  • "flavorName": "string"
}

Update Load Balancer

Updates the configuration of an existing Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to update.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The new name for the Load Balancer.

description
string or null

The new description for the Load Balancer.

enabled
boolean

Flag to enable or disable the Load Balancer.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Delete Load Balancer

Deletes an existing Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to delete.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Get details of a specific listener for a Load Balancer

Retrieves detailed information about a listener associated with a specific Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to which the listener belongs.

listenerId
required
string

The ID of the listener to retrieve details for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lb_protocol": "string",
  • "lb_protocol_port": 0,
  • "description": "string",
  • "loadbalancer_id": "string",
  • "status": "string",
  • "membersTotal": 0,
  • "membersState": "string",
  • "createdOn": "2019-08-24T14:15:22Z"
}

Get statistics of a specific listener for a Load Balancer

Retrieves statistical data about a listener associated with a specific Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to which the listener belongs.

listenerId
required
string

The ID of the listener to retrieve statistics for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lb_protocol": "string",
  • "lb_protocol_port": 0,
  • "totalConnections": 0,
  • "activeConnections": 0,
  • "trafficIn": 0,
  • "trafficOut": 0,
  • "errors": 0,
  • "status": "string"
}

Retrieve monitoring data for a load balancer

Retrieves monitoring data such as active connections, request errors, and network traffic for the specified load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer for which monitoring data is requested.

query Parameters
serverId
required
string

The server ID to filter the monitoring data.

start
required
number

The start timestamp for the monitoring data.

end
required
number

The end timestamp for the monitoring data.

service
required
string
Enum: "loadbalancer" "pool"

The service type for monitoring. Can be either 'loadbalancer' or 'pool'.

step
required
number

The time step (granularity) for the monitoring data.

Responses

Response samples

Content type
application/json
{
  • "active_connection": 0,
  • "request_errors": 0,
  • "network_rx": 0,
  • "network_tx": 0
}

CCE - LoadBalancer - Listener

Manages listeners in a load balancer within an OpenStack-based CCE environment. Listeners control traffic routing to backend pools based on protocol and port.

Get Listeners for Load Balancer

Retrieves all listeners associated with a specific Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer for which to retrieve listeners.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "listeners": [
    ]
}

Create a new listener for a Load Balancer

Creates a new listener and associates it with a specific Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to which the listener will be added.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The name of the listener.

lb_protocol
string
Enum: "HTTPS" "HTTP" "TCP" "UDP"

The protocol used by the listener (e.g., HTTPS, HTTP, TCP, UDP).

lb_protocol_port
integer

The port on which the listener will listen.

description
string

An optional description for the listener.

loadbalancer_id
string

The ID of the load balancer the listener will be associated with.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "lb_protocol": "HTTPS",
  • "lb_protocol_port": 0,
  • "description": "string",
  • "loadbalancer_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lb_protocol": "string",
  • "lb_protocol_port": 0,
  • "description": "string",
  • "loadbalancer_id": "string"
}

Update listener settings for a Load Balancer

Updates various configuration settings for a specific listener associated with a Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to which the listener belongs.

listenerId
required
string

The ID of the listener to update.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
description
string

A brief description of the listener.

admin_state_up
boolean

Indicates whether the listener is enabled or disabled.

connection_limit
number

The maximum number of concurrent connections allowed for the listener.

name
string

The name of the listener.

default_pool_id
string

The ID of the default pool associated with the listener.

allowed_cidrs
Array of strings

A list of CIDR blocks that are allowed to connect to the listener.

object
timeout_client_data
number

The timeout for client data in seconds.

timeout_member_connect
number

The timeout for member connection in seconds.

timeout_member_data
number

The timeout for member data in seconds.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "admin_state_up": true,
  • "connection_limit": 0,
  • "name": "string",
  • "default_pool_id": "string",
  • "allowed_cidrs": [
    ],
  • "insert_headers": {
    },
  • "timeout_client_data": 0,
  • "timeout_member_connect": 0,
  • "timeout_member_data": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "connection_limit": 0,
  • "description": "string",
  • "default_pool_id": "string",
  • "allowed_cidrs": [
    ]
}

Delete a specific listener from a Load Balancer

Deletes a listener associated with a Load Balancer by the provided listener ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer from which the listener will be deleted.

listenerId
required
string

The ID of the listener to delete.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - LoadBalancer - Pool

Manages pools in a load balancer within an OpenStack-based CCE environment. Pools group backend servers to distribute incoming traffic for improved scalability and availability.

Get all pools associated with a specific Load Balancer

Retrieves a list of all pools associated with the provided Load Balancer ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer for which the pools are being requested.

query Parameters
serverId
required
string

The ID of the server for which the associated pools are being retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new pool for a specified Load Balancer

Creates a new pool and associates it with the provided Load Balancer ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer to which the new pool will be added.

query Parameters
serverId
required
string

The ID of the server where the pool should be created.

Request Body schema: application/json
required
listener_id
required
string

The ID of the listener associated with the pool.

backend_protocol
required
string
Enum: "HTTP" "HTTPS" "TCP" "UDP"

The protocol used for backend communication.

backend_protocol_port
required
integer

The port used for backend communication.

lb_algorithm
required
string
Enum: "LEAST_CONNECTIONS" "ROUND_ROBIN" "SOURCE_IP"

The load balancing algorithm to be used for the pool.

Responses

Request samples

Content type
application/json
{
  • "listener_id": "string",
  • "backend_protocol": "HTTP",
  • "backend_protocol_port": 0,
  • "lb_algorithm": "LEAST_CONNECTIONS"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "lb_algorithm": "string"
}

Get details of a specific pool

Retrieves detailed information about a specific pool associated with a Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer that contains the pool.

poolId
required
string

The ID of the pool whose details are to be retrieved.

query Parameters
serverId
required
string

The ID of the server where the pool exists.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "protocol": "string",
  • "protocol_port": 0,
  • "lb_algorithm": "string",
  • "members": [
    ],
  • "created_on": "2019-08-24T14:15:22Z"
}

Update a specific load balancer pool

Updates the configuration of a specific pool associated with a Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer that contains the pool.

poolId
required
string

The ID of the pool to be updated.

query Parameters
serverId
required
string

The ID of the server where the pool exists.

Request Body schema: application/json
required
lb_algorithm
string
Enum: "LEAST_CONNECTIONS" "ROUND_ROBIN" "SOURCE_IP"

The load balancing algorithm applied to the pool.

sticky_session
boolean

Enables or disables sticky sessions for the pool.

Responses

Request samples

Content type
application/json
{
  • "lb_algorithm": "LEAST_CONNECTIONS",
  • "sticky_session": true
}

Delete a specific load balancer pool

Deletes a specific pool from the given Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer that contains the pool.

poolId
required
string

The ID of the pool to be deleted.

query Parameters
serverId
required
string

The ID of the server where the pool exists.

Responses

CCE - LoadBalancer - Balancing Pool

Manages balancing pools in a load balancer within an OpenStack-based CCE environment. Balancing pools distribute incoming traffic among backend servers to ensure load distribution and high availability.

Get list of balancing pools

Retrieves a list of balancing pools for the specified Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer.

query Parameters
serverId
required
string

The ID of the server where the Load Balancer exists.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new balancing pool

Creates a new balancing pool for the specified Load Balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer.

query Parameters
serverId
required
string

The ID of the server where the Load Balancer exists.

Request Body schema: application/json
required
sticky_session
boolean

Enable or disable session persistence.

certificate
string or null

SSL certificate for HTTPS/TLS termination.

private_key
string or null

Private key for the SSL certificate.

interval
number

Interval between health checks (in seconds).

timeout
number

Timeout for health checks (in seconds).

healthy_threshold
number

Number of successful checks before marking healthy.

unhealthy_threshold
number

Number of failed checks before marking unhealthy.

type
string
Enum: "HTTP" "HTTPS" "TCP" "PING" "UDP-CONNECT"

Health monitor type.

url_path
string or null

URL path for HTTP health checks.

backend_protocol
string
Enum: "HTTP" "HTTPS" "TCP" "UDP"

Backend protocol used by the pool.

backend_protocol_port
number

Backend port used by pool members.

lb_algorithm
string
Enum: "LEAST_CONNECTIONS" "ROUND_ROBIN" "SOURCE_IP"

Load balancing algorithm.

lb_protocol
string
Enum: "HTTPS" "HTTP" "TCP" "UDP" "TERMINATED_HTTPS"

Load balancer protocol.

lb_port
number

Load balancer port.

connection_limit
number or null

Maximum allowed connections.

allowed_cidrs
Array of strings

Allowed CIDR ranges for traffic.

object

Additional HTTP headers to be inserted.

timeout_client_data
number or null

Timeout for client data transmission.

timeout_member_connect
number or null

Timeout for backend connection.

timeout_member_data
number or null

Timeout for backend data transmission.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "sticky_session": true,
  • "certificate": "string",
  • "private_key": "string",
  • "interval": 0,
  • "timeout": 0,
  • "healthy_threshold": 0,
  • "unhealthy_threshold": 0,
  • "type": "HTTP",
  • "url_path": "string",
  • "backend_protocol": "HTTP",
  • "backend_protocol_port": 0,
  • "lb_algorithm": "LEAST_CONNECTIONS",
  • "lb_protocol": "HTTPS",
  • "lb_port": 0,
  • "connection_limit": 0,
  • "allowed_cidrs": [
    ],
  • "insert_headers": {
    },
  • "timeout_client_data": 0,
  • "timeout_member_connect": 0,
  • "timeout_member_data": 0,
  • "members": [
    ]
}

Get details of a balancing pool

Retrieves detailed information about a specific balancing pool.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer.

poolId
required
string

The ID of the balancing pool.

query Parameters
serverId
required
string

The ID of the server where the Load Balancer exists.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "balancingAlgorithm": "string",
  • "stickySession": "Enabled",
  • "healthMonitorId": "string",
  • "protocol": "string",
  • "urlPath": "string",
  • "interval": 0,
  • "timeout": 0,
  • "healthyThreshold": 0,
  • "unHealthyThreshold": 0,
  • "membersTotal": 0,
  • "listenerId": "string",
  • "lbProtocol": "string",
  • "backEndProtocol": "string",
  • "lbProtocolPort": 0,
  • "backEndProtocolPort": 0,
  • "membersState": [
    ],
  • "connectionLimit": 0,
  • "allowedCidrs": [
    ],
  • "insertHeaders": {
    },
  • "timeoutClientData": 0,
  • "timeoutMemberConnect": 0,
  • "timeoutMemberData": 0
}

Delete a balancing pool

Deletes a specific balancing pool from the load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the Load Balancer.

poolId
required
string

The ID of the balancing pool to be deleted.

query Parameters
serverId
required
string

The ID of the server where the Load Balancer exists.

Responses

CCE - LoadBalancer - Member

Manages members in a load balancer pool within an OpenStack-based CCE environment. Members are backend servers that handle traffic directed by the load balancer.

List members for add member request

Retrieves a list of VM instances that can be added as members to a load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network to retrieve available VMs.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List members of a load balancer pool

Retrieves the list of members associated with a specific load balancer pool.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

poolId
required
string

The ID of the pool.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a member to a load balancer pool

Adds a new member to a specified load balancer pool.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

poolId
required
string

The ID of the pool.

query Parameters
serverId
required
string

The ID of the server making the request.

Request Body schema: application/json

Data for the new pool member to be added.

name
string

The name of the pool member.

weight
number

The weight of the member.

admin_state_up
boolean

Whether the member is enabled or disabled.

monitor_port
number

The port to be monitored for the member.

monitor_address
string

The address to be monitored for the member.

backup
boolean

Indicates if the member is a backup member.

address
string

The IP address of the member.

compute_server_id
string

The ID of the compute server associated with the member.

protocol_port
number

The protocol port to be used by the member.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "weight": 0,
  • "admin_state_up": true,
  • "monitor_port": 0,
  • "monitor_address": "string",
  • "backup": true,
  • "address": "192.168.0.1",
  • "compute_server_id": "server-001",
  • "protocol_port": 80
}

Batch update members of a load balancer pool

Updates multiple members of a specified load balancer pool in a single request (batch update).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

poolId
required
string

The ID of the pool.

query Parameters
serverId
required
string

The ID of the server making the request.

Request Body schema: application/json

Data for batch updating the members of the pool.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "members": [
    ]
}

Update a specific member in the pool

Updates the details of a specific member within a load balancer pool.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

poolId
required
string

The ID of the pool.

memberId
required
string

The ID of the member to update.

query Parameters
serverId
required
string

The ID of the server making the request.

Request Body schema: application/json

Data for updating the specific pool member.

name
string

The name of the pool member.

weight
number

The weight of the pool member.

enabled
boolean

Whether the pool member is enabled or disabled.

monitor_port
number

The port to be monitored for the pool member.

monitor_address
string

The address to be monitored for the pool member.

backup
boolean

Indicates whether the pool member is a backup member.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "weight": 0,
  • "enabled": true,
  • "monitor_port": 0,
  • "monitor_address": "string",
  • "backup": true
}

Delete a specific member from the pool

Deletes a specific member from a load balancer pool.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

poolId
required
string

The ID of the pool.

memberId
required
string

The ID of the member to delete.

query Parameters
serverId
required
string

The server ID associated with the member to be deleted.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

CCE - LoadBalancer - Health Monitor

Manages health monitors in a load balancer within an OpenStack-based CCE environment. Health monitors check the status of backend servers to ensure traffic is only sent to healthy members.

List health monitors for a specific load balancer

Retrieves a list of health monitors associated with a given load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer.

query Parameters
serverId
required
string

The server ID associated with the load balancer to retrieve health monitors for.

Responses

Create a health monitor for a specific load balancer

Adds a new health monitor to the specified load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer to which the health monitor will be added.

query Parameters
serverId
required
string

The server ID associated with the load balancer to create the health monitor.

Request Body schema: application/json
required
pool_id
string

The ID of the pool to associate with the health monitor.

interval
number

The interval (in seconds) between health check attempts.

timeout
number

The timeout (in seconds) for each health check.

healthy_threshold
number

The number of successful checks required to consider the monitor healthy.

unhealthy_threshold
number

The number of failed checks required to consider the monitor unhealthy.

type
string
Enum: "HTTP" "HTTPS" "TCP" "PING"

The type of health monitor. One of 'HTTP', 'HTTPS', 'TCP', or 'PING'.

url_path
string

The URL path to use for HTTP/HTTPS health checks.

Responses

Request samples

Content type
application/json
{
  • "pool_id": "string",
  • "interval": 0,
  • "timeout": 0,
  • "healthy_threshold": 0,
  • "unhealthy_threshold": 0,
  • "type": "HTTP",
  • "url_path": "string"
}

Get details of a health monitor

Retrieves the details of a specific health monitor for the specified load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer where the health monitor is located.

hmId
required
string

The ID of the health monitor whose details are being requested.

query Parameters
serverId
required
string

The server ID associated with the health monitor.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "protocol": "string",
  • "urlPath": "string",
  • "interval": 0,
  • "timeout": 0,
  • "healthyThreshold": 0,
  • "unHealthyThreshold": 0
}

Update a health monitor

Updates the configuration of an existing health monitor for the specified load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer containing the health monitor.

hmId
required
string

The ID of the health monitor to be updated.

query Parameters
serverId
required
string

The server ID associated with the health monitor.

Request Body schema: application/json

The data to update the health monitor configuration.

interval
required
number

The interval (in seconds) between health check attempts.

timeout
required
number

The timeout (in seconds) for each health check.

healthy_threshold
required
number

The number of successful checks required to consider the monitor healthy.

unhealthy_threshold
required
number

The number of failed checks required to consider the monitor unhealthy.

url_path
required
string

The URL path for health checks, if applicable.

Responses

Request samples

Content type
application/json
{
  • "interval": 0,
  • "timeout": 0,
  • "healthy_threshold": 0,
  • "unhealthy_threshold": 0,
  • "url_path": "string"
}

Delete a health monitor

Deletes an existing health monitor for the specified load balancer.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
loadBalancerId
required
string

The ID of the load balancer containing the health monitor.

hmId
required
string

The ID of the health monitor to be deleted.

query Parameters
serverId
required
string

The server ID associated with the health monitor to be deleted.

Responses

CCE - Network

Manages networks within an OpenStack-based CCE environment. Networks provide connectivity for Kubernetes clusters, enabling communication between nodes and services.

Retrieve network details

Retrieves a list of networks with optional filters for name and network type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

name
string

Optional filter by network name.

networkType
string
Enum: "private" "public" "hybrid"

Optional filter by network type (e.g., "private", "public", "hybrid").

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new network

Creates a new network with the specified IP address management and other settings.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
IP_address_management
required
boolean

Whether IP address management is enabled.

name
required
string

The name of the network.

cidr
required
string^(?!0)(?!.*0$)(?!.*\.$)(?:[0-9]{1,3}\.){3}[0-...

The CIDR block for the network (must be IPv4).

Array of objects
dns_nameservers
Array of strings <ipv4> [ items <ipv4 > ]

List of DNS nameservers for the network.

enable_dhcp
boolean

Whether DHCP is enabled for the network.

gateway_ip
string <ipv4>

The gateway IP address for the network.

ip_version
integer

The IP version (e.g., 4 for IPv4, 6 for IPv6).

Responses

Request samples

Content type
application/json
{
  • "IP_address_management": true,
  • "name": "string",
  • "cidr": "string",
  • "allocation_pools": [
    ],
  • "dns_nameservers": [
    ],
  • "enable_dhcp": true,
  • "gateway_ip": "192.168.0.1",
  • "ip_version": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "cidr": "string",
  • "allocation_pools": [
    ],
  • "dns_nameservers": [
    ],
  • "enable_dhcp": true,
  • "gateway_ip": "192.168.0.1",
  • "ip_version": 0
}

Get network details

Retrieves detailed information about a specific network, including its configuration and subnets.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network for which details are being requested.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "networkConfiguration": {
    },
  • "subnets": [
    ]
}

Update network details

Updates the name of a specific network identified by the networkId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The new name for the network.

Responses

Request samples

Content type
application/json
{
  • "name": "New Network Name"
}

Delete a network

Deletes a specified network from OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - Network - Subnet

Manages subnets within an OpenStack-based CCE environment. Subnets define IP address ranges and network segmentation for Kubernetes clusters.

Get subnet details

Retrieves the details of a specific subnet within a network.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network the subnet belongs to.

subnetId
required
string

The ID of the subnet whose details are being requested.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Update subnet configuration

Updates the configuration of a specific subnet within a network.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
networkId
required
string

The ID of the network the subnet belongs to.

subnetId
required
string

The ID of the subnet to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
gateway_ip
string <ipv4>

The gateway IP address of the subnet. Can be null.

required
Array of objects non-empty

A list of IP allocation pools within the subnet.

dns_nameservers
required
Array of strings <ipv4> non-empty [ items <ipv4 > ]

A list of DNS nameservers to be used in the subnet.

enable_dhcp
required
boolean

Whether DHCP is enabled for the subnet.

Responses

Request samples

Content type
application/json
{
  • "gateway_ip": "192.168.0.1",
  • "allocation_pools": [
    ],
  • "dns_nameservers": [
    ],
  • "enable_dhcp": true
}

CCE - Project

Manages projects within an OpenStack-based CCE environment. Supports listing, modifying projects, and displaying resource quotas.

List OpenStack projects

Retrieves a list of OpenStack projects associated with the given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "lastServerId": "server-12345",
  • "lastProjectId": "project-67890",
  • "lastProject": "Development Project",
  • "projects": [
    ]
}

Change project

Change project for the given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
projectId
required
string

The ID of the project to create or update.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get OpenStack project quota

Retrieves quota and usage details for an OpenStack project.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

CCE - Regions

Manages regions within an OpenStack-based CCE environment.

Get OpenStack regions

Retrieves a list of available OpenStack regions.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Change OpenStack region

Changes the current OpenStack region.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
regionId
required
string

The ID of the region to switch to.

Responses

Request samples

Content type
application/json
{
  • "regionId": "region-1"
}

Response samples

Content type
application/json
{
  • "success": true
}

CCE - Router

Manages routers within an OpenStack-based CCE environment. Routers enable communication between different networks and manage traffic routing for Kubernetes clusters.

Get list of OpenStack routers

Retrieves a list of routers in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new OpenStack router

Creates a new router in the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

Name of the router.

external_networkId
string

The external network ID to attach the router to.

external_enableSnat
boolean

Whether SNAT should be enabled on the router.

subnetIds
Array of strings

List of subnet IDs to connect to the router.

Responses

Request samples

Content type
application/json
{
  • "name": "my-router",
  • "external_networkId": "network-12345",
  • "external_enableSnat": true,
  • "subnetIds": [
    ]
}

Update an existing OpenStack router

Updates the specified router with the given parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to update.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

Name of the router.

object or null

The external gateway configuration.

Responses

Request samples

Content type
application/json
{
  • "name": "updated-router",
  • "external_gateway_info": {
    }
}

Attach interfaces to virtual routers

Adds or updates the interface configuration on the specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to modify.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
network_id
string

The network ID to attach to the router interface.

Array of objects

A list of IP addresses to assign to the interface.

port_security_enabled
boolean

Whether port security is enabled for the interface.

Responses

Request samples

Content type
application/json
{
  • "network_id": "network-12345",
  • "fixed_ips": [
    ],
  • "port_security_enabled": true
}

List router interfaces

Retrieves the list of interfaces associated with a specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router whose interfaces are to be listed.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add or update routes on the router

Adds or updates the routes in the routing table of the specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to modify.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
nexthop
required
string

The next-hop IP address for the route.

destination
required
string

The destination IP address with CIDR for the route.

Responses

Request samples

Content type
application/json
{
  • "nexthop": "192.168.1.1",
  • "destination": "10.0.0.0/24"
}

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "routes": [
    ]
}

Update extra routes on the router

Updates the existing routes in the routing table of the specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to update routes for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
nexthop
required
string

The current next-hop IP address for the route to update.

destination
required
string

The current destination IP address with CIDR for the route to update.

newNextHop
required
string

The new next-hop IP address for the route.

newDestination
required
string

The new destination IP address with CIDR for the route.

Responses

Request samples

Content type
application/json
{
  • "nexthop": "192.168.1.1",
  • "destination": "10.0.0.0/24",
  • "newNextHop": "192.168.2.1",
  • "newDestination": "10.0.1.0/24"
}

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "updatedRoutes": [
    ]
}

Remove extra routes from the router

Removes the specified routes from the routing table of the given router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to remove routes from.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
nexthop
required
string

The next-hop IP address for the route to remove.

destination
required
string

The destination IP address with CIDR for the route to remove.

Responses

Request samples

Content type
application/json
{
  • "nexthop": "192.168.1.1",
  • "destination": "10.0.0.0/24"
}

Response samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "removedRoutes": [
    ]
}

Show router details

Retrieves the details of a specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router whose details are to be fetched.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Get external router details

Retrieves external router information including network and gateway details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "networkId": "0166bbb6-d42e-4002-9311-87a63aab1471",
  • "isExternal": true,
  • "dns": true,
  • "externalNetworkId": "external-network-id"
}

List static routes of a router

Retrieves a list of static routes for the specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to list static routes for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach or update a port to the router

Attach or update the network interface (port) to the specified router.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to attach the interface (port) to.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
port_id
required
string

The ID of the network port to be attached or updated.

Responses

Request samples

Content type
application/json
{
  • "port_id": "port-abc123"
}

Delete a router

Delete the specified router from the OpenStack environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
routerId
required
string

The ID of the router to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - Security Group

Manages security groups within an OpenStack-based CCE environment. Security groups control inbound and outbound traffic to Kubernetes cluster nodes for enhanced security.

Get the server's IP address

Retrieve the IP address of the server based on the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "ip": "192.168.0.1"
}

List security groups for the given serverId

Retrieve a list of security groups associated with a server based on the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new security group for the given serverId

Create a new security group associated with a specific server using the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the security group.

description
string

A description of the security group.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Get details of a specific security group for the given serverId

Retrieve the details of a specific security group by ID, associated with a specific server using the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group whose details are being requested.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "d": "string",
  • "protocol": "string",
  • "portRange": "string",
  • "source": "string"
}

Update a security group by ID

Update the name and description of a specific security group for the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The name of the security group.

description
string

A brief description of the security group. This field can be left empty.

Responses

Request samples

Content type
application/json
{
  • "name": "New Security Group",
  • "description": "Updated description of the security group"
}

Delete a security group by ID

Delete a specific security group for the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Get rules for a specific security group

Retrieve the rules associated with a specific security group for the provided serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group for which to retrieve rules.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Add a new rule to a security group

Add a new security group rule for the specified security group and server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to which the rule will be added.

query Parameters
serverId
required
string

The ID of the server where the security group is located.

Request Body schema: application/json
required
security_group_id
string

The ID of the security group to which the rule will be added.

remote_ip_prefix
string

The IP prefix (CIDR) for the rule's source or destination.

direction
string
Enum: "ingress" "egress"

The direction of the rule (either ingress or egress).

protocol
string

The protocol (e.g., TCP, UDP) for the rule.

ethertype
string
Enum: "IPv4" "IPv6"

The ethertype (IPv4 or IPv6) for the rule.

port_range_max
number

The maximum port for the rule (used with port range).

port_range_min
number

The minimum port for the rule (used with port range).

remote_group_id
string

The ID of a remote security group to which the rule applies.

Responses

Request samples

Content type
application/json
{
  • "security_group_id": "string",
  • "remote_ip_prefix": "string",
  • "direction": "ingress",
  • "protocol": "string",
  • "ethertype": "IPv4",
  • "port_range_max": 0,
  • "port_range_min": 0,
  • "remote_group_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Get details of a specific security group rule

Retrieve detailed information about a specific rule in the security group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to which the rule belongs.

securityGroupRuleId
required
string

The ID of the specific security group rule whose details are to be retrieved.

query Parameters
serverId
required
string

The ID of the server where the security group is located.

Responses

Delete a specific security group rule

Remove a specific rule from the security group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group containing the rule to delete.

securityGroupRuleId
required
string

The ID of the specific security group rule to delete.

query Parameters
serverId
required
string

The ID of the server where the security group is located.

Responses

CCE - Snapshot

Manages Snapshot within an OpenStack-based CCE environment.

Get a list of snapshots

Retrieve a list of snapshots for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Create a new snapshot

Creates a snapshot for the specified volume on a server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the snapshot.

volume_id
required
string

The ID of the volume from which the snapshot will be created.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "volume_id": "string"
}

Create an image from a snapshot

Converts a given snapshot into an image that can be used to create new instances.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
snapshotId
required
string

The ID of the snapshot to be converted into an image.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the newly created image.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Create a volume from a snapshot

Converts a given snapshot into a new volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
snapshotId
required
string

The ID of the snapshot to be converted into a volume.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the new volume.

snapshotId
required
string

The ID of the snapshot from which the volume will be created.

size
required
number

The size of the new volume in GB.

storagePolicy
required
string

The storage policy to be applied to the volume.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "snapshotId": "string",
  • "size": 0,
  • "storagePolicy": "string"
}

Update snapshot details

Updates the name or description of a given snapshot.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
snapshotId
required
string

The ID of the snapshot to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

The new name for the snapshot.

description
string or null

The new description for the snapshot. Can be null.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Delete a snapshot

Deletes a snapshot with the specified ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
snapshotId
required
string

The ID of the snapshot to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - SSH Key

Manages ssh key within an OpenStack-based CCE environment.

List SSH Keys

Retrieves a list of SSH key pairs associated with the given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new SSH Key

Adds a new SSH key pair to the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the SSH key pair.

publicKey
required
string

The public SSH key to be added.

Responses

Request samples

Content type
application/json
{
  • "name": "my-key",
  • "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA..."
}

Response samples

Content type
application/json
{
  • "id": "abc123",
  • "name": "my-key",
  • "created": "2024-01-15T12:34:56Z"
}

Get SSH Key Details

Retrieves details of a specific SSH key pair associated with the given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
keyName
required
string

The name of the SSH key pair.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "name": "my-key",
  • "fingerprint": "3a:ff:2c:1d:b6:4e:9f:3c:2d:7a:3b:5e:7d:fa:9c:7f",
  • "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA...",
  • "created": "2024-01-15T12:34:56Z"
}

Delete SSH Key

Deletes a specific SSH key pair associated with the given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
keyName
required
string

The name of the SSH key pair to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "message": "SSH key deleted successfully."
}

Generate SSH Key

Generates a new SSH key pair for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "name": "my-ssh-key",
  • "base64PublicKey": "c3NoLXJzYSBBQUFBQjNOemFD...",
  • "base64PrivateKey": "LS0tLS1CRUdJTiBQUklWQVRF..."
}

CCE - Virtual Machine

Manages virtual machine within an OpenStack-based CCE environment.

List Virtual Machines

Retrieves a list of virtual machines for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

status
string

Filter VMs by status (e.g., ACTIVE, SHUTOFF, ERROR).

task
string

Filter VMs by task state.

securityGroupName
string

Filter VMs by associated security group name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Virtual Machine

Creates a new virtual machine in OpenStack with the specified configuration.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string
flavorRef
string
key_name
string or null
user_data
string or null
Array of objects
object or null
Array of objects
Array of objects
isGPUImage
boolean
vmCount
integer >= 1

Responses

Request samples

Content type
application/json
Example
{
  • "name": "name",
  • "key_name": "ssh",
  • "user_data": "dGVzdA==",
  • "flavorRef": "100",
  • "type": "volume",
  • "networks": [
    ],
  • "block_device_mapping_v2": [
    ]
}

Get Virtual Machine Details

Retrieves detailed information about a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "5e63d012-2c78-4e5d-9d36-8f76f0c4b41f",
  • "name": "my-vm",
  • "status": "ACTIVE",
  • "creationTime": "2024-02-01T12:00:00Z",
  • "lastModified": "2024-02-10T15:30:00Z",
  • "image": "Ubuntu 22.04",
  • "imageOsType": "Linux",
  • "sshKey": "my-ssh-key",
  • "taskState": "None",
  • "flavor": {
    },
  • "fault": "Some error message"
}

Update a Virtual Machine

Updates the name of an existing virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "updated-vm-name"
}

Delete a Virtual Machine

Deletes a virtual machine from OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to be deleted.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Perform an action on a Virtual Machine

Executes a specified action on an OpenStack virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
action
required
string
Enum: "RebootSoft" "RebootHard" "start" "softStop" "shelve" "unshelve" "rescue" "unrescue" "consoleLog" "hardStop" "resize"

The action to be performed on the VM.

imageId
string

Required when action is rescue.

flavorRef
string

Required when action is resize.

Responses

Request samples

Content type
application/json
{
  • "action": "RebootSoft",
  • "imageId": "string",
  • "flavorRef": "string"
}

Get VM Action History

Retrieves a list of actions performed on a virtual machine in OpenStack, such as reboots, shutdowns, and volume attachments.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get VM Action History Detail

Retrieves details of a specific action performed on a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

historyId
required
string

The ID of the history record to retrieve.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Responses

Response samples

Content type
application/json
{
  • "dateAndTime": "2024-02-04T12:34:56Z",
  • "activity": "RebootSoft",
  • "status": "Success",
  • "initiator": "admin",
  • "id": "req-123456789"
}

Generate VM Remote Console URL

Generates a remote console URL for a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Responses

Response samples

Content type
application/json
{}

Get VM Monitoring Data

Retrieves monitoring metrics for a virtual machine within a specified time range.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

start
required
number <int64>

Start timestamp (Unix epoch format).

end
required
number <int64>

End timestamp (Unix epoch format).

step
required
number <int64>

Step interval in seconds for fetching monitoring data.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ],
  • "unit": "percentage, MB, IOPS, bytes",
  • "serverId": "server-123",
  • "start": 1712345600,
  • "end": 1712349200,
  • "step": 60,
  • "id": "vm-456"
}

CCE - Virtual Machine - Volume

Manages volumes for virtual machines within an OpenStack-based CCE environment. Volumes provide persistent storage for virtual machines, enabling data retention and scalability.

Get Volumes Attached to a Virtual Machine

Retrieves the list of volumes attached to a specific OpenStack virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach Volume to a Virtual Machine

Attaches a volume to a specific OpenStack virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
volumeId
required
string

The ID of the volume to attach.

Responses

Request samples

Content type
application/json
{
  • "volumeId": "string"
}

Create and Attach Volume to a Virtual Machine

Creates a new volume and attaches it to a specific OpenStack virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string

The name of the new volume.

size
required
number

The size of the volume in GB.

storagePolicy
required
string

The storage policy/type for the volume.

Responses

Request samples

Content type
application/json
{
  • "name": "my-volume",
  • "size": 100,
  • "storagePolicy": "high-performance"
}

Detach Volume from Virtual Machine

Detaches a specified volume from a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

volumeId
required
string

The ID of the volume to be detached.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

CCE - Virtual Machine - Network

Manages virtual machine networks within an OpenStack-based CCE environment. Provides network connectivity and configuration for virtual machines.

List Network Interfaces in VM

Retrieves a list of network interfaces attached to a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach Network Interface to VM

Attaches a network interface to a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Request Body schema: application/json
required
network_id
string

The ID of the network to attach.

mac_address
string

The MAC address for the network interface (optional).

Array of objects

List of fixed IPs to assign to the interface.

security_groups
Array of strings

Security groups to apply to the network interface.

Responses

Request samples

Content type
application/json
{
  • "network_id": "net-123456",
  • "mac_address": "fa:16:3e:12:34:56",
  • "fixed_ips": [
    ],
  • "security_groups": [
    ]
}

Update Network Interface on VM

Updates the network interface of a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

portId
required
string

The ID of the network interface (port) to update.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Request Body schema: application/json
required
mac_address
string

The new MAC address for the network interface (optional).

Array of objects

List of fixed IPs to assign to the interface (at least one of ip_version or ip_address is required).

security_groups
Array of strings

List of security groups to apply to the network interface.

Responses

Request samples

Content type
application/json
{
  • "mac_address": "fa:16:3e:12:34:56",
  • "fixed_ips": [
    ],
  • "security_groups": [
    ]
}

Detach Network Interface from VM

Detaches a network interface (port) from a virtual machine in OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

portId
required
string

The ID of the network interface (port) to detach.

query Parameters
serverId
required
string

The ID of the server where the VM is located.

Responses

CCE - Volume

Manages volumes within an OpenStack-based CCE environment. Provides persistent storage for Kubernetes clusters and virtual machines.

Get a list of volumes

Retrieves a list of volumes attached to a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new volume

Creates a new volume and attaches it to the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string
size
number [ 1 .. 8192 ]
storagePolicy
string
imageRef
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "MyVolume",
  • "size": 100,
  • "storagePolicy": "gold-tier",
  • "imageRef": "image-12345"
}

Response samples

Content type
application/json
{
  • "volumeId": "vol-12345",
  • "name": "MyVolume",
  • "status": "creating",
  • "policy": "gold-tier",
  • "size": 100,
  • "bootable": true,
  • "type": "HDD",
  • "diskSerialNumber": "SN-987654321"
}

Get volume details

Retrieves detailed information about a specific volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "vol-12345",
  • "name": "MyVolume",
  • "status": "in-use",
  • "attachedTo": "server-67890",
  • "attachedToStatus": "running",
  • "attachedToId": "vm-56789",
  • "size": 100,
  • "storagePolicy": "gold-tier",
  • "bootable": true,
  • "created": "2024-01-15T12:34:56Z",
  • "lastModified": "2024-02-01T08:22:30Z",
  • "volume_image_metadata": {
    },
  • "type": "HDD",
  • "isDetachable": true
}

List snapshots of a volume

Retrieves a list of snapshots for a specific volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "snapshots": [
    ]
}

Update volume

Updates the name or description of a specific volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "New Volume Name",
  • "description": "Updated description for the volume"
}

Delete a volume

Deletes a specific volume from OpenStack.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume to be deleted.

query Parameters
serverId
required
string

The ID of the server where the volume is attached.

Responses

Response samples

Content type
application/json
{
  • "message": "Volume deleted successfully."
}

Clone a volume

Creates a new volume by cloning an existing one.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume to be cloned.

query Parameters
serverId
required
string

The ID of the server where the volume is attached.

Request Body schema: application/json
required
name
required
string

Name of the new cloned volume.

size
required
number

Size of the new volume in GB.

storagePolicy
required
string

Storage policy for the new volume.

Responses

Request samples

Content type
application/json
{
  • "name": "Cloned Volume",
  • "size": 100,
  • "storagePolicy": "gold-tier"
}

Perform actions on a volume

Executes various actions on a specific OpenStack volume, such as extending, attaching, detaching, reverting, retyping, and uploading to an image.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume on which the action will be performed.

query Parameters
serverId
required
string

The ID of the server where the volume is attached.

Request Body schema: application/json
required
One of
object

Responses

Request samples

Content type
application/json
{
  • "osUploadImage": {
    }
}

Attach volume to a virtual machine

Attaches a specific volume to a virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume to be attached.

query Parameters
serverId
required
string

The ID of the server to which the volume will be attached.

Request Body schema: application/json
required
vmId
required
string

Responses

Request samples

Content type
application/json
{
  • "vmId": "b0a8cd1f-7c13-4d88-b09f-b1e88b02f647"
}

Force detach a volume from a virtual machine

Forcefully detaches a specific volume from a virtual machine, even if it is currently in use.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The ID of the volume to be forcefully detached.

query Parameters
serverId
required
string

The ID of the server from which the volume will be detached.

Request Body schema: application/json
required
vmId
required
string

Responses

Request samples

Content type
application/json
{
  • "vmId": "b0a8cd1f-7c13-4d88-b09f-b1e88b02f647"
}

Get all storage policies for volumes

Retrieves the list of storage policies available for volumes.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server for which the storage policies are being fetched.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CCE - VPN

Manages VPNs within an OpenStack-based CCE environment. VPNs enable secure, encrypted communication between networks or remote users and the Kubernetes cluster.

Get a list of VPNs

Retrieves a list of VPNs based on the optional filter for status and mandatory serverId.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server associated with the VPNs.

status
string

Optional filter to retrieve VPNs by their status (e.g., 'active', 'inactive').

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VPN configuration

Creates a new VPN configuration, including the associated IKE and IPsec policies, endpoints, and VPN settings.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server where the VPN configuration will be created.

Request Body schema: application/json
required
ikePolicyId
string
object
ipsecPolicyId
string
object
routerId
string

The ID of the router associated with the VPN.

localEndPointId
string

The ID of the local endpoint.

object
remoteEndPointId
string

The ID of the remote endpoint.

object
required
object

Responses

Request samples

Content type
application/json
{
  • "ikePolicyId": "string",
  • "ikePolicy": {
    },
  • "ipsecPolicyId": "string",
  • "ipsecPolicy": {
    },
  • "routerId": "string",
  • "localEndPointId": "string",
  • "localEndPoint": {
    },
  • "remoteEndPointId": "string",
  • "remoteEndPoint": {
    },
  • "vpn": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get VPN details

Retrieves detailed information about the VPN configuration, including the IPsec connection details and VPN parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN for which details are being requested.

query Parameters
serverId
required
string

The ID of the server where the VPN details will be retrieved from.

Responses

Response samples

Content type
application/json
{
  • "details": {
    },
  • "vpnParameters": {
    }
}

Show VPN Endpoints

Retrieves the local and remote endpoints for a given VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN for which endpoints are being requested.

query Parameters
serverId
required
string

The ID of the server where the VPN endpoints will be retrieved from.

Responses

Response samples

Content type
application/json
{
  • "localEndPoint": {
    },
  • "remoteEndPoint": {
    }
}

Show VPN Policies

Retrieves the IKE and IPsec policies for a given VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN for which policies are being requested.

query Parameters
serverId
required
string

The ID of the server where the VPN policies will be retrieved from.

Responses

Response samples

Content type
application/json
{
  • "ikePolicy": {
    },
  • "ipsecPolicy": {
    }
}

Delete VPN

Deletes a VPN connection from the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to be deleted.

query Parameters
serverId
required
string

The ID of the server where the VPN is located.

Responses

Update VPN

Updates an existing VPN connection with new configurations.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to be updated.

query Parameters
serverId
required
string

The ID of the server where the VPN is located.

Request Body schema: application/json
required
localEndPointId
string

The ID of the local endpoint.

object

Details of the local endpoint.

remoteEndPointId
string

The ID of the remote endpoint.

object

Details of the remote endpoint.

object

VPN configuration details.

Responses

Request samples

Content type
application/json
{
  • "localEndPointId": "string",
  • "localEndPoint": {
    },
  • "remoteEndPointId": "string",
  • "remoteEndPoint": {
    },
  • "vpn": {
    }
}

Restart a VPN

Restarts the specified VPN service.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to restart.

query Parameters
serverId
required
string

The ID of the server where the VPN service exists.

Responses

CCE - VPN - IKE

Manages IKE (Internet Key Exchange) configurations for VPNs within an OpenStack-based CCE environment. IKE is used for securely establishing and managing VPN connections between networks.

Get IKE policies for VPN

Retrieves the list of IKE (Internet Key Exchange) policies for VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "ikepolicies": [
    ]
}

Show IKE policy details

Retrieves the details of a specific IKE policy for a given VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

ikeId
required
string

The ID of the IKE policy to retrieve details for.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "ikepolicy": {
    }
}

Create a new IKE policy

Creates a new IKE policy for the given VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to which the IKE policy will be added.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string
pfs
required
string
auth_algorithm
required
string
encryption_algorithm
required
string
ike_version
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "vpn-ike-policy",
  • "pfs": "group14",
  • "auth_algorithm": "sha256",
  • "encryption_algorithm": "aes256",
  • "ike_version": "v2",
  • "lifetime": {
    }
}

Response samples

Content type
application/json
{
  • "ikepolicy": {
    }
}

Update an existing IKE policy

Updates the details of an existing IKE policy for the specified VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to which the IKE policy belongs.

ikeId
required
string

The ID of the IKE policy to be updated.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Request Body schema: application/json
required
name
required
string
pfs
required
string
auth_algorithm
required
string
encryption_algorithm
required
string
ike_version
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "name": "updated-ike-policy",
  • "pfs": "group14",
  • "auth_algorithm": "sha256",
  • "encryption_algorithm": "aes256",
  • "ike_version": "v2",
  • "lifetime": {
    }
}

Response samples

Content type
application/json
{
  • "ikepolicy": {
    }
}

Delete an IKE policy

Deletes the specified IKE policy from the VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN from which the IKE policy will be deleted.

ikeId
required
string

The ID of the IKE policy to be deleted.

query Parameters
serverId
required
string

The ID of the server where the IKE policy will be deleted.

Responses

CCE - VPN - Endpoint

Manages VPN endpoints within an OpenStack-based CCE environment. VPN endpoints define the connection points for secure communication between different networks or users.

Get VPN endpoint details

Retrieves the details of the VPN endpoint, including the subnets and endpoints.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server associated with the VPN endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "description": "string",
  • "endpoints": [
    ],
  • "subnets": [
    ]
}

Get detailed information about a VPN endpoint

Retrieves detailed information about a specific VPN endpoint, including its group details and associated endpoints.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

endpointId
required
string

The ID of the endpoint.

query Parameters
serverId
required
string

The ID of the server associated with the VPN endpoint.

Responses

Response samples

Content type
application/json
{
  • "endpoint_group": {
    }
}

Create a new VPN endpoint group

Creates a new endpoint group for the specified VPN, including the list of endpoints and other required details.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

query Parameters
serverId
required
string

The ID of the server associated with the VPN endpoint.

Request Body schema: application/json
required
name
string

The name of the endpoint group.

type
string

The type of the endpoint group.

endpoints
Array of strings

A list of endpoints for the group.

Responses

Request samples

Content type
application/json
{
  • "name": "my-endpoint-group",
  • "type": "vpn-endpoint",
  • "endpoints": [
    ]
}

Response samples

Content type
application/json
{
  • "endpoint_group": {
    }
}

Update an existing VPN endpoint group

Updates the name of an existing VPN endpoint group for the specified VPN and endpoint group ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

endpointId
required
string

The ID of the endpoint group to update.

query Parameters
serverId
required
string

The ID of the server associated with the VPN endpoint.

Request Body schema: application/json
required
name
string

The new name of the endpoint group.

Responses

Request samples

Content type
application/json
{
  • "name": "updated-endpoint-group"
}

Response samples

Content type
application/json
{
  • "endpoint_group": {
    }
}

Delete a VPN endpoint group

Deletes a specified VPN endpoint group for the given VPN and endpoint group ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

endpointId
required
string

The ID of the endpoint group to delete.

query Parameters
serverId
required
string

The ID of the server associated with the VPN endpoint.

Responses

CCE - VPN - Ipsec Policies

Manages IPsec policies for VPNs within an OpenStack-based CCE environment. IPsec policies define the encryption and security settings for secure communication over VPN connections.

Get IPSec VPN policies

Retrieves a list of IPSec VPN policies for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server associated with the IPSec policies.

Responses

Response samples

Content type
application/json
{
  • "ipsecpolicies": [
    ]
}

Get details of a specific IPSec VPN policy

Retrieves the details of a specific IPSec VPN policy for the specified VPN and IPSec policy IDs.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

ipsecId
required
string

The ID of the IPSec policy.

query Parameters
serverId
required
string

The ID of the server associated with the IPSec policy.

Responses

Response samples

Content type
application/json
{
  • "ipsecpolicy": {
    }
}

Create a new IPSec policy for the specified VPN

Creates a new IPSec policy for a VPN based on the provided parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to associate the IPSec policy with.

query Parameters
serverId
required
string

The ID of the server associated with the IPSec policy.

Request Body schema: application/json
required
name
required
string

The name of the IPSec policy.

pfs
required
string

The PFS group for the IPSec policy.

auth_algorithm
required
string

The authentication algorithm for the IPSec policy.

encryption_algorithm
required
string

The encryption algorithm for the IPSec policy.

required
object
encapsulation_mode
required
string

The encapsulation mode for the IPSec policy.

transform_protocol
required
string

The transform protocol for the IPSec policy.

description
required
string

A description of the IPSec policy.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "pfs": "string",
  • "auth_algorithm": "string",
  • "encryption_algorithm": "string",
  • "lifetime": {
    },
  • "encapsulation_mode": "string",
  • "transform_protocol": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "ipsecpolicy": {
    }
}

Update an existing IPSec policy for the specified VPN

Updates the details of an existing IPSec policy based on the provided parameters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to associate the IPSec policy with.

ipsecId
required
string

The ID of the IPSec policy to update.

query Parameters
serverId
required
string

The ID of the server associated with the IPSec policy.

Request Body schema: application/json
required
name
string

The name of the IPSec policy.

pfs
string

The PFS group for the IPSec policy.

auth_algorithm
string

The authentication algorithm for the IPSec policy.

encryption_algorithm
string

The encryption algorithm for the IPSec policy.

object
encapsulation_mode
string

The encapsulation mode for the IPSec policy.

transform_protocol
string

The transform protocol for the IPSec policy.

description
string

A description of the IPSec policy.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "pfs": "string",
  • "auth_algorithm": "string",
  • "encryption_algorithm": "string",
  • "lifetime": {
    },
  • "encapsulation_mode": "string",
  • "transform_protocol": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "ipsecpolicy": {
    }
}

Delete an existing IPSec policy for the specified VPN

Deletes the specified IPSec policy from the given VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN to which the IPSec policy belongs.

ipsecId
required
string

The ID of the IPSec policy to delete.

query Parameters
serverId
required
string

The ID of the server associated with the IPSec policy.

Responses

CCE - VPN - Service

Manages VPN services within an OpenStack-based CCE environment. VPN services enable the creation, configuration, and management of secure VPN connections for network communication.

Get VPN Services

Retrieves a list of VPN services associated with the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server where the VPN services are located.

Responses

Response samples

Content type
application/json
{
  • "vpnservices": [
    ]
}

Get VPN Service Details

Retrieves detailed information about a specific VPN service.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

serviceId
required
string

The ID of the VPN service.

query Parameters
serverId
required
string

The ID of the server where the VPN service is located.

Responses

Response samples

Content type
application/json
{
  • "vpnservice": {
    }
}

Create a VPN Service

Creates a new VPN service associated with a specified VPN.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

query Parameters
serverId
required
string

The ID of the server where the VPN service will be created.

Request Body schema: application/json
required
router_id
required
string

The ID of the router associated with the VPN service.

name
required
string

The name of the VPN service.

admin_state_up
required
boolean

Indicates whether the VPN service should be administratively up.

Responses

Request samples

Content type
application/json
{
  • "router_id": "router-12345",
  • "name": "MyVPNService",
  • "admin_state_up": true
}

Update a VPN Service

Updates the details of an existing VPN service.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

serviceId
required
string

The ID of the VPN service to update.

query Parameters
serverId
required
string

The ID of the server where the VPN service exists.

Request Body schema: application/json
required
description
string

A description for the VPN service.

name
string

The new name for the VPN service.

admin_state_up
boolean

Indicates whether the VPN service should be administratively up.

Responses

Request samples

Content type
application/json
{
  • "description": "Updated VPN service description.",
  • "name": "UpdatedVPNService",
  • "admin_state_up": true
}

Response samples

Content type
application/json
{
  • "vpnservice": {
    }
}

Delete a VPN Service

Deletes an existing VPN service by its ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vpnId
required
string

The ID of the VPN.

serviceId
required
string

The ID of the VPN service to delete.

query Parameters
serverId
required
string

The ID of the server where the VPN service exists.

Responses

DBP - Environment - Action

Provides actions for managing environments, including resetting database passwords, restarting nodes, and controlling environment states by appId.

Start an environment action

Starts an action for the specified application environment. Only database and storage are allowed as the type parameter.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

type
required
string
Enum: "database" "storage"

The type of action to start (only database or storage are allowed).

query Parameters
serverId
required
string

The ID of the server.

Responses

Stop an environment action

Stops an action for the specified application environment. Only database and storage are allowed as the type parameter.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

type
required
string
Enum: "database" "storage"

The type of action to stop (only database or storage are allowed).

query Parameters
serverId
required
string

The ID of the server.

Responses

Put an environment action to sleep

Puts an action for the specified application environment to sleep. Only database and storage are allowed as the type parameter.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

type
required
string
Enum: "database" "storage"

The type of action to put to sleep (only database or storage are allowed).

query Parameters
serverId
required
string

The ID of the server.

Responses

Restart nodes in the environment

Restarts nodes for the specified application environment. Only database and storage are allowed as the type parameter.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

type
required
string
Enum: "database" "storage"

The type of nodes to restart (only database or storage are allowed).

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
nodeId
required
number

The ID of the node to restart.

nodeGroup
required
string

The group to which the node belongs.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 123,
  • "nodeGroup": "primary-group"
}

Reset password for a DBP environment

Resets the password for a specific node in the application environment. Only database and storage are allowed as the type parameter.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
password
required
string

The new password to be set.

nodeGroup
required
string

The group to which the node belongs.

Responses

Request samples

Content type
application/json
{
  • "password": "NewSecurePassword123!",
  • "nodeGroup": "primary-group"
}

DBP - Environment - Alert

Manages environment alert triggers, including retrieval, addition, editing, enabling/disabling, deletion, and viewing alert execution history.

Get alerts for a DBP environment

Retrieves alerts configured for a specific application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "com.hivext.api.server.system.persistence.Trigger"
}

Create an alert for a DBP environment

Adds a new alert for the specified application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "object": {
    }
}

Update an existing alert for a DBP environment

Updates an existing alert for the specified application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
id
required
integer

The ID of the alert to be updated.

required
object

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "object": {
    }
}

Enable or disable an alert

Enables or disables an existing alert for the specified application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
id
required
integer

The ID of the alert to be updated.

enabled
required
boolean

Whether the alert should be enabled (true) or disabled (false).

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "enabled": true
}

Delete an alert

Deletes a specific alert for the given application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

id
required
integer

The ID of the alert to be deleted.

query Parameters
serverId
required
string

The ID of the server.

Responses

Get alert history

Retrieves the alert history for a given application environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
startTime
required
string

Start time for filtering history.

endTime
required
string

End time for filtering history.

startRow
integer

The starting row for pagination.

resultCount
integer

Number of results to return.

skipResults
integer

Number of results to skip.

nodeGroup
string

Filter results by node group.

resourceTypes
string
Enum: "CLOUDLETS" "MEM" "CPU" "DISK" "INODES" "DISK_IOPS" "DISK_IO" "NET_EXT" "NET_EXT_OUT" "OOM_KILLER"

Filter results by resource type.

orderField
string

The field by which to order the results.

orderDirection
string

The sorting direction (e.g., ASC, DESC).

Responses

Request samples

Content type
application/json
{
  • "startTime": "string",
  • "endTime": "string",
  • "startRow": 0,
  • "resultCount": 0,
  • "skipResults": 0,
  • "nodeGroup": "string",
  • "resourceTypes": "CLOUDLETS",
  • "orderField": "string",
  • "orderDirection": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string",
  • "totalCount": 0
}

DBP - Environment - Backup

Manages environment backups, including retrieval, installation, execution, restoration, update, and deletion of backup add-ons.

Get Environment Backup Info

Retrieves backup information for the specified environment. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
nodeGroup
required
string

The node group of the environment.

nodeType
required
string

The type of node in the environment.

Responses

Request samples

Content type
application/json
{
  • "nodeGroup": "string",
  • "nodeType": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "response": {
    }
}

Get UI Info for Backup Addon

Retrieves UI configuration information for the backup add-on. The serverId query parameter is required.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "response": {
    }
}

Install Backup Addon

Installs the backup add-on for a specific application with the given configuration settings.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
nodeGroup
required
string

Node group for the backup.

required
object

Responses

Request samples

Content type
application/json
{
  • "nodeGroup": "string",
  • "settings": {
    }
}

Execute Backup Action

Executes a backup-related action (backup, configure, or restore) for a specific application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application.

appUniqueName
required
string

The unique name of the application.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
action
required
string
Enum: "backup" "configure" "restore"

The action to perform.

nodeGroup
required
string

Node group for the action.

object or object

Responses

Request samples

Content type
application/json
{
  • "action": "backup",
  • "nodeGroup": "string",
  • "settings": {
    }
}

Get Restore Point for Environment

Retrieves the restore points available for a specific environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appUniqueName
required
string

The unique name of the application.

query Parameters
serverId
required
string

The ID of the server.

Responses

Delete a Backup

Deletes a specific backup for the given application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appid
required
string

The application ID.

appUniqueName
required
string

The unique name of the backup.

query Parameters
serverId
required
string

The ID of the server.

Responses

DBP - Environment - Endpoint

Manages environment endpoints, including retrieval, addition, modification, and deletion of endpoints.

Get Environment Endpoint

Retrieves endpoint details for the given application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appid
required
string

The application ID.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "nodeGroup": "string",
  • "id": 0,
  • "name": "string",
  • "nodeId": 0,
  • "privatePort": 0,
  • "protocol": "string",
  • "publicPort": 0,
  • "url": "string"
}

Create Environment Endpoint

Creates a new endpoint for the specified application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appid
required
string

The application ID.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
nodeId
required
integer

The node ID where the endpoint will be created.

name
required
string

The name of the endpoint.

privatePort
required
integer

The private port for the endpoint.

protocol
required
string
Enum: "TCP" "UDP"

The protocol used by the endpoint.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "name": "string",
  • "privatePort": 0,
  • "protocol": "TCP"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "object": {
    }
}

Update Environment Endpoint

Updates an existing endpoint for the specified application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appid
required
string

The application ID.

query Parameters
serverId
required
string

The ID of the server.

Request Body schema: application/json
required
id
required
integer

The unique identifier of the endpoint to be updated.

name
required
string

The updated name of the endpoint.

privatePort
required
integer

The updated private port for the endpoint.

protocol
required
string
Enum: "TCP" "UDP"

The updated protocol used by the endpoint.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "privatePort": 0,
  • "protocol": "TCP"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "object": {
    }
}

Delete an Endpoint Rule

Deletes a specific rule associated with an endpoint for the given application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appid
required
string

The application ID.

id
required
integer

The unique identifier of the rule to be deleted.

query Parameters
serverId
required
string

The ID of the server.

Responses

DBP - Environment

Handles environment management, including listing, creating, updating, deleting, and retrieving environment details and statistics.

List All Environments Info

Retrieves a list of all environment information for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "infos": [
    ]
}

Create DBP Environment

Creates a new DBP environment with specified configurations.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server where the environment will be created.

Request Body schema: application/json
required
required
object
crossNetwork
required
boolean

Whether cross-networking is enabled.

required
object

Responses

Request samples

Content type
application/json
{
  • "env": {
    },
  • "crossNetwork": true,
  • "nodes": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "response": {
    }
}

Show Environment Info

Retrieves detailed information about a specific environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the environment.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "envGroups": [
    ],
  • "nodes": [
    ],
  • "nodesInternalDomains": [
    ],
  • "env": { },
  • "nodesData": [
    ],
  • "nodeGroups": { }
}

Update DBP Environment

Updates an existing DBP environment with the specified configurations.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the DBP environment to update.

query Parameters
serverId
required
string

The ID of the server where the environment is located.

Request Body schema: application/json
required
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "env": {
    },
  • "nodes": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0
}

Delete DBP Environment

Deletes a specific DBP environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the DBP environment to delete.

query Parameters
serverId
required
string

The ID of the server where the environment is located.

Responses

Response samples

Content type
application/json
{
  • "result": 0
}

Get SSH and SFTP Information

Retrieves SSH connection details and SFTP access information for a given environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the environment.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "ssh": "string",
  • "sftp": [
    ]
}

List All Environment Stats

Retrieves statistics for all environments.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List DBP Environment Statistics

Retrieves statistics for a specific DBP environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the DBP environment.

query Parameters
serverId
required
string

The ID of the server where the environment is located.

Request Body schema: application/json
required
nodeGroup
required
string

The node group to retrieve statistics for.

duration
required
number

The duration in seconds for which stats should be retrieved.

interval
required
number

The time interval in seconds between each data point.

nodeId
number

The ID of the specific node (optional).

Responses

Request samples

Content type
application/json
{
  • "nodeGroup": "string",
  • "duration": 0,
  • "interval": 0,
  • "nodeId": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "stats": [
    ]
}

Check Domain Availability

Verifies if a specific domain is available in the environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server where the domain check should be performed.

Request Body schema: application/json
required
domain
required
string

The domain to check for availability.

Responses

Request samples

Content type
application/json
{
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "result": 0
}

DBP - Environment - Firewall

Manages environment firewall rules, including retrieving, adding, editing, enabling/disabling, and deleting inbound and outbound rules.

Get Environment Inbound Firewall Rules

Retrieves inbound firewall rules for the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which firewall rules are being retrieved.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "className": "string",
  • "rules": [
    ]
}

Get Environment Outbound Firewall Rules

Retrieves outbound firewall rules for the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which firewall rules are being retrieved.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "className": "string",
  • "rules": [
    ]
}

Set Environment Firewall

Enables or disables the firewall for the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which the firewall setting is being updated.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Request Body schema: application/json
required
enabled
required
boolean

Whether to enable (true) or disable (false) the firewall.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Set Rule Enabled Firewall

Enables or disables a specific firewall rule for the given environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which the firewall rule is being updated.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Request Body schema: application/json
required
ruleId
required
string

The ID of the firewall rule to be modified.

enabled
required
boolean

Whether to enable (true) or disable (false) the firewall rule.

Responses

Request samples

Content type
application/json
{
  • "ruleId": "string",
  • "enabled": true
}

Add Environment Firewall Rule

Adds a new firewall rule to the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which the firewall rule is being added.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Request Body schema: application/json
required
required
object
nodeGroup
required
string

The node group to which the rule is applied.

Responses

Request samples

Content type
application/json
{
  • "rule": {
    },
  • "nodeGroup": "string"
}

Edit Environment Firewall Rule

Updates an existing firewall rule in the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID for which the firewall rule is being updated.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Request Body schema: application/json
required
required
object
nodeGroup
required
string

The node group to which the rule is applied.

Responses

Request samples

Content type
application/json
{
  • "rule": {
    },
  • "nodeGroup": "string"
}

Delete Environment Firewall Rule

Deletes a specific firewall rule from the environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The application ID from which the firewall rule is being deleted.

ruleId
required
string

The ID of the firewall rule to delete.

query Parameters
serverId
required
string

The ID of the server where the environment exists.

Responses

DBP - Environment - Group

Manages environment groups, including listing, creating, updating, attaching, detaching, and deleting environment groups.

Get All Environment Groups

Retrieves a list of all environment groups.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP region. You can obtain valid region IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string"
}

Create Environment Group by Group Name

Creates a new environment group based on the provided group name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP region. You can obtain valid region IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
groupName
string

The name of the environment group to be created.

Responses

Request samples

Content type
application/json
{
  • "groupName": "New Group"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "groupId": 0,
  • "message": "string"
}

Attach Environment to Environment Group

Attaches an environment (appId) to a specific environment group (groupName).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
groupName
required
string

The name of the environment group.

appId
required
string

The ID of the environment to be attached.

query Parameters
serverId
required
string

The ID of the server where the environment group exists.

Responses

Detach Environment from Environment Group

Detaches an environment (appId) from a specific environment group (groupName).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
groupName
required
string

The name of the environment group.

appId
required
string

The ID of the environment to be detached.

query Parameters
serverId
required
string

The ID of the server where the environment group exists.

Responses

Response samples

Content type
application/json
{
  • "status": "Environment detached successfully."
}

Update Environment Group Name

Updates the name of an existing environment group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
srcGroupName
required
string

The current name of the environment group.

query Parameters
serverId
required
string

The ID of the server where the environment group exists.

Request Body schema: application/json
required
dstGroupName
string

The new name for the environment group.

Responses

Request samples

Content type
application/json
{
  • "dstGroupName": "UpdatedGroupName"
}

Delete Environment Group

Deletes an existing environment group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
groupName
required
string

The name of the environment group to delete.

query Parameters
serverId
required
string

The ID of the server where the environment group exists.

Responses

DBP - Environment - Log

Handles environment logs, including listing, retrieving details, downloading, clearing, and deleting log files.

List all logs

Retrieves a list of logs for the specified application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose logs are being retrieved.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
nodeId
number

The ID of the specific node (optional).

path
string

The path to the log file or directory (optional).

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ]
}

Get Log Detail

Retrieves the detailed log content for the specified application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose log details are being retrieved.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
nodeId
required
number

The ID of the node where the log is located.

path
required
string

The path of the log file to retrieve details from.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "linescount": 100,
  • "body": "2024-02-25 12:00:00 INFO Application started."
}

Download Log File

Generates a download link for the specified log file.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose log file is being downloaded.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
nodeId
required
number

The ID of the node where the log file is located.

path
required
string

The path of the log file to download.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "path": "string"
}

Response samples

Content type
application/json
{}

Clear Log File

Deletes the contents of the specified log file.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose log file is being cleared.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
nodeId
required
number

The ID of the node where the log file is located.

path
required
string

The path of the log file to be cleared.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "path": "string"
}

Delete Log File

Deletes the specified log file.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose log file is being deleted.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
nodeId
required
number

The ID of the node where the log file is located.

path
required
string

The path of the log file to be deleted.

Responses

Request samples

Content type
application/json
{
  • "nodeId": 0,
  • "path": "string"
}

DBP - Environment - Migration

Manages environment migration tasks, including checking migration feasibility and migrating environments to different hardnodes.

Checks migration possibility for environment.

Verifies whether it is possible to migrate the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application for which migration is being checked.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Request Body schema: application/json
required
hardwareNodeGroup
required
string

The hardware node group to which the environment is to be migrated.

Responses

Request samples

Content type
application/json
{
  • "hardwareNodeGroup": "string"
}

Migrates environment to another hardnode.

This endpoint migrates the environment to a different hardware node group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application to be migrated.

query Parameters
serverId
required
string

The ID of the server where the application is currently hosted.

Request Body schema: application/json
required
hardwareNodeGroup
required
string

The hardware node group where the environment will be migrated.

isOnline
required
boolean

Indicates whether the migration should be performed while the environment is online (true) or offline (false).

Responses

Request samples

Content type
application/json
{
  • "hardwareNodeGroup": "string",
  • "isOnline": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "error": "string",
  • "reason": 0,
  • "source": "string"
}

DBP - Environment - Scheduler

Manages environment scheduler tasks, including retrieving scheduler information, installing or updating the scheduler, and deleting backup add-ons.

Get Environment Scheduler Info

This endpoint retrieves information about the environment scheduler for the specified application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application for which scheduler information is requested.

query Parameters
serverId
required
string

The ID of the server where the application is hosted.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "total": 0,
  • "apps": [
    ]
}

Update Scheduler for Environment

This endpoint updates the scheduler configuration for the specified environment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose scheduler will be updated.

query Parameters
serverId
required
string

The ID of the server where the environment is hosted.

Request Body schema: application/json
required
appUniqueName
string

The unique name of the application whose scheduler is to be updated.

object

Responses

Request samples

Content type
application/json
{
  • "appUniqueName": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "uniqueName": "string",
  • "response": {
    },
  • "appid": "string",
  • "successText": "string",
  • "action": "string",
  • "error": "string",
  • "reason": "string",
  • "type": "string",
  • "message": "string"
}

Install Scheduler to Environment

This endpoint installs a scheduler to the specified environment and allows configuration of cron jobs and time zones.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application to which the scheduler will be installed.

query Parameters
serverId
required
string

The ID of the server where the environment is hosted.

Request Body schema: application/json
required
nodeGroup
string

The node group to which the scheduler will be installed.

object

Responses

Request samples

Content type
application/json
{
  • "nodeGroup": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "uniqueName": "string",
  • "response": {
    },
  • "appid": "string",
  • "successText": "string",
  • "action": "string",
  • "error": "string",
  • "reason": "string",
  • "type": "string",
  • "message": "string"
}

Delete Scheduler for Environment

This endpoint deletes the scheduler configuration for the specified application and unique name.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose scheduler will be deleted.

appUniqueName
required
string

The unique name of the application whose scheduler will be deleted.

query Parameters
serverId
required
string

The ID of the server where the environment is hosted.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "action": "string",
  • "error": "string",
  • "reason": "string",
  • "type": "string",
  • "message": "string"
}

DBP - Billing

Manages billing-related tasks, including retrieving account and environment billing history, listing pricing details, and checking quotas.

List Account Billing History by Period

This endpoint retrieves the billing history for an account based on the specified period.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
startTime
string

The start date/time for the billing history.

endTime
string

The end date/time for the billing history.

period
string
Enum: "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

The period for grouping billing data.

groupNodes
boolean

Whether or not to group the billing data by nodes.

Responses

Request samples

Content type
application/json
{
  • "startTime": "string",
  • "endTime": "string",
  • "period": "HOUR",
  • "groupNodes": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string",
  • "source": "string",
  • "error": "string"
}

List Environment Billing History

This endpoint retrieves the billing history for a specific environment based on the specified period and app ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
appId
string

The ID of the application for which billing history is requested.

startTime
string

The start date/time for the billing history.

endTime
string

The end date/time for the billing history.

period
string
Enum: "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

The period for grouping billing data.

groupNodes
boolean

Whether or not to group the billing data by nodes.

Responses

Request samples

Content type
application/json
{
  • "appId": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "period": "HOUR",
  • "groupNodes": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string",
  • "source": "string",
  • "error": "string"
}

List Pricing

This endpoint retrieves the pricing information for the environment. It includes tariff plans and pricing models for various resources.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string"
}

List Quotas

This endpoint retrieves the quota information for the environment. It provides details on the resource quotas and their respective values.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "string"
}

DBP - Cross Network

Manages cross-network tasks, enabling the integration and communication between different networks within the platform.

List Cross Network IP Addresses

This endpoint retrieves the list of cross-network IP addresses for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "array": [
    ],
  • "className": "com.hivext.api.server.data.po.CrossNetworkExtIpAddressSearchCriteria",
  • "totalCount": 4
}

Add a new Cross Network IP Address

This endpoint adds a new cross-network IP address for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
ip
string <ipv4>

The IP address to be added to the cross-network configuration.

Responses

Request samples

Content type
application/json
{
  • "ip": "10.100.120.66"
}

Response samples

Content type
application/json
{
  • "result": 0
}

Delete a Cross Network IP Address

This endpoint deletes a cross-network IP address for the specified server and IP address ID.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
id
required
string

The unique ID of the cross-network IP address to be deleted.

query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0
}

DBP - Dashboard

Provides access to platform region information, allowing users to retrieve and manage details about available DBP regions.

Get DBP Regions

This endpoint retrieves the list of DBP regions for a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Databases for a specified DBP server

This endpoint retrieves the list of databases associated with a specific DBP server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "nodes": [
    ]
}

DBP - Public Key

Allows users to manage public keys, including listing, creating, generating, and deleting public keys for secure access to the platform.

Get List of Public Keys for a specified DBP server

This endpoint retrieves a list of public keys associated with a specific DBP server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "keys": [
    ],
  • "debug": {
    }
}

Create a new Public Key for a specified DBP server

This endpoint allows you to create a new public key for a specified DBP server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
publicKey
string

The public key to be created.

title
string

The title of the public key.

Responses

Request samples

Content type
application/json
{
  • "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArG7...",
  • "title": "My New Key"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "debug": {
    },
  • "source": "Public Key API",
  • "error": "None",
  • "key": {
    }
}

Generate a new public/private key pair for a specified DBP server

This endpoint generates a new public/private key pair for a specified DBP server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "base64PublicKey": "AAAAB3NzaC1yc2EAAAABIwAAAQEArG7...",
  • "base64PrivateKey": "MIIEvAIBADANBgkqhkiG9w0BAQEFAASCB..."
}

Delete a public key by ID

This endpoint deletes a public key by its unique ID for a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
id
required
integer

The ID of the public key to be deleted.

query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 1,
  • "debug": {
    },
  • "source": "api-server",
  • "error": "Key not found."
}

DBP - Storage

Provides operations for managing storage backups, including listing existing backups and creating new backups for secure data storage.

Get storage information

This endpoint retrieves storage information for a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 1,
  • "infos": [
    ]
}

Create Storage Backup

This endpoint creates a storage backup for a specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
object
region
string

The region where the storage backup will be created.

envName
string

The environment name for the storage backup.

displayName
string

The display name for the storage backup.

Responses

Request samples

Content type
application/json
{
  • "settings": {
    },
  • "region": "us-west",
  • "envName": "production",
  • "displayName": "backup-01"
}

Response samples

Content type
application/json
{
  • "result": 1,
  • "uniqueName": "backup-001",
  • "response": {
    },
  • "appid": "app-123",
  • "successText": "Storage backup created successfully."
}

Update Storage Disk Limit

This endpoint updates the storage disk limit for a specific application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose storage disk limit is to be updated.

query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Request Body schema: application/json
required
diskLimit
required
number

The new disk limit to be applied to the storage.

Responses

Request samples

Content type
application/json
{
  • "diskLimit": 200
}

Response samples

Content type
application/json
{
  • "result": 1
}

Delete Storage for Application

This endpoint deletes the storage for a specific application.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
appId
required
string

The ID of the application whose storage is to be deleted.

query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 1
}

DBP - User

Allows users to view account details and retrieve information about the products associated with their user account.

Show Account Details

This endpoint retrieves the details of the user account.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the DBP product. You can obtain valid product IDs by calling the DBP-User endpoint.

Responses

Response samples

Content type
application/json
{
  • "result": 1,
  • "groupType": "Admin",
  • "bonus": 100,
  • "hardNodeGroups": [
    ],
  • "createdOn": "2021-01-01T00:00:00Z",
  • "updatedGroupOn": "2021-02-01T00:00:00Z",
  • "defaultHardNodeGroup": "group1",
  • "uid": 12345,
  • "isCommerial": true,
  • "balance": 50.75,
  • "isRegistered": true,
  • "updatedStatusOn": "2021-03-01T00:00:00Z",
  • "status": 1,
  • "group": "standard",
  • "source": "internal",
  • "error": "No errors"
}

Get User Products

This endpoint retrieves the list of products associated with the user account.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

Parameter

Provides access to the parameter table, which stores essential information
required for various requests and configurations.

Get system parameters

Retrieves a list of system parameters, optionally filtered by type and group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
type
string

Filter parameters by type.

group
string

Filter parameters by group.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get discovery parameters

Retrieves a list of discovery-related parameters based on the specified products.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
products
required
string

Specifies the product(s) for which discovery parameters should be retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Product

Provides requests that retrieve the status and information about products,
offering insights into their current state and configuration.

Get product status

Retrieves the status of the products.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Support - Request

Handles ticket creation and management requests,
allowing users to submit, update, and track support tickets.

Get Customer Requests

Retrieves customer support requests based on filters.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
start
number

The starting index for pagination.

limit
number
Example: limit=10

The number of requests returned per page.

requestTypeId
number
Example: requestTypeId=5

Filter by request type ID.

requestStatus
string
Example: requestStatus=Open

Filter by request status.

Responses

Response samples

Content type
application/json
{
  • "size": 25,
  • "start": 0,
  • "limit": 10,
  • "isLastPage": false,
  • "requests": [
    ]
}

Create Customer Request

Creates a new customer support request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: application/json
required
summary
string

A brief summary of the request.

description
string

Detailed description of the issue.

requestTypeId
string

The ID of the request type.

object

The category of the request.

object

(Optional) The priority of the request.

object

(Optional) The billing category related to the request.

object

(Optional) The sales category related to the request.

object

(Optional) The customer type for the request.

attachment
Array of strings

(Optional) List of attachment IDs related to the request.

Responses

Request samples

Content type
application/json
{
  • "summary": "Issue with cloud storage access",
  • "description": "User is unable to access their cloud storage despite having the correct permissions.",
  • "requestTypeId": "12345",
  • "requestCategory": {
    },
  • "priority": {
    },
  • "billingCategory": {
    },
  • "salesCategory": {
    },
  • "customerType": {
    },
  • "attachment": [
    ]
}

Response samples

Content type
application/json
{
  • "issueKey": "SUP-1001",
  • "issueId": "50001",
  • "requestTypeId": "12345",
  • "reporter": {
    },
  • "currentStatus": {
    }
}

Get Customer Request by ID or Key

Retrieves detailed information about a customer support request by issue ID or key.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string
Example: REQ-1234

The unique ID or key of the support request.

Responses

Response samples

Content type
application/json
{
  • "issueId": "REQ-1234",
  • "issueKey": "CUST-5678",
  • "requestTypeId": 5,
  • "reporter": {
    },
  • "requestTypeFields": {
    },
  • "createdDate": {
    },
  • "currentStatus": {
    },
  • "addCommentAllowed": true
}

Get customer attachments

Fetches attachments of a customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

query Parameters
start
integer >= 0

The starting index for pagination (optional).

limit
integer >= 1

The number of attachments to retrieve (optional).

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "start": 0,
  • "limit": 0,
  • "isLastPage": true,
  • "attachments": [
    ]
}

Get attachment content

Retrieves the content of a specific attachment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

attachmentId
required
string

The ID of the attachment.

Responses

Response samples

Content type
(Binary file data)

Get attachment thumbnail

Retrieves the base64-encoded thumbnail of a specific attachment.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

attachmentId
required
string

The ID of the attachment.

Responses

Response samples

Content type
application/json
{
  • "base64Thumbnail": "string"
}

Get customer request status

Retrieves the current status of a customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "statusDate": "2019-08-24T14:15:22Z"
}

Get comment attachments

Retrieves a paginated list of attachments for a specific comment in a customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

commentId
required
string

The ID of the comment.

query Parameters
start
integer >= 0

The starting index for pagination.

limit
integer >= 1

The number of attachments to retrieve per page.

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "start": 0,
  • "limit": 0,
  • "isLastPage": true,
  • "attachments": [
    ]
}

Get customer request comments

Retrieves a paginated list of comments for a specific customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

query Parameters
start
integer >= 0

The starting index for pagination.

limit
integer >= 1

The number of comments to retrieve per page.

Responses

Response samples

Content type
application/json
{
  • "size": 0,
  • "total": 0,
  • "start": 0,
  • "limit": 0,
  • "isLastPage": true,
  • "comments": [
    ]
}

Create Request Comment

Adds a new comment to the specified customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

Request Body schema: application/json
required
body
string

The content of the comment.

Responses

Request samples

Content type
application/json
{
  • "body": "This is a sample comment."
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "body": "string",
  • "public": true,
  • "author": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get Customer Request Transitions

Retrieves the available transitions for the specified customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

Responses

Response samples

Content type
application/json
{
  • "transitions": [
    ]
}

Perform Customer Request Transition

Executes a transition on the specified customer request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string

The ID or key of the customer request.

Request Body schema: application/json
required
id
string

The ID of the transition to perform.

object

An optional comment to include with the transition.

Responses

Request samples

Content type
application/json
{
  • "id": "5",
  • "additionalComment": {
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

Create Attachment to Customer Request

Create one or more temporary attachments to a customer support request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
issueIdOrKey
required
string
Example: SUP-1001

The issue ID or key of the customer request.

Request Body schema: application/json
required
object

(Optional) A comment to be added along with the attachment.

temporaryAttachmentIds
Array of strings

A list of temporary attachment IDs to be uploaded.

Responses

Request samples

Content type
application/json
{
  • "additionalComment": {
    },
  • "temporaryAttachmentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "comment": {
    },
  • "attachments": [
    ]
}

Get Request Types

Retrieves a list of available request types.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Request Type Fields

Retrieves the fields associated with a specific request type.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
requestTypeId
required
string
Example: req-type-123

The ID of the request type.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Support - Service Desk

Allows attaching temporary files to support requests
in the Service Desk module.

Upload Temporary File Attachment

Uploads a temporary file to the service desk for later use in a request.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
Request Body schema: multipart/form-data
required
file
string <binary>

The file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "temporaryAttachmentIds": [
    ]
}

LC - Project

Manages projects within a Light Compute (LC) environment. Supports project management of resources and configurations for lightweight compute instances.

Get LC Projects

Retrieves the list of LC projects for the specified server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the LC region. You can obtain valid region IDs by calling the LC-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "lastServerId": "server-12345",
  • "lastProjectIdVps": "project-98765",
  • "lastProject": "OpenStack Project X",
  • "projects": [
    ]
}

Get LC Project Quota

Retrieves the quota usage details for a LC project.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server for which the quota details are being requested.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

LC - Region

Manages regions within a Light Compute (LC) environment.
Defines and organizes geographic locations for deploying and managing compute resources.

Get LC Regions

Retrieves the available LC regions.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "id": "server-1234",
  • "name": "Region-East"
}

LC - Security Group

Manages security groups within a Light Compute (LC) environment.
Defines and controls inbound and outbound traffic rules for virtual machines

Get User IP

Retrieves the user's public IP address.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)

Responses

Response samples

Content type
application/json
{
  • "ip": "192.168.1.100"
}

Get Security Group Details

Retrieves details of security group rules for a given server.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a Security Group Rule

Adds a new rule to the specified security group.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to which the rule will be added.

query Parameters
serverId
required
string

The ID of the server for which the security rule is being added.

Request Body schema: application/json
required
remote_ip_prefix
string

The CIDR range for the rule.

direction
string
Enum: "ingress" "egress"

The direction of the rule (incoming or outgoing traffic).

protocol
string

The protocol to be used (e.g., TCP, UDP, ICMP).

ethertype
string
Enum: "IPv4" "IPv6"

The IP version.

port_range_max
number

The maximum port range for the rule.

port_range_min
number

The minimum port range for the rule.

remote_group_id
string

The ID of the remote security group.

Responses

Request samples

Content type
application/json
{
  • "remote_ip_prefix": "192.168.1.0/24",
  • "direction": "ingress",
  • "protocol": "TCP",
  • "ethertype": "IPv4",
  • "port_range_max": 443,
  • "port_range_min": 80,
  • "remote_group_id": "sg-remote-123"
}

Get Security Group Rule Details

Retrieves details of a specific security group rule.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group to which the rule belongs.

securityGroupRuleId
required
string

The ID of the security group rule to retrieve details for.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "security_group_rules": [
    ]
}

Delete Security Group Rule

Deletes a specific security group rule.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
securityGroupId
required
string

The ID of the security group that contains the rule.

securityGroupRuleId
required
string

The ID of the security group rule to be deleted.

query Parameters
serverId
required
string

The ID of the server.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Security group rule deleted successfully."
}

LC - Virtual Machine

Manages virtual machines within a Light Compute (LC) environment.
Enables the configuration, and management of lightweight virtual instances for various workloads.

Get VM Monitoring Data

Retrieves monitoring data for a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine for which monitoring data is being requested.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

start
required
number

The start timestamp for the monitoring data.

end
required
number

The end timestamp for the monitoring data.

step
required
number

The step interval for the monitoring data.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "serverId": "string",
  • "end": 0,
  • "start": 0,
  • "id": "string",
  • "step": 0
}

Get VM Details

Retrieves detailed information about a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
query Parameters
serverId
required
string

The ID of the server associated with the virtual machine.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "creationTime": "string",
  • "lastModified": "string",
  • "image": "string",
  • "imageOsType": "string",
  • "sshKey": "string",
  • "taskState": "string",
  • "flavor": {
    },
  • "fault": "string",
  • "host": "string"
}

List network interfaces in VM

Retrieves a list of network interfaces for a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to retrieve network interfaces for.

query Parameters
serverId
required
string

The ID of the server associated with the virtual machine.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List volumes in VM

Retrieves a list of volumes attached to a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to retrieve volumes for.

query Parameters
serverId
required
string

The ID of the server associated with the virtual machine.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List history for VM

Retrieves a list of historical activities related to a specific virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to retrieve history for.

query Parameters
serverId
required
string

The ID of the server associated with the virtual machine.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get detailed history for a specific action in VM history

Retrieves detailed information for a specific action within the history of a virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine to retrieve history details for.

historyId
required
string

The ID of the specific history event to retrieve detailed information for.

query Parameters
serverId
required
string

The ID of the server associated with the virtual machine.

Responses

Response samples

Content type
application/json
{
  • "dateAndTime": "string",
  • "activity": "string",
  • "status": "string",
  • "initiator": "string",
  • "id": "string"
}

Get remote console URL for a VM

Generates a remote console URL for accessing the virtual machine.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server associated with the VM.

Responses

Response samples

Content type
application/json
{}

Perform an action on a VM

Executes a specific action on the given virtual machine (VM).

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
vmId
required
string

The ID of the virtual machine.

query Parameters
serverId
required
string

The ID of the server associated with the VM.

Request Body schema: application/json
required
action
required
string
Enum: "start" "hardStop" "RebootHard" "RebootSoft" "shelve" "unshelve" "consoleLog"

The action to perform on the VM.

Responses

Request samples

Content type
application/json
{
  • "action": "start"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "VM started successfully."
}

LC - Volume

Manages storage volumes within a Light Compute (LC) environment.
Supports volume management for virtual machines.

Get details of a specific volume

Retrieves detailed information about a specific volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The unique ID of the volume.

query Parameters
serverId
required
string

The ID of the CCE region. You can obtain valid region IDs by calling the CCE-Region endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "vol-123456",
  • "name": "My Volume",
  • "status": "available",
  • "size": 100,
  • "storagePolicy": "Standard",
  • "created": "2024-01-15T12:30:00Z",
  • "lastModified": "2024-02-01T15:45:00Z",
  • "type": "HDD",
  • "volume_image_metadata": {
    }
}

Get snapshots of a specific volume

Retrieves a list of snapshots for a given volume.

Authorizations:
x-auth(x-api-access-keyx-api-secret-key)
path Parameters
volumeId
required
string

The unique ID of the volume.

query Parameters
serverId
required
string

The ID of the server associated with the volume.

Responses

Response samples

Content type
application/json
[
  • {
    }
]