--- title: "API Key 수정" slug: "apigateway-apikey-change" tags: ["API Gateway", "API Key"] updated: 2026-07-23T09:04:29Z published: 2026-07-23T09:04:29Z canonical: "api.ncloud-docs.com/apigateway-apikey-change" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # API Key 수정 Classic/VPC 환경에서 이용 가능합니다. API Key의 정보를 수정합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다. | 메서드 | URI | | --- | --- | | PUT | /api/v1/api-keys/{api-key-id} | ### 요청 헤더 API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 경로 파라미터 요청 경로 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `api-key-id` | String | Required | 수정할 API Key ID | ### 요청 구문 요청 구문은 다음과 같습니다. ``` { "isEnabled" : true, "apiKeyDescription" : "apiKeyDescription", "apiKeyName" : "apiKeyName" } ``` ### 요청 바디 요청 바디에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `isEnabled` | Boolean | Required | API Key 활성 여부 - `true` \| `false` - `true`: API Key 활성 - `false`: API Key 비활성 | | `apiKeyDescription` | String | Optional | API Key에 대한 설명 - 0~50자 | | `apiName` | String | Required | API Key의 이름 - 1~20자 | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl -X PUT '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 '{ "isEnabled" : true, "apiKeyDescription" : "apiKey-*** Description", "apiKeyName" : "apiKey-***" }' ``` ## 응답 응답 형식을 설명합니다. ### 응답 구문 응답 구문은 다음과 같습니다. ``` { "apiKey": { "apiKeyId": "apiKeyId", "tenantId": "tenantId", "apiKeyName": "apiKeyName", "apiKeyDescription": "apiKeyDescription", "primaryKey": "primaryKey", "secondaryKey": "secondaryKey", "modifier": "modifier", "isEnabled": true, "modTime": "2024-05-08T05:56:26Z", "domainCode": "domainCode" } } ``` ### 응답 상태 코드 API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오. ### 응답 예시 응답 예시는 다음과 같습니다. ``` { "apiKey": { "apiKeyId": "*****g079", "tenantId": "*****02f55ae4436913a6e2c65bab47c", "apiKeyName": "apiKey-***", "apiKeyDescription": "apiKey-*** Description", "primaryKey": "*****yVk37ZE39kJcZScH50cYsJiYf1EJUQ7haPj", "secondaryKey": "*****RWKmt1IVMAlXtg0yJ5jelwwiltuJBFKBDW9", "modifier": "d12c9fd0-****-****-****-246e96591a38", "isEnabled": true, "modTime": "2024-05-08T05:56:26Z", "domainCode": "PUB" } } ```