---
schema_version: "1"
id: d341a2f8968d56e79896e160ce2272d52d2aab4e04e12dfa1318722b0a2f7b13
title: HTTP and HTTPS Receive Endpoint Settings
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/partner-manager/latest/endpoint-https-receive.md
canonical_url: https://docs.mulesoft.com/partner-manager/latest/endpoint-https-receive
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 71122f0479d1c139b4f23d0727e04465fccebd0100945cc53daf5022f31efda1
description: MuleSoft Documentation Site
release: 2.x
latest: true
---
---
product: Partner Manager
version: 2.x
is-latest-version: true
---

# HTTP and HTTPS Receive Endpoint Settings

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

HTTP and HTTPS receive endpoints configure where to receive B2B messages transmitted over HTTP or
HTTPS, respectively. There are two type of HTTP and HTTPS endpoints:

- Receive from Partners

  Source endpoint in an inbound message flow that receives inbound B2B messages from partners either
  directly or via third-party connections.

  A host, partner, or third-party connection can own HTTP and HTTPS Receive from Partners endpoints.

- Source at Host

  Source endpoint in an outbound message flow that receives application messages from the backend
  applications

  Only a host can own HTTP or HTTPS Source at Host endpoints.

> [!IMPORTANT] Each HTTP and HTTPS receive endpoint configuration gets deployed as an individual
> Mule application in the runtime. To minimize the number of vCores needed to run Anypoint Partner
> Manager, use an existing HTTP or HTTPS receive endpoint configuration across multiple message
> flows.

Create HTTP and HTTPS receive endpoints by configuring these settings on the **<host>** page:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Endpoint Name</p></td><td><p>Automatically generated name used to identify the endpoint, which you can modify manually.</p></td><td><p>x</p></td></tr><tr><td><p>Owner</p></td><td><div><div><p>Host, partner, or third-party connection that owns the endpoint.</p></div></div></td><td><p>x</p></td></tr><tr><td><p>Usage</p></td><td><p>Endpoint function (<code>Receive from partners</code> or <code>Source at host</code>).</p></td><td><p>x</p></td></tr><tr><td><p>Protocol</p></td><td><p>Protocol that the endpoint supports (<code>HTTP</code> or <code>HTTPS</code>).</p></td><td><p>x</p></td></tr><tr><td><p>Description</p></td><td><p>User-supplied value that describes the purpose of the endpoint.</p></td><td></td></tr><tr><td><p>Private port (when deploying to VPC)</p></td><td><div><div><p>Applies when using Anypoint Virtual Private Cloud (Anypoint VPC) with CloudHub deployments:</p></div><div><ul><li><p>When enabled, the AS2 receive endpoint application deploys to the private port <code>8092</code> in your <a href="https://docs.mulesoft.com/cloudhub/virtual-private-cloud">Anypoint VPC</a>. You can manage the access control to the endpoint via the Anypoint VPC and dedicated load balancer settings.</p></li><li><p>When disabled, the AS2 receive endpoint application deploys to the public port <code>8082</code> by default.</p><div><p>You can access the endpoint URL directly over the internet.</p></div></li></ul></div></div></td><td></td></tr><tr><td><p>Manage with API Manager</p></td><td><div><div><p>Enable this setting to manage the endpoint, including its access control, with API Manager. When you manage an endpoint with API Manager, you can apply various policies, including authentication and client credentials, and you can configure SLA tiers for the endpoint. You can also leverage Anypoint Exchange to document your message specifications and share them with your partners via public portals by leveraging Anypoint API Experience Hub. (This requires an additional license.)</p></div><div><p>To have an endpoint managed with API Manager, create an HTTP API in API Manager in the same environment and organization as the endpoint.</p></div><div><p>When you create this API in API Manager:</p></div><div><ul><li><p>Select <code>HTTP API</code> as the asset type.</p></li><li><p>Leave the defaults on the <strong>Endpoint configuration</strong> screen.</p></li><li><p>Copy the API instance ID and paste it into the <strong>API Auto discovery id</strong> field in the Partner Manager <strong>New endpoint: Receive from Partners</strong> window.</p></li></ul></div><div><div data-type="NOTE">Using this feature requires an API Manager license.</div></div></div></td><td></td></tr><tr><td><p>URL</p></td><td><div><div><p>HTTP or HTTPS address where you receive outbound source messages from backend applications or inbound B2B messages from your partners. Partner Manager automatically generates this ID after the first message flow that uses the endpoint is deployed.</p></div></div></td><td><p>x</p></td></tr><tr><td><p>Preserve Public URL of Ingress application</p></td><td><div><div><p>Applies to CloudHub 2.0 inbound endpoint deployments.</p></div><div><p>When enabled, Partner Manager preserves the user-defined public URL for the ingress application across endpoint or message flow redeployments.</p></div><div><p>When disabled, Partner Manager can regenerate the public ingress URL during redeployment.</p></div></div></td><td><p>No</p></td></tr><tr><td><p>Response timeout (in milliseconds)</p></td><td><p>Response timeout period in milliseconds. The default is <code>15000</code>.</p></td><td><p>x</p></td></tr><tr><td><p>App Name Substitution Type</p></td><td><div><div><p>Defines how the ingress URL template <code>app-name</code> is substituted for this AS2 endpoint to generate the Runtime Fabric public endpoint.</p></div><div><ul><li><p>Select Default to use <code>app-name</code> as deployment-name.</p></li><li><p>Select Custom to provide a custom name for the <code>app-name</code> substitution.</p></li><li><p>Select BasePath to use the editable AS2 base path as the value for the <code>app-name</code> substitution.</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p>Authentication type</p></td><td><div><div><p>Authentication method used to protect the HTTP or HTTPS endpoint. This field is disabled when you manage the endpoint with API Manager.</p></div><div><p>Valid values are:</p></div><div><ul><li><p>None</p><div><p>No authentication</p></div></li><li><p><a href="#api-key">API key</a></p></li><li><p><a href="#basic">Basic</a></p></li></ul></div></div></td><td><p>x</p></td></tr></tbody></table>

