Quickstart.Environment/server

Estimated reading: 27 minutes 657 views

CreateEnvironment

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

Creates a new environment with the required settings.

URL

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

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.

Example

Method: POST

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

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"
}

DeleteEnv

DeleteEnv (envName, session, [password] ) :

Deletes an existing environment.

URL

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

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).

Example

Method: POST

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

Response

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

GetEnvs

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

Returns information on all user environments.

URL

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

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.

Example

Method: POST

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

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"
}

AddRepo

AddRepo (appid, session, name, url, [type], [branch], [keyId], [login], [password], [description] ) :

Adds a project from the remote VCS repository to the Deployment Manager storage (i.e. saves the appropriate access link and authentication credentials/SSH key) to allow its subsequent deployment with the Deploy method.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/addrepo

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
name : “string”
project name.
url : “string”
URL to the repository with the project sources.
type : “string” (optional)
VCS repository type (“GIT” or “SVN”).
branch : “string” (optional)
remote repository branch (master by default).
keyId : “int” (optional)
unique identifier of a private SSH key on the account. It can be found in the dashboard (account Settings > SSH Keys > Private Keys) or fetched with the GetSSHKeys method.
login : “string” (optional)
login for authentication in VCS.
password : “string” (optional)
password or token for authentication in VCS.
description : “string” (optional)
custom description for the project.

Example

Method: POST

POST https://[hoster-api-host]/1.0/environment/deployment/rest/addrepo?

password=[string]&session=[string]&appid=[string]&name=[string]&keyId=[int]&description=[string]&type=[string]&login=[string]&branch=[string]&url=[string]

Response

ObjectResponse

stdClass Object
(
[result] => 0
[object] => stdClass Object
(
[name] => "string"
[id] => "int"
[type] => "sting"
[branch] => "string"
[createdOn] => "Timestamp"
[url] => "string"
[hash] => "sting"
)
)

EditRepo

EditRepo (appid, session, id, [name], [type], [url], [branch], [keyId], [login], [password], [description] ) :

Applies changes to the VCS project in the Deployment Manager storage.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/editrepo

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the repository to be edited.
name : “string” (optional)
project name.
type : “string” (optional)
VCS repository type (“GIT” or “SVN”).
url : “string” (optional)
URL to the repository with the project sources.
branch : “string” (optional)
Remote repository branch (master by default).
keyId : “int” (optional)
unique identifier of a private SSH key on the account. It can be found in the dashboard (account Settings > SSH Keys > Private Keys) or fetched with the GetSSHKeys method.
login : “string” (optional)
login for authentication in VCS.
password : “string” (optional)
password or token for authentication in VCS.
description : “string” (optional)
custom description for the project.

Example

Method: POST

POST https://[hoster-api-host]/1.0/environment/deployment/rest/editrepo?

password=[string]&session=[string]&appid=[string]&name=[string]&keyId=[int]&description=[string]&id=[int]&type=[string]&login=[string]&branch=[string]&url=[string]

Response

ObjectResponse

{
"error": "string",
"name": "string",
"object": {
"branch": "string",
"description": "string",
"keyId": "int",
"login": "string",
"name": "string",
"type": "SVN(0) | GIT(1)",
"uid": "int",
"url": "string"
},
"reason": "int",
"result": "int",
"source": "string",
"warnings": [
"string",
"..."
]
}

```
 
```

RemoveRepo

RemoveRepo (appid, session, id ) :

Removes project from the Deployment Manager storage.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/removerepo

Parameters

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

Example

Method: POST

https://[hoster-api-host]/1.0/environment/deployment/rest/removerepo?session=[string]&appid=[string]&id=[int]

Response

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

GetRepos

GetRepos (appid, session, [id] ) :

Returns information on a specific or all projects in the Deployment Manager storage.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/getrepos

Parameters

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

Example

Method: POST

https://[hoster-api-host]/1.0/environment/deployment/rest/getrepos?session=[string]&appid=[string]&id=[int]

Response

ArrayResponse

{
"array": [
{
"branch": "string",
"description": "string",
"keyId": "int",
"login": "string",
"name": "string",
"type": "SVN(0) | GIT(1)",
"uid": "int",
"url": "string"
},
"..."
],
"className": "Class",
"error": "string",
"name": "string",
"reason": "int",
"result": "int",
"source": "string"
}

Deploy

Deploy (envName, session, repo, context, [nodeGroup], [buildNodeId], [settings], [hooks], [delay] ) :

