# getAddons

> Function getAddons in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Function getAddons in pulumi-portainer.

Invoke token: `portainer:index/getAddons:getAddons`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const result = await portainer.getAddons()
```

`getAddonsOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `id`     | `string` | no       |             |
| `view`   | `string` | no       |             |

## Result

| Property        | Type               | Always present | Description |
| --------------- | ------------------ | -------------- | ----------- |
| `addons`        | `GetAddonsAddon[]` | yes            |             |
| `catalogError`  | `string`           | yes            |             |
| `environmentId` | `number`           | yes            |             |
| `id`            | `string`           | yes            |             |
| `view`          | `string`           | no             |             |

## `GetAddonsAddon`

Output object `GetAddonsAddon`. Fields below belong to this object.

| Property                 | Type       | Always present | Description |
| ------------------------ | ---------- | -------------- | ----------- |
| `availableVersions`      | `string[]` | no             |             |
| `chartVersion`           | `string`   | no             |             |
| `description`            | `string`   | no             |             |
| `displayName`            | `string`   | no             |             |
| `enabled`                | `boolean`  | no             |             |
| `healthMessage`          | `string`   | no             |             |
| `healthStatus`           | `string`   | no             |             |
| `icon`                   | `string`   | no             |             |
| `id`                     | `string`   | no             |             |
| `lifecycleStatus`        | `string`   | no             |             |
| `lifecycleStatusMessage` | `string`   | no             |             |
| `path`                   | `string`   | no             |             |
| `shortDescription`       | `string`   | no             |             |
| `upgradeAvailable`       | `boolean`  | no             |             |