Image [image.openshift.io/v1] - Image <strong>api</strong>s | <strong>api</strong> reference

Specification
api endpoints

Description: Image is an immutable representation of a container image and metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users instead access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the api, any integration that implements the container image registry api must provide its own storage for the raw manifest data, image config, and layer contents.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`dockerImageConfig`	`string`	DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list.
`dockerImageLayers`	`array`	DockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.
`dockerImageLayers[]`	`object`	ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.
`dockerImageManifest`	`string`	DockerImageManifest is the raw JSON of the manifest
`dockerImageManifestMediaType`	`string`	DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.
`dockerImageManifests`	`array`	DockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
`dockerImageManifests[]`	`object`	ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.
`dockerImageMetadata`	`RawExtension`	DockerImageMetadata contains metadata about this image
`dockerImageMetadataVersion`	`string`	DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"
`dockerImageReference`	`string`	DockerImageReference is the string that can be used to pull this image.
`dockerImageSignatures`	`array (string)`	DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`signatures`	`array`	Signatures holds all signatures of the image.
`signatures[]`	`object`	ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

apiVersion

string

apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

dockerImageConfig

string

DockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list.

dockerImageLayers

array

DockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.

dockerImageLayers[]

object

ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

dockerImageManifest

string

DockerImageManifest is the raw JSON of the manifest

dockerImageManifestMediaType

string

DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.

dockerImageManifests

array

DockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.

dockerImageManifests[]

object

ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.

dockerImageMetadata

RawExtension

DockerImageMetadata contains metadata about this image

dockerImageMetadataVersion

string

DockerImageMetadataVersion conveys the version of the object, which if empty defaults to "1.0"

dockerImageReference

string

DockerImageReference is the string that can be used to pull this image.

dockerImageSignatures

array (string)

DockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

signatures

array

Signatures holds all signatures of the image.

signatures[]

object

ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature’s content by the server. They serve just an informative purpose.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

.dockerImageLayers

Description: DockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.
Type: array

.dockerImageLayers[]

Description

ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.

Type

object

Required

name
size
mediaType

Property Type Description

Property	Type	Description
`mediaType`	`string`	MediaType of the referenced object.
`name`	`string`	Name of the layer as defined by the underlying store.
`size`	`integer`	Size of the layer in bytes as defined by the underlying store.

mediaType

string

MediaType of the referenced object.

name

string

Name of the layer as defined by the underlying store.

size

integer

Size of the layer in bytes as defined by the underlying store.

.dockerImageManifests

Description: DockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.
Type: array

.dockerImageManifests[]

Description

ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.

Type

object

Required

digest
mediaType
manifestSize
architecture
os

Property Type Description

Property	Type	Description
`architecture`	`string`	Architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.
`digest`	`string`	Digest is the unique identifier for the manifest. It refers to an Image object.
`manifestSize`	`integer`	ManifestSize represents the size of the raw object contents, in bytes.
`mediaType`	`string`	MediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, application/vnd.docker.distribution.manifest.v2+json or application/vnd.docker.distribution.manifest.v1+json.
`os`	`string`	OS specifies the operating system, for example `linux`.
`variant`	`string`	Variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

architecture

string

Architecture specifies the supported CPU architecture, for example amd64 or ppc64le.

digest

string

Digest is the unique identifier for the manifest. It refers to an Image object.

manifestSize

integer

ManifestSize represents the size of the raw object contents, in bytes.

mediaType

string

MediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, application/vnd.docker.distribution.manifest.v2+json or application/vnd.docker.distribution.manifest.v1+json.

os

string

OS specifies the operating system, for example linux.

variant

string

Variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.

.signatures

Description: Signatures holds all signatures of the image.
Type: array

.signatures[]

Description

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required

type
content

Property Type Description

Property	Type	Description
`apiVersion`	`string`	apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`conditions`	`array`	Conditions represent the latest available observations of a signature’s current state.
`conditions[]`	`object`	SignatureCondition describes an image signature condition of particular kind at particular probe time.
`content`	`string`	Required: An opaque binary string which is an image’s signature.
`created`	`Time`	If specified, it is the time of signature’s creation.
`imageIdentity`	`string`	A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").
`issuedBy`	`object`	SignatureIssuer holds information about an issuer of signing certificate or key.
`issuedTo`	`object`	SignatureSubject holds information about a person or entity who created the signature.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`signedClaims`	`object (string)`	Contains claims from the signature.
`type`	`string`	Required: Describes a type of stored blob.

