Remote Management

• Control Panel
• HTTP API

Control Panel

The Control Panel is a web-based administrative interface with monitoring and configuration capabilities. To enable it, set endpoint.admin.enabled to true and set a username and secret in the endpoint.admin.* keys. Then, navigate to /admin in a web browser.

Changes made in the Control Panel will instantly update the application's configuration, although some changes will require a restart to take effect. They will also be written to the configuration file within a few seconds.

HTTP API

The HTTP API is disabled by default, but can be enabled by setting the endpoint.api.enabled configuration option to true.

Some API methods require HTTP Basic authentication. Credentials are set in endpoint.api.username and endpoint.api.secret.

Invoking a POST /tasks request creates an asynchronous task identified by a UUID and submits it to a processing queue. Its status can be checked via GET /tasks/:uuid. Tasks are retained in memory, but are not persisted, so checking a task after a restart will result in a 404 Not Found response.

Status

• Check the application status
• Check the application health

Check the application status since 4.1

Check the application health since 4.1

Configuration

• Retrieve the configuration
• Update the configuration

Retrieve the configuration since 3.3

Update the configuration since 3.3

{
  "config_key_1" : "some value",
  "config_key_2" : "some value",
  "config_key_3" : "some value"
}

Caching

• Purge invalid/expired content from all caches
• Purge all content relating to an individual source image from all caches
• Purge all content from all caches
• Purge the delegate method invocation cache
• Purge the info cache

Purge invalid/expired content from all caches since 3.4

{
  "verb" : "PurgeInvalidFromCache"
}

Purge all content relating to an individual source image from all caches since 3.4

{
  "verb" : "PurgeItemFromCache",
  "identifier" : "MyIdentifier"
}

Purge all content from all caches since 3.4

{
  "verb" : "PurgeCache"
}

Purge the delegate method invocation cache since 3.4

{
  "verb" : "PurgeDelegateMethodInvocationCache"
}

Purge the info cache since 3.4

{
  "verb" : "PurgeInfoCache"
}