API Key 상태 변경

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

지정한 API Key의 상태를 변경합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PATCH /products/{product-id}/api-keys/{api-key-id}

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
product-id String Required API Key가 속한 Product ID
api-key-id String Required 상태를 변경할 API Key ID

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
status String Required 변경할 상태
  • ACCEPTED | REJECTED
    • ACCEPTED: 승인
    • REJECTED: 거부

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PATCH 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/api-keys/***fmy2***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "status" : "ACCEPTED"
}'

응답

응답 형식을 설명합니다.

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.