Available in VPC
Get the secret list.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v1/secrets |
Request headers
For information about the headers common to all Secret Manager APIs, see Secret Manager request headers.
Request query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
pageNo |
Integer | Optional | Page number
|
Request example
The request example is as follows:
curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets?pageNo=0' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--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 |
---|---|---|---|
code |
String | - | Response code |
data |
Object | - | Response result |
data.totalPageNo |
Integer | - | Total number of pages |
data.currentPageNo |
Integer | - | Current page number |
data.totalCount |
Integer | - | Total secret count |
data.secretList |
Array | - | Secret list |
secretList
The following describes secretList
.
Field | Type | Required | Description |
---|---|---|---|
secretId |
String | - | Secret ID |
secretName |
String | - | Secret name |
secretStatus |
String | - | Secret status
|
secretType |
String | - | Secret type
|
region |
String | - | Area code |
registerDate |
Long | - | Secret creation date and time
|
Response status codes
For information about the HTTP status codes common to all Secret Manager APIs, see Secret Manager response status codes.
Response example
The response example is as follows:
{
"code": "SUCCESS",
"data": {
"totalPageNo": 1,
"currentPageNo": 1,
"totalCount": 2,
"secretList": [
{
"secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
"secretName": "test-***",
"secretStatus": "ENABLE",
"secretType": "BASIC",
"region": "KR",
"registerDate": 1753065580243
}
]
}
}