environment.Control

Estimated reading: 60 minutes 119 views

Namespace:	Environment
REST:	https://[hoster-api-host]/1.0/environment/control/rest/{method-name}
Scripting:	jelastic.environment.control.{method-name}

The Control service provides a flexible structure to manage environments. You can perform such tasks as:

Create environments with different topologies, change topology, clone them, change limits, etc.
Share and collaborate on environments, organize groups, etc.
Transfer environments to another accounts.
Deploy different apps to your environments.
Monitor resource usage.

Methods

AddContainerEnvVars

AddContainerEnvVars (envName, session, [nodeGroup], [nodeId], vars ) :

Adds environment variables to the container.

URL

https://[hoster-api-host]/1.0/environment/control/rest/addcontainerenvvars

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.
nodeId : “int” (optional)
unique identifier of the target node (container).
vars : “string”
JSON object with a list of container environment variables, e.g. {“var1″:”value1”, “var2″:”value2”}

Example

Method: POST

https://[hoster-api-host]/1.0/environment/control/rest/addcontainerenvvars?envName=[string]&session=[string]&vars=[string]&nodeGroup=[string]&nodeId=[int]

Response

{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

AddContainerVolume

AddContainerVolume (envName, session, nodeId, path ) :

use the AddContainerVolumes method instead.

URL

https://[hoster-api-host]/1.0/environment/control/rest/addcontainervolume

Deprecated since version 5.3.2-10

Parameters

envName : “string”
session : “string”
nodeId : “int”
path : “string”

Example

Method: POST

https://[hoster-api-host]/1.0/environment/control/rest/addcontainervolume?path=[string]&envName=[string]&session=[string]&nodeId=[int]

Response

NodeSSHResponse

stdClass Object
(
    [result] => 0
    [responses] => Array
        (
            [0] => stdClass Object
                (
                    [result] => 0
                    [nodeid] => "int"
                )
        )
)

AddContainerVolumeByGroup

AddContainerVolumeByGroup (envName, session, nodeGroup, path ) : NodeSSHResponse

use the AddContainerVolumes method instead.

Deprecated since version 5.3.2-10

Parameters

envName : “string”
session : “string”
nodeGroup : “string”
path : “string”

Response

NodeSSHResponse

{
   "errOut": "string",
   "error": "string",
   "exitStatus": "int",
   "name": "string",
   "nodeId": "int",
   "out": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/addcontainervolumebygroup?path=[string]&envName=[string]&session=[string]&nodeGroup=[string]

AddContainerVolumes

AddContainerVolumes (envName, session, [nodeGroup], [nodeId], volumes ) : NodeSSHResponses

Adds data volume(s) to the container (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.
nodeId : “int” (optional)
unique identifier of the target node (container).
volumes : “string”
an array of data volumes to be added, e.g. /data/volume or [“/data/volume”,”/data/volume2″, …]

Response

NodeSSHResponses

{
   "error": "string",
   "reason": "int",
   "responses": [
      {
         "errOut": "string",
         "error": "string",
         "exitStatus": "int",
         "name": "string",
         "nodeId": "int",
         "out": "string",
         "reason": "int",
         "result": "int",
         "source": "string"
      },
      "..."
   ],
   "result": "int",
   "source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/addcontainervolumes?envName=[string]&session=[string]&volumes=[string]&nodeGroup=[string]&nodeId=[int]

AddEndpoint

AddEndpoint (envName, session, nodeId, privatePort, protocol, name ) : ObjectResponse

Adds an endpoint for direct connection to the container (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
privatePort : “int”
local port on the container to connect to via endpoint.
protocol : “string”
connection protocol (“TCP” or “UDP”).
name : “string”
custom endpoint name.

Response

ObjectResponse

{
   "error": "string",
   "name": "string",
   "object": {
      "domain": "string",
      "name": "string",
      "nodeId": "int",
      "privatePort": "int",
      "protocol": "TCP(0) | UDP(1)",
      "publicPort": "int"
   },
   "reason": "int",
   "result": "int",
   "source": "string",
   "warnings": [
      "string",
      "..."
   ]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/addendpoint?protocol=[string]&envName=[string]&session=[string]&privatePort=[int]&name=[string]&nodeId=[int]

AddEnvProperty

AddEnvProperty (envName, session, properties ) : Response

Adds new custom properties to the target environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
properties : “string”
JSON object with environment properties. For example: {“customProperty1″:”value1″,”customProperty2″:”value2”}

Response

Response
```
{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/addenvproperty?envName=[string]&session=[string]&properties=[string]

AddPortRedirect

AddPortRedirect (envName, session, nodeId, srcPort, dstPort, protocol, [comment] ) : Response

Adds port redirect for the container (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
srcPort : “int”
source port on the container.
dstPort : “int”
destination port on the container.
protocol : “string”
transport protocol (“TCP” or “UDP”).
comment : “string” (optional)
custom comment for the redirect.

Response

Response
```
{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/addportredirect?protocol=[string]&dstPort=[int]&envName=[string]&session=[string]&comment=[string]&srcPort=[int]&nodeId=[int]

ApplyEnvProperty

ApplyEnvProperty (envName, session, properties ) : Response

Adds or changes (if it exists) custom properties for the target environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
properties : “string”
JSON object with environment properties. For example: {“customProperty1″:”value1″,”customProperty2″:”value2”}

Response

Response
```
{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/applyenvproperty?envName=[string]&session=[string]&properties=[string]

ApplyNodeGroupData

ApplyNodeGroupData (envName, session, nodeGroup, data ) : Response

use the ApplyData method instead.

Deprecated since version 5.9-2

Parameters

envName : “string”
session : “string”
nodeGroup : “string”
data : “string”

Response

Response
```
{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/applynodegroupdata?data=[string]&envName=[string]&session=[string]&nodeGroup=[string]

AttachEnvGroup

AttachEnvGroup (envName, session, envGroup ) : Response

Assigns groups to the target environment (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
envGroup : “string”
target group name or JSON array of group names.

Response

Response
```
{
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/attachenvgroup?envName=[string]&session=[string]&envGroup=[string]

ChangeTopology

ChangeTopology (envName, session, [actionkey], env, nodes ) : ScriptEvalResponse

Changes topology of the environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
actionkey : “string” (optional)
name of the action and domain name.

env : “json”

JSON object with environment settings:

{
   "displayName": "string",
   "engine": "string",
   "ishaenabled": "boolean",
   "region": "string",
   "shortdomain": "string",
   "sslstate": "boolean"
}

nodes : “json”

JSON object with a list of environment nodes and their settings:

[ 
{
   "count": "int",
   "displayName": "string",
   "docker": {
      "cmd": "string",
      "env": {
         "String": "string"
      },
      "image": "string",
      "links": [
         "string",
         "..."
      ],
      "nodeGroup": "string",
      "registry": {
         "password": "string",
         "url": "string",
         "user": "string"
      }
   },
   "extip": "boolean",
   "fixedCloudlets": "int",
   "flexibleCloudlets": "int",
   "nodeType": "string"
},
"..."
]

Response

ScriptEvalResponse

{
"error": "string",
"line": "int",
"reason": "int",
"response": {
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
},
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/changetopology?nodes=[json]&envName=[string]&session=[string]&actionkey=[string]&env=[json]

CheckMigrationPossibility

CheckMigrationPossibility (envName, session, [hardwareNodeGroup] ) : Response

Checks the possibility of migration for the environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
hardwareNodeGroup : “string” (optional)
unique identifier of the target region (host group).

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/checkmigrationpossibility?envName=[string]&session=[string]&hardwareNodeGroup=[string]

ClearLog

ClearLog (envName, session, nodeId, path ) : Response

Clears the log file.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
path : “string”
path to the target log file.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/clearlog?path=[string]&envName=[string]&session=[string]&nodeId=[int]

CloneEnv

CloneEnv (srcEnvName, session, dstEnvName, [useExternalMounts] ) : EnvironmentInfoResponse

Clones an existing environment.

Parameters

srcEnvName : “string”
source environment name (one that is going to be cloned).
session : “string”
user session or personal access token.
dstEnvName : “string”
destination (cloned) environment name.
useExternalMounts : “boolean” (optional)
defines whether to copy external mounts on the clone (true) or not (false).

Response

EnvironmentInfoResponse

{
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/cloneenv?useExternalMounts=[boolean]&srcEnvName=[string]&session=[string]&dstEnvName=[string]

CreateEnvironment

CreateEnvironment (appid, session, env, nodes, [actionkey], [ownerUid], [envGroups] ) : ScriptEvalResponse

Creates a new environment with the required settings.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.

env : “json”

JSON object with environment settings:

{
"displayName": "string",
"engine": "string",
"ishaenabled": "boolean",
"region": "string",
"shortdomain": "string",
"sslstate": "boolean"
}

nodes : “json”

JSON object with a list of environment nodes and their settings:

[ 
{
"count": "int",
"displayName": "string",
"docker": {
"cmd": "string",
"env": {
"String": "string"
},
"image": "string",
"links": [
"string",
"..."
],
"nodeGroup": "string",
"registry": {
"password": "string",
"url": "string",
"user": "string"
}
},
"extip": "boolean",
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"nodeType": "string"
},
"..."
]

actionkey : “string” (optional)
name of the action and domain name.
ownerUid : “int” (optional)
unique identifier of the environment owner (if installing as collaborator on another user account).
envGroups : “string” (optional)
target group name or JSON array of group names.

Response

ScriptEvalResponse

{
"error": "string",
"line": "int",
"reason": "int",
"response": {
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
},
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/createenvironment?envGroups=[string]&nodes=[json]&session=[string]&appid=[string]&actionkey=[string]&env=[json]&ownerUid=[int]

DeleteEnv

DeleteEnv (envName, session, [password] ) : Response

Deletes an existing environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
password : “string” (optional)
current user password or environment name to confirm environment deletion (depending on the ‘environment.delete.confirm.type’ quota).

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

POST https://[hoster-api-host]/1.0/environment/control/rest/deleteenv?
password=[string]&envName=[string]&session=[string]

DeployApp

DeployApp (envName, session, fileUrl, fileName, [context], [atomicDeploy], [delay], [nodeGroup], [hooks], [isSequential] ) : NodeSSHResponses

Deploys an application to the target environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
fileUrl : “string”
URL to the application archive to be deployed.
fileName : “string”
name of the application archive from the Deployment Manager to be deployed.
context : “string” (optional)
custom context for the application (ROOT by default).
atomicDeploy : “boolean” (optional)
defines whether to use zero-downtime deployment for PHP (true) or not (false).
delay : “int” (optional)
delay (in seconds) between two consecutive deployments when using the sequential deployment type (I.e. when deployment is performed on servers one-by-one to ensure uptime).
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.
hooks : “string” (optional)
JSON object with custom scripts (actual content) to be executed before and after the build/deployment operations. For example: {“preDeploy”:”script”, “postDeploy”:”script”, “preBuild”:”script”, “postBuild”:”script”}.
isSequential : “boolean” (optional)
defines whether to deploy the project on application servers one-by-one to ensure uptime (true) or simultaneously (false).

Response

NodeSSHResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"errOut": "string",
"error": "string",
"exitStatus": "int",
"name": "string",
"nodeId": "int",
"out": "string",
"reason": "int",
"result": "int",
"source": "string"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/deployapp?fileName=[string]&delay=[int]&envName=[string]&session=[string]&context=[string]&fileUrl=[string]&nodeGroup=[string]&hooks=[string]&isSequential=[boolean]&atomicDeploy=[boolean]

DetachEnvGroup

DetachEnvGroup (envName, session, envGroup ) : Response

Detaches groups from the target environment (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
envGroup : “string”
target group name or JSON array of group names.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/detachenvgroup?envName=[string]&session=[string]&envGroup=[string]

EditEndpoint

EditEndpoint (envName, session, id, name, privatePort, protocol ) : ObjectResponse

Adjusts an endpoint for direct connection to the container (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target endpoint.
name : “string”
custom endpoint name.
privatePort : “int”
local port on the container to connect to via endpoint.
protocol : “string”
transport protocol (“TCP” or “UDP”).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/editendpoint?protocol=[string]&envName=[string]&session=[string]&privatePort=[int]&name=[string]&id=[int]

EditNodeGroup

EditNodeGroup (envName, session, nodeGroup ) : Response

Adjusts node group (layer) parameters.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.

nodeGroup : “json”

JSON object with node group (layer) settings:

{
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
}

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/editnodegroup?envName=[string]&session=[string]&nodeGroup=[json]

EditRegistryCredentials

EditRegistryCredentials (appid, session, filter, [user], [password] ) : ObjectsCountResponse

Updates access credentials for the projects from custom Docker registries.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.

filter : “json”

JSON object to list parameters that need to be updated:

{
"envName": "string",
"nodeGroup": "string",
"registryRepo": "string",
"registryUrl": "string",
"registryUser": "string"
}

user : “string” (optional)
new username to access remote registry.
password : “string” (optional)
new password to access remote registry.

Response

ObjectsCountResponse
```
{
"count": "long",
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

POST https://[hoster-api-host]/1.0/environment/control/rest/editregistrycredentials?
filter=[json]&password=[string]&session=[string]&appid=[string]&user=[string]

ExecCmdByGroup

ExecCmdByGroup (envName, session, nodeGroup, commandList, [sayYes], [async] ) : ExecResponse

Runs provided commands on all nodes (containers) of the node group (layer).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string”
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.
commandList : “json”
JSON object with a list of commands to execute on the layer:
```
[ 
{
"command": "string",
"params": "string"
},
"..."
]
```
sayYes : “boolean” (optional)
defines whether to automatically confirm any operation if prompted (true) or not (false).
async : “boolean” (optional)
defines whether to run provided commands simultaneously (true) or one-by-one (false).

Response

ExecResponse

{
"error": "string",
"reason": "int",
"responses": [
{
"errOut": "string",
"error": "string",
"exitStatus": "int",
"name": "string",
"nodeId": "int",
"out": "string",
"reason": "int",
"result": "int",
"source": "string"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/execcmdbygroup?sayYes=[boolean]&async=[boolean]&envName=[string]&session=[string]&commandList=[json]&nodeGroup=[string]

ExecCmdById

ExecCmdById (envName, session, nodeId, commandList, [sayYes] ) : ExecResponse

Runs provided commands on the specified node (container).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
commandList : “json”
JSON object with a list of commands to execute on the node:
```
[ 
{
"command": "string",
"params": "string"
},
"..."
]
```
sayYes : “boolean” (optional)
defines whether to automatically confirm any operation if prompted (true) or not (false).

Response

ExecResponse

{
"error": "string",
"reason": "int",
"responses": [
{
"errOut": "string",
"error": "string",
"exitStatus": "int",
"name": "string",
"nodeId": "int",
"out": "string",
"reason": "int",
"result": "int",
"source": "string"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/execcmdbyid?sayYes=[boolean]&envName=[string]&session=[string]&commandList=[json]&nodeId=[int]

GetAllSumStatByUid

GetAllSumStatByUid (session, [duration], [endtime] ) : EnvironmentsStatisticResponse

Returns resource usage statistics for the specified user over the given period.

Parameters

session : “string”
user session or personal access token.
duration : “long” (optional)
period (in seconds) to show statistics for.
endtime : “string” (optional)
end time (UTC) in the format “yyyy-MM-dd hh:mm:ss”, e.g. “2022-11-16 00:00:00” (duration must be passed).

Response

EnvironmentsStatisticResponse

{
"error": "string",
"reason": "int",
"responses": [
{
"appid": "string",
"error": "string",
"isTransferring": "boolean",
"reason": "int",
"result": "int",
"source": "string",
"stats": [
{
"cpu": "int",
"disk": "int",
"disk_io_used": "int",
"duration": "int",
"envId": "string",
"iops_used": "int",
"mem": "int",
"netInExt": "long",
"netInInt": "long",
"netOutExt": "long",
"netOutInt": "long"
},
"..."
],
"status": "int"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getallsumstatbyuid?duration=[long]&session=[string]&endtime=[string]

GetBasicEnvsInfo

GetBasicEnvsInfo (appid, session, [ownerUid] ) : EnvironmentInfoResponses

Returns information on all user environments. However, it returns only some fields compared to the GetEnvs method (which gets full information on environments). The following fields are skipped: node.endpoints, node.customitem.dockerManifest, node.customitem.dockerVolumes, node.customitem.dockerVolumesFrom, node.packages

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
ownerUid : “int” (optional)
unique identifier of the target user account.

Response

EnvironmentInfoResponses

{
"error": "string",
"infos": [
{
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
},
"..."
],
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getbasicenvsinfo?session=[string]&appid=[string]&ownerUid=[int]

GetContainerEntryPoint

GetContainerEntryPoint (envName, session, nodeId ) : ObjectResponse

Returns container’s entry point.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": "string",
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainerentrypoint?envName=[string]&session=[string]&nodeId=[int]

GetContainerEnvVars

GetContainerEnvVars (envName, session, nodeId ) : ObjectResponse

Returns container’s environment variables.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"(key) string": "(value) string",
"...": "..."
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainerenvvars?envName=[string]&session=[string]&nodeId=[int]

GetContainerEnvVarsByGroup

GetContainerEnvVarsByGroup (envName, session, nodeGroup ) : ObjectResponse

Returns environment variables for all containers of the specified layer.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string”
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"(key) string": "(value) string",
"...": "..."
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainerenvvarsbygroup?envName=[string]&session=[string]&nodeGroup=[string]

GetContainerManifest

GetContainerManifest (appid, session, image, [registry], [userName], [password], [ignoreFormat] ) : ObjectResponse

Returns a manifest file for the custom Docker container.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
image : “string”
container’s Docker image and tag, e.g. “alpine:latest”.
registry : “string” (optional)
custom remote registry, where the container image is stored (Docker Hub by default).
userName : “string” (optional)
username for authentication at the remote registry.
password : “string” (optional)
password for authentication at the remote registry.
ignoreFormat : “boolean” (optional)
defines whether to ignore image format (true) or not (false).

Response

ObjectResponse
```
{
"error": "string",
"name": "string",
"object": "JSONObject",
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}
```
Example

POST https://[hoster-api-host]/1.0/environment/control/rest/getcontainermanifest?
image=[string]&registry=[string]&password=[string]&ignoreFormat=[boolean]&session=[string]&appid=[string]&userName=[string]

GetContainerNodeTags

GetContainerNodeTags (envName, session, nodeId ) : ObjectResponse

Returns a list of all tags for the existing container’s image.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": [
"string",
"..."
],
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainernodetags?envName=[string]&session=[string]&nodeId=[int]

GetContainerRunCmd

GetContainerRunCmd (envName, session, nodeId ) : ObjectResponse

Returns container’s run command (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": "string",
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainerruncmd?envName=[string]&session=[string]&nodeId=[int]

GetContainerRunConfig

GetContainerRunConfig (envName, session, nodeId ) : ObjectResponse

Returns container’s run config (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"dockerEntryPoint": "string",
"dockerRunCmd": "string"
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainerrunconfig?envName=[string]&session=[string]&nodeId=[int]

GetContainerTags

GetContainerTags (appid, session, image, [registry], [userName], [password] ) : ObjectResponse

Returns a list of all tags for the specified container’s image.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
image : “string”
container’s Docker image and tag, e.g. “alpine:latest”.
registry : “string” (optional)
custom remote registry, where the container image is stored (Docker Hub by default).
userName : “string” (optional)
username for authentication at the remote registry.
password : “string” (optional)
password for authentication at the remote registry.

Response

ObjectResponse
```
{
"error": "string",
"name": "string",
"object": [
"string",
"..."
],
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}
```
Example

POST https://[hoster-api-host]/1.0/environment/control/rest/getcontainertags?
image=[string]&registry=[string]&password=[string]&session=[string]&appid=[string]&userName=[string]

GetContainerVolumesByGroup

GetContainerVolumesByGroup (envName, session, nodeGroup ) : ObjectResponse

Returns container volumes for the specified layer (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string”
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": [
"string",
"..."
],
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainervolumesbygroup?envName=[string]&session=[string]&nodeGroup=[string]

GetContainerVolumesById

GetContainerVolumesById ( envName, session, nodeId ) : ObjectResponse

Returns container volumes for the specified node (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": [
"string",
"..."
],
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getcontainervolumesbyid?envName=[string]&session=[string]&nodeId=[int]

GetEndpoints

GetEndpoints (envName, session, [nodeId] ) : ArrayResponse

Returns a list of endpoints for the environment or specific node (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int” (optional)
unique identifier of the target node (container).

Response

ArrayResponse

{
"array": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getendpoints?envName=[string]&session=[string]&nodeId=[int]

GetEnvInfo

GetEnvInfo (envName, session, [lazy] ) : EnvironmentInfoResponse

Returns main or full information on the environment (list of nodes, settings, etc.).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
lazy : “boolean” (optional)
defines whether to load only the main environment metadata, e.g. name, alias, domain, etc., (true) or all the environment information (false).

Response

EnvironmentInfoResponse

{
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getenvinfo?envName=[string]&session=[string]&lazy=[boolean]

GetEnvProperty

GetEnvProperty (envName, session, [propertyKeys] ) : Response

Returns a list of custom properties from the target environment.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
propertyKeys : “string” (optional)
a comma-separated list of property keys (all properties if “null” or “empty”). For example: “customProperty1,customProperty2”.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/getenvproperty?envName=[string]&session=[string]&propertyKeys=[string]

GetEnvs

GetEnvs (appid, session, [lazy], [ownerUid] ) : EnvironmentInfoResponses

Returns information on all user environments.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
lazy : “boolean” (optional)
defines whether to load only the main environment metadata, e.g. name, alias, domain, etc., (true) or all the environment information (false).
ownerUid : “int” (optional)
unique identifier of the target user account.

Response

EnvironmentInfoResponses

{
"error": "string",
"infos": [
{
"env": {
"aliases": [
{
"domain": "string",
"id": "int",
"useObjectHash": "boolean"
},
"..."
],
"appid": "string",
"appname": "string",
"attributes": "string",
"attributesJson": "JSONObject",
"contexts": [
"AppContext",
"..."
],
"creatorUid": "int",
"displayName": "string",
"domain": {
"domain": "string"
},
"engine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"extDomains": [
{
"domain": "string",
"id": "int",
"sslCert": {
"cert": "string",
"domains": "string",
"id": "int",
"intermediate": "string",
"issuedBy": "string",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"useObjectHash": "boolean"
},
"sslEnabled": "boolean",
"useObjectHash": "boolean"
},
"..."
],
"fullDomain": "string",
"groups": [
{
"color": "string",
"hierarchy": "string",
"icon": "string",
"isIsolated": "boolean",
"name": "string",
"uid": "int",
"visibility": "SHOW(0) | HIDE(1) | SHOW_IF_NOT_EMPTY(2)"
},
"..."
],
"hardwareNodeGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"isBroken": "boolean",
"isFirewallEnabled": "boolean",
"isHAEnabled": "boolean",
"isProtected": "boolean",
"isRemote": "boolean",
"isShared": "boolean",
"isTransferring": "boolean",
"note": "string",
"originalStatus": "ENV_STATUS_TYPE_RUNNING(1) | ENV_STATUS_TYPE_DOWN(2) | ENV_STATUS_TYPE_LAUNCHING(3) | ENV_STATUS_TYPE_SLEEP(4) | ENV_STATUS_TYPE_UNKNOWN(5) | ENV_STATUS_TYPE_CREATING(6) | ENV_STATUS_TYPE_CLONING(7) | ENV_STATUS_TYPE_NOT_EXISTS(8) | ENV_STATUS_TYPE_EXPORTING(9) | ENV_STATUS_TYPE_MIGRATING(10) | ENV_STATUS_TYPE_BROKEN(11) | ENV_STATUS_TYPE_UPDATING(12) | ENV_STATUS_TYPE_STOPPING(13) | ENV_STATUS_TYPE_GOING_TO_SLEEP(14) | ENV_STATUS_TYPE_RESTORING(15)",
"properties": "string",
"sslState": "boolean",
"status": "int",
"uid": "int",
"winDomain": {
"dnsServer": "string",
"name": "string"
},
"zone": "string"
},
"envGroups": [
"string",
"..."
],
"error": "string",
"isExport": "boolean",
"mountpoints": [
{
"creator": "USER(0) | SYSTEM(1)",
"name": "string",
"nodeId": "int",
"path": "string",
"protocol": "string",
"readOnly": "boolean",
"sourceAddressType": "IP(0) | DOMAIN(1) | NODE_GROUP(2)",
"sourceHost": "string",
"sourceNodeId": "int",
"sourcePath": "string",
"type": "LOCAL(0) | INTERNAL(1) | EXTERNAL(2) | VIRTUAL(3)"
},
"..."
],
"nodes": [
{
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
"Feature",
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"..."
],
"nodesData": {
"(key) int": "(value) string",
"...": "..."
},
"nodesInternalDomains": {
"(key) int": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"softNodeGroups": [
"SoftNodeGroup",
"..."
],
"source": "string",
"triggers": [
{
"actions": [
{
"customData": "string",
"type": "NOTIFY(0) | REMOVE_NODE(1) | ADD_NODE(2) | NOTIFY_OOM(3)"
},
"..."
],
"condition": {
"resourceType": "CLOUDLETS(0) | MEM(1) | CPU(2) | DISK(3) | INODES(4) | DISK_IOPS(5) | DISK_IO(6) | NET_EXT(7) | NET_EXT_OUT(8) | OOM_KILLER(9)",
"type": "LESS(<) | GREATER(>)",
"value": "double",
"valueType": "PERCENTAGES(PERCENTAGES) | SPECIFIC(SPECIFIC)"
},
"isDeleted": "boolean",
"isEnabled": "boolean",
"name": "string",
"nodeGroup": "string",
"period": "int",
"state": "IDLE(0) | ACQUIRED(1)",
"vTypes": [
"VType",
"..."
]
},
"..."
],
"uid": "int"
},
"..."
],
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getenvs?session=[string]&lazy=[boolean]&appid=[string]&ownerUid=[int]

GetLogs

GetLogs (envName, session, nodeId, [path] ) : FilesListResponse

use the GetLogsList method instead.

Deprecated since version 4.7

Parameters

envName : “string”
session : “string”
nodeId : “int”
path : “string” (optional)

Response

FilesListResponse

{
"coreRootPath": "string",
"directoryPathList": [
"string",
"..."
],
"error": "string",
"keywords": {
"(key) string": "(value) [{\"absolutePath\":\"string\",\"fileType\":\"string\",\"isDir\":\"boolean\",\"isExported\":\"boolean\",\"isRoot\":\"boolean\",\"lastModified\":\"string\",\"length\":\"long\",\"name\":\"string\",\"permission\":\"string\",\"protocol\":\"string\",\"sourceHost\":\"string\",\"sourceNodeId\":\"int\",\"sourcePath\":\"string\"},\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getlogs?path=[string]&envName=[string]&session=[string]&nodeId=[int]

GetLogsList

GetLogsList (envName, session, nodeId, [path] ) : LogsListResponse

Returns a structured list of the log files.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
path : “string” (optional)
custom path to the log files (/var/log by default).

Response

LogsListResponse

{
"directories": {
"(key) string": "(value) [{\"absolutePath\":\"string\",\"fileType\":\"string\",\"isDir\":\"boolean\",\"isExported\":\"boolean\",\"isRoot\":\"boolean\",\"lastModified\":\"string\",\"length\":\"long\",\"name\":\"string\",\"permission\":\"string\",\"protocol\":\"string\",\"sourceHost\":\"string\",\"sourceNodeId\":\"int\",\"sourcePath\":\"string\"},\"...\"]",
"...": "..."
},
"error": "string",
"groups": {
"(key) string": "(value) [{\"absolutePath\":\"string\",\"fileType\":\"string\",\"isDir\":\"boolean\",\"isExported\":\"boolean\",\"isRoot\":\"boolean\",\"lastModified\":\"string\",\"length\":\"long\",\"name\":\"string\",\"permission\":\"string\",\"protocol\":\"string\",\"sourceHost\":\"string\",\"sourceNodeId\":\"int\",\"sourcePath\":\"string\"},\"...\"]",
"...": "..."
},
"path": "string",
"reason": "int",
"result": "int",
"rotatedLogs": {
"(key) string": "(value) [\"RemouteFile\",\"...\"]",
"...": "..."
},
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getlogslist?path=[string]&envName=[string]&session=[string]&nodeId=[int]

GetNodeGroups

GetNodeGroups (envName, session ) : ObjectResponse

Returns a list of environment node groups (layers).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getnodegroups?envName=[string]&session=[string]

GetNodeTags

GetNodeTags (envName, session, nodeId ) : TagsArrayResponse

Returns a list of all tags for the existing container’s image with additional information on whether the current tag can be safely redeployed to it (the “isRedeployable” flag in the response).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

TagsArrayResponse

{
"array": [
{
"isRedeployable": "boolean",
"name": "string"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getnodetags?envName=[string]&session=[string]&nodeId=[int]

GetRegions

GetRegions (appid, session ) : ArrayResponse

Returns a list of all the regions available for the user.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.

Response

ArrayResponse

{
"array": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getregions?session=[string]&appid=[string]

GetRegionsInner

GetRegionsInner (appid, session, groupName, [isEnabled] ) : ArrayResponse

Returns a list of all the regions available for the user group (trial, beta, billing, etc.).

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
groupName : “string”
unique identifier of the target user group.
isEnabled : “boolean” (optional)
defines whether to include only active regions (true) or not (false).

Response

ArrayResponse

{
"array": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getregionsinner?groupName=[string]&session=[string]&appid=[string]&isEnabled=[boolean]

GetRegistryInfo

GetRegistryInfo (envName, session, nodeGroup ) : RegistryInfoResponse

Returns information on the remote Docker registry for the projects deployed to the specified node group (layer).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeGroup : “string”
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Response

RegistryInfoResponse
```
{
"error": "string",
"reason": "int",
"repo": "string",
"result": "int",
"source": "string",
"url": "string",
"user": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/getregistryinfo?envName=[string]&session=[string]&nodeGroup=[string]

GetSSHAccessInfo

GetSSHAccessInfo (appid, session, nodeId ) : SoftwareNodeResponse

Returns information on a node via SSH configuration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).

Response

SoftwareNodeResponse

{
"error": "string",
"reason": "int",
"result": "int",
"softNode": {
"activeEngine": {
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"addons": [
{
"appTemplateId": "string",
"uniqueName": "string"
},
"..."
],
"address": "string",
"adminUrl": "string",
"adminUrls": "string",
"bandwidthLimit": "int",
"buildCustomData": "string",
"clustergroupid": "int",
"credential": {
"login": "string",
"sshKey": "string"
},
"ctid": "int",
"customItem": "string",
"diskIoLimit": "int",
"diskIopsLimit": "int",
"diskLimit": "int",
"displayName": "string",
"endpoints": [
{
"domain": "string",
"name": "string",
"nodeId": "int",
"privatePort": "int",
"protocol": "TCP(0) | UDP(1)",
"publicPort": "int"
},
"..."
],
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"envId": "string",
"extIps": [
{
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
{
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": {
"comment": "string",
"connected": "boolean",
"displayName": "string",
"dockerHost": "string",
"dockerLogin": "string",
"dockerPassword": "string",
"dockerSSHPort": "int",
"dockerSshKey": "string",
"dockerTCPPort": "int",
"domain": "string",
"domains": [
{
"domain": "string",
"isPrimary": "boolean",
"region": "Region",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
"HardwareNodeGroup",
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "CONFIGURING(0) | CONFIGURING_FAILED(1) | ADDING_FAILED(2) | ACTIVE(3) | DEACTIVATING(4) | DEACTIVATING_FAILED(5) | SET_PRIMARY_FAILED(6) | INACTIVE(7)"
},
"..."
],
"hardwareNodeGroups": [
{
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
{
"address": "string",
"credentials": {
"login": "string",
"sshKey": "string"
},
"data": "string",
"hostGroup": {
"comment": "string",
"data": "string",
"description": "string",
"displayName": "string",
"endpoints": [
"HostGroupEndpoint",
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"type": "RABBITMQ(0) | VHI_API(1) | VHI_ADMIN_API(2) | S3_ENDPOINT(3) | SSP_PANEL(4) | UNKNOWN(5)"
},
"..."
],
"engine": "PAAS(0) | VHI(1) | S3(2) | VCLOUD(3) | ANY(4)",
"iconsData": "string",
"isDefault": "boolean",
"isEnabled": "boolean",
"l3Group": "string",
"metadata": "string",
"osTypes": [
"OSType",
"..."
],
"regionUniqueName": "string",
"shortDescription": "string",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"uniqueName": "string",
"vTypes": [
"VType",
"..."
],
"vzType": "int",
"vzTypes": [
"int",
"..."
]
},
"..."
],
"ipRange": "string",
"isDefault": "boolean",
"isMigrationAllowed": "boolean",
"ospfArea": "int",
"ospfKey": "string",
"shortUniqueName": "string",
"sslEnabled": "boolean",
"sslExpireDate": "date",
"sslType": "CUSTOM(0) | LETSENCRYPT(1)",
"status": "ACTIVE(0) | MAINTENANCE(1)",
"stubnets": "string",
"subnet": "string",
"uniqueName": "string"
},
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"..."
],
"features": [
{
"name": "FIREWALL(0)"
},
"..."
],
"fixedCloudlets": "int",
"flexibleCloudlets": "int",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hn": "HardwareNode",
"hostGroupDisplayName": "string",
"hostGroupUniqName": "string",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"intIP": "string",
"isMaster": "boolean",
"maxchanks": "int",
"messages": [
{
"action": "string",
"actionId": "int",
"data": "string",
"type": "WARNING(0) | INFO(1)"
},
"..."
],
"nodeGroup": "string",
"nodeTypeAlias": "string",
"osType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"packages": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"primaryIpv4": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"primaryIpv6": {
"appid": "string",
"domain": "string",
"ipAddress": "string",
"isBusy": "boolean",
"regionUniqueNames": [
"Region",
"..."
],
"type": "IPV4(0) | IPV6(1)"
},
"softNodeGroup": {
"deployments": [
{
"archiveName": "string",
"context": "string",
"type": "ARCHIVE(0) | GIT(1) | SVN(2)"
},
"..."
],
"isSLBAccessEnabled": "boolean",
"isSequentialDeploy": "boolean",
"name": "string",
"redeployContainerDelay": "int",
"redeployContextDelay": "int",
"restartContainerDelay": "int",
"restartNodeDelay": "int",
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"templateType": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"vType": "CT(0) | VM(1)"
},
"uid": "int",
"url": "string",
"vType": "CT(0) | VM(1)",
"vmMemory": "double",
"vmVCPU": "int"
},
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getsshaccessinfo?session=[string]&appid=[string]&nodeId=[int]

GetSoftwarePackages

GetSoftwarePackages (envName, session, [nodeType], [nodeGroup] ) : ArrayResponse

Returns a list of software packages installed for the target layer or container type.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeType : “string” (optional)
unique identifier of the target node type (software stack), e.g. “tomcat11” for the Tomcat 11 stack.
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Response

ArrayResponse

{
"array": [
{
"actions": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"description": "string",
"documentationUrl": "string",
"emailTemplate": "string",
"iconUrl": "string",
"isInstalled": "boolean",
"keyword": "string",
"name": "string",
"packageName": "string",
"reconfigureFirewall": "boolean",
"requirements": [
{
"id": "int",
"keyword": "string",
"name": "string",
"useObjectHash": "boolean"
},
"..."
],
"user": "string"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getsoftwarepackages?envName=[string]&session=[string]&nodeType=[string]&nodeGroup=[string]

GetStats

GetStats (envName, session, duration, interval, [endtime], [nodeid], [nodetype], [nodeGroup] ) : EnvironmentStatisticResponse

Returns resource consumption statistics for the specified environment. Average consumption for each interval of the given period is provided.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
duration : “long”
period (in seconds) to show statistics for.
interval : “int”
interval (in seconds) to divide the stated period (duration).
endtime : “string” (optional)
end time (UTC) in the format “yyyy-MM-dd hh:mm:ss”, e.g. “2022-11-16 00:00:00” (duration must be passed).
nodeid : “int” (optional)
unique identifier of the target node (container).
nodetype : “string” (optional)
unique identifier of the target node type (software stack), e.g. “tomcat11” for the Tomcat 11 stack. Required if nodeid is not specified.
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Response

EnvironmentStatisticResponse

{
"appid": "string",
"error": "string",
"isTransferring": "boolean",
"reason": "int",
"result": "int",
"source": "string",
"stats": [
{
"cpu": "int",
"disk": "int",
"disk_io_used": "int",
"duration": "int",
"envId": "string",
"iops_used": "int",
"mem": "int",
"netInExt": "long",
"netInInt": "long",
"netOutExt": "long",
"netOutInt": "long"
},
"..."
],
"status": "int"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getstats?duration=[long]&nodetype=[string]&envName=[string]&session=[string]&endtime=[string]&interval=[int]&nodeid=[int]&nodeGroup=[string]

GetSumStat

GetSumStat (envName, session, duration, [endtime] ) : EnvironmentStatisticResponse

Returns resource usage statistics for the specified environment over the given period.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
duration : “long”
period (in seconds) to show statistics for.
endtime : “string” (optional)
end time (UTC) in the format “yyyy-MM-dd hh:mm:ss”, e.g. “2022-11-16 00:00:00” (duration must be passed).

Response

EnvironmentStatisticResponse

{
"appid": "string",
"error": "string",
"isTransferring": "boolean",
"reason": "int",
"result": "int",
"source": "string",
"stats": [
{
"cpu": "int",
"disk": "int",
"disk_io_used": "int",
"duration": "int",
"envId": "string",
"iops_used": "int",
"mem": "int",
"netInExt": "long",
"netInInt": "long",
"netOutExt": "long",
"netOutInt": "long"
},
"..."
],
"status": "int"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/getsumstat?duration=[long]&envName=[string]&session=[string]&endtime=[string]

GetTemplateManifest

GetTemplateManifest (appid, session, nodeType, tag ) : ObjectRespons

Returns a manifest file for the container’s base template.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
nodeType : “string”
unique identifier of the target node type (software stack), e.g. “tomcat11” for the Tomcat 11 stack.
tag : “string”
target tag for the template.

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": "JSONObject",
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/gettemplatemanifest?session=[string]&appid=[string]&tag=[string]&nodeType=[string]

GetTemplates

GetTemplates (appid, session, [type], [ownerUid] ) : TemplateArrayResponse

Returns a list of templates for the specified node types.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
type : “string” (optional)
filter the list by the template type (ALL,NATIVE,CARTRIDGE,DOCKERIZED)
ownerUid : “int” (optional)
filter the list by the templates available for the specific user.

Response

TemplateArrayResponse

{
"array": [
{
"appTemplate": "string",
"autoUpdate": "boolean",
"availableRegions": [
"string",
"..."
],
"config": "string",
"customData": "string",
"description": "string",
"distribution": "string",
"enabled": "boolean",
"engineType": "string",
"engines": [
{
"keyword": "string",
"name": "string",
"packageName": "string",
"type": "string",
"vcsSupport": "boolean",
"version": "string"
},
"..."
],
"features": "string",
"guestOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"hostOSType": "LINUX(0) | WINDOWS2008(1) | WINDOWS2012(2) | WINDOWS2016(3) | WINDOWS2019(4)",
"imagesData": "string",
"isExternalIpRequired": "boolean",
"keepSelectedTags": "boolean",
"minDiskLimit": "int",
"name": "string",
"nodeMission": "string",
"nodeType": "string",
"os": "string",
"packageName": "string",
"published": "boolean",
"registryId": "int",
"repository": "string",
"supportedFeatures": [
{
"name": "FIREWALL(0)"
},
"..."
],
"tags": [
{
"autoUpdate": "boolean",
"cloudletsCount": "int",
"cloudletsMinCount": "int",
"clusterData": "string",
"engine": "string",
"engineName": "string",
"engineVersion": "string",
"hash": "string",
"isCustomSslSupport": "boolean",
"isDefault": "boolean",
"isEnabled": "boolean",
"isExternalIpRequired": "boolean",
"isHighAvailability": "boolean",
"isVcsSupport": "boolean",
"labels": "string",
"name": "string",
"nodeTypeAlias": "string",
"nodeVersion": "string",
"osTemplate": "string",
"properties": {
"isCustomSslSupport": "boolean",
"isExternalIpRequired": "boolean",
"isHighAvailability": "boolean",
"isVcsSupport": "boolean"
},
"scalingMode": "STATELESS(0) | STATEFUL(1)",
"vzTypes": "string"
},
"..."
],
"type": "ALL(0) | NATIVE(1) | CARTRIDGE(2) | DOCKER(3) | DOCKERIZED(4) | OS(5)",
"updateDefaultTag": "boolean",
"userViewMode": "boolean",
"vType": "CT(0) | VM(1)"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/environment/control/rest/gettemplates?session=[string]&appid=[string]&type=[string]&ownerUid=[int]

Migrate

Migrate (envName, session, [hardwareNodeGroup], [isOnline] ) : Response

Migrates an environment to a different user region (learn more in the documentation).

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
hardwareNodeGroup : “string” (optional)
unique identifier of the target user region (host group).
isOnline : “boolean” (optional)
defines whether to perform online migration (true) or offline (false).

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/migrate?envName=[string]&session=[string]&isOnline=[boolean]&hardwareNodeGroup=[string]

ReadLog

ReadLog (envName, session, nodeId, path, [from], [count] ) : LogReadResponse

Returns a part of the required log file.

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeId : “int”
unique identifier of the target node (container).
path : “string”
path to the required log file.
from : “int” (optional)
index number of a symbol to start returning log file data from (all preceding symbols are skipped); from start of the file if not specified.
count : “int” (optional)
number of symbols to return (all subsequent symbols are skipped); till the end of the file if not specified.

Response

LogReadResponse
```
{
"body": "string",
"error": "string",
"linescount": "long",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example

https://[hoster-api-host]/1.0/environment/control/rest/readlog?path=[string]&envName=[string]&session=[string]&count=[int]&from=[int]&nodeId=[int]