Skip to main content
GET
Get the portal config

Authorizations

Authorization
string
header
required

Response

200 - application/json

OK

Blog
object
Database
object
Forms
object
HostPort
integer

Port on which the portal serves HTTP traffic

Example:

3001

JwtSigningKey
string
LicenseKey
string

License key for the portal. Provided by the Tyk's account managers

Example:

"XXX"

LogFormat
enum<string>

Log output format. The dev format is more human-friendly but takes more space, prod is a json-like format that fits in production use cases but is difficult to read

Available options:
dev,
prod
Example:

"prod"

LogLevel
enum<string>
default:info

The portal's log level. The default value is info

Available options:
debug,
info,
warn,
error,
dpanic,
panic,
fatal
Example:

"info"

PortalAPISecret
string

API secret that must be set by the admin team to use the SSO flow. SSO instructions

Example:

"portal123"

ProductDocRenderer
enum<string>
default:stoplight

Identifies which OpenAPI specification render engine the portal uses on the API Product Page

Available options:
stoplight,
redoc
Example:

"stoplight"

RefreshInterval
integer
default:10

Defines how often the portal synchronizes data with the connected API Providers. Measured in seconds

Example:

10

S3
object
Site
object
Storage
enum<string>

Defines which type of storage the portal uses for its CMS assets. More about storing the portal's assets in the documentation

Available options:
`fs`,
`db`,
`s3`
Example:

"db"

StoreSessionName
string
default:portal-store-session-name

Defines name of the cookie where the portal stores its session

Example:

"portal-store-session-name"

TLSConfig
object
Theming
object