apiVersion

string

conditions

array

Conditions represent the latest available observations of a signature’s current state.

conditions[]

object

SignatureCondition describes an image signature condition of particular kind at particular probe time.

content

string

Required: An opaque binary string which is an image’s signature.

created

Time

If specified, it is the time of signature’s creation.

imageIdentity

string

A human readable string representing image’s identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").

issuedBy

object

SignatureIssuer holds information about an issuer of signing certificate or key.

issuedTo

object

SignatureSubject holds information about a person or entity who created the signature.

kind

string

metadata

ObjectMeta

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

signedClaims

object (string)

Contains claims from the signature.

type

string

Required: Describes a type of stored blob.

.signatures[].conditions

Description: Conditions represent the latest available observations of a signature’s current state.
Type: array

.signatures[].conditions[]

Description

SignatureCondition describes an image signature condition of particular kind at particular probe time.

Type

object

Required

type
status

Property Type Description

Property	Type	Description
`lastProbeTime`	`Time`	Last time the condition was checked.
`lastTransitionTime`	`Time`	Last time the condition transit from one status to another.
`message`	`string`	Human readable message indicating details about last transition.
`reason`	`string`	(brief) reason for the condition’s last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of signature condition, Complete or Failed.

lastProbeTime

Time

Last time the condition was checked.

lastTransitionTime

Time

Last time the condition transit from one status to another.

message

string

Human readable message indicating details about last transition.

reason

string

(brief) reason for the condition’s last transition.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of signature condition, Complete or Failed.

.signatures[].issuedBy

Description: SignatureIssuer holds information about an issuer of signing certificate or key.
Type: object

Property Type Description

Property	Type	Description
`commonName`	`string`	Common name (e.g. openshift-signing-service).
`organization`	`string`	Organization name.

commonName

string

Common name (e.g. openshift-signing-service).

organization

string

Organization name.

.signatures[].issuedTo

Description

SignatureSubject holds information about a person or entity who created the signature.

Type

object

Required

publicKeyID

Property Type Description

Property	Type	Description
`commonName`	`string`	Common name (e.g. openshift-signing-service).
`organization`	`string`	Organization name.
`publicKeyID`	`string`	If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

commonName

string

Common name (e.g. openshift-signing-service).

organization

string

Organization name.

publicKeyID

string

If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key’s fingerprint (e.g. 0x685ebe62bf278440).

api endpoints

The following api endpoints are available:

/apis/image.openshift.io/v1/images
- DELETE: delete collection of Image
- GET: list or watch objects of kind Image
- POST: create an Image
/apis/image.openshift.io/v1/watch/images
- GET: watch individual changes to a list of Image. deprecated: use the 'watch' parameter with a list operation instead.
/apis/image.openshift.io/v1/images/{name}
- DELETE: delete an Image
- GET: read the specified Image
- PATCH: partially update the specified Image
- PUT: replace the specified Image
/apis/image.openshift.io/v1/watch/images/{name}
- GET: watch changes to an object of kind Image. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

/apis/image.openshift.io/v1/images

HTTP method: DELETE
Description: delete collection of Image

Table 1. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind Image

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ImageList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create an Image

Table 4. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 5. Body parameters
Parameter	Type	Description
`body`	`Image` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Image` schema
201 - Created	`Image` schema
202 - Accepted	`Image` schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/watch/images

HTTP method: GET
Description: watch individual changes to a list of Image. deprecated: use the 'watch' parameter with a list operation instead.

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/images/{name}

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Image

HTTP method: DELETE
Description: delete an Image

Table 9. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Image

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`Image` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Image

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Image` schema
201 - Created	`Image` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Image

Table 14. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15. Body parameters
Parameter	Type	Description
`body`	`Image` schema

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`Image` schema
201 - Created	`Image` schema
401 - Unauthorized	Empty

/apis/image.openshift.io/v1/watch/images/{name}

Table 17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Image

HTTP method: GET
Description: watch changes to an object of kind Image. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty