Updated on 2025-09-10 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 Organizations

Query the organization list.

Querying Details of an Organization

Query the details about 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 from 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 Image Repositories

Query the image repository list.

Querying Shared Images

Query the list of shared images.

Image Tag Management

API

Description

Querying Image Tags

Query all image tags of an image repository.

Deleting an Image with a Specified Tag

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

Shared Account Management

API

Description

Sharing an Image with an Account

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

Deleting an Account from the Sharing List

Delete an account used for image sharing.

Updating an Account an Image Is Shared With

Update an account used for image sharing.

Checking Whether an Account Exists for Receiving a Shared Image

Check whether an account exists for receiving a shared image.

Querying Accounts an Image Is Shared With

Query the list of accounts an image is shared with.

API Versions

API

Description

Querying All API Versions

Query all available API versions of SWR.

Querying a Specified API Version

Query a specific API version of SWR.

Organization Permission Management

API

Description

Granting Organization Permissions

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

Canceling Organization Permissions

Cancel 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.

Image Permission Management

API

Description

Granting Image Permissions

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

Canceling Image Permissions

Cancel the image operation permissions of certain users.

Updating Image Permissions

Update the image operation permission types for certain users.

Querying Image Permissions

Query image permissions.

Trigger Management

API

Description

Creating a Trigger

Create a trigger.

Querying Triggers of a Specific Image Repository

Query the trigger list of a specific image repository.

Deleting a Trigger

Delete a trigger.

Querying Details About a Trigger

Query the details about a trigger.

Updating a Trigger

Update the status of a trigger.

Image Retention Policy Management

API

Description

Adding an Image Retention Policy

Add an image retention policy.

Querying Image Retention Policies

Obtain the list of image retention policies.

Deleting an Image Retention Policy

Delete an image retention policy.

Querying Details About an Image Retention Policy

Obtain the records of image retention policies.

Modifying an Image Retention Policy

Modify an image retention policy.

Querying Image Retention Records

Obtain image retention records.

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.

Quota Management

API

Description

Querying Quotas

Obtain quota information.