
# NamedSnapshot

A named snapshot: a frozen copy of a box\'s disk at one moment, saved under a name you pick. Independent of the source box\'s later life: the box can change, stop, or be deleted and the named snapshot still deploys. Named snapshots never expire; re-saving a name replaces its artifact.

## Properties

Name | Type
------------ | -------------
`name` | string
`status` | string
`error` | string
`sourceBoxId` | string
`snapshotId` | string
`type` | string
`sizeBytes` | number
`createdAt` | Date

## Example

```typescript
import type { NamedSnapshot } from '@asciidev/box-sdk'

// TODO: Update the object below with actual values
const example = {
  "name": null,
  "status": null,
  "error": null,
  "sourceBoxId": null,
  "snapshotId": null,
  "type": null,
  "sizeBytes": null,
  "createdAt": null,
} satisfies NamedSnapshot

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as NamedSnapshot
console.log(exampleParsed)
```

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
