# Pause addon

Pause the given addon.

Required permission: Project > Addons > General > Update

**Path parameters:**

{object}
- `projectId`: (string) (required) ID of the project
- `addonId`: (string) (required) ID of the addon

**Response body:**

{object}
- `data`: {object}

## API reference

POST /v1/projects/{projectId}/addons/{addonId}/pause

POST /v1/teams/{teamId}/projects/{projectId}/addons/{addonId}/pause

### Example Response

200 OK: The operation was performed successfully.

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

## CLI reference

$ northflank pause addon

Options:

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

- `--addonId <addonId>`: ID of the addon

- `--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.addon({
  parameters: {
    "projectId": "default-project",
    "addonId": "example-addon"
  }    
});
```

### Example Response

 The operation was performed successfully.

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

Previous: [Update addon network settings](/docs/v1/api//project/addons/update-addon-network-settings)

Next: [Reset addon](/docs/v1/api//project/addons/reset-addon)