View API key subscription
- Print
- PDF
View API key subscription
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View information of the stage (subscribed stage) associated with an API key.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /api-keys/{api-key-id}/subscription-detail |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
api-key-id | String | Required | API key ID to view subscription information |
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
offset | Long | Optional | Starting point in the list of data to view
|
limit | Long | Optional | Number of data to view at once
|
apiId | String | Optional | API ID that the stage belongs to |
stageId | String | Optional | Stage ID associated with the API key |
productId | String | Required | Product ID associated with the API key |
Request example
The following is a sample request.
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail?productId=*****n0bk' \
--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}'
Response
The following describes the response format.
Response syntax
The syntax is as follows.
{
"apiKeyRelations": {
"content": [
{
"apiId": "apiId",
"apiName": "apiName",
"stageId": "stageId",
"stageName": "stageName",
"apiKeyId": "apiKeyId",
"apiKeyName": "apiKeyName",
"usagePlanId": "usagePlanId",
"usagePlanName": "usagePlanName",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "domainCode"
}
],
"total": 0
}
}
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Response example
The following is a sample response.
{
"apiKeyRelations": {
"content": [
{
"apiId": "*****uwtk",
"apiName": "api-***",
"stageId": "*****7mhdv",
"stageName": "v1",
"apiKeyId": "*****g079",
"apiKeyName": "apiKey-***",
"usagePlanId": "*****w2111",
"usagePlanName": "usagePlan-***",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "PUB"
}
],
"total": 1
}
}
Was this article helpful?