leafleafleafFlower illustration
Updated on May 29, 2024
Quick Reference

Quickstart.Network

Estimated reading: 16 minutes 643 views

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”

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

  • nodeId: “int”

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

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

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

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

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

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

  • DeleteSSL (envName, session ) : 

    Removes SSL certificate from the environment.

    URL

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

    Parameters

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

DisableSSL (envName, session ) :

Disables SSL on the environment.

URL

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

Parameters

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

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

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"
},
"..."
]
}

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

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

GetRegions (appid, session ) :

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

URL

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

Parameters

  • appid : “string” (optional)

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

  • session : “string”

    user session or personal access token.

Example

Method: POST

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

Response

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

Leave a Comment

Powered By AccuWeb.Cloud