Customize Pages with CSS and JavaScript

Legacy: Tyk Classic Portal

You’re viewing documentation for the Tyk Classic Portal, which is no longer actively maintained.

If you’re looking for the latest API documentation for the new Tyk Developer Portal, please refer to the Postman collection or visit the Tyk Developer Portal section.

The Classic Portal is in maintenance mode and will be deprecated soon. For questions or support, contact us at [e-mail].

The main customization that can be done with the Tyk Dashboard is via the CSS Editor.

JS customization is also available in a programmatic way.

Step 1: Open CSS Editor

Click CSS from the Portal Management menu.

Step 2: Make CSS Amendments

In the CSS Editor, add the classes that you would like to override in the home page. For Tyk Cloud and Multi-Cloud users, this will already be filled in with some initial overrides for you:

Step 3: Make Email CSS Amendments

If you wish to customize how emails are displayed to end-users, then you can also add new classes to the Email CSS editor, these classes will be added in-line to the email that is sent out.

Once you have finished making your changes, click Update and the new CSS will be available on your site.

Updating CSS via API

Alternatively, as always, you can perform the above actions with an API call instead of through the Dashboard UI.

First, we’ll need to get the block ID of the CSS component in order to update it. This is stored in Mongo by the Dashboard. To get the block ID, we have to make a REST call to the Dashboard API.

To do so, run this curl command:

curl www.tyk-test.com:3000/api/portal/css \
-H "Authorization:{DASHBOARD_API_KEY}"

Response:

{
    "email_css": "",
    "id": "{CSS_BLOCK_ID},
    "org_id": "{ORG_ID}",
    "page_css": ".btn-success {background-color: magenta1}"
}

Now we can use the id and the org_id to update the CSS. The below curl command will update the CSS for a specific organization.

curl -X PUT http://tyk-dashboard.com/api/portal/css \
  -H "authorization:{DASHBOARD_API_KEY}" \
  -d '{
    "email_css": "",
    "id": "{CSS_BLOCK_ID},
    "org_id": "{ORG_ID}",
    "page_css": ".btn-success {background-color: magenta}"
  }' 

Updating JavaScript via API

In order to initialize the portal JS object in the database use the following request where console.log(1) should be replaced by your JS snippet:

curl -X POST www.tyk-test.com:3000/api/portal/js \
-H "Authorization:{DASHBOARD_API_KEY}" \
-d '{"page_js": "console.log(1)"}'

Request:

{
    "page_js": "console.log(1)"
}

Response:

{
    "Status": "OK",
    "Message": "609b71df21c9371dd5906ec1",
    "Meta": null
}

The endpoint will return the ID of the portal JS object, this can be used to update it.

curl www.tyk-test.com:3000/api/portal/js \
-H "Authorization:{DASHBOARD_API_KEY}" \
--data '{"page_js": "console.log(2)", "id": "609b71df21c9371dd5906ec1"}'

Request:

{
    "page_js": "console.log(2)",
    "id": "609b71df21c9371dd5906ec1"
}

Response:

{
    "page_js": "console.log(1)"
}

The JavaScript snippet that’s added through this endpoint is injected at the bottom of the portal page using a <script> tag.