0.0.2OAS 3.0

DocumentHub admin Api

API Base URL
  • Server 1:http://documenthub.documenthub.svc.cluster.local:4400/v2

    Konnect cluster

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

Additional Information
Contact Kong

Collections

document collections operations

List collections

Create a document collection

get
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections

Query Parameters

sortstring

Sorts a list of collections. Supported sort attributes are:

  • created_at
  • updated_at
  • name
page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter documents returned in the response.

Show Child Parameters

Response

200 application/json

The collection has been created

ListCollectionResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document collection

Show Child Parameters
get/collections
 
200 application/json