The Image Resource

An Image Resource, which has information about a Cycle image.

Attributes
  • id
    string

    A unique identifier for the image.

  • name
    string

    A user defined name for the image resource.

  • stack
    object | null

    If this image is part of a stack that information will be available in this object.

    Show child fields
  • size
    integer

    The image size in bytes.

  • about
    object
    optional

    An object that holds a description of the image.

    Show child fields
  • backend
    object

    The backend describes where the image is hosted.

    Show child fields
  • tags
    array of strings

    A tag(s) that describe the version, package, or data about the image. Popular examples are latest, alpine, and slim.

  • config
    object

    Configuration settings for the image.

    Show child fields
  • source
    object
    includable

    Image source and origin information.

    Show child fields
  • creator
    object
    includable

    A creator object. Describes who created the resource.

    Show child fields
  • hub_id
    string

    A unique identifier for the hub that this image is associated with.

  • state
    object

    Information regarding the current state of the image.

    Show child fields
  • events
    object

    A collection of timestamps for each event in the image's lifetime.

    Show child fields
  • meta
    object
    optional

    A list of meta fields that can be applied to this images. See the meta section for more details.

    Show child fields
Example Image
{
"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
},
"includes": {
"creators": {
"api_keys": {
"5e72764f5e411200011bb4cc": {
"id": "5e72764f5e411200011bb4cc",
"name": "Test Runner",
"secret": "secre***...",
"permissions": {
"all_environments": true,
"environments": []
},
"capabilities": {
"all": true,
"specific": [
"hubs-update",
"hubs-delete",
"hubs-invites-send",
"hubs-invites-manage",
"hubs-members-manage",
"hubs-members-view",
"hubs-notifications-listen",
"billing-methods-manage",
"billing-invoices-view",
"billing-invoices-pay",
"billing-orders-manage",
"billing-services-view",
"billing-credits-view",
"environments-create",
"environments-delete",
"environments-view",
"environments-update",
"environments-state",
"environments-services-manage",
"environments-vpn",
"environments-vpn-manage",
"containers-deploy",
"containers-view",
"containers-console",
"containers-ssh",
"containers-state",
"containers-update",
"containers-delete",
"containers-volumes-manage",
"containers-volumes-view",
"containers-instances-migrate",
"jobs-view",
"api-keys-manage",
"sdn-networks-manage",
"sdn-networks-view",
"stacks-manage",
"stacks-view",
"stacks-builds-manage",
"stacks-hooks-manage",
"images-view",
"images-build",
"images-update",
"images-delete",
"ips-manage",
"storage-sans-view",
"storage-sans-manage",
"servers-provision",
"servers-view",
"servers-login",
"servers-update",
"servers-state",
"servers-decommission",
"usage-view",
"dns-view",
"dns-manage",
"images-import"
]
},
"creator": {
"id": "59c6f65891238b00012b1d96",
"type": "account"
},
"hub_id": "5a14ddd8b6393d0001976f44",
"state": {
"changed": "2020-03-18T19:28:15.14Z",
"current": "live"
},
"events": {
"created": "2020-03-18T19:28:15.14Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z"
},
"ips": []
}
}
},
"stack_builds": {},
"stacks": {}
}
}