Type Alias ClientOptions

ClientOptions: (
| { apiToken: string }
| { password: string; realm?: string; username: string }
) & { agent?: Agent; apiPath?: string; baseUrl: string; fetch?: FetchLike }

Type Declaration

{ apiToken: string }
- apiToken: string
  API token string, either full "PVEAPIToken=user@realm!token=secret" or shorthand "user@realm!token=secret"
{ password: string; realm?: string; username: string }
- password: string
- Optionalrealm?: string
  Defaults to "pam"
- username: string

Optionalagent?: Agent
OptionalapiPath?: string
Defaults to "/api2/json"
baseUrl: string
Base URL like https://pve.example.com:8006
Optionalfetch?: FetchLike