The List All Accessible Servers call returns an array of JSON objects representing each Endpoint to which the logged-in User has access.


Query:


http://host/dmadminweb/API/servers[?all=y]


Where:


Host

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


If the all parameter is not specified, then only the servers associated with the User’s home Domain are listed. If the all parameter is specified and is set to “y” then the result includes the servers included in any accessible Sub-Domains.


Example Result:


{

       "success": true,

       "result": [

                               {

                                       "automd5": true,

                                       "autoping": true,

                                       "basedir": "/tmp",

                                       "comptypes": [

                                               "Application File"

                                       ],

                                       "credential": "LDAP",

                                       "Domain": "GLOBAL.FIS",

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

               }

               Repeats for each Endpoint

       ]

}


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 array of objects, each object representing a server being retrieved.


For each Endpoint Object:


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 server’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 server’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 server is a User, then this is the name of the User.

ownergroup

If the “owner” of the server is a User Group, then this is the name of that group.

pingend

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

pingstart

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

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.