View product list
- Print
- PDF
View product list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View the list of products in all accounts that meet the user-defined conditions.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /published-products/search |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request syntax
The request syntax is as follows.
{
"subscribed" : true,
"publisherId" : "publisherId",
"offset" : 6,
"limit" : 0,
"productName" : "productName",
"productType" : [ "MY" ]
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
subscribed | Boolean | Optional | Subscription status of the published product
|
publisherId | String | Optional | Tenant ID of the published API |
offset | Long | Optional | Starting point of the response data
|
limit | Long | Optional | Maximum number of response data
|
productName | String | Optional | Product name
|
productType | Array | Optional | Product type
|
Request example
The following is a sample request.
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/published-products/search' \
--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 '{
"offset" : 6,
"limit" : 1,
"productName" : "product"
}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"initialCount" : 0,
"productPage" : {
"total" : 6,
"content" : [ {
"subscriptionCode" : "PROTECTED",
"subscribed" : true,
"domainCode" : "domainCode",
"productId" : "productId",
"tenantId" : "tenantId",
"productDescription" : "productDescription",
"productName" : "productName",
"zoneCode" : "PUBLIC"
} ]
}
}
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.
{
"productPage": {
"content": [
{
"productId": "***pxks***",
"tenantId": "***3f2489612436793577e878e69e***",
"productName": "product2",
"productDescription": "Unit for grouping and managing multiple APIs",
"subscribed": false,
"subscriptionCode": "PUBLIC",
"domainCode": "PUB",
"zoneCode": "PUBLIC"
}
],
"total": 28
},
"initialCount": 780
}
Was this article helpful?