---
title: "Gets a Snapshot for the resource by snapshot id"
method: GET
path: "/api/v1/plugins/{id}/files/{fileId}/snapshots/{snapshotId}"
tags: ["Plugins"]
---

# Gets a Snapshot for the resource by snapshot id

`GET /api/v1/plugins/{id}/files/{fileId}/snapshots/{snapshotId}`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/plugins/{id}/files/{fileId}/snapshots/{snapshotId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/usnistgov/apis/dioptra-rest-api/docs/api/v1/plugins/:id/files/:fileId/snapshots/:snapshotId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- NestedSnapshotsIdPluginFileDump
  - `id` integer: ID for the PluginFile resource.
  - `snapshot` integer: ID for the underlying PluginFile snapshot.
  - `group` GroupRef
    - `id` integer: ID for the Group resource.
    - `name` string: Name of the Group resource.
    - `url` string: URL for accessing the full Group resource.
  - `user` UserRefDump
    - `id` integer: ID for the User resource.
    - `username` string: Username of the User resource.
    - `url` string: URL for accessing the full User resource.
  - `createdOn` string, date-time: Timestamp when the PluginFile resource was created.
  - `snapshotCreatedOn` string, date-time: Timestamp when the PluginFile resource snapshot was created.
  - `lastModifiedOn` string, date-time: Timestamp when the PluginFile resource was last modified.
  - `latestSnapshot` boolean: Whether or not the PluginFile resource is the latest version.
  - `hasDraft` boolean: Whether a draft exists for the PluginFile resource.
  - `tags` TagRefDump[]
    - `id` integer: ID for the Tag.
    - `name` string: Name of the Tag.
    - `group` GroupRef
      - `id` integer: ID for the Group resource.
      - `name` string: Name of the Group resource.
      - `url` string: URL for accessing the full Group resource.
    - `url` string: URL for accessing the full Tag.
  - `deleted` boolean: Whether the PluginFile resource has been deleted.
  - `filename` string, required: Name of the PluginFile resource.
  - `contents` string, required: Contents of the file.
  - `tasks` PluginTaskContainer
    - `functions` FunctionTaskDump[]
      - `id` integer: Id of the PluginTask.
      - `name` string, required: Name of the PluginTask.
      - `inputParams` PluginTaskInputParameterDump[]
        - `name` string, required: Name of the PluginTaskParameter.
        - `parameterType` PluginParameterTypeRefDump
          - `id` integer: ID for the PluginParameterType resource.
          - `group` GroupRef
            - `id` integer: ID for the Group resource.
            - `name` string: Name of the Group resource.
            - `url` string: URL for accessing the full Group resource.
          - `url` string: URL for accessing the full PluginParameterType resource.
          - `deleted` boolean: Whether the PluginParameterType resource has been deleted.
          - `name` string: Name of the PluginParameterType resource.
        - `required` boolean: Sets whether the input parameter is required (True) or optional (False). If True, then this parameter must be assigned a value in order to execute the PluginTask.
      - `outputParams` PluginTaskOutputParameterDump[]
        - `name` string, required: Name of the PluginTaskParameter.
        - `parameterType` PluginParameterTypeRefDump
          - `id` integer: ID for the PluginParameterType resource.
          - `group` GroupRef
            - `id` integer: ID for the Group resource.
            - `name` string: Name of the Group resource.
            - `url` string: URL for accessing the full Group resource.
          - `url` string: URL for accessing the full PluginParameterType resource.
          - `deleted` boolean: Whether the PluginParameterType resource has been deleted.
          - `name` string: Name of the PluginParameterType resource.
    - `artifacts` ArtifactTaskDump[]
      - `id` integer: Id of the PluginTask.
      - `name` string, required: Name of the PluginTask.
      - `outputParams` PluginTaskOutputParameterDump[]
        - `name` string, required: Name of the PluginTaskParameter.
        - `parameterType` PluginParameterTypeRefDump
          - `id` integer: ID for the PluginParameterType resource.
          - `group` GroupRef
            - `id` integer: ID for the Group resource.
            - `name` string: Name of the Group resource.
            - `url` string: URL for accessing the full Group resource.
          - `url` string: URL for accessing the full PluginParameterType resource.
          - `deleted` boolean: Whether the PluginParameterType resource has been deleted.
          - `name` string: Name of the PluginParameterType resource.
  - `description` string: Description of the PluginFile resource.
  - `plugin` PluginRefDump
    - `id` integer: ID for the Plugin resource.
    - `group` GroupRef
      - `id` integer: ID for the Group resource.
      - `name` string: Name of the Group resource.
      - `url` string: URL for accessing the full Group resource.
    - `url` string: URL for accessing the full Plugin resource.
    - `deleted` boolean: Whether the Plugin resource has been deleted.
    - `name` string: Name of the Plugin resource.

## Changes

- **2026-09-30** `7615a76631a4`: 14 breaking, 3 warning, 9 info
  - the `group` response's property type changed from `object` to no type for status `200`
  - the `plugin` response's property type changed from `object` to no type for status `200`
  - the `tags/items/` response's property type changed from `object` to no type for status `200`
  - the `tags/items/allOf[#/components/schemas/TagRef-dump]/group` response's property type changed from `object` to no type for status `200`
  - …22 more
- **2026-02-11** `a73101579c5c`: 1 breaking, 2 info
  - the `tasks` response's property type changed from `array` to `object` for status `200`
  - added the optional property `snapshotCreatedOn` to the response with the `200` status
  - added `#/components/schemas/PluginTaskContainer` to the `tasks` response property `allOf` list for the response status `200`
- **2024-07-26** `9a36b9043379`: 1 breaking, 1 warning, 1 info
  - the `tasks` response's property type changed from `object` to `array` for status `200`
  - removed the optional property `snapshotCreatedOn` from the response with the `200` status
  - removed `#/components/schemas/PluginTaskContainer` from the `tasks` response property `allOf` list for the response status `200`

[Operation history](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/changes/api/v1/plugins/:id/files/:fileId/snapshots/:snapshotId/get.md)

---

[API](https://skmtc.dev/usnistgov/apis/dioptra-rest-api.md) - [All operations](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usnistgov/apis/dioptra-rest-api/revisions/e1a0ec3a40b2?raw)