> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/host-access/host-groups.md).

# Host groups

Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.

Use these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags.

## GET /host\_groups

> List host groups

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Host groups","description":"Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.\n\nUse these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."},"tag_key":{"name":"tag_key","in":"query","schema":{"type":"string"},"description":"Return only objects with this tag key."},"tag_value":{"name":"tag_value","in":"query","schema":{"type":"string"},"description":"Return only objects with this tag value."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"HostGroups":{"type":"object","properties":{"allow_different_host_types":{"type":"boolean","description":"When `true`, the group may contain hosts of mixed types (Linux, Windows, ESX). When `false`, all members must share the same `type`."},"connectivity_type":{"type":"string","description":"Reserved; defaults match the SDP's default connectivity type."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"hosts_count":{"type":"integer","description":"Number of hosts currently in the group."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"views_count":{"type":"integer","description":"Number of volume group views mapped to the group."},"volumes_count":{"type":"integer","description":"Number of volumes mapped to the group."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/host_groups":{"get":{"tags":["Host groups"],"summary":"List host groups","operationId":"listHostGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"},{"$ref":"#/components/parameters/tag_key"},{"$ref":"#/components/parameters/tag_value"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/HostGroups"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /host\_groups

> Create host group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Host groups","description":"Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.\n\nUse these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"HostGroups":{"type":"object","properties":{"allow_different_host_types":{"type":"boolean","description":"When `true`, the group may contain hosts of mixed types (Linux, Windows, ESX). When `false`, all members must share the same `type`."},"connectivity_type":{"type":"string","description":"Reserved; defaults match the SDP's default connectivity type."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"hosts_count":{"type":"integer","description":"Number of hosts currently in the group."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"views_count":{"type":"integer","description":"Number of volume group views mapped to the group."},"volumes_count":{"type":"integer","description":"Number of volumes mapped to the group."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/host_groups":{"post":{"tags":["Host groups"],"summary":"Create host group","operationId":"createHostGroups","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostGroups"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Create host group","properties":{"name":{"type":"string","description":"Display name."},"description":{"$ref":"#/components/schemas/HostGroups/properties/description"},"connectivity_type":{"$ref":"#/components/schemas/HostGroups/properties/connectivity_type"},"allow_different_host_types":{"$ref":"#/components/schemas/HostGroups/properties/allow_different_host_types"},"authentication_profiles":{"type":"string"}},"required":["name"]}}}}}}}}
```

## GET /host\_groups/{id}

> Get a host group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Host groups","description":"Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.\n\nUse these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"HostGroups":{"type":"object","properties":{"allow_different_host_types":{"type":"boolean","description":"When `true`, the group may contain hosts of mixed types (Linux, Windows, ESX). When `false`, all members must share the same `type`."},"connectivity_type":{"type":"string","description":"Reserved; defaults match the SDP's default connectivity type."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"hosts_count":{"type":"integer","description":"Number of hosts currently in the group."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"views_count":{"type":"integer","description":"Number of volume group views mapped to the group."},"volumes_count":{"type":"integer","description":"Number of volumes mapped to the group."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/host_groups/{id}":{"get":{"tags":["Host groups"],"summary":"Get a host group","operationId":"getHostGroups","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostGroups"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /host\_groups/{id}

> Delete a host group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Host groups","description":"Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.\n\nUse these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}},"paths":{"/host_groups/{id}":{"delete":{"tags":["Host groups"],"summary":"Delete a host group","operationId":"deleteHostGroups","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /host\_groups/{id}

> Update a host group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Host groups","description":"Host groups organize hosts that need access to the same volumes, such as the nodes of a database cluster. Mapping a volume to a host group makes it available to every host in the group.\n\nUse these endpoints to create a group, update its description or CHAP profiles, allow hosts of different operating system types in the same group, or manage its tags."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"HostGroups":{"type":"object","properties":{"allow_different_host_types":{"type":"boolean","description":"When `true`, the group may contain hosts of mixed types (Linux, Windows, ESX). When `false`, all members must share the same `type`."},"connectivity_type":{"type":"string","description":"Reserved; defaults match the SDP's default connectivity type."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"hosts_count":{"type":"integer","description":"Number of hosts currently in the group."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"views_count":{"type":"integer","description":"Number of volume group views mapped to the group."},"volumes_count":{"type":"integer","description":"Number of volumes mapped to the group."}}},"UserTag":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"is_inheritable":{"type":"boolean"},"is_automatic":{"type":"boolean"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/host_groups/{id}":{"patch":{"tags":["Host groups"],"summary":"Update a host group","operationId":"updateHostGroups","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Update host group","properties":{"name":{"type":"string","description":"Display name."},"description":{"$ref":"#/components/schemas/HostGroups/properties/description"},"allow_different_host_types":{"$ref":"#/components/schemas/HostGroups/properties/allow_different_host_types"},"map_auth_profiles_names":{"type":"string"},"unmap_auth_profiles_names":{"type":"string"},"force_sessions_disconnect":{"type":"boolean"},"disconnect_host_sessions":{"type":"boolean"}}},{"type":"object","title":"Maintain tags","properties":{"action":{"type":"string","enum":["set_object_tags"],"description":"Tag operation to perform."},"chkargs_validation_only":{"type":"boolean","description":"If `true`, validates the request and reports whether it would succeed without applying it."},"user_tags":{"type":"array","items":{"$ref":"#/components/schemas/UserTag"},"description":"Tags to set on the object."}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostGroups"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/host-access/host-groups.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
