Runtime Fabric API
MuleSoft Runtime Fabric (RTF) API enables programmatic management of Runtime Fabric instances, including fabric lifecycle, log forwarding, group management, downloads, and runtime configurations.
All API requests are scoped under an organization ({orgId}
) and, where applicable, a specific fabric ({fabricId}
) or group ({groupId}
).
Fabric Management
Endpoint |
Method |
Description |
/organizations/{orgId}/fabrics |
GET |
List all Runtime Fabrics for the organization. |
/organizations/{orgId}/fabrics |
POST |
Create a new Runtime Fabric. |
/organizations/{orgId}/fabrics/{fabricId} |
GET |
Retrieve details of a specific fabric. |
/organizations/{orgId}/fabrics/{fabricId} |
PATCH |
Update a specific fabric. |
/organizations/{orgId}/fabrics/{fabricId} |
DELETE |
Delete a specific fabric. |
Log Forwarding
Endpoint |
Method |
Description |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding |
GET |
Get log forwarding configuration. |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding |
PATCH |
Update log forwarding configuration. |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding |
DELETE |
Remove log forwarding configuration. |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding/external |
PATCH |
Update external log forwarding. |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding/external |
DELETE |
Remove external log forwarding. |
/organizations/{orgId}/fabrics/{fabricId}/logforwarding/external/test |
POST |
Test external log forwarding configuration. |
Fabric Monitoring
Endpoint |
Method |
Description |
/organizations/{orgId}/fabrics/{fabricId}/events |
GET |
Retrieve fabric events. |
/organizations/{orgId}/fabrics/{fabricId}/health |
GET |
Get fabric health status. |
Group Management
Endpoint |
Method |
Description |
/organizations/{orgId}/groups |
GET |
List groups. |
/organizations/{orgId}/groups/{groupId} |
GET |
Get details of a group. |
/organizations/{orgId}/groups/{groupId}/associations |
GET |
List group associations. |
/organizations/{orgId}/groups/{groupId}/associations |
POST |
Create a group association. |
/organizations/{orgId}/groups/{groupId}/associations/{associationId} |
GET |
Get details of an association. |
/organizations/{orgId}/groups/{groupId}/associations/{associationId} |
PATCH |
Update an association. |
/organizations/{orgId}/groups/{groupId}/associations/{associationId} |
DELETE |
Delete an association. |
Organization and Environment Management
Endpoint |
Method |
Description |
/organizations/{orgId} |
DELETE |
Delete an organization. |
/organizations/{orgId}/environments/{envId} |
DELETE |
Delete an environment. |
/organizations/{orgId}/imageregistrycredential |
GET |
Get image registry credentials. |
Runtimes
Endpoint |
Method |
Description |
/runtimes |
GET |
List available runtimes. |
/runtimes/{name} |
GET |
Get details of a runtime. |
/runtimes/{name}/tags |
GET |
List runtime tags. |
/runtimes/{name}/tags/{tagId} |
GET |
Get details of a runtime tag. |
Downloads
Endpoint |
Method |
Description |
/downloads |
GET |
List available downloads. |
/download |
|
(unspecified method, likely GET ) |
/download/scripts |
|
|
/download/scripts/latest |
GET |
Get the latest install scripts. |
/download/installer |
|
|
/download/installer/latest |
GET |
Get the latest installer. |
/download/installer/latest/url |
GET |
Get the URL for the latest installer. |
/download/agent |
|
|
/download/agent/latest |
GET |
Get the latest agent. |
/download/rtfctl |
|
|
/download/rtfctl/latest |
GET |
Get the latest rtfctl tool. |