Use the Push API

This is for:

In this article

The Push API exposes services that let you push items and their permission models into a source, and security identities into a security identity provider, rather than letting standard Coveo crawlers pull this content.

The Push API doesn’t have a graphical user interface, so you need to perform your own HTTP calls to use its services.

The articles in this section explain how to use the Push API.

Architecture diagram

The following diagram shows the main interactions between a custom crawler, the Push API, and a Coveo organization.

To index content using the Push API, you need the following:

See the Push source creation and post-creation steps for detailed instructions.

After completing the setup covered in the prerequisites section, you can use the Push API. This involves writing code that will run periodically to:

If you haven’t used the Push API before, we recommend checking the Push API usage example or following the tutorials.
Interactive reference documentation is available through the Swagger UI.
Consider using the following to interact with the Push API, as they can simplify your implementation: