Settings

>>>

GET /api/v1/settings
Display all application settings.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

PUT /api/v1/settings
Update application settings.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
settings
required

Hash with new settings to be applied.

Validations:

  • Must be a Hash
override
optional

Override user settings with identical names

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/settings/activate_osiris
Activates osiris if proper key is supplied.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
key
required

License key for osiris.

Validations:

  • Must be a String
>>>

PUT /api/v1/settings/deactivate_osiris
Deactivates osiris.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

GET /api/v1/settings/metadata_properties
Get all possible metadata properties for the indexer.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.