Class API

Marketplace API.

This API allows you to find available images for use when launching a Scaleway Instance.

Hierarchy

API
- API

Index

Constructors

constructor

Methods

getCategory getImage getLocalImage getVersion listCategories listImages listLocalImages listVersions

Constructors

constructor

new API(client): Marketplace.v2.API
Parameters
- client: Client
Returns Marketplace.v2.API
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

getCategory

getCategory(request): Promise<Category>
Get a specific category. Get information about a specific category of the marketplace catalog, specified by its category_id (UUID format).
Parameters
- request: Readonly<GetCategoryRequest>
  The request GetCategoryRequest
Returns Promise<Category>
A Promise of Category
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:230

getImage

getImage(request): Promise<Marketplace.v2.Image>
Get a specific marketplace image. Get detailed information about a marketplace image, specified by its image_id (UUID format).
Parameters
- request: Readonly<Marketplace.v2.GetImageRequest>
  The request GetImageRequest
Returns Promise<Marketplace.v2.Image>
A Promise of Image
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:83

getLocalImage

getLocalImage(request): Promise<LocalImage>
Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its local_image_id (UUID format).
Parameters
- request: Readonly<GetLocalImageRequest>
  The request GetLocalImageRequest
Returns Promise<LocalImage>
A Promise of LocalImage
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:186

getVersion

getVersion(request): Promise<Marketplace.v2.Version>
Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its version_id (UUID format).
Parameters
- request: Readonly<Marketplace.v2.GetVersionRequest>
  The request GetVersionRequest
Returns Promise<Marketplace.v2.Version>
A Promise of Version
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:128

listCategories

listCategories(request?): Promise<ListCategoriesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Category[], void, void>);
all: (() => Promise<Category[]>);
}
List existing image categories. Get a list of all existing categories. The output can be paginated.
Parameters
- request: Readonly<ListCategoriesRequest> = {}
  The request ListCategoriesRequest
Returns Promise<ListCategoriesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Category[], void, void>);
all: (() => Promise<Category[]>);
}
A Promise of ListCategoriesResponse
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:220

listImages

listImages(request): Promise<Marketplace.v2.ListImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Image[], void, void>);
all: (() => Promise<Marketplace.v2.Image[]>);
}
List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description.
Parameters
- request: Readonly<Marketplace.v2.ListImagesRequest>
  The request ListImagesRequest
Returns Promise<Marketplace.v2.ListImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Image[], void, void>);
all: (() => Promise<Marketplace.v2.Image[]>);
}
A Promise of ListImagesResponse
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:73

listLocalImages

listLocalImages(request?): Promise<ListLocalImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<LocalImage[], void, void>);
all: (() => Promise<LocalImage[]>);
}
List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its image_id (UUID format), version_id (UUID format) or image_label. Only one of these three parameters may be set.
Parameters
- request: Readonly<ListLocalImagesRequest> = {}
  The request ListLocalImagesRequest
Returns Promise<ListLocalImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<LocalImage[], void, void>);
all: (() => Promise<LocalImage[]>);
}
A Promise of ListLocalImagesResponse
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:174

listVersions

listVersions(request): Promise<Marketplace.v2.ListVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Version[], void, void>);
all: (() => Promise<Marketplace.v2.Version[]>);
}
List versions of an Image. Get a list of all available version of an image, specified by its image_id (UUID format).
Parameters
- request: Readonly<Marketplace.v2.ListVersionsRequest>
  The request ListVersionsRequest
Returns Promise<Marketplace.v2.ListVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Version[], void, void>);
all: (() => Promise<Marketplace.v2.Version[]>);
}
A Promise of ListVersionsResponse
- Defined in packages/clients/src/api/marketplace/v2/api.gen.ts:117

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Marketplace.v2.API

Methods

getCategory

Parameters

Returns Promise<Category>

getImage

Parameters

Returns Promise<Marketplace.v2.Image>

getLocalImage

Parameters

Returns Promise<LocalImage>

getVersion

Parameters

Returns Promise<Marketplace.v2.Version>

listCategories

Parameters

Returns Promise<ListCategoriesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Category[], void, void>);
all: (() => Promise<Category[]>);
}

listImages

Parameters

Returns Promise<Marketplace.v2.ListImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Image[], void, void>);
all: (() => Promise<Marketplace.v2.Image[]>);
}

listLocalImages

Parameters

Returns Promise<ListLocalImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<LocalImage[], void, void>);
all: (() => Promise<LocalImage[]>);
}

listVersions

Parameters

Returns Promise<Marketplace.v2.ListVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Version[], void, void>);
all: (() => Promise<Marketplace.v2.Version[]>);
}

Settings

On This Page

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Marketplace.v2.API

Methods

getCategory

Parameters

Returns Promise<Category>

getImage

Parameters

Returns Promise<Marketplace.v2.Image>

getLocalImage

Parameters

Returns Promise<LocalImage>

getVersion

Parameters

Returns Promise<Marketplace.v2.Version>

listCategories

Parameters

Returns Promise<ListCategoriesResponse> & { [asyncIterator]: (() => AsyncGenerator<Category[], void, void>); all: (() => Promise<Category[]>); }

listImages

Parameters

Returns Promise<Marketplace.v2.ListImagesResponse> & { [asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Image[], void, void>); all: (() => Promise<Marketplace.v2.Image[]>); }

listLocalImages

Parameters

Returns Promise<ListLocalImagesResponse> & { [asyncIterator]: (() => AsyncGenerator<LocalImage[], void, void>); all: (() => Promise<LocalImage[]>); }

listVersions

Parameters

Returns Promise<Marketplace.v2.ListVersionsResponse> & { [asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Version[], void, void>); all: (() => Promise<Marketplace.v2.Version[]>); }

Settings

On This Page

Returns Promise<ListCategoriesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Category[], void, void>);
all: (() => Promise<Category[]>);
}

Returns Promise<Marketplace.v2.ListImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Image[], void, void>);
all: (() => Promise<Marketplace.v2.Image[]>);
}

Returns Promise<ListLocalImagesResponse> & {
[asyncIterator]: (() => AsyncGenerator<LocalImage[], void, void>);
all: (() => Promise<LocalImage[]>);
}

Returns Promise<Marketplace.v2.ListVersionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Marketplace.v2.Version[], void, void>);
all: (() => Promise<Marketplace.v2.Version[]>);
}