Portal APIs
Mode
Log in
Getting Started
Authentication
Automate Your Portal Management
Manage Portal
Manage Products and Content
Manage Templates
Manage Access
API Changelog
SwaggerHub Portal API v. 0.6.0-beta
Access Requests
-
PATCH
Grant/deny access request
-
GET
Get access requests
Attachments
-
GET
Get all attachments
-
POST
Upload branding attachments (images)
-
POST
Upload attachment for documentation
-
POST
Upload attachment for template documentation
-
GET
Get attachment metadata
-
GET
Get attachment contents
Consumer
-
GET
Get consumer portal
-
GET
Get consumer products view
Content :: Documents
-
GET
Get document content and metadata
-
PATCH
Update the contents of a document
Content :: Publishing
-
GET
Search published product
-
PUT
Publish content changes
-
GET
Get publishing history
-
GET
Search published portal
-
GET
Get published page
-
GET
Get published product content sections
-
GET
Get unpublished changes
Content :: Sections
-
GET
Get sections
-
GET
Retrieve a specific section.
Content :: Table of Contents
-
GET
Get table of contents
-
POST
Add table of contents entry
-
DELETE
Delete table of contents entry
-
PATCH
Patch table of contents entry
-
GET
Get removed table of contents
OpenAPI Definition
-
GET
Get OpenAPI definition
-
GET
Get OpenAPI definition
Portals
-
GET
Get portals
-
POST
Create portal
-
GET
Get portal
-
DELETE
Delete portal
-
PATCH
Patch portal
Products
-
GET
Get products
-
POST
Create product
-
GET
Get product
-
DELETE
Delete product
-
PATCH
Patch product
Templates :: Preview
-
PUT
Generate template preview
-
GET
Get template preview sections
-
GET
Get template preview page
Templates :: Save
-
PUT
Save template
-
GET
Get unsaved changes
-
GET
Get saving history
Templates :: Sections
-
GET
Get template sections
-
GET
Retrieve a specific template section.
Templates :: Table of Contents
-
DELETE
Delete template table of contents entry
-
PATCH
Patch template table of contents entry
-
GET
Get templates table of contents
-
POST
Add template table of contents entry
Templates
-
GET
Get templates
-
POST
Create template
-
GET
Get template
-
DELETE
Delete template
-
PATCH
Patch template
Schemas
-
AccessRequestPage
-
AccessRequests
-
AccessRequest
-
Status
-
UpdateAccessRequest
-
Error
-
Page
-
AttachmentId
-
AttachmentResult
-
ListAttachmentsResult
-
ConsumerProductsPage
-
ConsumerProduct
-
PatchDocument
-
Document
-
DocContentType
-
SearchResultsPage
-
NoOfElements
-
SearchResult
-
SearchSnippetPart
-
ValidationResponse
-
ValidationMessage
-
PublishedTableOfContentsItem
-
PublishedSectionsPage
-
PublishedSectionItem
-
UnpublishedChanges
-
UnresolvedCommentsList
-
UnpublishedChangeList
-
UnpublishedChangeModifiedList
-
UnresolvedComment
-
UnpublishedChange
-
UnpublishedChangeModified
-
TocChanges
-
DocumentTocItem
-
ApiTocItem
-
GraphQLTocItem
-
GraphqlComponents
-
HtmlTocItem
-
PublishingHistory
-
Operation
-
SchemaItem
-
SectionsPage
-
Section
-
TableOfContentsItem
-
MarkdownReference
-
HtmlReference
-
ApiSpecEnum
-
ApiUrl
-
ContentReference
-
PatchTableOfContents
-
TableOfContentsPage
-
CreateTableOfContentsRequest
-
TableOfContentsItemNew
-
TableOfContentsItemCopy
-
RemovedTocItem
-
TypeEnum
-
DefinitionJson
-
DefinitionYaml
-
OpenAPIRenderer
-
PageContentFormat
-
Portal
-
PortalList
-
PortalBrandingSettings
-
PortalLandingPage
-
Product
-
ProductBrandingSettings
-
ProductItemNew
-
ProductItem
-
ProductRef
-
ProductCollaborationComments
-
ProductFull
-
ProductList
-
UnsavedChanges
-
UnsavedChangeList
-
UnsavedChangeModifiedList
-
UnsavedChange
-
UnsavedChangeModified
-
SavingHistory
-
TemplateSectionsPage
-
TemplateSection
-
TemplateTableOfContentsItem
-
TemplateMarkdown
-
TemplateHtml
-
TemplateApiUrl
-
TemplateContentReference
-
TemplateTableOfContentsPage
-
PatchTemplateTableOfContents
-
CreateTemplateRequest
-
TemplateItemNew
-
TemplateItem
-
TemplateRef
-
TemplatePage
-
TemplateFull
-
TemplateBrandingSettings
-
inline_response_200
-
inline_response_201
-
portals_body
-
inline_response_201_1
-
portalsportalId_landingPage
-
portalsportalId_branding
-
portals_portalId_body
-
inline_response_201_2
-
productsproductId_branding
-
products_productId_body
-
inline_response_201_3
-
templates_templateId_body
-
AccessRequest_product
-
ConsumerProduct_accessRequest
-
SearchResult_product
-
GraphqlComponents_inner
-
TableOfContentsItem_swaggerhubApi
Routing
Open in Explore
Generate Code