← Back

Image

API for image operations

Version: 0.1.0

Server

  • URL: https://api.kopernik.us/v0
    • Kopernik.us API server

Paths

/resource/image/{providerUid}

GET

List images

List images for the specified provider

Parameters:

Name In Type Required Description
providerUid path ProviderId ✅ Unique identifier of the provider
type query string enum ❌ Type of images to list. If set to “os-distribution”, returns only OS distribution images
nextToken query string ❌ Token for the next page of images, if there are more items to fetch
maxResults query integer ❌ Maximum number of images to fetch
jq query string ❌ JQ filter expression to filter the results. Only resources where the expression evaluates to a truthy value are included. The expression is applied to each resource’s JSON representation. Uses jq 1.7 syntax.

Responses:

/resource/image/{providerUid}/{resourceUid}

GET

Get image

Get image details

Parameters:

Name In Type Required Description
providerUid path ProviderId ✅ Unique identifier of the provider
resourceUid path string ✅ Unique identifier of the image

Responses:

  • 200: Image details

  • 400: Argument validation error

  • 404: Image not found

Schemas

Image

Image

Composition: allOf

Type: object

Properties:

Name Type Required Description
name string ✅ Name of the image
distribution string ✅ OS distribution of the image
architecture string ✅ Architecture of the image
description string ❌ Description of the image
vendor string ❌ Vendor of the image
createdAt number ❌ Creation time of the image, in seconds since epoch
supportedRegions array ❌ For regional images, the regions where the image is supported
tags array ❌ Tags of the image

ImageResourceResponse

Response with image

Composition: allOf

Type: object

Properties:

Name Type Required Description
resource Image ✅

ImagePagedResourceResponse

Response with paged images

Composition: allOf

Type: object

Properties:

Name Type Required Description
resources array<Image> ✅