Accounts

Accounts

The Accounts API allows sub-account creation and management.

Get Account

This API is useful for getting profile information of a sub-account under the organization.

GET /es/v2/accounts/<account_id>

Response:

{
  "statusCode": 0,
  "statusMessage": "string",
  "response": {
    "connections": "string",
    "createdTime": 0,
    "enabled": true,
    "env": {
      "host": "string",
      "id": "string",
      "name": "string"
    },
    "id": "string",
    "name": "string",
    "updatedTime": 0,
    "userId": "string",
    "userEmail": "string",
    "volume": 0
  }
}

Attributes:

Attribute	Description	Possible Values
connections	Number of connections the account has created	Integer (e.g., 0, 1, 2, etc.)
createdTime	Account creation time	Unix timestamp (seconds)
enabled	Indicates whether the account is enabled or not	true or false
env	Contains environment-related details	Hostname, ID, name, etc.
id	Unique identifier for the account	UUID (16-character identifier)
name	Name of the account	String (e.g., account name)
userEmail	Account owner's email address	Email address (e.g., [email protected])
updatedTime	Account update time	Unix timestamp (seconds)
userId	Identifier for the account owner	UUID (16-character identifier)
volume	Volume used by the account	Integer (e.g., 0, 1000, etc.)

Sample Curl:

curl --location '<host>/es/v2/accounts/0e1ebe4f518d3211' \
--header 'Authorization: Bearer c076dc2e-d0c2-4d4d-ab13-e4e3dd555fc0'

Get List of Accounts

The API returns list of accounts under the organization account.

GET /es/v2/accounts/list

Query params

&q=keyword
&size=10
&offset=0

Response:

{
  "statusCode": 0,
  "statusMessage": "string",
  "response": [
    {
      "connections": "string",
      "createdTime": 0,
      "enabled": true,
      "env": {
        "host": "string",
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "name": "string",
      "userEmail": "string",
      "updatedTime": 0,
      "userId": "string",
      "volume": 0
    }
  ]
}

Attributes:

Attribute	Description	Possible Values
connections	Number of connections the account has created	Integer (e.g., 0, 1, 2, etc.)
createdTime	Account creation time	Unix timestamp (seconds)
enabled	Indicates whether the account is enabled or not	true or false
env	Contains environment-related details	Hostname, ID, name, etc.
id	Unique identifier for the account	UUID (16-character identifier)
name	Name of the account	String (e.g., account name)
userEmail	Account owner's email address	Email address (e.g., [email protected])
updatedTime	Account update time	Unix timestamp (seconds)
userId	Identifier for the account user	UUID (16-character identifier)
volume	Volume used by the account	Integer (e.g., 0, 1000, etc.)

Sample Curl::

curl --location '<host>/es/v2/accounts/list?q=&size=10&offset=0' \
--header 'Authorization: Bearer c076dc2e-d0c2-4d4d-ab13-e4e3dd555fc0'

Add Account

This API can be used to create a sub-account under the organization account.

POST /es/v2/accounts

Request Body:

{
  "enabled": true,
  "name": "string",
  "userEmail": "string"
}

Response:

{
  "statusCode": 0,
  "statusMessage": "string",
  "response": {}
}

Attributes:

Attribute	Description	Possible Values
enabled	Indicates whether the account is enabled or not	true or false
name	Name of the account	String (e.g., account name)
userEmail	Account owner's email address	Email address (e.g., [email protected])

Sample Curl::

curl --location '<host>/es/v2/accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer c076dc2e-d0c2-4d4d-ab13-e4e3dd555fc0' \
--data-raw '{
  "enabled": true,
  "name": "Test Account",
  "userEmail": "[email protected]"
}'

Edit Account

This API can be used to update sub-account details under the organization.

PUT /es/v2/accounts/<account_id>

Request Body:

{
  "enabled": true,
  "name": "string"
}

Response:

{
  "statusCode": 0,
  "statusMessage": "string",
  "response": {}
}

Attributes:

Attribute	Description	Possible Values
enabled	Indicates whether the account is enabled or not	true or false
name	Name of the account	String (e.g., account name)

Sample Curl::

curl --location --request PUT '<host>/es/v2/accounts/0e1ebe4f518d3211' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer c076dc2e-d0c2-4d4d-ab13-e4e3dd555fc0' \
--data '{
  "enabled": true,
  "name": "Test Account Updated"
}'

Delete Account

This API can be used to delete a sub-account under the organization.

DELETE /es/v2/accounts/<account_id>

Request Body:

NA

Response:

{
  "statusCode": 0,
  "statusMessage": "string",
  "response": {}
}

Sample Curl::

curl --location --request DELETE '<host>/es/v2/accounts/0e1ebe4f518d3211' \
--header 'Authorization: Bearer c076dc2e-d0c2-4d4d-ab13-e4e3dd555fc0'