Fetch Single Image

Use this API call to fetch a single image.

Requires the images-view permission.

query
  • include

    Accepted Values: ownersstack_buildsstacks

  • meta

    Accepted Values: container_counts

  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns a image resource, otherwise returns an Error.

GET /v1/image/{ID}

Example Request
$ curl https://api.cycle.io/v1/images/5b9c2a77b6393d0001eb45fd \
  -H 
"Authorization: Bearer  API_KEY"
 \
  -H 
"X-HUB-ID:  HUB_ID"
Example Response
{
  "data": {
    "id": "5b9c2a77b6393d0001eb45fd",
    "source": {
      "type": "direct",
      "details": {
        "id": "5a232a77b6393d0001ac2df2",
        "origin": {
          "type": "docker-hub",
          "details": {
            "target": "cycleplatform/getting-started:latest"
          }
        }
      }
    },
    "size": 22947538,
    "name": "cycleplatform/getting-started:latest",
    "about": {
      "description": null
    },
    "backend": {
      "provider": "backblaze-b2",
      "file_name": "hub-5b9c2a77b6393d0001eb45fd/images/5fff2a77b6393d0001eb3333.tar.gz",
      "file_id": "4_zb5aaaaaaaa08df3e69f22222_abc00048bd4444281_d21111110_m233330_c220_v4444476_a0243",
      "size": 9517715
    },
    "config": {
      "user": "",
      "ports": [
        {
          "type": "tcp",
          "host": 80,
          "container": 80
        }
      ],
      "env": {
        "HOME": "/root",
        "NGINX_VERSION": "1.19.2",
        "NJS_VERSION": "0.4.3",
        "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
        "PKG_RELEASE": "1",
        "TERM": "xterm"
      },
      "labels": {
        "maintainer": "NGINX Docker Maintainers <docker-maint@nginx.com>",
        "org.opencontainers.image.architecture": "amd64",
        "org.opencontainers.image.author": "",
        "org.opencontainers.image.created": "2020-09-29T23:45:31.206005317Z",
        "org.opencontainers.image.exposedPorts": "80/tcp",
        "org.opencontainers.image.os": "linux",
        "org.opencontainers.image.stopSignal": "SIGTERM"
      },
      "command": [
        "/docker-entrypoint.sh",
        "nginx",
        "-g",
        "daemon off;"
      ],
      "entrypoint": [],
      "volumes": [],
      "workdir": "/",
      "signal_stop": "SIGTERM"
    },
    "creator": {
      "id": "5ccc2a2226393d1231eb4abd",
      "type": "api-key"
    },
    "hub_id": "5b9c2a77b6393d0001eb45fd",
    "state": {
      "changed": "2021-02-10T20:23:11.888Z",
      "current": "live"
    },
    "events": {
      "created": "2021-02-10T20:21:52.671Z",
      "updated": "0001-01-01T00:00:00Z",
      "deleted": "0001-01-01T00:00:00Z"
    },
    "meta": {
      "containers_count": 5
    }
  }
}