Portal Products (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

N/A (this description is removed during bundling)

products

The API for Konnect Portal Products.

Get a product

Gets the details for an existing published product.

Authorizations:

portalAccessTokenNone

path Parameters

productId

required

string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"name": "Billing",
"description": "API for billing functions",
"document_count": 3,
"version_count": 2,
"latest_version": {"name": "v2.0.0",
"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
},
"public_labels": {"category": "finance"
}
}

List Products

Returns a paginated list of published API Products.

Authorizations:

portalAccessTokenNone

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=good service Filter by contains comparison of the name property with a supplied substring
filter[description][eq]	string Example: filter[description][eq]=portal Filter by direct equality comparison of the description property with a supplied value.
filter[description]	string Example: filter[description]=portal Filter by direct equality comparison (short-hand) of the description property with a supplied value.
filter[description][contains]	string Example: filter[description][contains]=portal Filter by contains comparison of the description property with a supplied substring
filter[id][eq]	string Example: filter[id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by direct equality comparison of the id property with a supplied value.
filter[id]	string Example: filter[id]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by direct equality comparison (short-hand) of the id property with a supplied value.

Responses

Response samples

200
400
401

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"name": "Billing",
"description": "API for billing functions",
"document_count": 3,
"version_count": 2,
"latest_version": {"name": "v2.0.0",
"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
},
"public_labels": {"category": "finance"
}
}
]
}

Get Product Actions

Get a list of actions that the current developer is allowed to perform on an API product.

path Parameters

productId

required

string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

200
401
404
503

Content type

application/json

{"actions": {"register": false,
"view": true,
"view_documentation": true
}
}

versions

The API for Konnect Portal Product Versions.

Get page of product versions

Returns paginated list of versions of a given product.

Authorizations:

portalAccessTokenNone

path Parameters

productId

required

string <uuid>

Contains a unique identifier used by the Portal API for this resource.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=good service Filter by contains comparison of the name property with a supplied substring

Responses

Response samples

200
400
401
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"name": "v2.0.0",
"deprecated": true,
"registration_configs": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"auth_methods": ["bearer"
],
"credential_type": "client_credentials",
"name": "string",
"available_scopes": ["scope1",
"scope2"
],
"registration_enabled": true,
"registration_auto_approve": false
}
]
}
]
}

Get product version

Gets the details for an existing product version.

Authorizations:

portalAccessTokenNone

path Parameters

productId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.
productVersionId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"name": "v2.0.0",
"deprecated": true,
"registration_configs": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"auth_methods": ["bearer"
],
"credential_type": "client_credentials",
"name": "string",
"available_scopes": ["scope1",
"scope2"
],
"registration_enabled": true,
"registration_auto_approve": false
}
]
}

Get applications by product version

Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked). Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

Authorizations:

portalAccessToken

path Parameters

productId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.
productVersionId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=good service Filter by contains comparison of the name property with a supplied substring
filter[status][eq]	string Enum: "approved" "pending" "rejected" "revoked" Example: filter[status][eq]=approved Filter by direct equality comparison of the status property with a supplied value.
filter[status]	string Enum: "approved" "pending" "rejected" "revoked" Example: filter[status]=approved Filter by direct equality comparison (short-hand) of the status property with a supplied value.
filter[auth_strategy_id][eq]	string Example: filter[auth_strategy_id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by the id of the auth strategy supported by the application.
filter[auth_strategy_id]	string Example: filter[auth_strategy_id]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by the id of the auth strategy supported by the application (short-hand).
unregistered	boolean Return applications that do not have a registration for the product version (regardless of registration status).

Responses

Response samples

200
400
401
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"registration_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"registration_status": "approved",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["string"
]
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Get spec for product version

Returns the API specification document attached to given product version. Currently only OpenAPI is supported.

Authorizations:

portalAccessTokenNone

path Parameters

productId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.
productVersionId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

200
400
401
404

Content type

application/json

{"api_type": "openapi",
"content": "string"
}

Get operations in version spec

Returns list of operations used in the API specification document attached to given product version.

Authorizations:

portalAccessTokenNone

path Parameters

productId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.
productVersionId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

200
400
401
404

Content type

application/json

{"api_type": "openapi",
"operations": [{"path": "/pet",
"method": "post",
"operation_id": "addPet",
"tags": ["pet"
],
"summary": "Add a new Pet to the store",
"deprecated": true
}
]
}

documentation

The API for Konnect Portal API Documentation.

List product documents

Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).

Authorizations:

portalAccessTokenNone

path Parameters

productId

required

string <uuid>

Contains a unique identifier used by the Portal API for this resource.

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

header Parameters

Accept

string (DocumentContentTypeEnum)

Default: application/json

Enum: "application/json" "application/vnd.konnect.document-tree+json"

Responses

Response samples

200
400
401
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
"parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
"slug": "getting-started",
"title": "Getting Started",
"metadata": {"owner": "John Appleseed"
},
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Get one product document

Returns the specified document from the product's document tree.

Authorizations:

portalAccessTokenNone

path Parameters

productId required	string <uuid> Contains a unique identifier used by the Portal API for this resource.
documentId required	string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a ID of the document.

header Parameters

Accept

string (DocumentFormatContentTypeEnum)

Default: application/json

Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "string",
"parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
"slug": "getting-started",
"content": "# My Kong api\n\nThis api is powered by Konnect\n",
"title": "Hello World"
}