Expand description
Models generated from libpod swagger spec
Structs§
- Actor
- Address
- Auth
Config - AuthConfig contains authorization information for connecting to a Registry
- Auth
Report - AuthReport describes the response for authentication check
- Authenticate
OkBody - AuthenticateOKBody authenticate o k body
- Auto
User NsOptions - Bind
Options - Component
Version - Config
- It should hold only portable information about the container.
Here, “portable” means “independent from the host we are running on”.
Non-portable information should appear in HostConfig.
All fields added to this struct must be marked
omitemptyto keep getting predictable hashes from the oldv1Compatibilityconfiguration. - Config
Reference - ConfigReference specifies the source which provides a network’s configuration
- Conmon
Info - ConmonInfo describes the conmon executable being used
- Container
- Container
Basic Config - Container
Cgroup Config - ContainerCgroupConfig contains configuration information about a container’s cgroups.
- Container
Change Response Item - ContainerChangeResponseItem change item in response to ContainerChanges operation
- Container
Create Created Body - ContainerCreateCreatedBody OK response to ContainerCreate operation
- Container
Create Response - ContainerCreateResponse is the response struct for creating a container
- Container
Exec Control Param - Container
Exec Libpod Control Param - Container
Health Check Config - ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
- Container
Json - ContainerJSON is newly used struct along with MountPoint
- Container
Mount - Container
Network Config - ContainerNetworkConfig contains information on a container’s network configuration.
- Container
Node - ContainerNode stores information about the node that a container is running on. It’s only used by the Docker Swarm standalone API
- Container
Resource Config - Container
Security Config - ContainerSecurityConfig is a container’s security features, including SELinux, Apparmor, and Seccomp.
- Container
Size - ContainerSize holds the size of the container’s root filesystem and top read-write layer.
- Container
State - ContainerState stores container’s running state it’s part of ContainerJSONBase and will return by “inspect” command
- Container
Stats - ContainerStats contains the statistics information for a running container
- Container
Storage Config - ContainerStorageConfig contains information on the storage configuration of a container.
- Container
Store - ContainerStore describes the quantity of containers in the store by status
- Container
TopOk Body - ContainerTopOKBody OK response to ContainerTop operation
- Container
Update OkBody - ContainerUpdateOKBody OK response to ContainerUpdate operation
- Container
Wait OkBody - ContainerWaitOKBody OK response to ContainerWait operation
- Container
Wait OkBody Error - ContainerWaitOKBodyError container waiting error, if any
- Container
Wait Response - Wait container
- Container
Wait Response Error Inline Item - Containers
Prune Report - Containers
Prune Report Libpod - CpuUsage
- Create
Container Config - CreateContainerConfig used when compatible endpoint creates a container
- Device
Mapping - Device
Request - Used by GPU device drivers.
- Distribution
Info - DistributionInfo describes the host distribution for libpod
- Driver
- Driver
Data - DriverData handles the data for a storage driver
- Endpoint
Ipam Config - EndpointIPAMConfig represents IPAM configurations for the endpoint
- Endpoint
Resource - EndpointResource contains network resources allocated and used for a container in a network
- Endpoint
Settings - EndpointSettings stores the network endpoint details
- Error
Model - ErrorModel is used in remote connections with podman
- Error
Response - Event
- Exec
Start Control Param - Exec
Start Libpod Control Param - Graph
Driver Data - Health
- Health stores information about the container’s healthcheck results
- Health
Check Log - HealthCheckLog describes the results of a single healthcheck
- Health
Check Results - HealthCheckResults describes the results/logs from a healthcheck
- Health
Config - Healthcheck
Result - HealthcheckResult stores information about a single run of a healthcheck probe
- History
- History
Response - HistoryResponse provides details on image layers
- History
Response Item - HistoryResponseItem individual image layer information in response to ImageHistory operation
- Host
Config - Here, “non-portable” means “dependent of the host we are running on”. Portable information should appear in Config.
- Host
Info - HostInfo describes the libpod host
- IdMap
- IDMap contains a single entry for user namespace range remapping. An array of IDMap entries represents the structure that will be provided to the Linux kernel for creating a user namespace.
- IdMapping
Options - IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
- IdMappings
- IDMappings describe the GID and UID mappings
- IdResponse
- IDResponse Response to an API call that returns just an Id
- Image
Build200 Response - OK (As of version 1.xx)
- Image
Build Libpod200 Response - OK (As of version 1.xx)
- Image
Config - Image
Data - Image
Delete Response Inline Item - Image
Delete Response Item - ImageDeleteResponseItem image delete response item
- Image
Import Report - Image
Inspect - Image
Load Report - Image
Metadata - ImageMetadata contains engine-local data about the image
- Image
Store - ImageStore describes the image store. Right now only the number of images present
- Image
Summary - ImageSummary image summary
- Image
Tree Report - ImageTreeReport provides results from ImageEngine.Tree()
- Image
Volume - ImageVolume is a volume based on a container image. The container image is first mounted on the host and is then bind-mounted into the container. An ImageVolume is always mounted read-only.
- Info
- Info is the overall struct that describes the host system running libpod/podman
- Inspect
Additional Network - InspectAdditionalNetwork holds information about non-default CNI networks the container has been connected to. As with InspectNetworkSettings, many fields are unused and maintained only for compatibility with Docker.
- Inspect
Blkio Throttle Device - InspectBlkioThrottleDevice holds information about a speed cap for a device node. This cap applies to a specific operation (read, write, etc) on the given node.
- Inspect
Blkio Weight Device - InspectBlkioWeightDevice holds information about the relative weight of an individual device node. Weights are used in the I/O scheduler to give relative priority to some accesses.
- Inspect
Container Config - InspectContainerConfig holds further data about how a container was initially configured.
- Inspect
Container Data - InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
Large portions of this structure are defined such that the output is
compatible with
docker inspectJSON, but additional fields have been added as required to share information not in the original output. - Inspect
Container Host Config - nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed.
- Inspect
Container State - InspectContainerState provides a detailed record of a container’s current state. It is returned as part of InspectContainerData. As with InspectContainerData, many portions of this struct are matched to Docker, but here we see more fields that are unused (nonsensical in the context of Libpod).
- Inspect
Device - Inspect
Exec Process - InspectExecProcess contains information about the process in a given exec session.
- Inspect
Exec Session - Inspect
Host Port - InspectHostPort provides information on a port on the host that a container’s port is bound to.
- Inspect
IdMappings - Inspect
LogConfig - InspectLogConfig holds information about a container’s configured log driver
- Inspect
Mount - InspectMount provides a record of a single mount in a container. It contains fields for both named and normal volumes. Only user-specified volumes will be included, and tmpfs volumes are not included even if the user specified them.
- Inspect
Network Settings - InspectNetworkSettings holds information about the network settings of the
container.
Many fields are maintained only for compatibility with
docker inspectand are unused within Libpod. - Inspect
PodContainer Info - Inspect
PodData - InspectPodData contains detailed information on a pod’s configuration and state. It is used as the output of Inspect on pods.
- Inspect
PodInfra Config - InspectPodInfraConfig contains the configuration of the pod’s infra container.
- Inspect
Restart Policy - Inspect
Secret - InspectSecret contains information on secrets mounted inside the container
- Inspect
Ulimit - IpNet
- Ipam
- IPAM represents IP Address Management
- Ipam
Config - IPAMConfig represents IPAM configurations
- Json
Error - Json
Error Detail - Lease
Range - Libpod
Containers RmReport - Libpod
Image Summary - Libpod
Images Pull Report - Libpod
Images Remove Report - LibpodImagesRemoveReport is the return type for image removal via the rest api.
- Libpod
Ping Info - Data returned from /ping endpoint by libpod
- Linux
Block Io - LinuxBlockIO for Linux cgroup ‘blkio’ resource management
- Linux
Block IoDevice - linuxBlockIODevice holds major:minor format supported in blkio cgroup
- Linux
Cpu - LinuxCPU for Linux cgroup ‘cpu’ resource management
- Linux
Device - LinuxDevice represents the mknod information for a Linux special device file
- Linux
Device Cgroup - LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
- Linux
Hugepage Limit - LinuxHugepageLimit structure corresponds to limiting kernel hugepages
- Linux
Interface Priority - LinuxInterfacePriority for network interfaces
- Linux
Memory - LinuxMemory for Linux cgroup ‘memory’ resource management
- Linux
Network - LinuxNetwork identification and priority configuration
- Linux
Personality - LinuxPersonality represents the Linux personality syscall input
- Linux
Pids - LinuxPids for Linux cgroup ‘pids’ resource management (Linux 4.3)
- Linux
Rdma - LinuxRdma for Linux cgroup ‘rdma’ resource management (Linux 4.11)
- Linux
Resources - LinuxResources has container runtime resource constraints
- Linux
Throttle Device - LinuxThrottleDevice struct holds a
major:minor rate_per_secondpair - Linux
Weight Device - LinuxWeightDevice struct holds a
major:minor weightpair for weightDevice - List
Container - ListContainer describes a container suitable for listing
- List
Container Namespaces - ListContainerNamespaces contains the identifiers of the container’s Linux namespaces
- List
PodContainer - List
Pods Report - LogConfig
- LogConfig
Libpod - LogConfig describes the logging characteristics for a container
- Manifest
AddOptions - ManifestAddOptions provides model for adding digests to manifest list
- Manifest
Annotate Options - ManifestAnnotateOptions provides model for annotating manifest list
- Manifest
Modify Options - swagger 2.0 does not support oneOf for schema validation.
- Manifest
Modify Report - ManifestModifyReport provides the model for removed digests and changed manifest
- Manifest
Push Report - ManifestPushReport provides the model for the pushed manifest
- Manifest
Remove Report - ManifestRemoveReport provides the model for the removed manifest
- Mount
- Mount
Point - This is used for reporting the mountpoints in use by a container.
- Named
Volume - NamedVolume holds information about a named volume that will be mounted into the container.
- Namespace
- Namespace describes the namespace
- NetOptions
- NetOptions reflect the shared network options between pods and containers
- Network
- Network
Connect - NetworkConnect represents the data to be used to connect a container to the network
- Network
Connect Options - NetworkConnectOptions describes options for connecting a container to a network
- Network
Create - NetworkCreate is the expected body of the “create network” http request message
- Network
Create201 Response - network created
- Network
Create Libpod - Network create
- Network
Create Request - Network
Disconnect - NetworkDisconnect represents the data to be used to disconnect a container from the network
- Network
Prune200 Response - OK
- Network
Prune Report - NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
- Network
Resource - NetworkResource is the body of the “get network” http response message
- Network
RmReport - NetworkRmReport describes the results of network removal
- Network
Settings - NetworkSettings exposes the network settings in the api
- Networking
Config - NetworkingConfig represents the container’s networking configuration for each of its interfaces
Carries the networking configs specified in the
docker runanddocker network connectcommands - NoSuch
Secret - No such secret
- OciRuntime
Info - OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
- Overlay
Volume - OverlayVolume holds information about a overlay volume that will be mounted into the container.
- Peer
Info - PeerInfo represents one peer of an overlay network
- PerNetwork
Options - Platform
- Play
Kube Pod - PlayKubePod represents a single pod and associated containers created by play kube
- Play
Kube Report - Play
Kube Volume - Play
Secret - Plugin
- Plugin A plugin for the Engine API
- Plugin
Config - Plugin
Config Args - PluginConfigArgs plugin config args
- Plugin
Config Interface - PluginConfigInterface The interface between Docker and the plugin
- Plugin
Config Linux - PluginConfigLinux plugin config linux
- Plugin
Config Network - PluginConfigNetwork plugin config network
- Plugin
Config Rootfs - PluginConfigRootfs plugin config rootfs
- Plugin
Config User - PluginConfigUser plugin config user
- Plugin
Device - PluginDevice plugin device
- Plugin
Env - PluginEnv plugin env
- Plugin
Interface Type - PluginInterfaceType plugin interface type
- Plugin
Mount - PluginMount plugin mount
- Plugin
Settings - Plugins
- PodBasic
Config - PodCgroup
Config - This will be expanded in future updates to pods.
- PodCreate
Options - The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping.
- PodKill
Report - PodNetwork
Config - PodPause
Report - PodPrune
Report - PodResource
Config - PodRestart
Report - PodRm
Report - PodSecurity
Config - PodSpec
Generator - PodSpecGenerator describes options to create a pod
- PodStart
Report - PodStats
Report - PodStop
Report - PodStorage
Config - PodTop
OkBody - PodUnpause
Report - Port
- Port An open port on a container
- Port
Binding - PortBinding represents a binding between a Host IP address and a Host Port
- Port
Mapping - Posix
Rlimit - POSIXRlimit type and restrictions
- Prune
Report - Registry
Search Response - Registry Search
- Remote
Socket - RemoteSocket describes information about the API socket
- Resources
- Resources contains container’s resources (cgroups config, ulimits…)
- Restart
Policy - RootFs
- Schema2
Health Config - Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
- Schema2
List - Schema2
Manifest Descriptor - Schema2
Platform Spec - Schema2PlatformSpec describes the platform which a particular manifest is specialized for.
- ScpReport
- Secret
- Secret
Create - Secret
Create Report - Secret
Create Response - Secret create response
- Secret
Driver Spec - Secret
InUse - Secret in use
- Secret
Info Report - Secret
Info Report Compat - Secret
Spec - Secret
Version - Security
Info - SecurityInfo describes the libpod host
- Service
Info - ServiceInfo represents service parameters with the list of service’s tasks
- Service
Update Response - ServiceUpdateResponse service update response
- Slirp
Info - SlirpInfo describes the slirp executable that is being used
- Spec
Generator - SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
- Store
Info - StoreInfo describes the container storage and its attributes
- Subnet
- Summary
Network Settings - SummaryNetworkSettings provides a summary of container’s networks in /containers/json
- System
DfContainer Report - SystemDfContainerReport describes a container for use with df
- System
DfImage Report - SystemDfImageReport describes an image for use with df
- System
DfReport - SystemDfReport describes the response for df information
- System
DfVolume Report - SystemDfVolumeReport describes a volume and its size
- System
Prune Report - Task
- Task carries the information about one backend task
- Throttle
Device - ThrottleDevice is a structure that holds device:rate_per_second pair
- Tmpfs
Options - Ulimit
- Update
Entities - UpdateEntities used to wrap the oci resource spec in a swagger model
- Version
- Version is an output struct for API
- Volume
- Volume volume
- Volume
Config Response - Volume
Create - Details for creating a volume
- Volume
Create Body - VolumeCreateBody Volume configuration
- Volume
Create Options - VolumeCreateOptions provides details for creating volumes
- Volume
List OkBody - VolumeListOKBody Volume list response
- Volume
Options - Volume
Usage Data - VolumeUsageData Usage details about the volume. This information is used by the
GET /system/dfendpoint, and omitted in other endpoints. - Volumes
Prune Report - POST “/volumes/prune”
- Weight
Device - WeightDevice is a structure that holds device:weight pair
Enums§
Type Aliases§
- Attributes
- BadParam
Error - ErrorModel is used in remote connections with podman
- Cgroup
Spec - Cgroupns
Mode - CgroupnsMode represents the cgroup namespace mode of the container
- Conflict
Error - ErrorModel is used in remote connections with podman
- Consistency
- Container
Already Started Error - ErrorModel is used in remote connections with podman
- Container
Already Stopped Error - ErrorModel is used in remote connections with podman
- Container
Archive200 Response - no error
- Container
Archive Libpod200 Response - no error
- Container
Create Body Param - CreateContainerConfig used when compatible endpoint creates a container
- Container
Create Libpod Create Param - SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
- Container
Inspect Response - ContainerJSON is newly used struct along with MountPoint
- Container
Inspect Response Libpod - InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
Large portions of this structure are defined such that the output is
compatible with
docker inspectJSON, but additional fields have been added as required to share information not in the original output. - Container
Mount Libpod200 Response - mounted container
- Container
NotFound - ErrorModel is used in remote connections with podman
- Container
Remove Libpod - Remove Containers
- Container
Show Mounted Libpod200 Response - mounted containers
- Container
Stats200 Response - no error
- Container
TopResponse - ContainerTopOKBody OK response to ContainerTop operation
- Container
Update Libpod Resources Param - UpdateEntities used to wrap the oci resource spec in a swagger model
- Container
Wait Libpod200 Response - Status code
- Containers
List - List Containers
- Containers
List Libpod - List Containers
- Containers
Prune - Prune Containers
- Containers
Prune Libpod - Prune Containers
- Digest
- The following is an example of the contents of Digest types:
- Duration
- A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.
- Exec
Session Inspect - Exec
Session NotFound - ErrorModel is used in remote connections with podman
- File
Mode - The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all systems. The only required bit is ModeDir for directories.
- Generate
Kube Libpod200 Response - Kubernetes YAML file describing pod
- Generate
Systemd Libpod200 Response - no error
- Hardware
Addr - Health
Check - HealthCheckResults describes the results/logs from a healthcheck
- Health
Check OnFailure Action - HealthCheckOnFailureAction defines how Podman reacts when a container’s health status turns unhealthy.
- Image
Build Input Stream Param - Image
Create200 Response - no error
- Image
Create Input Image Param - Image
Delete Response - Image Delete
- Image
Export Libpod200 Response - no error
- Image
Get200 Response - no error
- Image
GetAll200 Response - no error
- Image
GetLibpod200 Response - no error
- Image
Import Libpod Upload Param - Image
List - Image summary for compat API
- Image
List Libpod - Image summary for libpod API
- Image
Load Libpod Upload Param - Image
Load Request Param - Image
NotFound - ErrorModel is used in remote connections with podman
- Image
Push200 Response - no error
- Image
Push Libpod200 Response - no error
- Images
Import Response Libpod - Images
Load Response Libpod - Images
Prune Libpod - Image Prune
- Images
Pull Response Libpod - Images
Remove Response Libpod - LibpodImagesRemoveReport is the return type for image removal via the rest api.
- Images
ScpResponse Libpod - Info
Response - Info is the overall struct that describes the host system running libpod/podman
- Inspect
Image Response Libpod - Internal
Error - ErrorModel is used in remote connections with podman
- IpMask
- See type IPNet and func ParseCIDR for details.
- IpcMode
- Isolation
- Isolation represents the isolation technology of a container. The supported values are platform specific
- Linux
Personality Domain - Linux
Personality Flag - Manifest
AddLibpod Options Param - ManifestAddOptions provides model for adding digests to manifest list
- Manifest
Create Libpod Options Param - swagger 2.0 does not support oneOf for schema validation.
- Manifest
Inspect - Manifest
Modify Libpod Options Param - swagger 2.0 does not support oneOf for schema validation.
- Manifest
NotFound - ErrorModel is used in remote connections with podman
- Manifest
Remove Options - ManifestRemoveOptions provides the model for removing digests from a manifest
- Namespace
Mode - Network
Connect Request - NetworkConnect represents the data to be used to connect a container to the network
- Network
Connect Request Libpod - NetworkConnectOptions describes options for connecting a container to a network
- Network
Create Libpod Create Param - Network create
- Network
Create Response - Network
Disconnect Request - NetworkDisconnect represents the data to be used to disconnect a container from the network
- Network
Inspect Compat - NetworkResource is the body of the “get network” http response message
- Network
Inspect Response - Network
List Compat - Network list
- Network
List Libpod - Network list
- Network
Mode - Network
NotFound - ErrorModel is used in remote connections with podman
- Network
Prune Response - Network prune
- Network
RmResponse - Network Delete
- Ok
- Success
- PidMode
- Play
Kube Libpod Request Param - Play
Kube Response Libpod - PodAlready
Started Error - ErrorModel is used in remote connections with podman
- PodAlready
Stopped Error - ErrorModel is used in remote connections with podman
- PodCreate
Libpod409 Response - status conflict
- PodCreate
Libpod Create Param - PodSpecGenerator describes options to create a pod
- PodInspect
Response - InspectPodData contains detailed information on a pod’s configuration and state. It is used as the output of Inspect on pods.
- PodKill
Response - PodNot
Found - ErrorModel is used in remote connections with podman
- PodPause
Response - PodPrune
Response - PodRestart
Response - PodRm
Response - PodStart
Response - PodStats
Response - Pod Statistics
- PodStop
Response - PodTop
Response - PodUnpause
Response - Pods
List Response - List pods
- PortMap
- PortMap is a collection of PortBinding indexed by Port
- PortSet
- PortSet is a collection of structs indexed by Port
- Propagation
- PutContainer
Archive Libpod Request Param - PutContainer
Archive Request Param - Secret
Create Create Param - Secret
Create Libpod Request Param - Secret
Inspect Compat Response - Secret
Inspect Response - Secret
List Compat Response - Secret list response
- Secret
List Response - Secret list response
- Signal
- It implements the os.Signal interface.
- StrSlice
- We need to override the json decoder to accept both options.
- System
Auth Auth Config Param - AuthConfig contains authorization information for connecting to a Registry
- System
Auth Response - AuthReport describes the response for authentication check
- System
Disk Usage - SystemDfReport describes the response for df information
- System
Ping200 Response - Success
- System
Prune Response - Tree
Response - ImageTreeReport provides results from ImageEngine.Tree()
- Type
- Userns
Mode - UtsMode
- Version
Response - Volume
Create Create Param - Details for creating a volume
- Volume
Create Libpod Create Param - VolumeCreateOptions provides details for creating volumes
- Volume
Create Response - Volume
Inspect - Volume volume
- Volume
List - VolumeListOKBody Volume list response
- Volume
List Libpod - Volume list
- Volume
NotFound - ErrorModel is used in remote connections with podman
- Volume
Prune Libpod - Volume Prune
- Volume
Prune Response - POST “/volumes/prune”