GET
/
configs
Get the portal config
curl --request GET \
  --url http://localhost:3001/portal-api/configs \
  --header 'Authorization: <api-key>'
[
  {
    "Blog": {
      "AllowFormSubmission": true,
      "Enable": true
    },
    "Database": {
      "ConnectionString": "por....db",
      "Dialect": "`sqlite3`",
      "EnableLogs": true,
      "MaxRetries": 3,
      "RetryDelay": 5000
    },
    "Forms": {
      "Enable": false
    },
    "HostPort": 3001,
    "JwtSigningKey": "<string>",
    "LicenseKey": "XXX",
    "LogFormat": "prod",
    "LogLevel": "info",
    "PortalAPISecret": "portal123",
    "ProductDocRenderer": "stoplight",
    "RefreshInterval": 10,
    "S3": {
      "ACL": "<string>",
      "AccessKey": "<string>",
      "Bucket": "<string>",
      "Endpoint": "<string>",
      "PresignURLs": true,
      "Region": "<string>",
      "SecretKey": "<string>"
    },
    "Site": {
      "Enable": true
    },
    "Storage": "`db`",
    "StoreSessionName": "portal-store-session-name",
    "TLSConfig": {
      "Certificates": [
        {
          "CertFile": "portal.crt",
          "KeyFile": "portal.key",
          "Name": "localhost"
        }
      ],
      "Enable": true,
      "InsecureSkipVerify": true,
      "MinVersion": 123,
      "MaxVersion": 123,
      "PreferServerCipherSuites": true,
      "CipherSuites": [
        "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
      ]
    },
    "Theming": {
      "Path": "./themes",
      "Theme": "default"
    }
  }
]

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