---
title: Push API reference
slug: '78'
canonical_url: https://docs.coveo.com/en/78/
collection: index-content
source_format: adoc
---
# Push API reference
This article provides reference material describing the Push API requests, along with the item and security identity models required for the request bodies.
## API resources
The Push API exposes the following resources:
* [Source status](#source-status)
* [Item](#item)
* [Security identity](#security-identity)
* [File container](#file-container)
### Source status
The **Source status** resource exposes a request to modify the status of a Push source.
#### "Set the status of a push source"
This request updates the source **Status** value on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/), and it creates [activity](https://docs.coveo.com/en/173/) logs.
**US East region**
[%collapsible%open]
#### [source,http,subs=attributes]
```
POST https://api.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
#### .Canada region
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target Push [source](https://docs.coveo.com/en/246/).
You can get this ID on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page.
**Example**: `mycoveoorganizationg8tp8wu3-xavb2urm6i6zagfhut2bgmsoee`
Details
The status you want to set the [source](https://docs.coveo.com/en/246/) to.
Possible values are: `IDLE`, `INCREMENTAL`, `REBUILD`, `REFRESH`.
Setting the source status to `REBUILD`, `REFRESH`, or `INCREMENTAL` creates an activity.
Setting the status to `IDLE` terminates the activity and marks it as completed.
**Example**: `IDLE`
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target Push [source](https://docs.coveo.com/en/246/).
You can get this ID on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page.
**Example**: `mycoveoorganizationg8tp8wu3-xavb2urm6i6zagfhut2bgmsoee`
Details
The unique identifier of the item.
Must be the item URI.
**Example**: `+file://folder/my-file.html+`
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
The algorithm that was used to compress the item data.
Specifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to [push item data](https://docs.coveo.com/en/73/).
The possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`.
These values are case-sensitive and the default value is `ZLib`.
**Example**: `"Uncompressed"`
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target Push [source](https://docs.coveo.com/en/246/).
You can get this ID on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page.
**Example**: `mycoveoorganizationg8tp8wu3-xavb2urm6i6zagfhut2bgmsoee`
Details
The unique identifier of the item.
Must be the item URI.
**Example**: `+file://folder/my-file.html+`
Details
Whether to delete the children of the item, that is, items whose `documentId` values start with the `documentId` of the item being deleted.
The default value is `false`.
**Example**: `true`
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target Push [source](https://docs.coveo.com/en/246/).
You can get this ID on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page.
**Example**: `mycoveoorganizationg8tp8wu3-xavb2urm6i6zagfhut2bgmsoee`
Details
The unique identifier of the file container into which the JSON definition of the content update was previously uploaded.
This `fileId` is returned in the response of the [`Create a file container`](#create-a-file-container) request.
**Example**: `d22778ca-7f42-4e13-9d9a-47d01bce866c`
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target Push [source](https://docs.coveo.com/en/246/).
You can get this ID on the [**Sources**](https://platform.cloud.coveo.com/admin/#/orgid/content/sources/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/sources/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/sources/)) page.
**Example**: `mycoveoorganizationg8tp8wu3-xavb2urm6i6zagfhut2bgmsoee`
Details
The 13-digit Push API Unix Epoch operation timestamp value that determines the items that will be deleted.
All items whose last update occurred before the specified `orderingId` will be deleted.
For reference, the last update time of an item is recorded in its `orderingId` field and may be seen in the [Content Browser properties panel](https://docs.coveo.com/en/1712/).
**Example**: `1506700606240`
Details
A grace period (in minutes) whose purpose is to give the [Coveo Platform](https://docs.coveo.com/en/186/) enough time to finish processing any previously enqueued operation that would affect the target Push source.
The default value is 15 minutes.
**Example**: `5`
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target [security identity provider](https://docs.coveo.com/en/242/).
You can get this ID on the [**Security Identities**](https://platform.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/permissions/providers/)) page.
See [Create or update a security identity provider for a secured Push source](https://docs.coveo.com/en/85/) for more information.
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target [security identity provider](https://docs.coveo.com/en/242/).
You can get this ID on the [**Security Identities**](https://platform.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/permissions/providers/)) page.
See [Create or update a security identity provider for a secured Push source](https://docs.coveo.com/en/85/) for more information.
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target [security identity provider](https://docs.coveo.com/en/242/).
You can get this ID on the [**Security Identities**](https://platform.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/permissions/providers/)) page.
See [Create or update a security identity provider for a secured Push source](https://docs.coveo.com/en/85/) for more information.
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
The object that lists the key-value pairs that uniquely identify the security identity to delete.
Details
The name of the security identity.
This name needs to be unique across the entire system.
For simple use cases, this should be an email address.
**Example**: `+"asmith@example.com+"`
Details
The type of the security identity.
Possible values are:
* `"User"`: An individual user with a specific identity, such as an email address.
* `"Group"`: A collection of users grouped together, allowing you to manage permissions for multiple users collectively.
Individual members of this group can be of any valid `identityType`.
The JSON representation of a `Group` is the following:
```text
{
"identity": {
"name": string,
"type": "Group"
},
"members": [
{
"name": string,
"type": "User"|"Group"|"VirtualGroup"|"Unknown"
}
]
}
```
* `"VirtualGroup"`: A virtual group that doesn't exist in the indexed enterprise system, used for defining granted identities.
Functionally, a `VirtualGroup` is identical to a `Group`.
* `"Unknown"`: An entity that doesn't fit into the predefined `identityType` values.
See [Security identity definition examples](https://docs.coveo.com/en/42/) for more information on the different types of security identities.
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target [security identity provider](https://docs.coveo.com/en/242/).
You can get this ID on the [**Security Identities**](https://platform.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/permissions/providers/)) page.
See [Create or update a security identity provider for a secured Push source](https://docs.coveo.com/en/85/) for more information.
Details
The unique identifier of the file container into which the JSON definition of the content update was previously uploaded.
This `fileId` is returned in the response of the [`Create a file container`](#create-a-file-container) request.
**Example**: `d22778ca-7f42-4e13-9d9a-47d01bce866c`
Details
A value indicating the order of arrival of the Push operation.
The default value is the current 13-digit timestamp ([number of milliseconds since Unix Epoch](https://currentmillis.com/)).
[WARNING]
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
The unique identifier of the target [security identity provider](https://docs.coveo.com/en/242/).
You can get this ID on the [**Security Identities**](https://platform.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/content/permissions/providers/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/content/permissions/providers/)) page.
See [Create or update a security identity provider for a secured Push source](https://docs.coveo.com/en/85/) for more information.
Details
The 13-digit Push API Unix Epoch operation timestamp value that determines the items that will be deleted.
All items whose last update occurred before the specified `orderingId` will be deleted.
For reference, the last update time of an item is recorded in its `orderingId` field and may be seen in the [Content Browser properties panel](https://docs.coveo.com/en/1712/).
**Example**: `1506700606240`
Details
A grace period (in minutes) whose purpose is to give the [Coveo Platform](https://docs.coveo.com/en/186/) enough time to finish processing any previously enqueued operation that would affect the target Push source.
The default value is 15 minutes.
**Example**: `5`
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
Details
[source,http,subs=attributes]
```
POST https://api-ca.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-eu.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
[source,http,subs=attributes]
```
POST https://api-au.cloud.coveo.com/push/v1/organizations/{organizationId}/files HTTP/1.1
Accept: application/json
Authorization: Bearer {accessToken}
```
Details
The unique identifier of the target [Coveo organization](https://docs.coveo.com/en/185/) which appears after `#/` in the URL of your [Coveo Administration Console](https://docs.coveo.com/en/183/) pages and can also be found using [other methods](https://docs.coveo.com/en/n1ce5273/).
**Example**: `mycoveoorganizationg8tp8wu3`
Details
Whether to generate the presigned URL using the [virtual hosted-style URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#virtual-hosted-style-access).
The default and recommended value is `true`.
**Example**: `true`
Details
A valid access token with the required privileges to perform the operation.
We recommend replacing `{accessToken}` with an API key [generated from the relevant Push source](https://docs.coveo.com/en/1546#api-key) because it will automatically have the required [privileges](https://docs.coveo.com/en/228/).
**Example**: `xsf7a197f1-981b-4mb5-59c9-d347267597p8`
My raw textual item data
"`
#### `compressedBinaryData` (string)
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"`
#### `compressedBinaryDataFileId` (string)
The `fileId` value returned in the response to the [`Create a file container`](#create-a-file-container) request containing the compressed binary data of the original item.
File containers are created as part of a multi-step process when [pushing large items](https://docs.coveo.com/en/69#when-pushing-a-single-item) or [batches of items](https://docs.coveo.com/en/69#when-pushing-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"`
#### `fileExtension` (string)
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)](https://docs.coveo.com/en/191/) about how to correctly process the item.
**Example**: `".html"`
#### `parentId` (string)
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](https://docs.coveo.com/en/57/) for more details.
**Example**: `"+file://folder/my-file.html+"`
#### Metadata key-value pairs
Metadata key-value pairs to populate fields in your [items](https://docs.coveo.com/en/210/).
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](https://docs.coveo.com/en/115/).
See the [Push source key characteristics table](https://docs.coveo.com/en/1546#source-key-characteristics) for further details on indexing metadata with a Push source.
See also [Manage fields](https://docs.coveo.com/en/1833/).
#### `permissions` (array)
See [Item permission models](#item-permission-models).
#### Examples
The following are examples of `DocumentBody` objects:
**Using `data` in a public item**
Details
```json
{
"author": "Alice Smith",
"date": "2017-11-08T12:18:41.666Z",
"documenttype": "Text",
"filename": "mytext.txt",
"language": [
"English"
],
"permanentid": "my93849text03985permanent93849id",
"sourcetype": "Push",
"title": "My Text",
"data": "This is a sample text written by Alice Smith.",
"fileExtension": ".txt"
}
```
Details
```json
{
"documenttype": "Image",
"filename": "myimage.png",
"height": 200,
"permanentid": "my838290image93940permanent9394id",
"sourcetype": "Push",
"width": 200,
"CompressedBinaryData": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAp80lEQVR4nOx9C5QU1bnu7tdMz3uG[...]",
"fileExtension": ".png",
"parentId": "http://www.example.com/mypost/",
"permissions": [
{
"allowAnonymous": true
}
]
}
```
Details
```json
{
"author": "Sample Group",
"documenttype": "Video",
"duration": 180.72,
"filename": "myvideo.avi",
"language": [
"English"
],
"permanentid": "my93920video8472permanent94820id",
"sourcetype": "Push",
"title": "My Video",
"compressedBinaryDataFileId": "b5e8767e-8f0d-4a89-9095-1127915c89c7",
"fileExtension": ".avi",
"permissions": [
{
"name": "MyPermissionLevel1",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User",
"securityProvider": "My Security Identity Provider"
}
]
}
]
},
{
"name": "MyPermissionLevel2",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup2",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "bjones@example.com",
"identityType": "User"
}
]
}
]
}
]
}
```
My raw textual item data
"`
##### `compressedBinaryData` (string)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > `compressedBinaryData`
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"`
##### `compressedBinaryDataFileId` (string)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > `compressedBinaryDataFileId`
The `fileId` value returned in the response to the [`Create a file container`](#create-a-file-container) request containing the compressed binary data of the original item.
File containers are created as part of a multi-step process when [pushing large items](https://docs.coveo.com/en/69#when-pushing-a-single-item) or [batches of items](https://docs.coveo.com/en/69#when-pushing-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"`
##### `fileExtension` (string)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > `fileExtension`
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)](https://docs.coveo.com/en/191/) about how to correctly process the item.
**Example**: `".html"`
##### `parentId` (string)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > `parentId`
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](https://docs.coveo.com/en/57/) for more details.
**Example**: `"+file://folder/my-file.html+"`
##### Metadata key-value pairs
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > Metadata key-value pairs
Metadata key-value pairs to populate fields in your [items](https://docs.coveo.com/en/210/).
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](https://docs.coveo.com/en/115/).
See the [Push source key characteristics table](https://docs.coveo.com/en/1546#source-key-characteristics) for further details on indexing metadata with a Push source.
See also [Manage fields](https://docs.coveo.com/en/1833/).
##### `permissions` (array)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`addOrUpdate`](#addorupdate-array) > `permissions`
See [Item permission models](#item-permission-models).
#### `delete` (array)
[`BatchDocumentBody` model](#batchdocumentbody-model) > `delete`
The array of items to delete.
Each object in the `delete` array supports the following properties:
* [`documentId`](#documentid-string-required-2) (required)
* [`deleteChildren`](#deletechildren-boolean)
##### `documentId` (string, required)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`delete`](#delete-array) > `documentId`
The unique identifier of the item, its `URI`.
**Example**: `+file://folder/my-file.html+`
##### `deleteChildren` (Boolean)
[`BatchDocumentBody` model](#batchdocumentbody-model) > [`delete`](#delete-array) > `deleteChildren`
Whether to delete the children of the target item.
Children have `documentId` values that start with the `documentId` of the parent item.
The default value is `false`.
**Example**: `true`
#### Example
The following is an example of a `BatchDocumentBody` object:
**Using `data` and the complete permission model**
Details
```json
{
"addOrUpdate": [
{
"author": "Alice Smith",
"date": "2017-11-08T12:18:41.666Z",
"documenttype": "Text",
"filename": "mytext.txt",
"language": [
"English"
],
"permanentid": "sample2156permanent165464id",
"sourcetype": "Push",
"title": "My Text",
"data": "This is a sample text written by Alice Smith.",
"documentId": "http://www.example.com/mytext.txt",
"fileExtension": ".txt",
"permissions": [
{
"allowAnonymous": true
}
]
},
{
"documenttype": "Image",
"filename": "myimage.png",
"height": 200,
"permanentid": "my56182image65132permanent5456id",
"sourcetype": "Push",
"width": 200,
"compressedBinaryData": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAp80lEQVR4nOx9C5QU1bnu7tdMz3uG[...]",
"compressionType": "UNCOMPRESSED",
"documentId": "http://www.example.com/mypost/myimage.png",
"fileExtension": ".png",
"parentId": "http://www.example.com/mypost/",
"permissions": [
{
"allowAnonymous": true
}
]
},
{
"author": "Sample Group",
"documenttype": "Video",
"duration": 180.72,
"filename": "myvideo.avi",
"language": [
"English"
],
"permanentid": "my94293video03938permanent93892id",
"sourcetype": "Push",
"title": "My Video",
"compressedBinaryDataFileId": "b5e8767e-8f0d-4a89-9095-1127915c89c7",
"compressionType": "LZMA",
"documentId": "http://www.example.com/myvideo.avi",
"fileExtension": ".avi",
"permissions": [
{
"name": "MyPermissionLevel1",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User",
"securityProvider": "My Security Identity Provider"
}
]
}
]
},
{
"name": "MyPermissionLevel2",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup2",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "bjones@example.com",
"identityType": "User"
}
]
}
]
}
]
}
],
"delete": [
{
"documentId": "http://www.example.com/mydeleteditem/",
"deleteChildren": true
}
]
}
```
Details
Details
```json
{
...
"permissions": [
{
"allowAnonymous": true
}
]
}
```
Details
```json
{
...
"permissions": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User",
"securityProvider": "My Security Identity Provider"
}
]
}
]
}
```
Details
Details
```json
{
...
"permissions": [
{
"name": "MyPermissionLevel",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleGroup",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User",
"securityProvider": "My Security Identity Provider"
}
]
}
]
}
]
}
```
**Effective permissions**:
* `SampleGroup`: This group isn't specifically denied in any of the permission level 1 permission sets, and is specifically allowed in all of those permission sets.
Users in this group can see the item in query results.
* `+asmith@example.com+`: This user is specifically denied in at least one of the permission level 1 permission sets.
The user can't see the item in query results.
Details
```json
{
...
"permissions": [
{
"name": "Permission Level 1",
"permissionSets": [
{
"allowAnonymous": true
},
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "SampleTeam1",
"identityType": "Group"
}
],
"deniedPermissions": [
{
"identity": "SampleTeam2",
"identityType": "Group"
}
]
},
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User"
},
{
"identity": "cbrown@example.com",
"identityType": "User"
}
],
"deniedPermissions": [
{
"identity": "bjones@example.com",
"identityType": "User"
}
]
}
]
},
{
"name": "Permission Level 2",
"permissionSets": [
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "bjones@example.com",
"identityType": "User"
},
{
"identity": "emitchell@example.com",
"identityType": "User"
}
],
"deniedPermissions": [
{
"identity": "asmith@example.com",
"identityType": "User"
}
]
},
{
"allowAnonymous": false,
"allowedPermissions": [
{
"identity": "MysteryUserX",
"identityType": "User"
}
]
}
]
}
]
}
```
**Effective permissions**:
* `+asmith@example.com+`: This user isn't specifically denied in any of the permission level 1 permission sets, and is specifically allowed in all of those permission sets.
The user can see the item in query results.
* `+bjones@example.com+`: This user is specifically denied in at least one of the permission level 1 permission sets.
The user can't see the item in query results.
* `+cbrown@example.com+`: This user is specifically denied in at least one of the permission level 1 permission sets.
The user can't see the item in query results.
* `+emitchell@example.com+`: This user is unknown in permission level 1.
Consequently, permission level 2 is evaluated.
The user isn't denied in any of the permission level 2 permission sets, and is specifically allowed in all of those permission sets.
The user can see the item in query results.
* An unauthenticated user: Unauthenticated users are denied in at least one of the permission level 1 permission sets.
These users can't see the item in query results.
Details
```json
{
"identity": {
"name": "msinger@abc.com",
"type": "USER",
"additionalInfo": {
"Department": "R&D"
}
}
}
```
Details
```json
{
"identity": {
"name": "SampleGroup",
"type": "GROUP",
"additionalInfo": {}
},
"members": [
{
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity",
"type": "GROUP",
"additionalInfo": {}
}
]
}
```
Details
```json
{
"identity": {
"name": "SampleGroup",
"type": "GROUP"
},
"members": [
{
"name": "asmith@example.com",
"type": "USER"
},
{
"name": "SampleVirtualGroup",
"type": "VIRTUAL_GROUP"
}
],
"wellKnowns": [
{
"name": "Domain Users",
"type": "GROUP"
}
]
}
```
Details
```json
{
"members": [
{
"identity": {
"name": "SampleGroup",
"type": "GROUP",
"additionalInfo": {}
},
"members": [
{
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity",
"type": "GROUP",
"additionalInfo": {}
}
]
}
],
"mappings": [
{
"identity": {
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
},
"mappings": [
{
"name": "alice_smith@example.com",
"type": "USER",
"provider": "Email Security Provider",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity2",
"type": "VIRTUAL_GROUP",
"additionalInfo": {}
}
]
}
],
"deleted": [
{
"identity": {
"name": "bjones@example.com",
"type": "USER",
"additionalInfo": {}
}
}
]
}
```
Details
```json
{
"identity": {
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
},
"mappings": [
{
"name": "alice_smith@example.com",
"type": "USER",
"provider": "Email Security Provider",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity2",
"type": "VIRTUAL_GROUP",
"additionalInfo": {}
}
]
}
```