View image details

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

View details of an image 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}/{imageName}

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 image for which you want to view information is registered
`imageName`	String	Required	Name of the image to view the details of Need to use URI encoded values <Example> For `hello/world`, convert to `hello%2Fworld` and use it

Request example

The following is a sample request.

curl -X GET "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}" 
-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.

{
  "can_edit": "boolean",
  "description": "string",
  "full_description": "string",
  "is_automated": "boolean",
  "is_private": "boolean",
  "last_updated": "number",
  "name": "string",
  "namespace": "string",
  "private_id": "",
  "pull_count": "number",
  "repository_type": "string",
  "star_count": "number",
  "status": "number",
  "tag_mutability_enabled": true,
  "user": "string",
}

Response body

The following describes the response body.

Field	Type	Required	Description
`can_edit`	Boolean	-	Not used
`description`	String	-	Short description for the image
`full_description`	String	-	Detailed description for the image
`is_automated`	Boolean	-	Not used
`is_private`	Boolean	-	Not used
`last_update`	Number	-	Last modification date of the image It returns the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
`name`	String	-	Image name
`namespace`	String	-	Registry name
`private_id`	String	-	ID of the private endpoint
`pull_count`	Number	-	Total pull count value for the image
`repository_type`	String	-	Not used
`star_count`	Number	-	Not used
`status`	Number	-	Not used
`tag_mutability_enabled`	Boolean	-	Whether tag mutability is set
`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.

{
  "can_edit": true,
  "description": "ncp docker",
  "full_description": "Naver Cloud Platform Docker",
  "is_automated": null,
  "is_private": null,
  "last_updated": 1711928488000,
  "name": "ncpdocker",
  "namespace": "ncpdocker",
  "private_id": "",
  "pull_count": 0,
  "repository_type": "image",
  "star_count": null,
  "status": 0,
  "tag_mutability_enabled": true,
  "user": null
}

Was this article helpful?

What's Next

Edit image information

Table of contents

Requests
Responses