-
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
Push API Tutorials
This section contains introductory, intermediate, and advanced Push API tutorials.
These tutorials assume that the reader knows how to make HTTP requests, and is familiar with REST interfaces and micro services in general.
- You should do these tutorials sequentially, as the outcome of one tutorial is often used as a prerequisite in the next one.
- You may want to consider using the open source Coveo Push API SDK for Python to interact with the Push API.
Articles in this section:
-
Push API Tutorial 1 - Managing Shared Content
Create a shared Push source, update its status, and manage a single item.
-
Push API Tutorial 2 - Managing Secured Content
Configure a secured Push source and its security identity provider, and perform mock content and security identity updates using single calls.
-
Push API Tutorial 3 - Using Batch Calls to Manage Complex Secured Content
Create fields, define custom mappings, and perform mock content and security identity updates using batch calls.