Getting Started
The SwaggerHub Portal API allows you to manage your SwaggerHub Portal instance, a comprehensive platform for showcasing and managing APIs. Whether you're a team or a company, this guide will help you get started and understand the business value of the API.
Note: These APIs enable direct configuration and content management of a SwaggerHub Portal instance.
Why the SwaggerHub Portal API is Valuable
- Effortless API Productization: Create a centralized platform for developers and consumers to explore, understand, and consume your APIs with rich documentation, tutorials, and guides.
- Superior Developer Experience: Provide a best-in-class developer experience through interactive documentation, SDKs, and tools that accelerate API adoption.
Prerequisites
- A SaaS Enterprise plan with SwaggerHub (you can request a trial at try.smartbear.com).
- A designer or owner role in your SwaggerHub organization.
- SwaggerHub Portal must be enabled for your organization.
Management Resources and Capabilities
The SwaggerHub Portal API provides management access to the following resources:
| Resource | Description | Permissions |
|---|---|---|
| Portals | Manage portal instances including branding, domain, and availability via general, branding, and landingPage settings. | Read, Modify, Delete |
| Attachments | Upload and manage image files and Markdown content used across portal settings and products. | Create, Modify, Delete |
| Documents | Store and update Markdown or attachment content. | Read, Modify, Delete |
| Sections | Organize APIs and docs into table-of-contents sections. | Create, Modify, Delete |
| Products | Create bundled offerings of API reference docs and docs with product metadata. | Create, Modify, Delete |
Base Info
Base URL Endpoint: https://api.portal.swaggerhub.com/v1
Authentication
See the authentication guide for details on using API keys.