Get registry list

Prev Next

Available in Classic and VPC

Get the list of registries registered in Container Registry.

Request

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

Method URI
GET /repositories

Request headers

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

Request query parameters

You can use the following query parameters with your request:

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

Request example

The request example is as follows:

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

Response

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

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
results[].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

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

Response example

The response example is as follows:

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