> 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/volumes-and-data-protection/user-tags.md).

# User tags

User-defined metadata tags associated with supported Silk objects. Tags can be used to organize resources, apply business context, and filter API queries.

Supported object types: DataPods, host groups, hosts, volume groups, volumes, snapshots, views, and replication sessions.

**Managing tags through object endpoints.** Tags can be created directly with `POST /user_tags`, but for most workflows Silk recommends managing tags through the associated object endpoint (for example `/volumes`, `/hosts`, or `/volume_groups`). Object endpoints provide additional tag management options and support filtering objects by tag key and value.

**Inherited tags.** This endpoint returns only tags that are directly owned by an object or explicitly redefined on it. Inherited tags are calculated on demand and are not included. To retrieve all tags for an object, including inherited ones, use the object's endpoint.

**Reserved tag prefixes.** Only users with the `root` role can create or modify tags whose key starts with `Internal_Echo_`, `Internal_Flex_`, `Internal_Clarity_`, `Internal_Silk_`, or `Internal_Sys_`. Other users receive an error saying the key is reserved for internal system use.

## List user tags

> Returns only tags owned by, or explicitly redefined on, an object. Inherited tags are not included; use the object's own endpoint to see them.

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"User tags","description":"User-defined metadata tags associated with supported Silk objects. Tags can be used to organize resources, apply business context, and filter API queries.\n\nSupported object types: DataPods, host groups, hosts, volume groups, volumes, snapshots, views, and replication sessions.\n\n**Managing tags through object endpoints.** Tags can be created directly with `POST /user_tags`, but for most workflows Silk recommends managing tags through the associated object endpoint (for example `/volumes`, `/hosts`, or `/volume_groups`). Object endpoints provide additional tag management options and support filtering objects by tag key and value.\n\n**Inherited tags.** This endpoint returns only tags that are directly owned by an object or explicitly redefined on it. Inherited tags are calculated on demand and are not included. To retrieve all tags for an object, including inherited ones, use the object's endpoint.\n\n**Reserved tag prefixes.** Only users with the `root` role can create or modify tags whose key starts with `Internal_Echo_`, `Internal_Flex_`, `Internal_Clarity_`, `Internal_Silk_`, or `Internal_Sys_`. Other users receive an error saying the key is reserved for internal system use."}],"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."}},"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."}}},"UserTags":{"type":"object","properties":{"id":{"type":"integer"},"is_automatic":{"type":"boolean"},"is_inheritable":{"type":"boolean"},"key":{"type":"string"},"object_id":{"type":"integer"},"object_type":{"type":"string"},"value":{"type":"string"}}},"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":{"/user_tags":{"get":{"tags":["User tags"],"summary":"List user tags","operationId":"listUserTags","description":"Returns only tags owned by, or explicitly redefined on, an object. Inherited tags are not included; use the object's own endpoint to see them.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/UserTags"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## Create tag

> Silk recommends managing tags through the object endpoints (\`/volumes\`, \`/hosts\`, \`/volume\_groups\`, and so on) for most workflows.

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"User tags","description":"User-defined metadata tags associated with supported Silk objects. Tags can be used to organize resources, apply business context, and filter API queries.\n\nSupported object types: DataPods, host groups, hosts, volume groups, volumes, snapshots, views, and replication sessions.\n\n**Managing tags through object endpoints.** Tags can be created directly with `POST /user_tags`, but for most workflows Silk recommends managing tags through the associated object endpoint (for example `/volumes`, `/hosts`, or `/volume_groups`). Object endpoints provide additional tag management options and support filtering objects by tag key and value.\n\n**Inherited tags.** This endpoint returns only tags that are directly owned by an object or explicitly redefined on it. Inherited tags are calculated on demand and are not included. To retrieve all tags for an object, including inherited ones, use the object's endpoint.\n\n**Reserved tag prefixes.** Only users with the `root` role can create or modify tags whose key starts with `Internal_Echo_`, `Internal_Flex_`, `Internal_Clarity_`, `Internal_Silk_`, or `Internal_Sys_`. Other users receive an error saying the key is reserved for internal system use."}],"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":{"UserTags":{"type":"object","properties":{"id":{"type":"integer"},"is_automatic":{"type":"boolean"},"is_inheritable":{"type":"boolean"},"key":{"type":"string"},"object_id":{"type":"integer"},"object_type":{"type":"string"},"value":{"type":"string"}}},"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":{"/user_tags":{"post":{"tags":["User tags"],"summary":"Create tag","operationId":"createUserTags","description":"Silk recommends managing tags through the object endpoints (`/volumes`, `/hosts`, `/volume_groups`, and so on) for most workflows.","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTags"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Create tag","properties":{"object_type":{"type":"string"},"object_name":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"is_inheritable":{"type":"boolean"},"is_automatic":{"type":"boolean"},"chkargs_validation_only":{"type":"boolean","description":"If `true`, validates the request and reports whether it would succeed without applying it."}},"required":["object_type","object_name","key","value","is_inheritable","is_automatic"]}}}}}}}}
```

## GET /user\_tags/{id}

> Get a user tag

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"User tags","description":"User-defined metadata tags associated with supported Silk objects. Tags can be used to organize resources, apply business context, and filter API queries.\n\nSupported object types: DataPods, host groups, hosts, volume groups, volumes, snapshots, views, and replication sessions.\n\n**Managing tags through object endpoints.** Tags can be created directly with `POST /user_tags`, but for most workflows Silk recommends managing tags through the associated object endpoint (for example `/volumes`, `/hosts`, or `/volume_groups`). Object endpoints provide additional tag management options and support filtering objects by tag key and value.\n\n**Inherited tags.** This endpoint returns only tags that are directly owned by an object or explicitly redefined on it. Inherited tags are calculated on demand and are not included. To retrieve all tags for an object, including inherited ones, use the object's endpoint.\n\n**Reserved tag prefixes.** Only users with the `root` role can create or modify tags whose key starts with `Internal_Echo_`, `Internal_Flex_`, `Internal_Clarity_`, `Internal_Silk_`, or `Internal_Sys_`. Other users receive an error saying the key is reserved for internal system use."}],"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":{"UserTags":{"type":"object","properties":{"id":{"type":"integer"},"is_automatic":{"type":"boolean"},"is_inheritable":{"type":"boolean"},"key":{"type":"string"},"object_id":{"type":"integer"},"object_type":{"type":"string"},"value":{"type":"string"}}},"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":{"/user_tags/{id}":{"get":{"tags":["User tags"],"summary":"Get a user tag","operationId":"getUserTags","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTags"}}}},"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/volumes-and-data-protection/user-tags.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.
