Flex Gateway Manager API

1.0.x
(0 reviews)

Getting Started

Overview

The Anypoint Flex Gateway Manager API provides endpoints to manage Flex Gateways registered in Anypoint Platform. It exposes all CRUD (Create, Read, Update, Delete) operations on Anypoint Managed Flex Gateways (Flex Gateways deployed to Cloudhub 2.0) through this RESTful API.

Base URL

The API is accessible through the Anypoint Platform base URL in /gatewaymanager path. For example:
- US Production: https://anypoint.mulesoft.com/gatewaymanager/api/v1
- EU Production: https://eu1.anypoint.mulesoft.com/gatewaymanager/api/v1

Authentication

All API requests require authentication using Anypoint Platform credentials.

Available Operations

List Managed Gateways

  • Endpoint: GET /organizations/{organizationId}/environments/{environmentId}/gateways
  • Description: Retrieves a list of managed gateways for a specific organization and environment
  • Query Parameters:
    • name: Filter gateways by name
    • pageSize: Number of items per page
    • pageNumber: Page number for pagination
    • sortBy: Field to sort by
    • sortOrder: Sort order (asc/desc)

Create Managed Gateway

  • Endpoint: POST /organizations/{organizationId}/environments/{environmentId}/gateways
  • Description: Creates a new managed gateway in the specified environment
  • Request Body: Gateway configuration details

Get Gateway Details

  • Endpoint: GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}
  • Description: Retrieves detailed information about a specific managed gateway
  • Path Parameters:
    • gatewayId: UUID of the gateway

Update Gateway

  • Endpoint: PUT /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}
  • Description: Updates the configuration of an existing managed gateway
  • Path Parameters:
    • gatewayId: UUID of the gateway
  • Request Body: Updated gateway configuration

Delete Gateway

  • Endpoint: DELETE /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}
  • Description: Removes a managed gateway from the environment
  • Path Parameters:
    • gatewayId: UUID of the gateway

Get Gateway Registration Data

  • Endpoint: GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/registration
  • Description: Retrieves registration information for a specific gateway
  • Path Parameters:
    • gatewayId: UUID of the gateway

Get Gateway Usage

  • Endpoint: GET /organizations/{organizationId}/usage/managed-gateways
  • Description: Retrieves usage information for managed gateways in an organization
  • Query Parameters:
    • size: Gateway size (small/large)

Reviews