-
Cloud V2 for Developers
- API Overview
- Basic Topics
- API PaaS Tutorials
- Building Custom Search Integrations Using Coveo Cloud PaaS
- Search API
- Usage Analytics Write API
- Usage Analytics Read API
-
Push API
- Overview
- Usage Example
- Tutorials
- Limits
- Leading Practices
- Managing Items and Permissions
- Managing Security Identities in a Security Identity Provider
- Updating the Status of a Push Source
- Resetting a Push Source
- Creating a File Container
- Understanding the orderingId Parameter
- Understanding the API Processing Delay
- Troubleshooting API Error Codes
- API Reference
- Activity API
- Authorization Server API
- Field API
- Index API
- Notification API
- Platform API
- Security Cache API
- Source API
- Customer Service API
- Source Logs API
- Indexing Pipeline Customization Tools Overview
- Indexing Pipeline Extensions
- Crawling Module
- Crawling Module (Docker Version)
- Coveo on Elasticsearch
- Coveo Cloud V2: API Reference
Push API
The Push API exposes services which allow you to 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.
There’s no graphical user interface sitting on top of the Push API, so you need to perform your own HTTP calls when you want to use its services.
You may want to consider using the open source Coveo Push API SDK for Python to interact with the Push API.
The following diagram provides a visual overview of the main interactions between custom crawlers, the Push API and a Coveo organization.
The articles in this section explain how to use the Push API.
Interactive generated reference documentation is also available through Swagger UI (see Coveo Platform API - Push API).