Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

v1.ImageStreamTag

Description

ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:

conditions:

- generation:

  lastTransitionTime:

  message:

  reason:

  status:

  type:

generation:

image:

  apiVersion:

  dockerImageConfig:

  dockerImageLayers:

  - mediaType:

    name:

    size:

  dockerImageManifest:

  dockerImageManifestMediaType:

  dockerImageMetadata:

    Raw:

  dockerImageMetadataVersion:

  dockerImageReference:

  dockerImageSignatures:

  - [string]:

  kind:

  metadata:

    annotations:

      [string]:

    clusterName:

    creationTimestamp:

    deletionGracePeriodSeconds:

    deletionTimestamp:

    finalizers:

    - [string]:

    generateName:

    generation:

    initializers:

      pending:

      - name:

      result:

        apiVersion:

        code:

        details:

          causes:

          - field:

            message:

            reason:

          group:

          kind:

          name:

          retryAfterSeconds:

          uid:

        kind:

        message:

        metadata:

          resourceVersion:

          selfLink:

        reason:

        status:

    labels:

      [string]:

    name:

    namespace:

    ownerReferences:

    - apiVersion:

      blockOwnerDeletion:

      controller:

      kind:

      name:

      uid:

    resourceVersion:

    selfLink:

    uid:

  signatures:

  - apiVersion:

    conditions:

    - lastProbeTime:

      lastTransitionTime:

      message:

      reason:

      status:

      type:

    content:

    created:

    imageIdentity:

    issuedBy:

      commonName:

      organization:

    issuedTo:

      commonName:

      organization:

      publicKeyID:

    kind:

    metadata:

      annotations:

        [string]:

      clusterName:

      creationTimestamp:

      deletionGracePeriodSeconds:

      deletionTimestamp:

      finalizers:

      - [string]:

      generateName:

      generation:

      initializers:

        pending:

        - name:

        result:

          apiVersion:

          code:

          details:

            causes:

            - field:

              message:

              reason:

            group:

            kind:

            name:

            retryAfterSeconds:

            uid:

          kind:

          message:

          metadata:

            resourceVersion:

            selfLink:

          reason:

          status:

      labels:

        [string]:

      name:

      namespace:

      ownerReferences:

      - apiVersion:

        blockOwnerDeletion:

        controller:

        kind:

        name:

        uid:

      resourceVersion:

      selfLink:

      uid:

    signedClaims:

      [string]:

    type:

kind:

lookupPolicy:

  local:

metadata:

  annotations:

    [string]:

  clusterName:

  creationTimestamp:

  deletionGracePeriodSeconds:

  deletionTimestamp:

  finalizers:

  - [string]:

  generateName:

  generation:

  initializers:

    pending:

    - name:

    result:

      apiVersion:

      code:

      details:

        causes:

        - field:

          message:

          reason:

        group:

        kind:

        name:

        retryAfterSeconds:

        uid:

      kind:

      message:

      metadata:

        resourceVersion:

        selfLink:

      reason:

      status:

  labels:

    [string]:

  name:

  namespace:

  ownerReferences:

  - apiVersion:

    blockOwnerDeletion:

    controller:

    kind:

    name:

    uid:

  resourceVersion:

  selfLink:

  uid:

tag:

  annotations:

    [string]:

  from:

    apiVersion:

    fieldPath:

    kind:

    name:

    namespace:

    resourceVersion:

    uid:

  generation:

  importPolicy:

    insecure:

    scheduled:

  name:

  reference:

  referencePolicy:

    type:

Operations

Create a ImageStreamTag

Create an ImageStreamTag

HTTP request

POST /apis/image.openshift.io/v1/imagestreamtags HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/imagestreamtags <<'EOF'
{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ImageStreamTag

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTag

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Create a ImageStreamTag in a namespace

Create an ImageStreamTag

HTTP request

POST /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags <<'EOF'
{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ImageStreamTag

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTag

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get a ImageStreamTag in a namespace

Read the specified ImageStreamTag

HTTP request

GET /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME

Path parameters

Parameter Description

name

name of the ImageStreamTag

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTag

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all ImageStreamTags

List objects of kind ImageStreamTag

HTTP request

GET /apis/image.openshift.io/v1/imagestreamtags HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/imagestreamtags

Query parameters

Parameter Description

pretty

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

fieldSelector

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

includeUninitialized

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

labelSelector

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

resourceVersion

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

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTagList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Get all ImageStreamTags in a namespace

List objects of kind ImageStreamTag

HTTP request

GET /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags

Path parameters

Parameter Description

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

fieldSelector

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

includeUninitialized

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

labelSelector

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

resourceVersion

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

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTagList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch

Update a ImageStreamTag in a namespace

Replace the specified ImageStreamTag

HTTP request

PUT /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME <<'EOF'
{
  "kind": "ImageStreamTag",
  "apiVersion": "image.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.ImageStreamTag

Path parameters

Parameter Description

name

name of the ImageStreamTag

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTag

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Patch a ImageStreamTag in a namespace

Partially update the specified ImageStreamTag

HTTP request

PATCH /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter Schema

body

v1.Patch

Path parameters

Parameter Description

name

name of the ImageStreamTag

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.ImageStreamTag

401 Unauthorized

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Delete a ImageStreamTag in a namespace

Delete an ImageStreamTag

HTTP request

DELETE /apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/apis/image.openshift.io/v1/namespaces/$NAMESPACE/imagestreamtags/$NAME

Path parameters

Parameter Description

name

name of the ImageStreamTag

namespace

object name and auth scope, such as for teams and projects

Query parameters

Parameter Description

pretty

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

Responses

HTTP Code Schema

200 OK

v1.Status

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf