This is a cache of https://docs.openshift.com/aro/3/rest_api/image_openshift_io/image-image-openshift-io-v1.html. It is a snapshot of the page at 2024-11-26T21:08:56.382+0000.
Imag<strong>e</strong> [imag<strong>e</strong>.op<strong>e</strong>nshift.io/v1] - imag<strong>e</strong>.op<strong>e</strong>nshift.io | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | Azur<strong>e</strong> R<strong>e</strong>d Hat Op<strong>e</strong>nShift 3
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. explore the new docs experience today.
  1. Documentation
&times;

Image [image.openshift.io/v1]

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Description

Image is an immutable representation of a Docker image and metadata at a point in time.

Type

object

Required

  • dockerImageLayers

Specification

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/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.

.dockerImageLayers

array

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

.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.

.dockerImageMetadata

Rawextension pkg/runtime

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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s 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.
.dockerImageLayers
Description

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

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

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.
.signatures
Description

Signatures holds all signatures of the image.

Type

array

.signatures[]
Description

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.

Type

object

Required

  • type

  • content

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/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 meta/v1

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/api-conventions.md#types-kinds

metadata

ObjectMeta meta/v1

Standard object’s 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

lastProbeTime

Time meta/v1

Last time the condition was checked.

lastTransitionTime

Time meta/v1

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

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

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/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/images

Table 1. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DeLeTe

Description

delete collection of Image

Table 2. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 Resourceexpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

empty
HTTP method

GeT

Description

list or watch objects of kind Image

Table 4. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 Resourceexpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

ImageList image.openshift.io/v1

401 - Unauthorized

empty
HTTP method

POST

Description

create an Image

Table 6. Body parameters
Parameter Type Description

body

Image image.openshift.io/v1
Table 7. HTTP responses
HTTP code Reponse body

200 - OK

Image image.openshift.io/v1

201 - Created

Image image.openshift.io/v1

202 - Accepted

Image image.openshift.io/v1

401 - Unauthorized

empty

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

Table 8. Global path parameters
Parameter Type Description

name

string

name of the Image
Table 9. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DeLeTe

Description

delete an Image

Table 10. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 11. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

empty
HTTP method

GeT

Description

read the specified Image

Table 13. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. export strips fields that a user can not specify.
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

Image image.openshift.io/v1

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update the specified Image

Table 15. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

Image image.openshift.io/v1

401 - Unauthorized

empty
HTTP method

PUT

Description

replace the specified Image

Table 17. Body parameters
Parameter Type Description

body

Image image.openshift.io/v1
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

Image image.openshift.io/v1

201 - Created

Image image.openshift.io/v1

401 - Unauthorized

empty