Gets the details for a individual server group and any sub-groups and servers that it contains. Calls to this operation must include a token acquired from the authentication endpoint. See the Login API for information on acquiring this token.
When to Use It
Use this API operation when you want to identify the servers in a particular group, retrieve a group hierarchy, or get links to information (e.g. billing, monitoring, scheduled activities) about a group.
URL
Structure
GET https://api.ctl.io/v2/groups/{accountAlias}/{groupId}
Example
GET https://api.ctl.io/v2/groups/ALIAS/2a5c0b9662cf4fc8bf6180f139facdc0
Request
URI Parameters
Name
Type
Description
Req.
AccountAlias
string
Short code for a particular account.
Yes
GroupID
string
ID of the group being queried. Retrieved from query to parent group, or by looking at the URL on the new UI pages in the Control Portal.
Yes
Response
Group Entity Definition
Name
Type
Description
id
string
ID of the group being queried
name
string
User-defined name of the group
description
string
User-defined description of this group
locationId
string
Data center location identifier
type
string
Group type which could include system types like "archive"
status
string
Describes if group is online or not
serversCount
integer
Number of servers this group contains
groups
array
Refers to this same entity type for each sub-group
links
array
Collection of [entity links](../Getting Started/api-v20-links-framework.md) that point to resources related to this group