leafleafleafFlower illustration
Updated on May 28, 2024
Environment

environment.Binder

Estimated reading: 24 minutes 757 views
Namespace: Environment
REST: https://[hoster-api-host]/1.0/environment/binder/rest/{method-name}
Scripting: environment.binder.{method-name}
With the platform, you can set your own external domain name for your projects instead of using the default hosting provider domain name. Binding can be done in two ways: by adding a CNAME record or by setting A Records. A CNAME specifies an alias for a canonical name record in a Domain Name System (DNS) database. If you don’t have your own Public IP, your URL is an alias for a single canonical name that is associated with a common platform IP address in the DNS database. In this case, it’s recommended to set your own custom domain by adding a CNAME record. A Record is an entry in your DNS zone file that maps each domain name to an IP address. When you type www.mycustomsite.com, the browser goes to the nameserver for mycustomsite.com and asks for the A Record. This record must point to an IP address – it will be the IP address of your web server. Setting your own custom external domain name using A Record is more appropriate if you have a personal Public IP address. Also you can bind Custom SSL to your custom domain.

Methods

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

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

AddSSLCert (envName, session, key, cert, [interm] ) :

Creates an SSL certificate linked to the user.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • key : “string”

    private key (can be either key body or link to download it).

  • cert : “string”

    domain certificate (can be either certificate body or link to download it).

  • interm : “string” (optional)

    intermediate certificate (CA) (can be either intermediate body or link to download it).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/addsslcert?interm=[string]&envName=[string]&session=[string]&cert=[string]&key=[string]

Response

  • SSLCertResponse
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "sslCert": {
      "cert": "string",
      "domains": "string",
      "id": "int",
      "intermediate": "string",
      "issuedBy": "string",
      "sslType": "CUSTOM(0) | LETSENCRYPT(1)",
      "useObjectHash": "boolean"
   }
}

AttachExtIp (envName, session, nodeid, [type] ) : ObjectResponse

(use the < a href = ” # ! / api / environment.Binder – method – SetExtIpCount ” > SetExtIpCount < / a > method instead)

URL

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

Deprecated since version 5.3

Parameters

  • envName : “string”
  • session : “string”
  • nodeid : “int”
  • type : “string” (optional)

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/attachextip?envName=[string]&session=[string]&type=[string]&nodeid=[int]

Response

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

BindExtDomain (envName, session, extdomain, [certId] ) : ExtDomainResponse

Sets the external domain name for the environment. (use the BindExtDomains method instead).

URL

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

Deprecated since version 5.7-6

Parameters

  • envName : “string”
  • session : “string”
  • extdomain : “string”
  • certId : “int” (optional)

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/bindextdomain?envName=[string]&session=[string]&extdomain=[string]&certId=[int]

Response

  • ExtDomainResponse
    {
   "error": "string",
   "extDomain": {
      "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"
   },
   "reason": "int",
   "result": "int",
   "source": "string"
}

BindExtDomains (envName, session, extDomains, [certId] ) :

Sets the external domain name(s) for the environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • extDomains : “string”

    a semicolon-separated list of external domains to be bound to the environment.

  • certId : “int” (optional)

    unique identifier of the SSL certificate.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/bindextdomains?envName=[string]&session=[string]&extDomains=[string]&certId=[int]

Response

  • ExtDomainResponses
    {
   "error": "string",
   "extDomains": [
      {
         "error": "string",
         "extDomain": {
            "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"
         },
         "reason": "int",
         "result": "int",
         "source": "string"
      },
      "..."
   ],
   "reason": "int",
   "result": "int",
   "source": "string"
}

BindSSL (envName, session, cert_key, cert, intermediate ) :

(use the < a href = ” # ! / api / environment.Binder – method – BindSSLCert ” > BindSSLCert < / a > method instead)

URL

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

Deprecated since version 5.7-6

Parameters

  • envName : “string”
  • session : “string”
  • cert_key : “string”
  • cert : “string”
  • intermediate : “string”

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/bindssl?cert_key=[string]&envName=[string]&session=[string]&intermediate=[string]&cert=[string]

Response

  • SSLCustomResponse
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "sslCustom": {
      "cert": "string",
      "certKey": "string",
      "domain": "string",
      "id": "int",
      "intermediate": "string",
      "sslEnable": "boolean",
      "useObjectHash": "boolean"
   }
}

BindSSLCert (envName, session, certId, [entryPoint], [extDomains] ) :

Binds an existing SSL certificate with the existing external domains. The certificate is bound to all environment domains by default. In order to bind specific domains, provide optional parameters “entryPoint = SLB” and a list of domains in “extDomains”.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • certId : “int”

    unique identifier of the SSL certificate.

  • entryPoint : “string” (optional)

    entry point can be either “ENV” (for all environments domains, by default) or “SLB” (for environment domains specified in the extDomains parameter).

  • extDomains : “string” (optional)

    a comma-separated list of external domains to be bound with the SSL certificate.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/bindsslcert?envName=[string]&session=[string]&certId=[int]&entryPoint=[string]&extDomains=[string]

Response

  • Response
    {
   "error": "string",
   "reason": "int",
   "responses": [
      {
         "error": "string",
         "reason": "int",
         "result": "int",
         "source": "string"
      },
      "..."
   ],
   "result": "int",
   "source": "string"
}

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

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

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

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

DeleteSSL (envName, session ) : 

Removes SSL certificate from the environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

Example

Method: POST

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

Response

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

DetachExtIp (envName, session, nodeid, ip ) :

Removes (detaches) external IP address from a node.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • nodeid : “int”

    unique identifier of the target node (container).

  • ip : “string”

    IP address that should be removed from the node.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/detachextip?envName=[string]&session=[string]&ip=[string]&nodeid=[int]

Response

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

DisableSSL (envName, session ) :

Disables SSL on the environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

Example

Method: POST

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

Response

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

EditSSLCert (envName, session, id, [key], [cert], [interm] ) :

Updates an SSL certificate that is linked to the user ID.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • id : “int”

    unique identifier of the target SSL certificate.

  • key : “string” (optional)

    private key (can be either key body or link to download it).

  • cert : “string” (optional)

    domain certificate (can be either certificate body or link to download it).

  • interm : “string” (optional)

    intermediate certificate (CA) (can be intermediate body or link to download it); if set to “*”, “null”, or “none”, the intermediate certificate will be removed from the platform database.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/editsslcert?interm=[string]&envName=[string]&session=[string]&cert=[string]&id=[int]&key=[string]

Response

  • SSLCertResponse
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "sslCert": {
      "cert": "string",
      "domains": "string",
      "id": "int",
      "intermediate": "string",
      "issuedBy": "string",
      "sslType": "CUSTOM(0) | LETSENCRYPT(1)",
      "useObjectHash": "boolean"
   }
}

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

