System

Routes focused on meta-information for the Gofer service

MethodEndpoint
GET/api/system
PATCH/api/system
GET/api/system/metadata

Get system parameters

GET/api/system

Responses

StatusBodyDescription
200GetSystemPreferencesResponsesuccessful operation
4XXErrorError
5XXErrorError

Update system parameters

PATCH/api/system

Request body (required): UpdateSystemPreferencesRequest

Responses

StatusBodyDescription
200UpdateSystemPreferencesResponsesuccessful operation
4XXErrorError
5XXErrorError

Describe current system meta-information

GET/api/system/metadata

Return a number of internal metadata about the Gofer service itself.

Responses

StatusBodyDescription
200GetSystemMetadataResponsesuccessful operation
4XXErrorError
5XXErrorError