Manage Portal Settings
This section describes how to configure a portal instance via its administrative APIs. The portal settings control branding, name, domain URL, and availability. These settings are categorized into general, branding, landingPage and footer.
Portal Settings Table
| Level | Setting Name | Description |
|---|---|---|
| general | name | The name of the portal instance. |
| general | subdomain | The subdomain used in your portal URL. |
| general | offline | Marks portal as offline and inaccessible to customers. |
| branding | faviconId | Reference to favicon (16x16 .ico/.gif/.png under 5MB). |
| branding | faviconDarkModeId | Reference to favicon used in the dark mode (16x16 .ico/.gif/.png under 5MB). |
| branding | logoId | Reference to logo (64x64 .jpg/.gif/.png under 5MB). |
| branding | logoDarkModeId | Reference to logo used in the dark mode (64x64 .jpg/.gif/.png under 5MB). |
| branding | fontName | Font used in portal (e.g., Roboto, Lato). |
| branding | accentColor | Hex color for branding. |
| branding | accentColorDarkMode | Hex color for dark mode branding. |
| landingPage | content | Free-form landing page content, up to 100,000 characters. |
| footer | visible | Indicates if the footer is visible to customers. |
| footer | content | Free-form footer content, up to 10,000 characters. |
Retrieve Base Portal Info
Use the GET Get portal endpoint to retrieve your current configuration.
curl --location 'https://api.portal.swaggerhub.com/v1/portals' \
--header 'Authorization: Bearer <YOUR-SWAGGER-APIKEY>'Sample Response
{
"items": [
{
"id": "a2f36ebc-7142-4cbe-b19a-9c1df41317d9",
"name": "My portal",
"subdomain": "my-portal",
"customDomain": "pet-co.custom.com",
"gtmKey": "GTM-123456",
"swaggerHubOrganizationId": "...",
"offline": false,
"createdAt": "...",
"updatedAt": "...",
"openapiRenderer": "TOGGLE",
"pageContentFormat": "BOTH",
"routing": "browser",
"credentialsEnabled": true,
"branding": {
"faviconId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"faviconDarkModeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logoDarkModeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fontName": "Inter",
"accentColor": "#097EB2",
"accentColorDarkMode": "#097EB2"
},
"landingPage": {
"content": "Welcome to our developer portal!"
},
"footer": {
"visible": true,
"content": "Welcome to our developer portal! [Terms of use](https://example.com/terms)"
}
}
]
}📝 Keep this response handy. You’ll need values like
portalIdfor image uploads and updates.
Upload Branding Images
Use the POST upload branding attachments endpoint to upload images.
curl -X POST -H "Content-Type: image/png" --data-binary "@fav.png" \
'https://api.portal.swaggerhub.com/v1/attachments/branding/<YOUR-PORTALID>?name=<IMAGE-NAME>' \
--header 'Authorization: Bearer <YOUR-SWAGGER-APIKEY>'Update Portal Settings
Use the PATCH portal endpoint to apply configuration changes.
{
"name": "<The Portal Name>",
"subdomain": "<The subdomain for the Portal>",
"offline": false,
"routing": "browser",
"credentialsEnabled": true,
"landingPage": {
"content": "Welcome to our developer portal!"
},
"branding": {
"faviconId": "<favicon ID>",
"faviconDarkModeId": "<favicon dark mode ID>",
"logoId": "<logo ID>",
"logoDarkModeId": "<logo dark mode ID>",
"fontName": "Montserrat",
"accentColor": "#63DB2A",
"accentColorDarkMode": "#097EB2"
},
"openapiRenderer": "SWAGGER_UI",
"pageContentFormat": "BOTH",
"footer": {
"visible": true,
"content": "Welcome to our developer portal! [Terms of use](https://example.com/terms)"
}
}Sample Request
curl --location --request PATCH 'https://api.portal.swaggerhub.com/v1/portals/<YOUR-PORTALID>' \
--header 'Authorization: Bearer <YOUR-SWAGGER-APIKEY>' \
--header 'Content-Type: application/json' \
--data @payload.jsonSample Portal Appearance