# Omni Gateway Manager API

Register, manage, and monitor Omni Gateway instances. Configure runtime settings and track gateway status.

- **Version:** 0.1.0
- **Category:** Gateway
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/flex-gateway-manager/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/gatewaymanager/api/v1`
- `https://{region}.anypoint.mulesoft.com/gatewaymanager/api/v1`
- `https://{region}.platform.mulesoft.com/gatewaymanager/api/v1`

## Operations (11)
### GET /organizations/{organizationId}/usage/managed-gateways

**Operation ID:** `getOrganizationsByOrganizationidUsageManagedGateways`
Retrieves a managed gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `size` | query | The size query parameter. | optional |

### GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/runtime-configuration

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRuntimeConfiguration`
Get the runtime configuration of a Managed or Self-Managed Omni Gateway

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/runtime-configuration

**Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRuntimeConfiguration`
Replaces a runtime configuration.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/gateways

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGateways`
Retrieves a gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `name` | query | The name query parameter. | optional |
| `pageSize` | query | Maximum number of results to return per page. | optional |
| `sortBy` | query | Field and direction to sort results by. | optional |
| `sortOrder` | query | The sortOrder query parameter. | optional |
| `pageNumber` | query | Pagination offset or page number for results. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/gateways

**Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidGateways`
Creates a gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid`
Retrieves a gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### PUT /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}

**Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid`
Replaces a gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayid`
Deletes a gateways.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/registration

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidRegistration`
Retrieves a registration.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/status

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidStatus`
Retrieves a status.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/environments/{environmentId}/gateways/{gatewayId}/desiredstatus

**Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidGatewaysByGatewayidDesiredstatus`
Updates a desiredstatus.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `gatewayId` | query | The gateway ID to identify the target resource. | required |