Swagger: Create Portal
swagger_create_portalCreate a new portal for your Swagger organization by providing a unique subdomain. Configure offline mode, routing, authentication, and renderer settings for API documentation.
Instructions
Create a new portal within Swagger.
Toolset: Portals
Parameters:
name (string): The display name for the portal - shown to users and in branding (3-40 characters)
subdomain (string) required: The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens. Recommended: slugified organization name plus a random 3-character suffix (e.g., 'acmecorp-k7p') to avoid collisions
offline (boolean): If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false
routing (string): Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser'
credentialsEnabled (boolean): Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true
swaggerHubOrganizationId (string) required: The corresponding Swagger organization UUID - required for portal creation. This links the portal to your Swagger organization. Only one Portal per Swagger organization is allowed.
openapiRenderer (string): OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE'
pageContentFormat (string): Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML'
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The display name for the portal - shown to users and in branding (3-40 characters) | |
| offline | No | If true, the portal will not be visible to customers - useful for development/staging environments. Defaults to false | |
| routing | No | Routing strategy for the portal - either 'browser' (client-side routing) or 'proxy' (server-side routing). Defaults to 'browser' | |
| subdomain | Yes | The portal subdomain - used in the portal URL (e.g., 'myportal' for myportal.example.com). Must be unique, lowercase, 3-20 characters, alphanumeric with hyphens. Recommended: slugified organization name plus a random 3-character suffix (e.g., 'acmecorp-k7p') to avoid collisions | |
| openapiRenderer | No | OpenAPI renderer type: 'SWAGGER_UI' (Swagger UI), 'ELEMENTS' (Stoplight Elements), or 'TOGGLE' (allows switching between both with Elements as default). Defaults to 'TOGGLE' | |
| pageContentFormat | No | Format for page content rendering - determines how documentation pages are processed: 'HTML', 'MARKDOWN', or 'BOTH'. Defaults to 'HTML' | |
| credentialsEnabled | No | Whether authentication credentials are enabled for accessing the portal. When true, users can authenticate to access private content. Defaults to true | |
| swaggerHubOrganizationId | Yes | The corresponding Swagger organization UUID - required for portal creation. This links the portal to your Swagger organization. Only one Portal per Swagger organization is allowed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | No | ||
| offline | No | ||
| routing | No | ||
| subdomain | No | ||
| customDomain | No | ||
| openapiRenderer | No | ||
| credentialsEnabled | No | ||
| swaggerHubOrganizationId | No |