Get image details

Available in Classic and VPC

Get details of an image registered in the registry of Container Registry.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/ncr/api/v2/repositories/{registry}/{imageName} (Korea Region)
GET	/ncr/sgn-api/v2/repositories/{registry}/{imageName} (Singapore Region)
GET	/ncr/jpn-api/v2/repositories/{registry}/{imageName} (Japan Region)

Request headers

For information about the headers common to all Container Registry APIs, see Container Registry request headers.

Request path parameters

You can use the following path parameters with your request:

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 request example is as follows:

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

Response

This section 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 response body includes the following data:

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

For information about the HTTP status codes common to all Container Registry APIs, see Container Registry response status codes.

Response example

The response example is as follows:

{
  "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
}