Get the Details for Storage Location Endpoints

Use the get details for storage location endpoints request to get a list of storage location endpoints along with their details.

Endpoint

Method: POST

URL: /policy/endpoint/s3/details

Request Parameter

There is a request body but there is no need to input data into this request, for an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

Parameter Name	Data Type	Description
`endpointDetails`	Array	A list of storage location endpoints configured in the system consisting of the following parameters.
`id`	Integer	The automatically generated ID for the storage location endpoint.
`endpoint`	Array	Basic details for the storage location endpoint, consisting of `name`, `exportChannel`, and `description`.
`name`	String	The friendly name for the storage location endpoint.
`exportChannel`	Array	Details on the export channel used for the storage location endpoint, consisting of `exportChannelId` (an ID of the export channel), and `channelName` (the type of export channel). At the time of writing, for storage locations the channel ID will be `2` and type will be `S3`.
`description`	String	A useful description of the endpoint.
`host`	String	The host address of the S3 bucket.
`bucket`	String	The name of the bucket that the endpoint connects to.
`folder`	String	A useful reference for the Folder that the bucket is part of if applicable- you may or may not use folders for your S3 buckets, for more information, see the relevant documentation from Amazon here.
`region`	String	The Regional endpoint of the AWS instance that the endpoint connects to, for example `eu-west-2`. For a list of valid entries see Amazon’s documentation on Regional endpoints.
`accessKey`	String	The Access Key ID for connecting to the S3 bucket.
`secretKey`	String	The Access Secret Key for connecting to the S3 bucket.
`useHTTP`	Boolean	If the connection to the endpoint uses HTTP, either `true` or `false` (defaults to `false`), if false the parameter will not show in the response.

For an example response, see Sample Response.

Sample Request

{
    "s3EndpointDetailsIds": []
}

Sample Response

{
    "s3EndpointDetails": [
        {
            "id": "3954",
            "endpoint": {
                "name": "ConversationMedia",
                "exportChannel": {
                    "exportChannelId": "2",
                    "channelName": "S3"
                },
                "description": "External Media Storage"
            },
            "host": "s3.amazonaws.com",
            "bucket": "uniphore-staging",
            "folder": "conversations",
            "region": "us-west-2",
            "accessKey": "AKIAIOSFODNN7EXAMPLE",
            "secr etKey": "HqtjSplesHjWtujktSChR4jJl5yhEnEXAMPLEKEY"
        },
        {
            "id": "3955",
            "endpoint": {
                "name": "ConversationMetadataArchive",
                "exportChannel": {
                    "exportChannelId": "2",
                    "channelName": "S3"
                },
                "description": "Archived Metadata Cold Storage"
            },
            "host": "s3.amazonaws.com",
            "bucket": "uniphore-staging",
            "folder": "conversations",
            "region": "us-west-2",
            "accessKey": "AKIAIOSFODNN7EXAMPLE",
            "secretKey": "HqtjSplesHjWtujktSChR4jJl5yhEnEXAMPLEKEY"
        }
    ]
}

In this section:

Uniphore Customer Portal