GetExtDomains (appid, session ) :

Returns a list of all the external domains for the environment.

URL

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

Parameters

  • appid : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

Example

Method: POST

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

Response

  • ExtDomainResponses
    {
   "error": "string",
   "extDomains": [
      {
         "error": "string",
         "extDomain": {
            "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"
         },
         "reason": "int",
         "result": "int",
         "source": "string"
      },
      "..."
   ],
   "reason": "int",
   "result": "int",
   "source": "string"
}

GetSSL (envName, session ) :

Returns a list of all the SSL certificates assigned to the target environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

Example

Method: POST

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

Response

  • SSLCustomResponse
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "sslCustom": {
      "cert": "string",
      "certKey": "string",
      "domain": "string",
      "id": "int",
      "intermediate": "string",
      "sslEnable": "boolean",
      "useObjectHash": "boolean"
   }
}

GetSSLCerts (envName, session, [ids] ) :

Returns SSL certificates for the specific or all certificates assigned to the target environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • ids : “string” (optional)

    a comma-separated list of certificate IDs (will return all certificates if not specified).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/getsslcerts?envName=[string]&session=[string]&ids=[string]

Response

  • SSLCertResponses
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "sslCerts": [
      {
         "cert": "string",
         "domains": "string",
         "id": "int",
         "intermediate": "string",
         "issuedBy": "string",
         "sslType": "CUSTOM(0) | LETSENCRYPT(1)",
         "useObjectHash": "boolean"
      },
      "..."
   ]
}

ManageNodeDnsState (envName, session, [nodeId], enabled ) :

Enables/disables external and internal DNS records for the target node. The method is only applicable for node groups with multiple nodes. The recommended flow is to exclude a node from DNS before performing any maintenance operations to it (shutdown, restart, redeploy, etc.) to prevent losing any requests.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • nodeId : “int” (optional)

    unique identifier of the target node (container).

  • enabled : “boolean”

    defines whether to enable (true) or disable (false) DNS records for the target node.

Example

Method: POST

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

Response

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

MoveExtIps (envName, session, sourceNodeId, targetNodeId, ips ) :

Moves external IP addresses from the source node to the target node.

URL

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

