list

<< Click to Display Table of Contents >>

Navigation:  API > servergroups >

list

Description

Returns the list of servers within a given cluster.

Syntax

https://api.cameyo.com/servergroups/[servergroup-id]/list?clientId=...&clientSecret=...

Required parameters

servergroup-id: GUID of the server cluster (listed in online.cameyo.com/servergroups)

Return codes

200: success, along with the servers list.

400: invalid parameters.

403: authentication failed or insufficient permissions.

404: an item with this id does not exist.

Response

id: server ID.

created: server creation time.

enabled: is server enabled or disabled.

name: server name.

shortname: DNS subname (cloud / Cameyo-managed SSL servers only).

Response example

[

 {

   "id": "a2f3304f-f968-4a50-ade5-6eb705446c33",

   "created": "2023-10-04T18:03:18.423",

   "enabled": true,

   "name": "loadtest-2",

   "shortname": "loadtest-2"

 },

 {

   "id": "e9316f88-0c7c-4c19-82b9-882439112c77",

   "created": "2023-10-04T18:03:18.267",

   "enabled": true,

   "name": "loadtest-1",

   "shortname": "loadtest-1"

 },

 {

   "id": "385c5fa7-3f36-4c70-80fb-8f48b6f9854c",

   "created": "2023-10-04T18:03:18.203",

   "enabled": true,

   "name": "loadtest-5",

   "shortname": "loadtest-5"

 }

]