Add Storage Location Endpoints

Use the create S3 endpoints request to add a new storage location endpoint to the system. To add an export endpoint see Add Export Endpoints.

Note

This article describes the steps to add an existing S3 bucket to your system, and does not cover the steps to create an S3 bucket, see the relevant S3 documentation from Amazon here.

Endpoint

Method: POST

URL: /policy/endpoint/s3/createOrUpdate

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`userId`	String	The user ID of the user with permission to create new endpoints.	Required
`tenantId`	String	The ID of the tenant to add a storage location endpoint to.	Required
`s3EndpointDetails`	Array	A list of parameters that set the details of the storage location endpoint to add, consisting of the following parameters in this table.	Required
`endpoint`	Array	Set the system details for the endpoint, see endpoint Sub-parameters for further details.	Required
`bucket`	String	Specify the name of the bucket to connect to, required.	Required
`folder`	String	A useful reference for the Folder that the bucket is part of, optional - you may or may not use folders for your here S3 buckets, for more information, see the relevant documentation from Amazon here.	Optional
`host`	String	Set to the host address of the S3 bucket.	Required
`region`	String	Set to the Regional endpoint of the AWS instance, for example eu-west-2. For a list of valid entries see Amazon’s documentation on Regional endpoints.	Required
`accessKey`	String	Set to the Access Key ID for connecting to the S3 bucket.	Required
`secretKey`	String	Set to the Access Secret Key for connecting to the S3 bucket.	Required
`useHTTP`	Boolean	Determine if the connection to the endpoint is to use HTTP, either `true` or `false` (defaults to `false`).	Optional

For an example request, see Sample Request.

endpoint Sub-Parameters

Parameter Name	Data Type	Description	Required/Optional
`name`	String	Set the friendly name for the storage location endpoint.	Required
`description`	String	Add a useful description for the storage location endpoint.	Optional
`exportChannel`	String	Set the details for the storage location (S3) channel for the endpoint - set `channelName` to `s3` and set `exportChannelId` to `2`.	Required

Response and Error Code

Response Code	Condition
201	Created

Response Parameter

Parameter Name	Data Type	Description
`s3EndpointDetailsId`	Integer	The automatically generated ID of the newly created storage location endpoint.

For an example response, see Sample Response.

Sample Request

{
"userId":"auth0|735ujf53h235bn09835d984h",
"tenantId":"67hg8362-g3d2-7g92-9273-d9h02kr83736",
"s3EndpointDetails":{
	"endpoint":{
		"name":"ExampleS3Endpoint",
		"description":"Example Storage location",
		"exportChannel":{
			"channelName":"S3",
			"exportChannelId":2
		}
	},
	"bucket":"uniphore-staging",
	"folder":"conversations",
	"host":"s3.amazonaws.com",
	"region":"us-west-2",
    "accessKey":"AKIAIOSFODNN7EXAMPLE",
	"secretKey":"HqtjSplesHjWtujktSChR4jJl5yhEnEXAMPLEKEY",
	"useHttp":false
	}
}

Sample Response

{
    "s3EndpointDetailsId": "5305"
}

In this section:

Uniphore Customer Portal