Parameters

  • envName : “string”

    source environment name.

  • session : “string”

    user session or personal access token.

  • sourceNodeId : “int”

    unique identifier of the source node (from the source environment).

  • targetNodeId : “int”

    unique identifier of the target node (could be from the same or different environment on the account).

  • ips : “string”

    a comma- or semicolon-separated list of IP addresses that should be transferred (use “*” to move all the source node external IP addresses).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/moveextips?envName=[string]&session=[string]&sourceNodeId=[int]&targetNodeId=[int]&ips=[string]

Response

  • SoftwareNodesListResponse
    {
"error": "string",
"filters": [
"..."
],
"isFiltered": "boolean",
"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": [
{
"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"
},
"..."
],
"reason": "int",
"result": "int",
"source": "string"
}

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

RemoveExtDomain (envName, session, extdomain ) :

Removes (detaches) an external domain name from the environment.

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • extdomain : “string”

    external domain name to be detached.

Example

Method: POST

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

Response

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

RemoveSSL (envName, session ) :

(use the < a href = ” # ! / api / environment.Binder – method – RemoveSSLCerts ” > RemoveSSLCerts < / a > method instead)

URL

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

Deprecated since version 4.9.5

Parameters

  • envName : “string”
  • session : “string”

Example

Method: POST

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

Response

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

RemoveSSLCerts (envName, session, ids ) :

Removes SSL certificates (all or by IDs).?

URL

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

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • ids : “string”

    a comma-separated list of certificate IDs (e.g. id1,id2,id3); provide “*” to remove all certificates.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/removesslcerts?envName=[string]&session=[string]&ids=[string]

Response

  • Response
    {
"error": "string",
"reason": "int",
"responses": [
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
},
"..."
],
"result": "int",
"source": "string"
}

SetExtIpCount (envName, session, type, count, [nodeGroup], [nodeId] ) :

Sets (changes) the number of external IPs attached to the specific node or all nodes in the layer.

URL

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

Parameters

  • envName: “string”

    target environment name.

  • session: “string”

    user session or personal access token.

  • type: “string”

    external IP address type (“ipv4” or “ipv6”).

  • count: “int”

    number of IPs to add per container – requires the multiple IPs feature enabled on the account.

  • 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/setextipcount?envName=[string]&session=[string]&count=[int]&type=[string]&nodeGroup=[string]&nodeId=[int]

Response

  • ArrayExtIPAddressResponse
    {
"error": "string",
"ipAddresses": {
"(key) string": "(value) [{\"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)\"},\"...\"]",
"...": "..."
},
"reason": "int",
"result": "int",
"source": "string"
}

SwapExtDomains (envName, session, targetappid ) :

Swaps the external domain names between two environments.

URL

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

Parameters

  • envName : “string”

    source (first) environment name.

  • session : “string”

    user session or personal access token.

  • targetappid : “string”

    Target (second) environment name.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/swapextdomains?targetappid=[string]&envName=[string]&session=[string]

Response

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

SwapExtIps (envName, session, sourceNodeId, targetNodeId, [sourceIp], [targetIp] ) :

Swaps external IP addresses between source and target nodes (just moves IP if the target node does not have one).

URL

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

Note: Before using the swapExtIps API request, please get acquainted with the method specifics listed in the documentation.

Parameters

  • envName : “string”

    source environment name.

  • session : “string”

    user session or personal access token.

  • sourceNodeId : “int”

    source node ID (from the source environment).

  • targetNodeId : “int”

    target node ID (could be from the same or different environment on the account).

  • sourceIp : “string” (optional)

    source IP address that should be swapped (if not specified, all external IPs from source node are transferred to the target).

  • targetIp : “string” (optional)

    target IP address that should be swapped (if not specified, all external IPs from target node are transferred to the source).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/swapextips?targetIp=[string]&sourceIp=[string]&envName=[string]&session=[string]&sourceNodeId=[int]&targetNodeId=[int]

Response

  • SoftwareNodesListResponse
    {
"error": "string",
"filters": [
"..."
],
"isFiltered": "boolean",
"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": [
{
"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"
},
"..."
],
"reason": "int",
"result": "int",
"source": "string"
}

UnbindSSLCert (envName, session, [extDomains] ) :

Removes (unbinds) SSL certificates from the environment or specific external domains.

URL

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

Parameters

  • envName: “string”

    target environment name.

  • session: “string”

    user session or personal access token.

  • extDomains: “string” (optional)

    a comma-separated list of external domains to be unbound (if not specified, SSL certificates are unbound from the environment).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/binder/rest/unbindsslcert?envName=[string]&session=[string]&extDomains=[string]

Response

  • Response
    {
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
Next - Environment environment.Build

Leave a Comment

Powered By AccuWeb.Cloud