Galia Guide 1.0

HTTP API

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

All 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. Task records are retained in memory, but are not persisted, nor shared with any other clustered application instances.

Status

Check application status

Request Method GET
URI /status
Expected Response Status 200 OK
Expected Response Content Type application/json

Tasks

Show a task

Request Method GET
URI /tasks/:uuid
Expected Response Status 200 OK
Expected Response Content Type application/json

Configuration

Retrieve the configuration

Request Method GET
URI /configuration
Expected Response Status 200 OK
Expected Response Content Type application/json

Update the configuration

Request Method PUT
URI /configuration
Request Content Type application/json
Request Body Contains the configuration keys to change: 
{
  "config_key_1" : "some value",
  "config_key_2" : "some value",
  "config_key_3" : "some value"
}
Expected Response 200 OK
Notes The in-memory configuration will be updated instantly, but not all key changes will have an effect on a running application instance—particularly ones that configure components that can't be restarted. In order to make these changes permanent, they must be made in the source configuration.

Caching

Evict all content relating to an individual source image from all caches

Request Method POST
URI /tasks
Request Content Type application/json
Request Body 
{
  "verb" : "EvictItemFromCache",
  "identifier" : "MyIdentifier"
}
Expected Response 202 Accepted with task URI in Location header

Evict all infos from the info caches

Request Method POST
URI /tasks
Request Content Type application/json
Request Body 
{
  "verb" : "EvictInfosFromCache"
}
Expected Response 202 Accepted with task URI in Location header

Evict invalid/expired content from all caches

Request Method POST
URI /tasks
Request Content Type application/json
Request Body 
{
  "verb" : "EvictInvalidFromCache"
}
Expected Response 202 Accepted with task URI in Location header

Purge all content from all caches

Request Method POST
URI /tasks
Request Content Type application/json
Request Body 
{
  "verb" : "PurgeCache"
}
Expected Response 202 Accepted with task URI in Location header