Get Subnet Group

Retrieves information of a specified subnet group.

HTTP Request

GET /api/sonar/subnet-groups/:guid
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/subnet-groups/bb994ca4-1471-4b91-89f2-99a61bd529b5
Request Parameter
KeyRequiredTypeDescriptionNote
guidOStringSubnet group identifier36 characters

Success Response

{
  "subnet_group": {
    "guid": "bb994ca4-1471-4b91-89f2-99a61bd529b5",
    "name": "Private network",
    "description": null,
    "subnet_count": 3,
    "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
    "company_name": "Logpresso",
    "user_guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
    "user_name": "Admin",
    "created": "2022-09-01 00:31:14+0900",
    "updated": "2022-09-01 00:31:14+0900"
  }
}
  • subnet_group (Map): Subnet group
    • guid (String): Subnet group GUID
    • name (String): Subnet group name
    • description (String): Subnet group description
    • subnet_count (32-bit integer): Number of the subnets that belong to the group
    • company_guid (String): GUID of the company (tenant) to which the group belongs.
    • company_name (String): Name of the company (tenant) to which the group belongs.
    • user_guid (String): GUID of the user who creates the subnet group
    • user_name (String): Name of the user who creates the subnet group

Error Responses

Identifier is not in valid GUID format

HTTP status code 400

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
Subnet group is not found

HTTP status code 200

{
  "subnet_group": null
}