## Site groups (`site-groups`)

Groups for organizing sites; names are unique within a tenant and a group that still contains sites cannot be deleted.

Authentication: User (some parameters admin only) · Docs: https://www-demo.kuxitong.com/en/docs/api/site-groups

### GET `/api/v2/site-groups`

List site groups · Authentication: User (some parameters admin only)

Query parameters:

| Field | Type | Required | Description |
|---|---|---|---|
| `page` | integer |  | Page number, starting from 1 Default: 1 |
| `page_size` | integer |  | Items per page Default: 20 |
| `sort` | string |  | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
| `tenant_id` | integer |  | Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data |
| `ids` | string |  | Only list these IDs: comma-separated positive integers, at most 200 after deduplication (same as the page_size limit; more returns 400); an empty value is the same as omitting it. Combined with other filters as an intersection; IDs you cannot see are silently left out. Pagination is unchanged: set page_size to at least the number of IDs to get them in one page |

```sh
curl "https://panel.example.com/api/v2/site-groups" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### POST `/api/v2/site-groups`

Create site group · Authentication: User (some parameters admin only)

Query parameters:

| Field | Type | Required | Description |
|---|---|---|---|
| `tenant_id` | integer |  | Owning tenant when an admin creates on behalf of a tenant (required); ignored for tenant callers, whose own account is always the owner. |

Request body:

| Field | Type | Required | Description |
|---|---|---|---|
| `des` | string |  | Description |
| `name` | string | Yes | Name |

```sh
curl -X POST "https://panel.example.com/api/v2/site-groups" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/site-groups/{id}`

Get site group · Authentication: User (some parameters admin only)

```sh
curl "https://panel.example.com/api/v2/site-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### PUT `/api/v2/site-groups/{id}`

Update site group · Authentication: User (some parameters admin only)

Request body:

| Field | Type | Required | Description |
|---|---|---|---|
| `des` | string |  | Description |
| `name` | string | Yes | Name |

```sh
curl -X PUT "https://panel.example.com/api/v2/site-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### DELETE `/api/v2/site-groups/{id}`

Delete site group · Authentication: User (some parameters admin only)

```sh
curl -X DELETE "https://panel.example.com/api/v2/site-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

Site groups object:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string |  | Created at (read-only) |
| `des` | string |  | Description |
| `id` | integer |  | Record ID (read-only) |
| `name` | string |  | Name |
| `tenant_id` | integer |  | Owner tenant (user) ID (read-only) |
| `updated_at` | string |  | Updated at (read-only) |