# Configuration

> Configuration for pulumi-portainer.

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

Configuration for pulumi-portainer.

npm package `pulumi-portainer` version `2.0.2`.
Pulumi bridge `terraform-provider` version `1.4.0`.
Upstream provider `registry.opentofu.org/portainer/portainer` version `2.0.0`.

An explicit provider is `new portainer.Provider(name, args)`. Stack configuration is a `pulumi.Config` object named `portainer`.

A value marked secret is passed through `pulumi.secret` or listed in `additionalSecretOutputs` on the provider resource.

## Fields

| Property        | Type                        | Source                                           | Secret | Description                                                                                                           |
| --------------- | --------------------------- | ------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------- |
| `apiKey`        | `string`                    | provider args; stack config via config.get       | yes    | API key to authenticate with Portainer. Mutually exclusive with 'user' and 'password'.                                |
| `apiPassword`   | `string`                    | provider args; stack config via config.get       | yes    | Password for authentication. Must be used together with 'user'.                                                       |
| `apiUser`       | `string`                    | provider args; stack config via config.get       | yes    | Username for authentication. Must be used together with 'password'.                                                   |
| `customHeaders` | `{ [key: string]: string }` | provider args; stack config via config.getObject | no     | Custom headers to add to all requests (e.g. for Cloudflare Access or other security proxies).                         |
| `endpoint`      | `string`                    | provider args; stack config via config.get       | no     | URL of the Portainer instance (e.g. https://portainer.example.com). '/api' will be appended automatically if missing. |
| `skipSslVerify` | `boolean`                   | provider args; stack config via config.getObject | no     | Verify the SSL/TLS certificate for the Portainer endpoint                                                             |