Updated on 2024-04-19 GMT+08:00

API Overview

You can query information about organizations, image repositories, and images, and manage organizations, image repositories, and images by using interfaces provided by the container image service.

Organization Management

API

Description

Creating an Organization

Create an organization.

Deleting an Organization

Delete an organization.

Querying the List of Organizations

Query the list of organizations.

Querying the Details of an Organization

Query the details of an organization, including its ID, name, creator, and user permissions.

Image Repository Management

API

Description

Creating an Image Repository in an Organization

Create an image repository in an organization.

Deleting an Image Repository in an Organization

Delete an image repository in an organization.

Updating the Brief Information on an Image Repository

Update the brief information on an image repository in an organization, including the category, is_public, and description.

Querying the Brief Information on an Image Repository

Query the brief information on an image repository in an organization, including the image's repository ID, organization ID, repository name, description of the repository, the creator and capacity of the repository, and the image pull address.

Querying the Image Repository List

Query the image repository list.

Viewing the List of Shared Images

View the list of shared images.

Image Tag Management

API

Description

Querying the List of Image Repository Tags

Query all image tags of an image repository.

Deleting the Image with a Specified Tag

Delete the image with a specified tag in an image repository.

Shared Account Management

API

Description

Creating an Account Used for Image Sharing

Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.

Deleting an Account Used for Image Sharing

Delete an account used for image sharing.

Updating an Account Used for Image Sharing

Update an account used for image sharing.

Checking the Existence of an Account Used for Image Sharing

Check whether an account used for image sharing exists.

Obtaining the List of Accounts Used for Image Sharing

Obtain the list of accounts used for image sharing.

API Versions

API

Description

Querying All API Versions

Query all available API versions of SWR.

Querying a Specific API Version

Query a specific API version of SWR.

Organization Permission Management

API

Description

Creating Organization Permissions

Grant permissions of an organization to certain users so that they can manage, edit, and read images from the organization.

Deleting Organization Permissions

Delete the organization operation permissions of certain users.

Updating Organization Permissions

Update the organization operation permission types for certain users.

Querying Organization Permissions

Query organization permissions.

Temporary Login Command

API

Description

Generating a Temporary Login Command

Generate a temporary login command using the value of X-Swr-Dockerlogin in the response header and the value of host in the response body.