Get repository

Prev Next

Available in Classic and VPC

Get repository details.

Request

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

Method URI
GET /api/v1/repository/{repositoryName}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
repositoryName String Required Repository name

Request example

The request example is as follows:

curl --location --request GET 'https://sourcecommit.apigw.ntruss.com/api/v1/repository/repository001' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.id Number - Repository ID
result.name String - Repository name
result.description String - Repository description
result.created Object - Repository creation information
result.git Object - Repository Git information
result.linked Object - Service integration information

created

The following describes created.

Field Type Required Description
created.timestamp Number - Repository creation date and time (millisecond)
  • Unix timestamp format
created.user String - Repository creator ID

git

The following describes git.

Field Type Required Description
git.https String - Repository public URL (HTTPS)
git.ssh String - Repository SSH URL (SSH)
git.httpsPrivate String - Repository private URL (HTTPS)

linked

The following describes linked.

Field Type Required Description
linked.FileSafer Boolean - File Safer service integration
  • true | false
    • true: integrate
    • false: not integrate
linked.ObjectStorage Boolean - Object Storage service integration
  • true | false
    • true: integrate
    • false: not integrate

Response status codes

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

Response example

The response example is as follows:

{
    "result": {
        "id": 632***,
        "name": "repository001",
        "description": "repository001",
        "created": {
            "timestamp": 1747025341000,
            "user": "nb*****@navercorp.com"
        },
        "git": {
            "https": "https://devtools.ncloud.com/****/repository001.git",
            "ssh": "ssh://devtools.ncloud.com/****/repository001.git",
            "httpsPrivate": "https://********.devtools.ncloud.com/****/repository001.git"
        },
        "linked": {
            "FileSafer": true,
            "ObjectStorage": false
        }
    }
}