Skip to end of banner
Go to start of banner

Proxy Endpoints

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Overview

Proxy endpoints allow users to access your APIs and third-party APIs.

You can:

Prerequisites

  • Org Admin permissions

Viewing the List of Endpoints

To view the list of endpoints for a Proxy:

  1. In SnapLogic Manager, go to API Management > API Manager.

  2. In the API Manager, go to the APIs & Proxies tab.

  3. Set Filter by Type to Proxy and click Search.

  4. Click the Proxy's name in the list.

  5. Go to the Proxy Endpoints tab.

The Proxy Endpoints tab of the proxy in the API Manager

Creating an Endpoint

To create an endpoint:

  1. In the API Manager, open a Proxy for editing, then go to the Proxy Endpoints tab.

  2. Click (blue star) to open the Create Proxy Endpoint dialog.

  3. Configure the new endpoint:

Create Proxy Endpoint dialog

Field

Description

Endpoint Name

The name for your proxy's endpoint:

  • Must be unique.

  • Must begin with alphanumeric characters A-Z, a-z, or 0-9.

  • Cannot contain the reserved keyword shared.

  • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.

  • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.

URL

The URL to which users send their requests.

Example: https://www.example.com/path/to/the/api

HTTP Method(s)

One or more REST methods for the API that this endpoint will service.

  • Get

  • Put

  • Head

  • Post

  • Patch

  • Delete

Editing an Endpoint

To edit an endpoint:

  1. In the API Manager, open a proxy for editing, then go to the Proxy Endpoints tab.

  2. Click the endpoint's name in the list.

    Details about the endpoint

    Learn more: Proxy Endpoint Details

  3. To edit the proxy details, click the Edit Details button.

    Note: You can update only the URL and HTTP Method(s) of the endpoint.

  4. To apply security policies to the endpoint, click the plus icon ( (blue star) ) below the View Applied Policies button.

Deleting an Endpoint

To delete an endpoint:

  1. In the API Manager, open a proxy for editing, then go to the Proxy Endpoints tab.

  2. Check the box for the endpoint to delete.

  3. Click the trash icon ( (blue star) ).

  • No labels