Push API reference

This operation updates the source Status value on the Sources (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console and creates activity logs.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Manage the Push source for more details and usage examples.

This operation adds or updates a source item.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Add or update a single item in a Push source for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation deletes a specific item. Optionally, you can also delete the item’s children: items whose documentId values start with the documentId of the item being deleted.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Delete an item and optionally, its children in a Push source for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation pushes the content of a file container to the Coveo indexing pipeline.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Manage batches of items in a Push source for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation deletes all items whose last update orderingId value is lower than the orderingId value specified in the request query string.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Delete old items in a Push source for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation adds or updates a security identity in the specified security identity provider.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Add or update a single security identity for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation adds or updates alias and granted identity relationships for the specified security identity.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Add or update a single alias for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation disables a specific security identity in the specified security identity provider.

The request parameters are:

The request body properties are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Disable a single security identity for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation pushes the security identity update content of a file container to the security identity provider.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Manage batches of security identities for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation disables all security identities whose last update orderingId value is lower than the orderingId value specified in the request query string.

The request parameters are:

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Disable old security identities for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

This operation creates a temporary, private, and encrypted Amazon S3 file container. This operation is the first step in the three-step process of pushing large items, batches of items, or batches of security identities.

The request parameters are:

The uploadUri and requiredHeaders values are required in the second step of the three-step process to push large items, batches of items, or batches of security identities to the file container. The fileId value is required in the third step of the process to push the large item, batch of item, or batch of security identity file container content to the Coveo Platform.

Coveo provides a Swagger UI that generates real Push API calls on your Coveo organization data, allowing you to validate your requests before integrating them into your code. You can try this operation in the Swagger UI (CA | EU | AU).

See Create a file container for more details and usage examples.

For help troubleshooting this and other Push API operations, refer to the Common Push API errors and Indexing process and other issues sections.

The textual, non-binary content of the original item.

When pushing a compressed binary item, such as XML/HTML, PDF, or Word document, you should use the CompressedBinaryData or CompressedBinaryDataFileId attribute instead, depending on the content size.

Example: "<div>My raw textual item data</div>"

The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.

Use this parameter when you’re pushing a compressed binary item, such as XML/HTML, PDF, or Word document of less than 5 MB. When pushing an item whose size is 5 MB or more, use the compressedBinaryDataFileId parameter instead. When pushing less than 5 MB of textual, non-binary content, use the data parameter instead.

Example: "H4sIAAAAAAAA/0utSMwtyEkFAJ+b7G4HAAAA"

The fileId value returned by the "Create a file container" operation containing the compressed binary data of the original item. File containers are created as part of a three-step process to push large items or batches of items.

Use this parameter when you’re pushing compressed binary item data, such as XML/HTML, PDF, or Word documents of 5 MB or more. When pushing compressed binary data of less than 5 MB, use the compressedBinaryData parameter instead. When pushing less than 5 MB of textual, non-binary content, use the data parameter instead.

Example: "d22778ca-7f42-4e13-9d9a-47d01bce866c"

The file extension of the data you’re pushing, including the leading dot (.) character. This is useful when pushing a compressed item because it informs the document processing manager (DPM) about how to correctly process the item.

Example: ".html"

The documentId of the parent item.

Specifying a parentId value creates a relationship between the current item and its parent. See About the parentId property for more details.

Example: "file://folder/my-file.html"

Metadata key-value pairs to populate fields in your items. Metadata keys are case insensitive.

Each piece of metadata you add must have a value that matches the data type of the field it populates.

See the Push source key characteristics table for further details on indexing metadata with a Push source. See also Add or edit a field.

See Item permission models.

The following are examples of DocumentBody objects:

BatchDocumentBody model > addOrUpdate

The array of items to add or update.

Each object in the addOrUpdate array supports the following properties:

BatchDocumentBody model > delete

The array of items to delete.

Each object in the delete array supports the following properties:

The following is an example of a BatchDocumentBody object:

permissions > allowAnonymous

Whether the current permission set allows anonymous users to see the item in their query results.

The default value is false.

permissions > allowedPermissions

The array of security identities that should be allowed access to the item.

The allowedPermissions array objects support the following properties:

permissions > deniedPermissions

The array of security identities that should be denied access to the item.

The deniedPermissions array objects support the following properties:

The following are examples of permissions objects when using the simplified permission model:

permissions > name

The permission level name.

permissions > permissionSets

The array of permission sets in the permission level.

Each object in the array supports the following top-level properties:

The following are examples of permissions objects when using the complete permission model:

IdentityBody model > identity

The characteristics of the security identity.

The identity object supports the following properties:

IdentityBody model > members

The array of identities in a Group or VirtualGroup security identity.

Each member in the array is an object that supports the following properties:

IdentityBody model > wellKnowns

The array of granted identities that the target security identity becomes a member of.

You can consider wellKnowns as groups. Membership to an existing wellKnowns granted identity is defined through the member (typically a User security identity), not through the group.

See Defining a granted identity and Defining a user with granted identities for more information.

Each object in the array supports the following properties:

The following are examples of IdentityBody objects:

BatchIdentityBody model > members

The array of identities to add or update.

Each object in the members array implements the IdentityBody model.

BatchIdentityBody model > mappings

The array of alias and granted identity relationships to establish.

Each object in this mappings array supports the following properties:

BatchIdentityBody model > deleted

The array of security identities to disable.

Each object in the deleted array supports the identity required property.

The following is an example of a BatchIdentityBody object:

MappedIdentityBody model > identity

The target security identity to which you want to establish alias and/or granted identity relationships.

The identity object supports the following properties:

MappedIdentityBody model > mappings

The array of alias relationships for the target security identity.

This mappings array objects support the following properties:

MappedIdentityBody model > wellKnowns

The array of granted identities that the target security identity becomes a member of.

You can consider wellKnowns as groups. Membership to an existing wellKnowns granted identity is defined through the member (typically a User security identity), not through the group.

See Defining a granted identity and Defining a user with granted identities for more information.

Each object in this wellKnowns array supports the following properties:

The following is an example of a MappedIdentityBody object: