Help Center

Menu

Server configuration API

The server configuration API provides a set of API calls for managing server configuration keys.

This API can only be accessed by a server administrator.

Accessing the server configuration API

Access to the server configuration API requires a valid API token or administration login.

In the DXP token-based access must use the username and password that is provided by a v2 token.

The APi can be used interactively using the API UI, which can be accessed from the administration dashboard (system) menu.

See: API authentication using an API token

Server configuration API calls

All APIs open in full page width to accommodate schema expansion and exploration.
Click Funnelback APIs to return to the full list of APIs offered in Squiz Search.

All server configuration API calls should be made relative to the /admin-api path on your search administration server URL. e.g. GET https://searchadmin.example.com/admin-api/config/v2/server/keys/urls.search_port/value.