View image list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

View the list of images registered in the registry of Container Registry.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method	URI
GET	/repositories/{registry}

Request headers

For headers common to all Container Registry APIs, see Container Registry common headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`registry`	String	Required	Name of the registry where the images you are viewing are registered

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`page`	Number	Optional	Page number to view Enter a value greater than 0 for the page number
`pagesize`	Number	Optional	Size of the page to view Enter a value greater than 0 for the page size

Request example

The following is a sample request.

curl -X GET "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}" 
-H "x-ncp-apigw-timestamp: {Timestamp}"
-H "x-ncp-iam-access-key: {Sub Account Access Key}"
-H "x-ncp-apigw-signature-v2: {API Gateway Signature}"

Responses

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "count": "number",
  "next": "number",
  "previous": "number",
  "results": [
    {
      "can_edit": "boolean",
      "description": "string",
      "is_automated": "boolean",
      "is_private": "boolean",
      "last_updated": "number"
      "name": "string",
      "namespace": "string",
      "pull_count": "number",
      "repository_type": "string",
      "star_count": "number",
      "status": "number",
      "user": "string",
    }
  ]
}

Response body

The following describes the response body.

Field	Type	Required	Description
`count`	Number	-	Total number of registries registered
`next`	Number	-	Number of the next page It returns null if there is no next page
`previous`	Number	-	Number of the previous page It returns null if there is no previous page
`result[].can_edit`	Boolean	-	Currently not used
`result[].description`	String	-	Short description for the image
`result[].is_automated`	Boolean	-	Not used
`result[].is_private`	Boolean	-	Not used
`result[].last_update`	Number	-	Last modification date of the image It returns elapsed time in milliseconds since January 1, 1970 00:00:00 UTC
`result[].name`	String	-	Image name
`result[].namespace`	String	-	Registry name
`result[].pull_count`	Number	-	Total pull count value for the image
`result[].repository_type`	String	-	Not used
`result[].star_count`	Number	-	Not used
`result[].status`	Number	-	Not used
`result[].user`	String	-	Not used

Response status codes

The following describes response status codes. For response status codes common to all Container Registry APIs, see Container Registry response status codes.

HTTP status code	Code	Message	Description
200	-	OK	Request succeeded
404	-	Not Found	Requested resource not found

Response example

The following is a sample response.

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
      {
          "can_edit": true,
          "description": null,
          "is_automated": null,
          "is_private": null,
          "last_updated": 1711928488000,
          "name": "ncpdocker",
          "namespace": "ncpdocker",
          "pull_count": 0,
          "repository_type": "image",
          "star_count": null,
          "status": 0,
          "user": null
      }
  ]
}

Was this article helpful?

What's Next

View image details

Table of contents

Requests
Responses