get

<< Click to Display Table of Contents >>

Navigation:  API > servergroups >

get

Description

Obtains information about a specific cluster.

Syntax

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

Required parameters

servergroup-id: GUID of the server cluster (listed in online.cameyo.com/servergroups) or an empty GUID (00000000-0000-0000-0000-000000000000) if you wish to list all of the company's clusters.

Return

200: success.

400: invalid parameters.

403: authentication failed or insufficient permissions.

404: item not found.

500: an internal error has occurred.

Response

id: cluster ID.

name: cluster's descriptive name.

created: server creation time.

powertags: cluster's powertags, if any.

Response example (with a specific servergroup-id):

{

 "id": "f6c426bb-f0bc-468f-b039-d213b8ff20c4",

 "name": "cirrus",

 "created": "2023-04-27T08:26:55.55",

 "powertags": [

   "!WEBFS=1",

   "!TASKBAR=1",

   "!ALLOW_COUNTRY=FR,PT",

   "!USERNAME=%USER_SHORTID%",

 ]

}

 

Response example (with empty GUID):

[

{

   "id": "be4dc96b-3cfb-4f42-a67a-4176c104b704",

   "name": "cloud6",

   "created": "2024-01-08T22:24:26.093",

   "powertags": [

     "!USERPROFILE_DRIVE=X",

     "!FILEDIALOG_MYFILES=0"

   ]

 },

 {

   "id": "a22b517a-2acc-43d0-9bef-65f4c27a7df5",

   "name": "rich-clipboard.account-clone",

   "created": "2022-07-07T10:34:20.04",

   "powertags": [

     "!USERPROFILE_DRIVE=X",

     "!FILEDIALOG_MYFILES=0"

   ]

 },

 {

   "id": "32ada299-39b3-488e-ac0b-66f0c0b0f764",

   "name": "selfhost",

   "created": "2023-06-30T17:07:18.83",

   "powertags": [

     "!USERPROFILE_DRIVE=X",

     "!FILEDIALOG_MYFILES=0"

   ]

 }

]