Image Repository

Lists image repositories¶

GET/api/v2/databases/{database}/schemas/{schema}/image-repositories
Lists the image repositories under a specified database and schema.

Path Parameters¶

ParameterDescription
database 
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Creates an image repository in the specified database and schema¶

POST/api/v2/databases/{database}/schemas/{schema}/image-repositories
Creates an image repository in the specified database, schema, and create mode. The `createMode` query parameter specifies what action to take based on whether the repository already exists. See the ImageRepository component definition for what is required to be provided in the request body.

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetches an image repository¶

GET/api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}
Fetches a named image repository in a specified database and schema.

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
Successful request.
202

Deletes an image repository¶

DELETE/api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}
Deletes an image repository with the given name. If you enable the `ifExists` query parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist.

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

List images in the image repository¶

GET/api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}/images
List images in the given image repository.

Response¶

CodeDescription
200
Successful request.
202