API Key 재생성
- 인쇄
- PDF
API Key 재생성
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
API Key의 Primary Key 또는 Secondary Key를 재생성합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PATCH | /api-keys/{api-key-id} |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
api-key-id | String | Required | API Key를 재생성할 API Key ID |
요청 구문
요청 구문은 다음과 같습니다.
{
"keyType" : "keyType"
}
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
keyType | String | Required | 재생성할 API Key의 유형
|
요청 예시
요청 예시는 다음과 같습니다.
curl -X PATCH 'https://apigateway.apigw.ntruss.com/api/v1//api-keys/{api-key-id}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
"keyType" : "PRIMARY"
}'
응답
응답 형식을 설명합니다.
응답 구문
구문은 다음과 같습니다.
{
"apiKey": {
"apiKeyId": "apiKeyId",
"tenantId": "tenantId",
"apiKeyName": "apiKeyName",
"apiKeyDescription": "apiKeyDescription",
"primaryKey": "primaryKey",
"secondaryKey": "secondaryKey",
"modifier": "modifier",
"isEnabled": false,
"modTime": "2024-05-08T00:21:31Z",
"domainCode": "domainCode"
}
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"apiKey": {
"apiKeyId": "*****bgro1",
"tenantId": "*****02f55ae4436913a6e2c65bab47c",
"apiKeyName": "apiKeyName",
"apiKeyDescription": "apiKeyDescription",
"primaryKey": "*****f7AOklrKqLQiZfLRUPnXsHHLQi4jhYURYSU",
"secondaryKey": "*****a2121vr736Q7JlU2L3erP7Kkuryvu2iJRi8",
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"isEnabled": false,
"modTime": "2024-05-08T00:21:31Z",
"domainCode": "PUB"
}
}
이 문서가 도움이 되었습니까?