Get Default Storage

Use the get default storage request to fetch details on your default storage.

Important

This article details how to get the details of your configured customer-side default storage, and not the details for the Uniphore-provided default storage, which is not editable by customers.

Endpoint

Method: GET

URL: /v1/media/external-storages

Response and Error Code

Response Code	Condition
200	OK

Response Parameter

Parameter Name	Data Type	Description
`s3_storage_details`	Array	The details of the configured customer-side default storage include the following parameters in this table.
`uuid`	String	The automatically generated unique identifier for the default storage.
`name`	String	The name of the default storage.
`description`	String	The description of the default storage.
`host`	String	The host address of the S3 bucket.
`bucket`	String	The name of the bucket to connect to.
`folder`	String	A useful reference for the Folder that the bucket is part of; however, you might 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, for example, `us-west-2`. For a list of valid entries, see Amazon’s documentation on Regional endpoints.
`s3Credentials`	Array	The credentials that are used to connect to the S3 bucket.
`accessKey`	String	The Access Key ID to use when connecting to the S3 bucket.
`secretKey`	String	The Access Secret Key to use when connecting to the S3 bucket.
`fallbackStorageEnabled`	Boolean	If Uniphore-provided storage should be used to temporarily store audio chunks as a fallback in case this storage is unavailable, either `true` or `false`.

For an example response, see Sample Response.

Sample Response

{
    "s3_storage_Details":{
	"uuid": "92837437-53jg-6j47-h6gs-746ydhh39u78",
        "name": "DefaultStorage"
        "description": "The primary storage for captured calls",
	"host": "s3.amazonaws.com",
	"bucket": "uniphore-storage",
	"folder": "conversations",
	"region": "us-east-2",
        "s3Credentials": {
            "accessKey": "LKJHIOSFODNN7EXAMPLE",
            "secretKey": "TrfgSplesHjWtujktSChR4jJl5yhEnEXAMPLEKEY",
	},
        "fallbackStorageEnabled": true
    }
}

In this section:

Uniphore Help Center Portal