Deploys a VCS project that has been previously added to the Deployment Manager storage with the AddRepo method.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/deploy

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
repo : “string”
unique identifier of a repository in the Deployment Manager (e.g. 1 or {“id”:1}) or JSON object with repository access details {“url”:”…”, [“login”:”…”], [“password”:”…”], [“branch”:”…”], [“type”:”GIT/SVN”], [“keyId”:1]}
context : “string”
target context name of the deployed project.
nodeGroup : “string” (optional)
unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.
buildNodeId : “int” (optional)
unique identifier of a Maven build node (for Java-based projects only).

settings : “json” (optional)

JSON object with the deployment settings:

{
"autoResolveConflict": "boolean",
"autoUpdate": "boolean",
"autoUpdateInterval": "int",
"workDir": "string",
"zdt": "boolean"
}

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”}.
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).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/deployment/rest/deploy?settings=[json]&delay=[int]&envName=[string]&session=[string]&repo=[string]&context=[string]&buildNodeId=[int]&nodeGroup=[string]&hooks=[string]

Response

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

Undeploy

Undeploy (envName, session, nodeGroup, context ) :

Removes a deployed project from the specified context.

URL

https://[hoster-api-host]/1.0/environment/deployment/rest/undeploy

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.
context : “string”
target context name of the deployed project.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/deployment/rest/undeploy?envName=[string]&session=[string]&context=[string]&nodeGroup=[string]

Response

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

```
 
```

AddDomains

AddDomains (envName, session, domains, [nodeGroup], [nodeId], [subdomain] ) :

Assigns additional domains to the target environment. Using the optional nodeGroup or nodeId (has a higher priority if both are specified) parameters, you can set domains for the particular layer or node.
See Additional Domains

URL

https://[hoster-api-host]/1.0/environment/binder/rest/adddomains

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
domains : “string”
a comma- or semicolon-separated list of domains (e.g. domain1,domain2 or domain1;domain2).
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).
subdomain : “boolean” (optional)
defines whether the layer/node subdomain should be attached via “-” (false) or “.” (true, by default).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/adddomains?envName=[string]&session=[string]&domains=[string]&subdomain=[boolean]&nodeGroup=[string]&nodeId=[int]

Response

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

CheckDomain

CheckDomain (appid, [session], domain, [region] ) : Response

Checks if an internal domain name is busy.

URL

https://[hoster-api-host]/1.0/environment/binder/rest/checkdomain

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string” (optional)
user session or personal access token.
domain : “string”
domain name to be checked.
region : “string” (optional)
unique name of a region to be checked.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/checkdomain?session=[string]&appid=[string]&domain=[string]&region=[string]

Response

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

CheckExtDomain

CheckExtDomain (appid, session, extdomain ) :

Checks if an external domain name is busy.

URL

https://[hoster-api-host]/1.0/environment/binder/rest/checkextdomain

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
extdomain : “string”
external domain name to be checked.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/checkextdomain?session=[string]&extdomain=[string]&appid=[string]

Response

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

RemoveDomains

RemoveDomains (envName, session, domains, [nodeGroup], [nodeId] ) :
Removes (detaches) the listed domains from the environment or specific layer/node. Only custom domains can be removed, the default ones will be skipped.
URL
https://[hoster-api-host]/1.0/environment/binder/rest/removedomains
Parameters
- envName : “string”
  target environment name.
- session : “string”
  user session or personal access token.
- domains : “string”
  a comma- or semicolon-separated list of domains (e.g. domain1,domain2 or domain1;domain2); provide “*” to remove all custom domains.
- 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).
Example
Method: POST
https://[hoster-api-host]/1.0/environment/binder/rest/removedomains?envName=[string]&session=[string]&domains=[string]&nodeGroup=[string]&nodeId=[int]
Response
- Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```

GetDomains

GetDomains (envName, session, [nodeGroup], [nodeId], [inShort] ) :

Gets a list of all the domains assigned to the target environment.

URL

https://[hoster-api-host]/1.0/environment/binder/rest/getdomains

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) for filtering, e.g. “cp” for the default application server layer.
nodeId : “int” (optional)
unique identifier of the target node (container) for filtering. It has priority over the nodeGroup parameter.
inShort : “boolean” (optional)
defines whether domains should be presented in the short (true, by default) or extended (false) form.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/getdomains?inShort=[boolean]&envName=[string]&session=[string]&nodeGroup=[string]&nodeId=[int]

Response

DomainsResponse

{
"envDomains": [
"string",
"..."
],
"error": "string",
"nodeGroupsDomains": {
"(key) string": "(value) [\"string\",\"...\"]",
"...": "..."
},
"nodesDomains": {
"(key) string": "(value) [\"string\",\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"source": "string"
}

```
 
