Flex Gateway Manager API

0.1.0

Overview

Statistics
11 Operations
0 Skills
Gateway Category
Register, manage, and monitor Flex Gateway instances. Configure runtime settings and track gateway status.

Servers

  • https://anypoint.mulesoft.com/gatewaymanager/api/v1
  • https://{region}.anypoint.mulesoft.com/gatewaymanager/api/v1
  • https://{region}.platform.mulesoft.com/gatewaymanager/api/v1

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Get Organizations By Organizationid Usage Managed Gateways getOrganizationsByOrganizationidUsageManagedGateways

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a managed gateways.

Path Parameters

organizationId *: string

Query Parameters

size: string
The size query parameter.

Response

json
Amount of existing Managed Gateways created for the specified organization
items: array
Array items
Examples
application/json
[ { "resource": "string", "value": 0.0 } ]

Get Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid Runtime Configuration getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRuntimeConfiguration

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the runtime configuration of a Managed or Self-Managed Flex Gateway

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Response

json
Successful operation.
id: string
name: string
targetId: string
status: string
createdAt: string
updatedAt: string
desiredStatus: string
gatewayVersion: string
configuration *: any
Examples
application/json
{ "id": "string", "type": "string" }

Update Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid Runtime Configuration updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRuntimeConfiguration

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a runtime configuration.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Request Body *

json
configuration *: object

Response

json
Successful operation.
id: string
name: string
targetId: string
status: string
createdAt: string
updatedAt: string
desiredStatus: string
gatewayVersion: string
configuration *: any
Examples
application/json
{ "id": "string", "type": "string" }

Get Organizations By Organizationid Environments By Environmentid Gateways getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGateways

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a gateways.

Path Parameters

organizationId *: string
environmentId *: string

Query Parameters

name: string
The name query parameter.
pageSize: integer
Maximum number of results to return per page.
sortBy: string
Field and direction to sort results by.
sortOrder: string
The sortOrder query parameter.
pageNumber: integer
Pagination offset or page number for results.

Response

json
Successful operation.
content *: array
totalElements *: integer
pageNumber *: integer
pageSize *: integer
Examples
application/json
{ "content": [ { "id": "string", "type": "string" } ], "totalElements": 21, "pageNumber": 0, "pageSize": 20 }

Create Organizations By Organizationid Environments By Environmentid Gateways createOrganizationsByOrganizationidEnvironmentsByEnvironmentidGateways

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a gateways.

Path Parameters

organizationId *: string
environmentId *: string

Request Body

json
name *: string
targetId *: string(uuid)
releaseChannel *: string
runtimeVersion *: string
size *: string
configuration: object

Response

json
Resource created successfully.
id *: string
name *: string
status *: string
lastUpdated *: string
dateCreated *: string
targetId *: string
targetName: string
desiredStatus *: string
releaseChannel *: string
runtimeVersion *: string
size *: string
apiLimit: number
configuration *: any
Examples
application/json
{ "id": "string", "type": "string" }

Get Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a gateways.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Response

json
Successful operation.
id *: string
name *: string
status *: string
lastUpdated *: string
dateCreated *: string
targetId *: string
targetName: string
desiredStatus *: string
releaseChannel *: string
runtimeVersion *: string
size *: string
apiLimit: number
configuration *: any
Examples
application/json
{ "id": "string", "type": "string" }

Update Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a gateways.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Request Body

json
name *: string
targetId *: string(uuid)
releaseChannel *: string
runtimeVersion *: string
size *: string
configuration: object

Response

json
Successful operation.
id *: string
name *: string
status *: string
lastUpdated *: string
dateCreated *: string
targetId *: string
targetName: string
desiredStatus *: string
releaseChannel *: string
runtimeVersion *: string
size *: string
apiLimit: number
configuration *: any
Examples
application/json
{ "id": "string", "type": "string" }

Delete Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes a gateways.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Response

Operation completed successfully with no content returned.

Get Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid Registration getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRegistration

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a registration.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Response

json
Successful operation.
expiration *: string
Examples
application/json
{ "expiration": "2024-11-22T17:34:09.000Z" }

Get Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid Status getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidStatus

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a status.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Response

json
Successful operation.
status *: string
ready *: boolean
running *: boolean
Examples
application/json
{ "status": "RUNNING", "ready": true, "running": true }

Patch Organizations By Organizationid Environments By Environmentid Gateways By Gatewayid Desiredstatus patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidDesiredstatus

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a desiredstatus.

Path Parameters

organizationId *: string
environmentId *: string
gatewayId *: string(uuid)

Request Body

json
desiredStatus *: string

Response

Request accepted for processing.
Examples
application/json
{}