Versions Compared

Old Version 16

changes.mady.by.user John Brinckwirth

Saved on

compared with

New Version 17

changes.mady.by.user John Brinckwirth

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

SnapLogic's Proxies feature allows you to seamlessly integrate with your APIs and third-party APIs by providing API administration, monitoring, and security management in the API Manager.

You can:

Prerequisites

  • Org Admin permissions

Table of Contents
minLevel1
maxLevel2

Anchor
view-proxy-list
view-proxy-list
Viewing the List of Proxies

To view the list of Proxies:

  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.

The APIs and Proxies tab of the API Manager

Anchor
create-proxy
create-proxy
Creating a Proxy

Info

Proxies support referencing OAS 2.0 and 3.0 API specifications. You can define the metadata for the proxy or overwrite the data from the specification. Proxies support referencing OAS 2.0 and 3.0 JSON and YAML API specifications. You can assign policies and other routing/mapping conditions to the proxy endpoints imported from the specification.

To create a proxy:

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

  2. Click the plus icon ( (blue star) ).Select , and select New Proxy from the dropdown.

  3. In Create proxy dialog, choose the source of the OAS 2.0 or 3.0 file.

    Image Added

    • Upload File. Click Choose File to specify the location of the specification file to upload.

    • Enter URL. Enter a valid URL pointing to the location of the specification file.

    • Create empty proxy: Do not reference a specification during proxy creation.

  4. Click Continue.

    Image Added

  5. Configure the new proxy.

Create Proxy dialogImage Removed

  1. , then click Create and exit.

Field

Description

Proxy Name

The name for your Proxy.

  • 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.

The Proxy name is appended to the Hostname.

Proxy Description

(Optional) Information about the Proxy.

Hostname

The prefix /gateway/ is concatenated with the Proxy Name.

Tags

(Optional) Tags you can use to organize your proxies.

Tip

To associate endpoints with the new Proxy at this time, click Create with Endpoints. To do so at a later time, click Create and Exit.
Learn more about creating Proxy endpoints.

Anchor
delete-proxy
delete-proxy
Deleting a Proxy

Prerequisite: If a Proxy has endpoints, delete the endpoints before deleting the Proxy.

To delete a Proxy:

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

  2. Hover over the row of the Proxy.

  3. Click the trash icon ( (blue star) ) that appears at the end of the row.