# Runtime Fabric Management API

Manage Runtime Fabric clusters, agents, associations, ingress configurations, and deployment targets.

- **Version:** 1.0.0
- **Category:** Runtime
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/runtime-fabric/api.yaml)

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

## Operations (33)
### GET /organizations/{organizationId}/fabrics

**Operation ID:** `getOrganizationsByOrganizationidFabrics`
Get the list of Runtime Fabrics in the organization.

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

### POST /organizations/{organizationId}/fabrics

**Operation ID:** `createOrganizationsByOrganizationidFabrics`
Runtime Fabric register endpoint

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

### GET /organizations/{organizationId}/fabrics/{fabricId}

**Operation ID:** `getOrganizationsByOrganizationidFabricsByFabricid`
Get the fabric
with id =
{fabricId}


**Parameters:**
| `includeCapacityForEnv` | query | If provided an enviornment Id, the response will include capacity information about the runtime fabric for that environment
 | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `fabricId` | query | The fabric ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/fabrics/{fabricId}

**Operation ID:** `patchOrganizationsByOrganizationidFabricsByFabricid`
Update existing fabric

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

### DELETE /organizations/{organizationId}/fabrics/{fabricId}

**Operation ID:** `deleteOrganizationsByOrganizationidFabricsByFabricid`
Deletes a fabrics.

**Parameters:**
| `force` | query | If set to "true", forces deletion of associated applications | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `fabricId` | query | The fabric ID to identify the target resource. | required |

### GET /organizations/{organizationId}/fabrics/{fabricId}/logforwarding

**Operation ID:** `getOrganizationsByOrganizationidFabricsByFabricidLogforwarding`
Get the Log forwarding config information.

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

### PATCH /organizations/{organizationId}/fabrics/{fabricId}/logforwarding

**Operation ID:** `patchOrganizationsByOrganizationidFabricsByFabricidLogforwarding`
Update the Anypoint Log forwarding config

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

### DELETE /organizations/{organizationId}/fabrics/{fabricId}/logforwarding

**Operation ID:** `deleteOrganizationsByOrganizationidFabricsByFabricidLogforwarding`
Deletes the External and Anypoint Monitoring log forwarding.

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

### PATCH /organizations/{organizationId}/fabrics/{fabricId}/logforwarding/external

**Operation ID:** `patchOrganizationsByOrganizationidFabricsByFabricidLogforwardingExternal`
Configure the External log forwarding

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

### DELETE /organizations/{organizationId}/fabrics/{fabricId}/logforwarding/external

**Operation ID:** `deleteOrganizationsByOrganizationidFabricsByFabricidLogforwardingExternal`
Deletes the External log forwarding configuration

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

### POST /organizations/{organizationId}/fabrics/{fabricId}/logforwarding/external/test

**Operation ID:** `createOrganizationsByOrganizationidFabricsByFabricidLogforwardingExternalTest`
Lets the user send test message to validate the end to end connectivity.
Precondition is to have External log forwarding configured.
Response will have the 'messageRef' uuid, which is the key word for user to search in the external log service.


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

### GET /organizations/{organizationId}/fabrics/{fabricId}/events

**Operation ID:** `getOrganizationsByOrganizationidFabricsByFabricidEvents`
Get cluster events.


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

### GET /organizations/{organizationId}/fabrics/{fabricId}/health

**Operation ID:** `getOrganizationsByOrganizationidFabricsByFabricidHealth`
Get detailed health information.


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

### GET /organizations/{organizationId}/groups

**Operation ID:** `getOrganizationsByOrganizationidGroups`
Get the list of Fabric Groups.

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

### GET /organizations/{organizationId}/groups/{groupId}

**Operation ID:** `getOrganizationsByOrganizationidGroupsByGroupid`
Retrieves a groups.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |

### GET /organizations/{organizationId}/groups/{groupId}/associations

**Operation ID:** `getOrganizationsByOrganizationidGroupsByGroupidAssociations`
Get the list of environment associations.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |

### POST /organizations/{organizationId}/groups/{groupId}/associations

**Operation ID:** `createOrganizationsByOrganizationidGroupsByGroupidAssociations`
Create a new association

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |

### GET /organizations/{organizationId}/groups/{groupId}/associations/{associationId}

**Operation ID:** `getOrganizationsByOrganizationidGroupsByGroupidAssociationsByAssociationid`
Retrieves a associations.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `associationId` | query | The association ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/groups/{groupId}/associations/{associationId}

**Operation ID:** `patchOrganizationsByOrganizationidGroupsByGroupidAssociationsByAssociationid`
Update an existing environment association.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `associationId` | query | The association ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/groups/{groupId}/associations/{associationId}

**Operation ID:** `deleteOrganizationsByOrganizationidGroupsByGroupidAssociationsByAssociationid`
Deletes a associations.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `groupId` | query | API Manager API group id (integer; not Exchange Maven groupId). | required |
| `associationId` | query | The association ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}

**Operation ID:** `deleteOrganizationsByOrganizationid`
Deletes a organizations.

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

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

**Operation ID:** `deleteOrganizationsByOrganizationidEnvironmentsByEnvid`
Deletes a environments.

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

### GET /organizations/{organizationId}/imageregistrycredential

**Operation ID:** `getOrganizationsByOrganizationidImageregistrycredential`
Retrieve short-lived credential to allow pulling Runtime Fabric Docker images

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

### GET /runtimes

**Operation ID:** `getRuntimes`
Retrieve all supported Mule versions. The first version returned is the most recent, recommended version, and the last version returned is the oldest supported version


**Parameters:**
| `search` | query | Search or filter expression to narrow results. | required |
| `recommended` | query | The recommended query parameter. | required |

### GET /runtimes/{name}

**Operation ID:** `getRuntimesByName`
Retrieve a single name


**Parameters:**
| `name` | query | The name to identify the target resource. | required |

### GET /runtimes/{name}/tags

**Operation ID:** `getRuntimesByNameTags`
Retrieves tags for a name


**Parameters:**
| `name` | query | The name to identify the target resource. | required |

### GET /runtimes/{name}/tags/{tagId}

**Operation ID:** `getRuntimesByNameTagsByTagid`
Retrieve a single name for a name


**Parameters:**
| `name` | query | The name to identify the target resource. | required |
| `tagId` | query | The tag ID to identify the target resource. | required |

### GET /downloads

**Operation ID:** `getDownloads`
List the available downloads

### GET /download/scripts/latest

**Operation ID:** `getDownloadScriptsLatest`
Download the latest installer scripts

### GET /download/installer/latest

**Operation ID:** `getDownloadInstallerLatest`
Download the latest installer package

### GET /download/installer/latest/url

**Operation ID:** `getDownloadInstallerLatestUrl`
Get the pre-signed url of the latest installer package

### GET /download/agent/latest

**Operation ID:** `getDownloadAgentLatest`
Download the latest rtf agent helm chart

### GET /download/rtfctl/latest

**Operation ID:** `getDownloadRtfctlLatest`
Download the latest rtfctl binary