> 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/snapshot-scheduler-mappings.md).

# Snapshot scheduler mappings

Snapshot scheduler mappings connect snapshot schedulers to the volume groups they protect.

Use these endpoints to apply a schedule to a volume group, see which schedules protect each group, or remove a schedule from a group.

## GET /snapshot\_scheduler\_mapping

> List snapshot scheduler mappings

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshot scheduler mappings","description":"Snapshot scheduler mappings connect snapshot schedulers to the volume groups they protect.\n\nUse these endpoints to apply a schedule to a volume group, see which schedules protect each group, or remove a schedule from a group."}],"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."}}},"SnapshotSchedulerMapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"last_successful_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last successful run."},"snapshot_scheduler":{"$ref":"#/components/schemas/Ref","description":"Reference to the scheduler. Shape: `{ \"ref\": \"/snapshot_scheduler/{id}\" }`."},"status":{"type":"string","nullable":true,"description":"Status of the most recent run."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group being snapshotted. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"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":{"/snapshot_scheduler_mapping":{"get":{"tags":["Snapshot scheduler mappings"],"summary":"List snapshot scheduler mappings","operationId":"listSnapshotSchedulerMapping","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/SnapshotSchedulerMapping"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /snapshot\_scheduler\_mapping

> Map scheduler to volume group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshot scheduler mappings","description":"Snapshot scheduler mappings connect snapshot schedulers to the volume groups they protect.\n\nUse these endpoints to apply a schedule to a volume group, see which schedules protect each group, or remove a schedule from a group."}],"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":{"SnapshotSchedulerMapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"last_successful_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last successful run."},"snapshot_scheduler":{"$ref":"#/components/schemas/Ref","description":"Reference to the scheduler. Shape: `{ \"ref\": \"/snapshot_scheduler/{id}\" }`."},"status":{"type":"string","nullable":true,"description":"Status of the most recent run."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group being snapshotted. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"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":{"/snapshot_scheduler_mapping":{"post":{"tags":["Snapshot scheduler mappings"],"summary":"Map scheduler to volume group","operationId":"createSnapshotSchedulerMapping","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotSchedulerMapping"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Map scheduler to volume group","properties":{"snapshot_scheduler":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the scheduler. Shape: `{ \"ref\": \"/snapshot_scheduler/{id}\" }`."},"volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the volume group being snapshotted. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."}},"required":["snapshot_scheduler","volume_group"]}}}}}}}}
```

## GET /snapshot\_scheduler\_mapping/{id}

> Get a snapshot scheduler mapping

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshot scheduler mappings","description":"Snapshot scheduler mappings connect snapshot schedulers to the volume groups they protect.\n\nUse these endpoints to apply a schedule to a volume group, see which schedules protect each group, or remove a schedule from a group."}],"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":{"SnapshotSchedulerMapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"last_successful_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last successful run."},"snapshot_scheduler":{"$ref":"#/components/schemas/Ref","description":"Reference to the scheduler. Shape: `{ \"ref\": \"/snapshot_scheduler/{id}\" }`."},"status":{"type":"string","nullable":true,"description":"Status of the most recent run."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group being snapshotted. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"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":{"/snapshot_scheduler_mapping/{id}":{"get":{"tags":["Snapshot scheduler mappings"],"summary":"Get a snapshot scheduler mapping","operationId":"getSnapshotSchedulerMapping","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotSchedulerMapping"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /snapshot\_scheduler\_mapping/{id}

> Delete a snapshot scheduler mapping

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshot scheduler mappings","description":"Snapshot scheduler mappings connect snapshot schedulers to the volume groups they protect.\n\nUse these endpoints to apply a schedule to a volume group, see which schedules protect each group, or remove a schedule from a group."}],"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":{"/snapshot_scheduler_mapping/{id}":{"delete":{"tags":["Snapshot scheduler mappings"],"summary":"Delete a snapshot scheduler mapping","operationId":"deleteSnapshotSchedulerMapping","responses":{"204":{"description":"No content"},"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/snapshot-scheduler-mappings.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.
