# Pause preview environment

Pause a preview environment generated by a preview blueprint.

Required permission: Project > PreviewBlueprints > Previews > Pause

**Path parameters:**

{object}
- `projectId`: (string) (required) ID of the project
- `previewBlueprintId`: (string) (required) ID of the preview blueprint
- `previewId`: (string) (required) ID of the preview

**Response body:**

{object}
- `data`: {object}

## API reference

POST /v1/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/pause

POST /v1/teams/{teamId}/projects/{projectId}/preview-blueprints/{previewBlueprintId}/previews/{previewId}/pause

### Example Response

200 OK: The operation was performed successfully.

```json
{
  "data": {}
}
```

## CLI reference

$ northflank pause blueprint-template-preview

Options:

- `--projectId <projectId>`: ID of the project

- `--previewBlueprintId <previewBlueprintId>`: ID of the preview blueprint

- `--previewId <previewId>`: ID of the preview

- `--verbose `: Verbose output

- `--quiet `: No console output

- `-o --output <format>`: Output formatting 

### Example Response

 The operation was performed successfully.

```json
{}
```

## JavaScript client reference

### Example request



```javascript
await apiClient.pause.blueprintTemplatePreview({
  parameters: {
    "projectId": "default-project",
    "previewBlueprintId": "development",
    "previewId": "example-preview"
  }    
});
```

### Example Response

 The operation was performed successfully.

```json
{
  "data": {},
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

Previous: [Delete preview environment](/docs/v1/api//project/preview-blueprints/delete-preview-environment)

Next: [Reset preview environment expiry](/docs/v1/api//project/preview-blueprints/reset-preview-environment-expiry)