Help Center

Menu

Push API

The push API provides a set of API calls for managing push data sources, and for maintaining content stored within push indexes.

See also: Integrate with a push index

Accessing the push API

Access to the push 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

Push API calls

All push API calls should be made relative to the /push-api path on your search administration server URL. e.g. PUT https://searchadmin.example.com/push-api/v2/collections/{collection}/documents/content-and-metadata.