Creating a File Container

A file container is a temporary, private, and encrypted Amazon S3 data structure you can use to safely upload content you intend to push into a Push source or security identity provider. You will typically use a file container when you want to push:

Use the Create a file container operation to create an Amazon S3 file container for a specific Coveo Cloud organization:

Request template

POST https://push.cloud.coveo.com/v1/organizations/<MyOrganizationId>/files HTTP/1.1
 
Content-Type: application/json
Accept: application/json
Authorization: Bearer <MyAccessToken>

Payload

{}

In the request path:

In the Authorization HTTP header:

The body of a successful response contains important information about the temporary, private and encrypted Amazon S3 file container you just created:

  • The uploadUri property contains a pre-signed URI where you can send a PUT request whose binary content must be your request body or item data.

    The Amazon S3 file container applies AES-256 server side encryption to your data (see Advanced Encryption Standard).

    Moreover, the file container is automatically deleted as soon as its content has been successfully forwarded to the service. Anyhow, the uploadUri automatically expires after 60 minutes.

    It is therefore perfectly safe to upload sensitive information into the Amazon S3 file container.

  • The fileId property contains the unique identifier of your file container.
  • The requiredHeaders property contains the HTTP headers which are required when sending a PUT request to the uploadUri.

Sample Request

Creating a file container for a specific Coveo Cloud organization

POST https://push.cloud.coveo.com/v1/organizations/mycoveocloudv2organizationg8tp8wu3/files HTTP/1.1
Content-Type: application/json
 
Accept: application/json
Authorization: Bearer **********-****-****-****-************

Payload

{}

Successful response - 201 Created

{
  "uploadUri": "https://s3.amazonaws.com/coveo-nprod-customerdata/proda/blobstore/mycoveocloudv2organizationg8tp8wu3/b5e8767e-8f0d-4a89-9095-1127915c89c7[...]",
  "fileId": "b5e8767e-8f0d-4a89-9095-1127915c89c7",
  "requiredHeaders": {
    "x-amz-server-side-encryption": "AES256",
    "Content-Type": "application/octet-stream"
  }
}