Update Default Storage

Use the update default storage request to update your default storage. This is where your captured conversations are first saved before any storage policies move, purge, or archive them.

Warning

Configuring your default storage takes approximately one hour for the changes to take effect and for all calls to start processing in the newly configured S3 bucket. Until then, all calls will continue to be processed in the old default bucket. We recommend that the default storage configuration be performed during a maintenance window or planned downtime, when all services are temporarily stopped. Once the services are brought back online, they will immediately pick up the new configuration, and all subsequent calls will be processed in the new S3 bucket.

During downtime, no calls or policies should be processed, and all related services should remain stopped (disabling policies is not necessary). This ensures that no data or calls are lost during the transition.

If downtime is not feasible, it takes approximately one hour before calls start appearing in the new bucket. Until the propagation is complete, calls continue to flow into the old bucket.

Important

This article details how to update 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.

Your customer-side storage requires a CORS policy to ensure that the security standards set by modern browsers are met, and to enforce that any traffic coming from uniphore.com is safe. Click here for details.

Endpoint

Method: PUT

URL: /v1/media/external-storages

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`s3_storage_details`	Array	A list of parameters that set the details of the default storage to update, consisting of the following parameters in this table.	Required
`uuid`	String	The automatically generated unique identifier for the default storage that you want to update. Use the get default storage request to find the UUID for the default storage in use.	Required
`name`	String	A useful name for the default storage.	Required
`description`	String	A useful description for the default storage.	Required
`host`	String	Set to the host address of the S3 bucket.	Required
`bucket`	String	Specify the name of the bucket to connect to.	Required
`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.	Optional
`region`	String	Set to the Regional endpoint of the AWS instance, for example, `us-east-2`. For a list of valid entries, see Amazon’s documentation on Regional endpoints. Please contact Uniphore support for guidance and assistance from the professional services team before making any changes. There are customer-specific considerations to take into account when deciding which region to use for optimal performance. Changing regions may result in increased latency. For more information, see Considerations.	Required
`s3Credentials`	Array	The credentials for connecting to the S3 bucket.	Required
`accessKey`	String	Set the Access Key ID for connecting to the S3 bucket.	Required
`secretKey`	String	Set the Access Secret Key for connecting to the S3 bucket.	Required
`fallbackStorageEnabled`	Boolean	Determine if Uniphore-provided storage should be used to temporarily store audio chunks as a fallback in case this new default storage is unavailable, either `true` or `false`. If set to `true`, the system attempts to sync the media to the new default storage at intervals. If set to `false`, audio chunks are lost if your new default storage becomes unavailable.	Required

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK
500	Server Error (the UUID is invalid or can not be found)

Response Parameter

Parameter Name	Data Type	Description
`s3_storage_details`	Array	A list of newly created default storage details, consisting of the following parameters in this table.
`uuid`	String	The unique identifier for the default storage.
`name`	String	The updated name of the default storage.
`description`	String	The updated description of the default storage.
`host`	String	The updated host address of the S3 bucket.
`bucket`	String	The updated name of the bucket to connect to.
`folder`	String	A updated useful reference for the Folder that the bucket is part of, optional - you may or may not use folders for your S3 buckets. For more information, see the relevant documentation from Amazon here.
`region`	String	The updated Regional endpoint of the AWS instance, for example, `us-east-2`. For a list of valid entries, see Amazon’s documentation on Regional endpoints.
`s3Credentials`	Array	The updated credentials to use when connecting to the S3 bucket.
`accessKey`	String	The updated Access Key ID to use when connecting to the S3 bucket.
`secretKey`	String	The updated 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 Request

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

Sample Response

{
    "s3_storage_Details":{
	"uuid":"92837437-53jg-6j47-h6gs-746ydhh39u78",
        "name": "DefaultStorageNew"
        "description": "The new primary storage for captured calls Oct2025",
	"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