Collections

Collections are top-level documentation projects (doc sites, API references, blogs) inside an organization. Use these endpoints to list, create, configure, delete/restore, import, export and bulk-publish collections; every collection has an invisible root page (rootParentId) under which its pages live.

  • List Collections — GET https://api.docstar.io/orgs/:orgId/collections
  • Get Collection — GET https://api.docstar.io/orgs/:orgId/collections/:collectionId
  • Create Collection — POST https://api.docstar.io/orgs/:orgId/collections
  • Update Collection — PUT https://api.docstar.io/orgs/:orgId/collections/:collectionId
  • Delete Collection — DELETE https://api.docstar.io/orgs/:orgId/collections/:collectionId
  • List Deleted Collections — GET https://api.docstar.io/orgs/:orgId/deletedCollections
  • Restore Collection — PUT https://api.docstar.io/orgs/:orgId/collections/:collectionId/restore
  • Bulk Publish Pages — PATCH https://api.docstar.io/orgs/:orgId/collections/:collectionId/bulkPublish
  • Import Collection — POST https://api.docstar.io/orgs/:orgId/importCollection
  • Export Collection — GET https://api.docstar.io/orgs/:orgId/collection/:collectionId/export
  • Save Run Collection Data — POST https://api.docstar.io/api/collections/:collectionId/runCollection
GET
List Collections
GET
Get Collection
POST
Create Collection
PUT
Update Collection
DELETE
Delete Collection
GET
List Deleted Collections
PUT
Restore Collection
PATCH
Bulk Publish Pages
POST
Import Collection
GET
Export Collection
POST
Save Run Collection Data
Built with DocStar