The Create a New Server call adds a new Endpoint. All the new attributes are set through parameters to the API.

API Call


http://host/dmadminweb/API/new/server/server_id

[?param=value]

[&param=value]+


Where:


Host

The hostname and port of the DeployHub Server (e.g.: hostname:8080 or for SaaS console.deployhub.com).

server_id

The name of the Endpoint to be created.

Param=value

An Endpoint attribute (listed below).

Domain

Is the identifier of the Domain to which the Endpoint is to be moved. Either its name, its qualified name (i.e.: with its parent Domain(s) included in dot notation) or its internal ID.

env

Is the identifier of the Environment to which the Endpoint should be allocated. Either its name, its qualified name (i.e.: with its parent Domain(s) included in dot notation) or its internal ID.

type

The Endpoint type. i.e.: Windows, Unix etc.

hostname

The Endpoint’s hostname.

protocol

The transport protocol used to deploy to this Endpoint. One of ftp, ftps, sftp or win.

basedir

The base directory for this Endpoint.

credname

The name of the credential User to connect to this Endpoint.

autoping

Y or N. Whether auto ping is enabled.

automd5

Y or N. Whether auto MD5 checks are enabled.

comptype

A CSV list of Component types that this Endpoint will accept.

pinginterval

The ping interval. Value from 15 – 240 in 15 minute increments. Ignored if “autoping” is N or not specified.

pingstart

The start time for autoping in HH:MM format. Ignored if “autoping” is N or not specified.

pingend

The end time for autoping in HH:MM format. Ignored if “autoping” is N or not specified.

pingtemplate

The ping template to use if the Endpoint stops responding to ping or other parts of the connection test. Ignored if “autoping” is N or not specified.

md5template

The MD5 template to use if any of the previously deployed files have different MD5 sums to those calculated at deployment time. Ignored if “automd5” is N or not specified.

sshport

The port number for SSH connections if protocol is SFTP.


NOTE: If “Domain” is not specified, then the server is created in the logged-in User’s home Domain.

Example Result:


{

       success: true

}