---
schema_version: "1"
id: 21b8d85074a4f0d2dc945ea25cc684262ffbe3843034582177c6ef153de8d49f
title: Configuring a Payload Storage API
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/partner-manager/latest/setup-payload-storage-api.md
canonical_url: https://docs.mulesoft.com/partner-manager/latest/setup-payload-storage-api
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 047753f7cc42e0aeaafd51f3627aab78efed385fb0047e4c5abc00f0568ed691
description: MuleSoft Documentation Site
release: 2.x
latest: true
---
---
product: Partner Manager
version: 2.x
is-latest-version: true
---

# Configuring a Payload Storage API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Partner Manager enables you to configure your own storage solution (for example, a
database, Amazon S3, or Azure Blob Storage) to store transmission content.

To use your own storage solution, you must implement an API that provides Partner Manager with a
standardized way to connect to your storage.

> [!NOTE] If you want the payload to be available from the Partner Manager Activity page, the
> payload storage API must be publicly accessible. If your payload storage API is accessible only
> through your network, you must implement the API differently. See
> [Payload view URL](#payload-view) for more information.

## Download and Deploy the Payload Storage API

Before you create your first partner and message flow, you must configure your payload storage API
within the host organization in Partner Manager:

1.  Access and download the following APIs from Anypoint Exchange:

    - [Partner Manager Content Storage API](https://www.mulesoft.com/exchange/com.mulesoft.b2b/partner-manager-content-storage-api)

      RAML specification for the payload storage API, which includes the URI parameters and record
      ID (contentRecordId) that the API implementation’s HTTP response header must return

    - [Partner Manager Content Storage API - S3 Template](https://www.mulesoft.com/exchange/com.mulesoft.b2b/partner-manager-content-storage-service-s3)

      Sample template for creating the payload storage API using Amazon S3

2.  [Implement the API](https://docs.mulesoft.com/general/api-led-develop) to connect with your choice of storage
    location; for example, a database, Amazon S3, or filesystem.

3.  [Deploy the API](https://docs.mulesoft.com/runtime-manager/deployment-strategies) on a runtime that can access the
    storage solution.

4.  Make a note of the API URL and configuration values:

    - Host, port, and path connection

    - Connection Idle and Response timeouts

    - Authentication types:

      - None

      - API Key

      - Basic

      - Client Credentials

      - OAuth Token

    - Certificate (`.PEM` format) and connection types

      You’ll need this information when you associate Anypoint Partner Manager with your payload
      storage API. Your payload storage API must be accessible over the internet via HTTPS. Ensure
      you implement the appropriate authentication mechanisms to enable access over HTTPS.

## Add the Payload Storage API to the Host Profile

1.  In Anypoint Platform, open Anypoint Partner Manager.

2.  From the sidebar, select your organization’s host page.

3.  In the **Payload storage** section of the page, click **Edit** to add the path to your payload
    storage.

4.  Enter the following values:

    - **Endpoint name**: The name of the payload storage API

    - **Description**: The optional description for your payload storage

    - **URL**: The path to your payload storage

      This URL does the following:

      - Stores payloads when transactions process in the runtime

      - Retrieves the payload when you click **View Payload** on the **Transaction Activity** page,
        unless a payload view URL is configured

    - **Payload view URL**: (Optional) A secondary payload storage API URL that you can use to view
      the payload on the **Activity** page if the payload storage API is restricted to your internal
      network. See the Partner Manager
      [API implementation](https://anypoint.mulesoft.com/exchange/com.mulesoft.muleesb.modules/apm-payload-storage-with-ext-ui-template/minor/1.0/)
      example in Exchange for more information.

      If the payload storage API _isn’t_ restricted to your internal network, leave this field blank
      so that you can view the payload by using the **View Payload** button.

5.  Optionally, if you want to view (or allow your users to view) the raw payloads of the files you
    receive or send, select **Allow users to download payloads**.

6.  Click **Save**.

## Change the Payload Storage API Configuration

To change the payload storage API configuration:

1.  In the **Payload storage** section of the **Host** page, click **Edit**.

2.  Modify the field values that require changing.

3.  Click **Save**.

4.  To have the changes take effect, either redeploy an existing message flow or deploy a new
    message flow.

## See Also

- [Configure and Manage a Host Profile](https://docs.mulesoft.com/partner-manager/latest/configure-host)