leafleafleafFlower illustration
Updated on May 7, 2024
environment.Control

environment.control.Env

Estimated reading: 29 minutes 93 views

AddEnvProperty (envName, session, properties ) :

Adds new custom properties to the target environment.

URL

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

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

Example

Method: POST

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

Response

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

ApplyEnvProperty (envName, session, properties ) : Response

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

URL

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

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

Example

Method: POST

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

Response

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

AttachEnvGroup (envName, session, envGroup ) :

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

URL

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

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.

Example

Method: POST

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

Response

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

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

Clones an existing environment.

URL

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

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

Example

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

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

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 (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

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

DetachEnvGroup (envName, session, envGroup ) : Response

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

URL

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

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.

Example

Method: POST

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

Response

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

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

URL

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

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”
  • ownerUid : “int” (optional)

    unique identifier of the target user account.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/control/rest/getbasicenvsinfo?session=[string]&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"
}

GetEnvInfo (envName, session, [lazy] ) :

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

URL

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

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

Example

Method: POST

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

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

GetEnvProperty (envName, session, [propertyKeys] ) :

Returns a list of custom properties from the target environment.

URL

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

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

Example

Method: POST

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

Response

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

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

RemoveEnvProperty (envName, session, propertyKeys ) :

Removes custom properties from the target environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • propertyKeys : “string”

    a comma-separated list of property keys. For example: “customProperty1,customProperty2”.

Example

Method: POST

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

Response

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

SetEnvDisplayName (envName, session, [displayName] ) :

Sets environment’s display name.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • displayName : “string” (optional)

    new display name of the environment

Example

Method: POST

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

Response

  • Response
    Array
(
[result] => 0
)

SetEnvGroup (envName, session, envGroup ) :

Sets environment’s groups (learn more in the documentation).

URL

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

Parameters

Example

Method: POST

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

Response

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

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

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

URL

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

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.

Example

Method: POST

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

Response

  • Response
    {
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
environment.Control - Previous environment.control.Endpoint Next - environment.Control environment.control.Container

Leave a Comment

Powered By AccuWeb.Cloud