Documentation | Images › List Images

Images

images

Methods

Create Image -> { tasks }

post/v1/images/{project_id}/{region_id}

Create image

Delete The Image -> { tasks }

delete/v1/images/{project_id}/{region_id}/{image_id}

Delete the image

List Images -> { count, results }

get/v1/images/{project_id}/{region_id}

Retrieve an available images list. Returned entities owned by the project and public OR shared with the client

Parameters

project_id: number

region_id: number

include_prices: boolean

Optional

Show price

metadata_k: string

Optional

Filter by metadata keys. Must be a valid JSON string. ' curl -G --data-urlencode 'metadata_k=["key1", "key2"]' --url 'http://localhost:1111/v1/images/1/1'

metadata_kv: string

Optional

Filter by metadata key-value pairs. Must be a valid JSON string. 'curl -G --data-urlencode 'metadata_kv={"key": "value"}' --url 'http://localhost:1111/v1/images/1/1'"

private: string

Optional

Any value to show private images

visibility:

Optional

Image visibility. Globally visible images are public

"private"

"public"

"shared"

Response fields

count: number

Optional

Number of objects

results: Array<

Image

Optional

Objects

Request example

curl https://api.gcore.com/cloud/v1/images/$PROJECT_ID/$REGION_ID \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "name": "ubuntu-20.10-x64",
      "architecture": "aarch64",
      "created_at": "2020-11-13T11:26:19+0000",
      "currency_code": "USD",
      "description": "string",
      "disk_format": "raw",
      "display_order": 2010,
      "hw_firmware_type": "bios",
      "hw_machine_type": "i440",
      "internally_shared": true,
      "is_baremetal": false,
      "min_disk": 3,
      "min_ram": 0,
      "os_distro": "ubuntu",
      "os_type": "linux",
      "os_version": "20.10",
      "price_per_hour": 1,
      "price_per_month": 720,
      "price_status": "error",
      "size": 2361393152,
      "ssh_key": "allow",
      "status": "active",
      "updated_at": "2020-12-18T14:51:20+0000",
      "visibility": "public"
    }
  ]
}

List Images Owned By Project -> { count, results }

get/v1/projectimages/{project_id}/{region_id}

List images owned by project

Get Image ->

Image

get/v1/images/{project_id}/{region_id}/{image_id}

Get image

Update Image Fields ->

Image

patch/v1/images/{project_id}/{region_id}/{image_id}

Update image fields

Domain types

Image = { name, id, architecture, 29 more... }

Image schema

Images

Metadata

images.metadata

Methods

Create Or Update Image Metadata ->

post/v1/images/{project_id}/{region_id}/{image_id}/metadata

Create or update one or more metadata items for an image. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List Image Metadata -> { count, results }

get/v1/images/{project_id}/{region_id}/{image_id}/metadata

List all metadata for an image

Replace Image Metadata ->

put/v1/images/{project_id}/{region_id}/{image_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Images

Metadata Item

images.metadata_item

Methods

Delete Image Metadata Item By Key ->

delete/v1/images/{project_id}/{region_id}/{image_id}/metadata_item

Delete image metadata item by key

Get Image Metadata Item By Key -> { key, read_only, value }

get/v1/images/{project_id}/{region_id}/{image_id}/metadata_item

Get image metadata item by key

Images

Reseller Image

images.reseller_image

Methods

Deprecated Delete Image Limits For Reseller Clients ->

delete/v1/reseller_image/{reseller_id}

Deprecated. Delete image limits for reseller clients

Deprecated Get Available Image IDs For The Reseller -> { count, results }

get/v1/reseller_image/{reseller_id}

If the reseller isn't showed or has image_ids = None, all public images available to him. If the reseller has image_ids = [], all public images are unavailable to the client.

Deprecated Set Or Update Available Image List For Reseller -> { image_ids, region_id, reseller_id }

put/v1/reseller_image

Reseller and cloud admin can change the set of images, available to reseller clients. Firstly, they may limit the number of public images available. Secondly, they can share the image of the reseller client to all clients of the reseller. If the reseller isn't showed or has image_ids = None, all public images available to him. If the reseller has image_ids = [], all public images are unavailable to the client.

Images

Shared Image

images.shared_image

Methods

Create Or Update Shared Image ->

SharedImageList

put/v1/shared_image

Create or update shared image

Delete Entity Shared Image ->

delete/v1/shared_image

Delete entity shared image

Get Available Image IDs ->

SharedImageList

get/v1/shared_image

If the entity isn't showed or has image_ids = None, all public images available to him. If the entity has image_ids = [], all public images are unavailable to the client.

Domain types

SharedImageList = { count, results }