View registry list

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in Classic and VPC

View the list of registries registered in Container Registry.

Requests

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

Method	URI
GET	/repositories

Request headers

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

Request query parameters

The following describes the request query 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" 
-H "Content-Type: application/json; charset=utf-8"
-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": [
        {
            "bucket": "string",
            "created": "number",
            "end_point": "string",
            "end_point_enabled": "boolean",
            "name": "string",
            "private_end_point": "string",
            "private_id": "string",
            "public_reg_status": "boolean",
            "scan_on_push_enabled": "boolean",
            "status": "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
`results[].bucket`	String	-	Name of the Object Storage bucket integrated with the registry
`result[].[].created`	Number	-	Registry creation date
`results[].end_point`	String	-	Endpoint for Docker client to access the registry
`results[].end_point_enabled`	Boolean	-	Endpoint accessibility
`results[].name`	String	-	Registry name
`results[].private_end_point`	String	-	Endpoint for Docker client to access the registry Available only on NAVER Cloud Platform's VPC network
`results[].private_id`	String	-	ID of the private endpoint
`results[].public_reg_status`	Boolean	-	Whether the user who accessed without authentication has Pull permissions `true` \| `false`
`results[].scan_on_push_enabled`	Boolean	-	Whether to automatically scan for vulnerabilities when uploading container images `true` \| `false`
`results[].status`	String	-	Integration status of registry and Object Storage `running` \| `disconnected` `running`: normal status `disconnected`: bucket deleted

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

Response example

The following is a sample response.

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "bucket": "ncpdocker",
            "created": 1711695272000,
            "end_point": "ncpdocker.kr.ncr.ntruss.com",
            "end_point_enabled": true,
            "name": "ncpdocker",
            "private_end_point": "pdxxxnzd.kr.private-ncr.ntruss.com",
            "private_id": "pdxxxnzd",
            "public_reg_status": false,
            "scan_on_push_enabled": false,
            "status": "running"
        }
    ]
}

Was this article helpful?

What's Next

Table of contents

Requests
Responses