1. Curator Styles

    2. Homepage

    3. Titles and Toolbars

    4. Group Overrides

    1. Pages Overview

    2. Tiles

    3. Error Pages

    4. SSRS Embedding

    5. Explorer

    6. User Customized Metrics

    7. Box Embedding

    8. Forms

    9. Blogs

    1. Tutorials

    2. Search

    3. Managing Menus

    4. Menu Items

    5. Keywords

    6. Files

    7. Notices

    8. Loading Screens

    1. Embedded Tableau Server Views

    2. Thumbnails

    3. Tagged Workbooks

    4. Favorites

    5. Email Subscriptions

    6. Data Export

    7. Download Workbook

    8. Share Workbook

    9. Custom Views

    10. Pause/Resume Changes

    11. Dashboard Titles

    1. Filters

    2. Parameters

    3. Apply Button

    4. Filter Categories

    5. Hidden Sticky Filters/Parameters

    6. Specify Filter Sheet

    7. Mark Commenting

    8. URL Action Overrides (Link Target)

    9. Hidden Dashboards

    10. Replace Dashboard URLs

    11. Site Switcher

    12. Cache Filter/Parameter Options

    1. Data Manager Basics

    2. Web Data Connector (WDC)

    3. Import Data

    4. Connecting to Data Manager

    5. User Commenting

    6. Field Calculations

    1. Overview and Enabling

    2. Report Builder: Scheduled Reports Option

    3. Report Builder: Email Option

    4. Report Builder: Watermark Text

    1. Automatic License Provisioning

    2. Just-in-time (JIT) Provisioning

    3. Users and Groups

    4. Reset User's Password

    5. Username Mapping

    6. User Sync and Membership Sync Overview

    7. Custom Attributes

    1. Frontend User Permissions

    2. Password Change

    3. Password Reset

    4. Password Expiration and Complexity

    5. Bypass Link-preview Security

    1. E-mail Configuration

    2. System Notifications

    1. Force SSL

    2. Trusted Tickets

    3. Basic HTTP Authentication

    1. Import / Export

    2. Backend Users

    3. Frontend Users

    4. Updating License Key

    5. Linux: Cron Troubleshooting

    6. Filesystem Permissions

    7. Backend Administrator Password Reset

    8. Manual Restoration of Curator Backup

    9. Updating Curator Logging

    10. Third Party Cookies

    11. Troubleshooting Load Times

    12. Tableau API Debugging

    13. Curator Backup

    14. Taking a Manual Full Backup

    1. System Upgrade

    2. Disable Curator Upgrades

    3. Offline Upgrades (Airgapped)

    4. Dependency Updates

    5. Troubleshooting Upgrades

    1. Scripts

    2. Commands

    3. Subscription Routing

    1. Curator API Overview

    2. Integration

    3. Curator API

    4. Tableau API

    5. Content

    6. User API

    Documentation: API Docs

    Curator API

    /portal/info

    Returns all information about Curator.

    Parameters:

    boolean ini Shows PHP ini settings boolean extensions Shows loaded PHP extensions

    Returns:

    array


    Example Response:

    {
        "version": "2020.09.17-01",
        "kernal_build": 446,
        "key": "[YOUR KEY HERE]",
        "php_version": "7.2.11",
        "os": "Linux ip-XX-XX-XX-XXXus-west.compute.internal 4.14.77-86.82.amzn2.x86_64 #1 SMP Tue Dec 1 20:40:13 UTC 2018 x86_64",
        "user": "apache",
        "server_addr": "ip-XXX-XX-XX-XXX.us-west-2.compute.internal",
        "server_ips": [
            "XX.XXX.XXX.X,
            "XXX.XX.XX.XXX",
            "curatordemo.interworks.com",
            "ip-XX-XX-XX-XXX.us-west.compute.internal"
        ],
        "database": "mysql",
        "display_errors": "Off",
        "max_execution_time": "60",
        "cache": "memcached",
        "gd": true,
        "fileinfo": true,
        "zip": true,
        "zlib": true,
        "curl": true,
        "openssl": true,
        "memcached": true,
        "php_ini_path": "\/etc\/php.ini",
        "tableau_version": "2018.1",
        "php_location": "\/usr\/bin\/php",
        "is_windows": false,
        "post_max_size": "250M",
        "upload_max_filesize": "250M",
        "memory_limit": "1024M",
        "webroot": "\/var\/www\/html",
        "cron_timestamp": "2019-01-08T21:01:02+00:00",
        "writeable": true,
        "upload_max_filesize_bytes": 262144000,
        "post_max_size_bytes": 262144000,
        "memory_limit_bytes": 1073741824,
        "install_files": false,
        "cron_check": true
    }


    /portal/version

    Returns version information about the Curator portal.

    Returns:

    array


    Example Response:

    {
        "version": "2017.08.10-01"
    }


    /portal/key

    Returns key for the Curator portal.

    Returns:

    array


    Example Response:

    {
        "key": "1234-5678-9101-1112-1314"
    }


    /portal/setKey

    Sets the Curator's portal key.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/upgrade

    Upgrades Curator to the latest version.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/cron

    Runs the Curator Schedules.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/migrations

    Runs database migrations.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/clearCache

    Clears Curator cache.

    Returns:

    array

    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/phpinfo

    Returns the PHP Information Page

    Returns:

    array


    /portal/setPortalName

    Sets the Curator portal name.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/octoberUpgrade

    Upgrades the underlying OctoberCMS.

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": 0
    }


    /portal/export

    Exports Curator portal data.

    Returns:

    array

    /portal/cacheInfo

    Returns all cache information about Curator

    Parameters:

    boolean ini Shows PHP ini settings boolean extensions Shows loaded PHP extensions

    Returns:

    array


    Example Response:

    {
        "result": "Success",
        "msg": {
            "cms_cache_path": "5.7 KB",
            "cms_combiner_path": "964.04 KB",
            "twig_cache": "529.57 KB",
            "framework_cache": "1.05 MB",
            "thumbnails": "28.95 MB"
        }
    }


    /portal/setAnalyticsSettings

    Sets the analytics tracking settings.

    Returns:

    array


    /portal/setParameter

    Sets a system parameter.

    Parameters:

    Returns:

    array


    /portal/cleanSettings

    Cleans up settings data, if there are duplicates.

    Returns:

    array


    /portal/fixStoragePerms

    Attempts to fix storage file permissions, recursively.

    Returns:

    array


    /portal/checkSettings

    Check settings items.

    Returns:

    array


    /portal/downloadLog

    Exports Curator's system log data.

    Returns:

    array


    /portal/cleanUploadDir

    Cleans out old uploaded files.

    Returns:

    array


    /portal/features

    Returns information on features in use.

    Returns:

    array


    /portal/stats

    Returns stats on Curator.

    Returns:

    array


    /portal/styles

    Returns head insert and custom stylesheet from Portal Settings.

    Returns:

    array