@podman-desktop/api
The Podman Desktop API provides a way to interact with Podman Desktop.
This file extension-api.d.ts is automatically generated from typedoc comments
in the source code and provided on our website.
For more information, see the main Podman Desktop developing extensions documentation.
Example
import * as api from '@podman-desktop/api';
console.log(api.version);
Namespaces
- authentication
- cli
- commands
- configuration
- containerEngine
- context
- env
- extensions
- fs
- imageChecker
- kubernetes
- navigation
- process
- provider
- proxy
- registry
- tray
- window
Enumerations
Classes
Interfaces
- AuditRecord
- AuditRequestItems
- AuditResult
- Auditor
- AuthConfig
- AuthenticationGetSessionOptions
- AuthenticationProvider
- AuthenticationProviderAuthenticationSessionsChangeEvent
- AuthenticationProviderInformation
- AuthenticationProviderOptions
- AuthenticationSession
- AuthenticationSessionAccountInformation
- AuthenticationSessionsChangeEvent
- BlkioStatEntry
- BlkioStats
- BuildImageOptions
- CPUStats
- CPUUsage
- CancellationToken
- CheckResult
- CheckResultFixCommand
- CliTool
- CliToolOptions
- CliToolUpdate
- CliToolUpdateOptions
- Clipboard
- Command
- Configuration
- ConfigurationChangeEvent
- ContainerAuthInfo
- ContainerCreateOptions
- ContainerCreateResult
- ContainerEngineInfo
- ContainerInfo
- ContainerInspectInfo
- ContainerJSONEvent
- ContainerProviderConnection
- ContainerProviderConnectionEndpoint
- ContainerProviderConnectionFactory
- ContainerStatsInfo
- CustomPick
- CustomPickItem
- CustomPickSectionItem
- DeviceRequest
- EndpointIPAMConfig
- EndpointSettings
- Event
- Extension
- ExtensionContext
- FileSystemWatcher
- GenerateKubeResult
- HealthCheckLog
- HealthCheckResults
- HealthConfig
- HostConfig
- HostRestartPolicy
- IPAM
- ImageCheck
- ImageCheckerProvider
- ImageCheckerProviderMetadata
- ImageChecks
- ImageFile
- ImageFileSymlink
- ImageFilesCallbacks
- ImageFilesProvider
- ImageFilesProviderMetadata
- ImageFilesystemLayer
- ImageFilesystemLayers
- ImageInfo
- ImageInspectInfo
- InputBoxOptions
- InputBoxValidationMessage
- InstallCheck
- KubeconfigUpdateEvent
- KubernetesGeneratorProvider
- KubernetesProviderConnection
- KubernetesProviderConnectionEndpoint
- KubernetesProviderConnectionFactory
- LifecycleContext
- Link
- ListImagesOptions
- ListInfosOptions
- Logger
- ManifestCreateOptions
- ManifestInspectInfo
- ManifestPushOptions
- MemoryStats
- MenuItem
- MountSettings
- NetworkContainer
- NetworkCreateOptions
- NetworkCreateResult
- NetworkInfo
- NetworkInspectInfo
- NetworkStats
- NetworkingConfig
- NotificationOptions
- OpenDialogOptions
- PidsStats
- PodContainerInfo
- PodCreateOptions
- PodCreatePortOptions
- PodInfo
- PodmanContainerCreateOptions
- Port
- PortBinding
- PortMap
- Progress
- ProgressOptions
- Provider
- ProviderAutostart
- ProviderCleanup
- ProviderCleanupAction
- ProviderCleanupExecuteOptions
- ProviderConnectionFactory
- ProviderConnectionLifecycle
- ProviderContainerConnection
- ProviderDetectionCheck
- ProviderEvent
- ProviderImages
- ProviderInformation
- ProviderInstallation
- ProviderLifecycle
- ProviderOptions
- ProviderUpdate
- ProxySettings
- PullEvent
- QuickInputButton
- QuickPickItem
- QuickPickOptions
- RegisterContainerConnectionEvent
- RegisterKubernetesConnectionEvent
- Registry
- RegistryConfig
- RegistryCreateOptions
- RegistryProvider
- RegistrySuggestedProvider
- RunError
- RunOptions
- RunResult
- SaveDialogOptions
- SecretStorage
- SecretStorageChangeEvent
- StatusBarItem
- StorageStats
- TelemetryLogger
- TelemetryLoggerOptions
- TelemetrySender
- ThrottlingData
- UnregisterContainerConnectionEvent
- UnregisterKubernetesConnectionEvent
- UpdateContainerConnectionEvent
- UpdateKubernetesConnectionEvent
- VolumeCreateOptions
- VolumeCreateResponseInfo
- VolumeDeleteOptions
- VolumeInfo
- VolumeListInfo
- Webview
- WebviewInfo
- WebviewOptions
- WebviewPanel
- WebviewPanelOnDidChangeViewStateEvent
Type Aliases
- CheckResultLink
- CliToolState
- ConfigurationScope
- KubernetesGeneratorArgument
- KubernetesGeneratorSelector
- KubernetesGeneratorType
- MountConfig
- MountConsistency
- MountPropagation
- MountType
- NotificationType
- ProviderConnectionStatus
- ProviderLinks
- ProviderResult
- ProviderStatus
- StatusBarAlignment