Portal

/portal/info

Returns all information about the portal.

Example Response:

{
    "version": "2019.01.03-01",
    "kernal_build": 446,
    "key": "11RS-K66D-VXSS-G6CN-YAC4-CEEQ-JN32-XYZE",
    "php_version": "7.2.11",
    "os": "Linux ip-172-31-39-174.us-west-2.compute.internal 4.14.77-86.82.amzn2.x86_64 #1 SMP Mon Dec 3 19:40:13 UTC 2018 x86_64",
    "user": "apache",
    "server_addr": "ip-172-31-39-174.us-west-2.compute.internal",
    "server_ips": [
        "35.166.102.2",
        "172.31.39.174",
        "portaldemo.interworks.com",
        "ip-172-31-39-174.us-west-2.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 portal.

Example Response:

{
    "version": "2017.08.10-01"
}

/portal/key

Returns version information about the portal.

Example Response:

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

/portal/setKey

Sets the portal key.

Example Response:

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

/portal/upgrade

Upgrades the portal to the latest version.

Example Response:

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

/portal/cron

Runs the Portal Schedules.

Example Response:

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

/portal/migrations

Runs database migrations.

Example Response:

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

/portal/clearCache

Clears portal cache.

Example Response:

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

/portal/phpinfo

Returns the PHP Information Page

/portal/setPortalName

Sets the portal name.

Example Response:

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

/portal/octoberUpgrade

Upgrades the underlying OctoberCMS.

Example Response:

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

/portal/export

Exports portal data.

/portal/cacheInfo

Returns all information about the portal.

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.

/portal/setParameter

Sets a system parameter.

/portal/cleanSettings

Cleans up settings data, if there are duplicates.

/portal/fixStoragePerms

Attempts to fix storage file permissions, recursively.

/portal/checkSettings

Check settings items.

/portal/downloadLog

Exports portal data.

/portal/cleanUploadDir

Cleans out old uploaded files.