The List Specific Server call returns a JSON object representing the specified Endpoint.


Query:


http://host/dmadminweb/API/server/identifier


Where:


Host

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

Identifier

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


Example Result:


{

       "success": true,

       "result": {

                                       "automd5": true,

                                       "autoping": true,

                                       "basedir": "/tmp",

                                       "comptypes": [

                                               "Application File"

                                       ],

                                       "credential": "LDAP",

                                       "Domain": "Openmake",

                                       "Environments": [

                                               {

                                               "Domain": "GLOBAL",

                                               "id": 2,

                                               "name": "tempenv"

                                               }

                               Repeats for each Environment

                                       ],

                                       "hostname": "",

                                       "id": 84,

                                       "md5template": "DeployFailure",

                                       "name": "serverfromui",

                                       "owneruser": "fisadmin",

                                       "pingend": "03:30",

                                       "pingstart": "01:15",

                                       "pingtemplate": "DeploySuccess",

                                       "protocol": "sftp",

                                       "summary": ""

               }

}

       


success

Is true or false depending on the success or failure of the query. If success is false, then result is not returned, and a text field named “error” is returned instead.

result

Is a JSON object representing the Endpoint being retrieved.

automd5

Is a Boolean representing if “Auto MD5 Scanning” is set for the Endpoint.

autoping

Is a Boolean representing if “Auto Ping” is set for the Endpoint.

basedir

Is the base directory for the Endpoint.

comptypes

Is an array of strings listing the Component types associated with this Endpoint (i.e.” the Component types that the Endpoint will accept during a deployment).

credential

Is the name of the Credential used to connect to the Endpoint.

Domain

Is the Endpoint’s fully qualified Domain.

Environments

Is an array of Environment objects representing each Environment to which the Endpoint belongs.

hostname

Is the hostname of the Endpoint.

id

Is the Endpoint’s internal object ID.

md5template

Is the name of the template to be used for notification should the Endpoint fail an automated mD5 scan.

name

Is the Endpoint’s name.

owneruser

If the “owner” of the Endpoint is a User, then this is the name of the User.

ownergroup

If the “owner” of the Endpoint is a user Group, then this is the name of that Group.

pingend

The time after which auto ping will stop (in format HH

pingstart

The time at which auto ping will start (in format HH

pingtemplate

Is the name of the template to be used for notification should the Endpoint fail an automated ping.

protocol

The protocol used to connect to the Endpoint.

summary

Any summary text associated with the Endpoint.


Within each Environment Object:


Domain:

The fully-qualified Domain name of the Domain in which the Environment is located.

Id:

Is the internal ID of the Environment.

Name:

Is the name of the Environment.