Versions Compared

Old Version 19

changes.mady.by.user John Brinckwirth

Saved on

compared with

New Version 39

changes.mady.by.user Rachana Mannath

Saved on

Key

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

In On this articlepage

Table of Contents
minLevel1
maxLevel2

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. With Proxies, you can use industry-standard API specifications to design and share APIs. This enables the reusability and portability of your Proxy APIs. Proxies support OAS 2.0 and 3.0 API specifications in either JSON or YAML formats.

You can:

Prerequisites

  • Org Admin permissions

Pages in this article

Child pages (Children Display)
depth2

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 ManagerImage Removed

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.

Limitations:

  • We do not support paths where the first element is a dynamic path/path parameter.
    For example: /{petId}

  • If the proxy does not match any mappings, an is null error is displayedYou can provide Basic Authentication authorization support for Proxy by adding Basic Authentication security schema in the API specification file.

  • When you upload a incorrect data Proxy specification file it displays error messages in the Create Proxy wizard and Swagger Editor of Publish Proxy wizard.

To create a proxy:

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

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

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

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

  5. Configure the new proxy, 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.

  • API Proxies do not support versioning.

  • Because a Proxy connects to an implementation of an API, you can simply create new Proxies and endpoints to connect to new implementations.

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.

Edit Proxy name

To Rename Proxy name for unpublished proxies:

  1. Navigate to API Manager > Proxy > Proxy details.

  2. Click Edit Details to rename the Proxy:

    editdetails-proxy.pngImage Added

  3. Click Save. A message “Proxy details has been updated successfully” displays in the UI.

Edit Proxy endpoint

  1. Navigate to API Manager > API > Proxy endpoint details.

  2. Select the Proxy endpoint to be edited.

  3. Click Edit Details to edit the Proxy endpoint:

    editdetails-proxy-endpoint.pngImage Added

  4. Click Save. A message “Endpoint details has been updated successfully” displays in the UI.

  • You can only edit the Proxy name or Proxy endpoint of the unpublished APIs.

  • Unpublish the Proxy to edit the Proxy name or the Proxy endpoint.

  • Special characters such as |, <, >, [, ], {, },#, ?, /, and \. cannot be used.

Video: Create and Publish a Proxy to your Developer Portal

Watch the following video to learn how to create and publish a Proxy to the Developer Portal.

APIM-5 Create and Publish a Proxy API.mp4

Anchor
delete-proxy
delete-proxy
Deleting a Proxy

Info

The June 2023 release supports soft delete operation for API Proxies. When you delete a proxy, it goes to the Recycle Bin in Manager.

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.

    Image Added

    The Delete confirmation prompt opens.

    Image Added

  4. Click Delete.

  5. Verify the deleted Assets by navigating to the Manager Recycle Bin for your Org.

  6. To delete forever:

    1. Select the Proxy.

    2. Click (blue star) to delete it permanently from the Manager Recycle Bin.

Image Added