> [!NOTE]
>
> - When deploying to Anypoint Runtime Fabric, Partner Manager deploys the HTTP or HTTPS receive
>   endpoint as an HTTP listener.
>
>   - You must configure an Ingress controller to provide external consumers with an HTTPS endpoint.
>     For more information, see
>     [Configuring Ingress for Runtime Fabric](https://docs.mulesoft.com/runtime-fabric/latest/custom-ingress-configuration).
>
> - When deploying to CloudHub 2.0, Partner Manager deploys the HTTP or HTTPS Receive endpoint as an
>   HTTPS listener.
>
>   - When using a shared space as a deployment target, HTTP requests aren’t allowed.
>
>   - To keep a user-defined public ingress URL stable across redeployments, select **Preserve
>     Public URL of Ingress application** in the endpoint settings.
>
>   - If you want to allow HTTP requests to the HTTP or HTTPS receive endpoint application:
>
>     1.  Use a private space as the deployment target.
>
>     2.  On the **Advanced** tab, select `Accept HTTP` in the **HTTP requests** field.
>
>     3.  Optionally, configure Network-Level Ingress Rules to allow HTTP requests from specific IP
>         addresses.

## API Key Authentication

Authentication type that requires a valid API key in the HTTP request header.

Use the following settings to configure API Key authentication:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>HTTP Header Name</p></td><td><p>HTTP header parameter associated with the API key value.</p></td><td><p>x</p></td></tr><tr><td><p>API Key</p></td><td><p>Value of the API key.</p><p>After saving your new or reconfigured endpoint, you cannot subsequently retrieve or modify the API key.</p></td><td><p>x</p></td></tr><tr><td><p>Certificate</p></td><td><p>Certificate to use for authentication.</p></td><td></td></tr></tbody></table>

### Basic Authentication

Authentication type that requires a username and password in the HTTP or HTTP request header.

Use the following settings to configure Basic authentication:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p>Username</p></td><td><p>Username to use when making a request.</p></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><p>Password to use when making a request.</p></td><td><p>x</p></td></tr></tbody></table>

## Next Step

After you create an HTTP or HTTPS receive endpoint, you can deploy it, as described in
[Deploying AS2, HTTP, and HTTPS Receive Endpoints](https://docs.mulesoft.com/partner-manager/latest/deploying-receive-endpoints).

## See Also

- [Endpoints](https://docs.mulesoft.com/partner-manager/latest/endpoints)

- [Creating Endpoints](https://docs.mulesoft.com/partner-manager/latest/create-endpoint)

- [Managing Partner and Third-Party Connection Certificates](https://docs.mulesoft.com/partner-manager/latest/manage-partner-certificates)