```

GetStats

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

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

URL

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

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”

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”

unique identifier of the target node group (layer), e.g. “cp” for the default application server layer.

Example

Method: POST

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]

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"
}

RestartNodes

RestartNodes (envName, session, [nodeGroup], [nodeId], [delay], [isSequential], [manageDNSState] ) : Response

Restarts target containers (nodes).

URL

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

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).
delay : “int” (optional)
delay (in seconds) between two consecutive restarts when using the sequential restart type (I.e. when restart is performed on servers one-by-one to ensure uptime).
isSequential : “boolean” (optional)
defines whether to restart containers one-by-one to ensure uptime (true) or simultaneously (false).
manageDNSState : “boolean” (optional)
defines whether to exclude a target node from DNS for the duration of the operation (true) or not (false, by default). This parameter only works with the sequential processes (isSequential=true) and is ignored otherwise. Enabling the parameter will bring additional delay (as the DNS records have TTL and cannot be disabled instantly), while disabling can cause some of the requests to be lost.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/control/rest/restartnodes?manageDNSState=[boolean]&delay=[int]&envName=[string]&session=[string]&nodeGroup=[string]&nodeId=[int]&isSequential=[boolean]

Response

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

RestartContainerById

RestartContainerById (envName, session, nodeid, [manageDNSState] ) :

URL

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

Deprecated since version 5.1

Parameters

envName : “string”
session : “string”
nodeid : “int”
manageDNSState : “boolean” (optional)

Example

Method: POST

https://[hoster-api-host]/1.0/environment/control/rest/restartcontainerbyid?manageDNSState=[boolean]&envName=[string]&session=[string]&nodeid=[int]

Response

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

GetLogsList

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

Returns a structured list of the log files.

URL

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

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).

Example

Method: POST

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

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"
}

GetSSHAccessInfo

GetSSHAccessInfo (appid, session, nodeId ) :

Returns information on a node via SSH configuration.

URL

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

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).

Example

Method: POST

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

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"
}

```
 
```

ExecCmdById

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

Runs provided commands on the specified node (container).

URL

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

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).

Example

Method: POST

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

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"
}

ExecCmdByGroup

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

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

URL

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

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).

Example

Method: POST

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

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"
}

SetCloudletsCountById

SetCloudletsCountById (envName, session, nodeid, flexibleCloudlets, fixedCloudlets ) :

Sets cloudlets count for compute node(s) (learn more in the documentation).

URL

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

Parameters

envName : “string”
target environment name.
session : “string”
user session or personal access token.
nodeid : “int”
unique identifier of the target node (container). If not defined, the cloudlet count will be set for all compute Nodes of the environment.
flexibleCloudlets : “int”
a number of dynamic cloudlets to be set.
fixedCloudlets : “int”
a number of reserved cloudlets to be set.

Example

https://[hoster-api-host]/1.0/environment/control/rest/setcloudletscountbyid?envName=[string]&session=[string]&flexibleCloudlets=[int]&fixedCloudlets=[int]&nodeid=[int]

Response

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

Quickstart.Environment/server

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

URL

Parameters

Example

Response

DeleteEnv (envName, session, [password] ) :

URL

Parameters

Example

Response

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

URL

Parameters

Example

Response

AddRepo (appid, session, name, url, [type], [branch], [keyId], [login], [password], [description] ) :

URL

Parameters

Example

Response

EditRepo (appid, session, id, [name], [type], [url], [branch], [keyId], [login], [password], [description] ) :

URL

Parameters

Example

Response

RemoveRepo (appid, session, id ) :

URL

Parameters

Example

Response

GetRepos (appid, session, [id] ) :

URL

Parameters

Example

Response

Deploy (envName, session, repo, context, [nodeGroup], [buildNodeId], [settings], [hooks], [delay] ) :

URL

Parameters

Example

Response

Undeploy (envName, session, nodeGroup, context ) :

URL

Parameters

Example

Response

AddDomains (envName, session, domains, [nodeGroup], [nodeId], [subdomain] ) :

URL

Parameters

Example

Response

CheckDomain (appid, [session], domain, [region] ) : Response

URL

Parameters

Example

Response

CheckExtDomain (appid, session, extdomain ) :

URL

Parameters

Example

Response

RemoveDomains (envName, session, domains, [nodeGroup], [nodeId] ) :

URL

Parameters

Example

Response

GetDomains (envName, session, [nodeGroup], [nodeId], [inShort] ) :

URL

Parameters

Example

Response

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

URL

Parameters

Example

Response

RestartNodes (envName, session, [nodeGroup], [nodeId], [delay], [isSequential], [manageDNSState] ) : Response

URL

Parameters

Example