Runtime Fabric Management API

List Runtime Fabrics listFabrics

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get the list of Runtime Fabrics in the organization.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

items: array

Array items

id *: string

name *: string

The name of the Runtime Fabric cluster.

region *: string

The region in where the Runtime Fabric will be registered.

vendor: string

The Kubernetes vendor of the Runtime Fabric.

organizationId: string

The anypoint organization Id associated with the Runtime Fabric.

version *: string

Version of the Runtime Fabric.

status: string

Last reported status.

desiredVersion: string

Desired version of the Runtime Fabric.

availableUpgradeVersion: string

If present, there is an new version available.

lastUpgradeTimestamp: number

Timestamp of last reported upgrade activity in EPOCH format.

createdAt *: number

Timestamp in EPOCH format.

upgrade: object

If present, describes the status of the last upgrade.

nodes *: array

Information of nodes that make up the cluster.

secondsSinceHeartbeat: integer

Seconds since last reported heartbeat.

statusMessage: string

channel: string

Upgrade channel. If empty, the Fabric is subscribed to the "stable" channel.

activationData: string

Data used to activate the Runtime Fabric cluster on the control plane.

clusterVersion: string

(Deprecated) Version of the underlying cluster

kubernetesVersion: string

Version of the kubernetes software in the cluster.

capacity: object

This field provides resource usage and limits for a particular environment.

isManaged: boolean

Indicates if the infrastructure of the Runtime Fabric is managed in cloud.

appliance: object

If present, it contains the details of the appliance supporting the Runtime Fabric.

clusterConfigurationLevel: string

This property indicates configuration level for this Runtime Fabric. Possible values: "production", "development", "unsupported"

features: any

Optional features that are enabled/disabled on the Runtime Fabric.

ingress: object

Ingress config for byok clusters

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Register a Runtime Fabric registerFabric

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Runtime Fabric register endpoint

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

name *: string

The name of the Runtime Fabric cluster.

region *: string

The region in where the Runtime Fabric will be registered.

version: string

The desired agent version of the Runtime Fabric.

channel: string

The desired release channel to subscribe to for the Runtime Fabric.

organizationId: string

vendor: string

The Kubernetes vendor of the Runtime Fabric.

Response

json

Resource created successfully.

id *: string

name *: string

The name of the Runtime Fabric cluster.

region *: string

The region in where the Runtime Fabric will be registered.

vendor: string

The Kubernetes vendor of the Runtime Fabric.

organizationId: string

The anypoint organization Id associated with the Runtime Fabric.

version *: string

Version of the Runtime Fabric.

status: string

Last reported status.

desiredVersion: string

Desired version of the Runtime Fabric.

availableUpgradeVersion: string

If present, there is an new version available.

lastUpgradeTimestamp: number

Timestamp of last reported upgrade activity in EPOCH format.

createdAt *: number

Timestamp in EPOCH format.

upgrade: object

If present, describes the status of the last upgrade.

nodes *: array

Information of nodes that make up the cluster.

secondsSinceHeartbeat: integer

Seconds since last reported heartbeat.

statusMessage: string

channel: string

Upgrade channel. If empty, the Fabric is subscribed to the "stable" channel.

activationData: string

Data used to activate the Runtime Fabric cluster on the control plane.

clusterVersion: string

(Deprecated) Version of the underlying cluster

kubernetesVersion: string

Version of the kubernetes software in the cluster.

capacity: object

This field provides resource usage and limits for a particular environment.

isManaged: boolean

Indicates if the infrastructure of the Runtime Fabric is managed in cloud.

appliance: object

If present, it contains the details of the appliance supporting the Runtime Fabric.

clusterConfigurationLevel: string

This property indicates configuration level for this Runtime Fabric. Possible values: "production", "development", "unsupported"

features: any

Optional features that are enabled/disabled on the Runtime Fabric.

ingress: object

Ingress config for byok clusters

Examples

application/json

{ "id": "string", "name": "string", "region": "string", "vendor": "string", "organizationId": "string", "version": "string", "status": "string", "desiredVersion": "string", "availableUpgradeVersion": "string", "lastUpgradeTimestamp": 0.0 }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Runtime Fabric by ID getFabric

GET

Try it out

Path Parameters

organizationId *

fabricId *

Query Parameters

includeCapacityForEnv

Custom Query Parameters

Custom Headers

Get the fabric
with id =
{fabricId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Query Parameters

includeCapacityForEnv: string

If provided an enviornment Id, the response will include capacity information about the runtime fabric for that environment

Response

Successful operation.

Examples

application/json

{}

Update Runtime Fabric updateFabric

PATCH

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update existing fabric

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Request Body

json

version: string

The desired agent version of the Runtime Fabric.

channel: string

The desired release channel to subscribe to for the Runtime Fabric.

name: string

The name of the Runtime Fabric cluster.

features: any

Optional features that are enabled/disabled on the Runtime Fabric.

ingress: object

Ingress config for byok clusters

Response

json

Successful operation.

id *: string

name *: string

The name of the Runtime Fabric cluster.

region *: string

The region in where the Runtime Fabric will be registered.

vendor: string

The Kubernetes vendor of the Runtime Fabric.

organizationId: string

The anypoint organization Id associated with the Runtime Fabric.

version *: string

Version of the Runtime Fabric.

status: string

Last reported status.

desiredVersion: string

Desired version of the Runtime Fabric.

availableUpgradeVersion: string

If present, there is an new version available.

lastUpgradeTimestamp: number

Timestamp of last reported upgrade activity in EPOCH format.

createdAt *: number

Timestamp in EPOCH format.

upgrade: object

If present, describes the status of the last upgrade.

nodes *: array

Information of nodes that make up the cluster.

secondsSinceHeartbeat: integer

Seconds since last reported heartbeat.

statusMessage: string

channel: string

Upgrade channel. If empty, the Fabric is subscribed to the "stable" channel.

activationData: string

Data used to activate the Runtime Fabric cluster on the control plane.

clusterVersion: string

(Deprecated) Version of the underlying cluster

kubernetesVersion: string

Version of the kubernetes software in the cluster.

capacity: object

This field provides resource usage and limits for a particular environment.

isManaged: boolean

Indicates if the infrastructure of the Runtime Fabric is managed in cloud.

appliance: object

If present, it contains the details of the appliance supporting the Runtime Fabric.

clusterConfigurationLevel: string

This property indicates configuration level for this Runtime Fabric. Possible values: "production", "development", "unsupported"

features: any

Optional features that are enabled/disabled on the Runtime Fabric.

ingress: object

Ingress config for byok clusters

Examples

application/json

{ "id": "string", "name": "string", "region": "string", "vendor": "string", "organizationId": "string", "version": "string", "status": "string", "desiredVersion": "string", "availableUpgradeVersion": "string", "lastUpgradeTimestamp": 0.0 }

Delete Runtime Fabric deleteFabric

DELETE

Try it out

Path Parameters

organizationId *

fabricId *

Query Parameters

force

Custom Query Parameters

Custom Headers

Deletes a fabrics.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Query Parameters

force: boolean

If set to "true", forces deletion of associated applications

default: False

Response

Successful operation.

Get log forwarding configuration getFabricLogForwarding

GET

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Get the Log forwarding config information.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

json

Successful operation.

anypointMonitoring: boolean

The desired action to push logs to Anypoint monitoring.

externalLogForwarding: object

The desired action to push logs to external third party services.

Examples

application/json

{ "anypointMonitoring": true, "externalLogForwarding": { "azureConfig": { "id": "string", "type": "string" }, "splunkConfig": { "id": "string", "type": "string" }, "grayLogConfig": { "id": "string", "type": "string" }, "elasticSearchConfig": { "id": "string", "type": "string" }, "cloudWatchConfig": { "id": "string", "type": "string" }, "syslogConfig": { "id": "string", "type": "string" }, "dataDogConfig": { "id": "string", "type": "string" }, "forwardLogs": { "id": "string", "type": "string" } } }

Update log forwarding configuration updateFabricLogForwarding

PATCH

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update the Anypoint Log forwarding config

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Request Body

json

anypointMonitoring: boolean

The desired action to push logs to Anypoint monitoring.

externalLogForwarding: object

The desired action to push logs to external third party services.

Response

json

Successful operation.

anypointMonitoring: boolean

The desired action to push logs to Anypoint monitoring.

externalLogForwarding: object

The desired action to push logs to external third party services.

Examples

application/json

{ "anypointMonitoring": true, "externalLogForwarding": { "azureConfig": { "id": "string", "type": "string" }, "splunkConfig": { "id": "string", "type": "string" }, "grayLogConfig": { "id": "string", "type": "string" }, "elasticSearchConfig": { "id": "string", "type": "string" }, "cloudWatchConfig": { "id": "string", "type": "string" }, "syslogConfig": { "id": "string", "type": "string" }, "dataDogConfig": { "id": "string", "type": "string" }, "forwardLogs": { "id": "string", "type": "string" } } }

Delete log forwarding configuration deleteFabricLogForwarding

DELETE

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Deletes the External and Anypoint Monitoring log forwarding.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

Operation completed successfully with no content returned.

Configure external log forwarding updateExternalLogForwarding

PATCH

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Configure the External log forwarding

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Request Body

multipart/form-data

logConfig *: object

ca_file: string(binary)

Response

json

Successful operation.

azureConfig *: object

splunkConfig *: object

Host *: string

IP address or hostname of the target Splunk service.

Port *: string

TCP port of the target Splunk service.

Splunk_Token: string

Specify the Authentication Token for the HTTP Event Collector interface.

Splunk_Send_Raw: string

When enabled, the record keys and values are set in the top level of the map instead of under the event key.

Tls: string

Enable or disable TLS support

HTTP_User: string

Optional username for Basic Authentication on HEC

HTTP_Passwd: string

Password for user defined in HTTP_User

CA_file_content: string

grayLogConfig *: object

Match *: string

Pattern to match which tags of logs to be outputted by this plugin

Host *: string

IP address or hostname of the target Graylog server

Port *: string

The port that your Graylog GELF input is listening on

Mode *: string

The protocol to use (tls, tcp or udp)

Tls: string

Enable or disable TLS support

Gelf_Short_Message_Key *: string

A short descriptive message

Gelf_Timestamp_Key: string

Your log timestamp

Gelf_Host_Key *: string

Key which its value is used as the name of the host, source or application that sent this message.

Gelf_Full_Message_Key *: string

Key to use as the long message that can i.e. contain a backtrace.

Gelf_Level_Key: string

Key to be used as the log level. Its value must be in standard syslog levels (between 0 and 7).

Packet_Size: string

If transport protocol is udp, you can set the size of packets to be sent.

Compress: boolean

If transport protocol is udp, you can set this if you want your UDP packets to be compressed.

CA_file_content: string

elasticSearchConfig *: object

Host *: string

IP address or hostname of the target Elasticsearch instance

Port *: string

TCP port of the target Elasticsearch instance

Index *: string

Index name

Tls: string

Enable or disable TLS support

Path: string

Elasticsearch accepts new data on HTTP query path "/_bulk". But it is also possible to serve Elasticsearch behind a reverse proxy on a subpath. This option defines such path on the fluent-bit side. It simply adds a path prefix in the indexing HTTP POST URI.

Buffer_Size: string

Specify the buffer size used to read the response from the Elasticsearch HTTP service. This option is useful for debugging purposes where is required to read full responses, note that response size grows depending of the number of records inserted. To set an unlimited amount of memory set this value to False, otherwise the value must be according to the Unit Size specification.

HTTP_User: string

Optional username credential for Elastic X-Pack access

HTTP_Passwd: string

Password for user defined in HTTP_User

Type: string

Type name

Logstash_Format: string

Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off

Logstash_Prefix: string

When Logstash_Format is enabled, the Index name is composed using a prefix and the date, e.g: If Logstash_Prefix is equals to 'mydata' your index will become 'mydata-YYYY.MM.DD'. The last string appended belongs to the date when the data is being generated.

Logstash_DateFormat: string

Time format (based on strftime) to generate the second part of the Index name.

Time_Key: string

When Logstash_Format is enabled, each record will get a new timestamp field. The Time_Key property defines the name of that field.

Time_Key_Format: string

When Logstash_Format is enabled, this property defines the format of the timestamp.

Include_Tag_Key: string

When enabled, it append the Tag name to the record.

Tag_Key: string

When Include_Tag_Key is enabled, this property defines the key name for the tag.

Generate_ID: string

When enabled, generate _id for outgoing records. This prevents duplicate records when retrying ES.

Replace_Dots: string

When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.

Trace_Output: string

When enabled print the elasticsearch API calls to stdout (for diag only)

Trace_Error: string

When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error

Current_Time_Index: string

Use current time for index generation instead of message record

Logstash_Prefix_Key: string

Prefix keys with this string

CA_file_content: string

cloudWatchConfig *: object

region *: string

The AWS region where CloudWatch service is hosted.

aws_access_key_id *: string

Aws Access Key Id

aws_secret_access_key *: string

Aws Secret Access Key

log_group_name *: string

The name of the CloudWatch Log Group that you want log records sent to.

log_stream_name: string

The name of the CloudWatch Log Stream that you want log records sent to. Either of Log stream name or Log stream prefix is required.

log_stream_prefix: string

Prefix for the Log Stream name. The tag is appended to the prefix to construct the full log stream name. Not compatible with the log_stream_name option.

auto_create_group: string

Automatically create the log group. Valid values are "true" or "false" (case insensitive). Defaults to false.

log_key: string

If specified a key name with this option, then only the value of that key will be sent to CloudWatch. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to CloudWatch.

role_arn: string

ARN of an IAM role to assume (for cross account access).

syslogConfig *: object

dataDogConfig *: object

Host *: string

The Datadog server where user wants to send the logs

apikey *: string

Users Datadog API key

Tls: string

End-to-end security communications security protocol.

compress: string

Compresses the payload in Datadog supported formats. Datadog supports and recommends setting this to gzip.

dd_service: string

The human readable name for your service generating the logs - the name of your application or database.

dd_source: string

A human readable name for the underlying technology of your service. For example, postgres or nginx.

dd_tags: string

The tags you want to assign to your logs in Datadog.

messageRef *: string

rtfName *: string

Examples

application/json

{ "messageRef": "string", "rtfName": "string" }

List Runtime Fabric cluster events listFabricEvents

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Retrieve the cluster events across the Runtime Fabrics in the organization.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "type": "connectivity", "message": "Cannot reach anypoint.mulesoft.com: connection timed out", "createdAt": 1573599617.0, "updatedAt": 1573599618.0 }, { "type": "component", "message": "Cronjob/registry-creds failed: aws-cli connection timed out", "createdAt": 1573599617.0, "updatedAt": 1573599618.0, "resolvedAt": 1573599618.0 } ]

Get Runtime Fabric health getFabricHealth

GET

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Get detailed health information.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

json

Successful operation.

clusterMonitoring *: object

The ability to monitor and report the status of the Runtime Fabric cluster.

manageDeployments *: object

The ability to create, update, or delete application deployments in this Runtime Fabric.

loadBalancing *: object

The ability to accept inbound requests and load-balance across different replicas of application instances.

anypointMonitoring: object

The ability to see metrics and logs in Anypoint Monitoring.

externalLogForwarding: object

The ability to forward application logs to an external provider.

appliance: object

Detailed status of the appliance, when applicable.

infrastructure: object

Detailed status of the infrastructure supporting the Runtime Fabric cluster.

persistentGateway: object

Detailed status of the persistent gateway for Runtime Fabric cluster.

Examples

application/json

{ "clusterMonitoring": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "manageDeployments": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "loadBalancing": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "anypointMonitoring": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "externalLogForwarding": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "appliance": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "infrastructure": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] }, "persistentGateway": { "healthy": true, "updatedAt": 0.0, "probes": {}, "failedProbes": [ { "id": "string", "type": "string" } ] } }

Get OIDC issuers getFabricOidcIssuers

GET

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Retrieve the OIDC issuers associated with the Runtime Fabric.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

json

Successful operation.

oidcIssuers: array

OIDC issuer URLs associated with the Runtime Fabric. Omit the field to leave the existing value unchanged. Send an empty array ([]) to explicitly clear the OIDC issuers.

Examples

application/json

{ "oidcIssuers": [ "https://login.example.com/oidc" ] }

Update OIDC issuers updateFabricOidcIssuers

PATCH

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update the OIDC issuers associated with the Runtime Fabric. Omit the field to leave the existing value unchanged. Send an empty array ([]) to explicitly clear the OIDC issuers.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Request Body

json

oidcIssuers: array

OIDC issuer URLs associated with the Runtime Fabric. Omit the field to leave the existing value unchanged. Send an empty array ([]) to explicitly clear the OIDC issuers.

Response

json

Successful operation.

id *: string

name *: string

The name of the Runtime Fabric cluster.

region *: string

The region in where the Runtime Fabric will be registered.

vendor: string

The Kubernetes vendor of the Runtime Fabric.

organizationId: string

The anypoint organization Id associated with the Runtime Fabric.

version *: string

Version of the Runtime Fabric.

status: string

Last reported status.

desiredVersion: string

Desired version of the Runtime Fabric.

availableUpgradeVersion: string

If present, there is an new version available.

lastUpgradeTimestamp: number

Timestamp of last reported upgrade activity in EPOCH format.

createdAt *: number

Timestamp in EPOCH format.

upgrade: object

If present, describes the status of the last upgrade.

nodes *: array

Information of nodes that make up the cluster.

secondsSinceHeartbeat: integer

Seconds since last reported heartbeat.

statusMessage: string

channel: string

Upgrade channel. If empty, the Fabric is subscribed to the "stable" channel.

activationData: string

Data used to activate the Runtime Fabric cluster on the control plane.

clusterVersion: string

(Deprecated) Version of the underlying cluster

kubernetesVersion: string

Version of the kubernetes software in the cluster.

capacity: object

This field provides resource usage and limits for a particular environment.

isManaged: boolean

Indicates if the infrastructure of the Runtime Fabric is managed in cloud.

appliance: object

If present, it contains the details of the appliance supporting the Runtime Fabric.

clusterConfigurationLevel: string

This property indicates configuration level for this Runtime Fabric. Possible values: "production", "development", "unsupported"

features: any

Optional features that are enabled/disabled on the Runtime Fabric.

ingress: object

Ingress config for byok clusters

Examples

application/json

{ "id": "string", "name": "string" }

List fabric associations listFabricAssociations

GET

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Retrieve all associations of the Runtime Fabric.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" } ]

Create fabric associations createFabricAssociations

POST

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create associations for the Runtime Fabric with business groups and environments.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Request Body

json

associations *: array

The list of associations to create.

Examples

application/json

{ "associations": [ { "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b", "environment": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb" }, { "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b", "environment": "3e9d5bde-6ef7-4947-9f98-0f7c32d48909" } ] }

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" } ]

Get fabric association getFabricAssociation

GET

Try it out

Path Parameters

organizationId *

fabricId *

associationId *

Custom Query Parameters

Custom Headers

Retrieve a specific association of the Runtime Fabric.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

associationId *: string

The association ID to identify the target resource.

Response

json

Successful operation.

id *: string

name *: string

environmentId *: string

organizationId *: string

deploymentStatus *: string

errorMessage: string

Examples

application/json

{ "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" }

Delete fabric association deleteFabricAssociation

DELETE

Try it out

Path Parameters

organizationId *

fabricId *

associationId *

Custom Query Parameters

Custom Headers

Delete a specific association of the Runtime Fabric.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

associationId *: string

The association ID to identify the target resource.

Response

Resource deleted successfully.

Get upgrade pre-check status getUpgradeCompatibilityCheck

GET

Try it out

Path Parameters

organizationId *

fabricId *

Query Parameters

scope

Custom Query Parameters

Custom Headers

Retrieve the pre-upgrade compatibility check status.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Query Parameters

scope: string

Optional parameter to limit the scope of the pre-check operation.

default: all

Response

json

Successful operation.

mTls: object

rtfRegistry: object

Examples

application/json

{ "mTls": { "status": "success" }, "rtfRegistry": { "status": "running", "actionId": "string" } }

Run upgrade pre-check runUpgradeCompatibilityCheck

POST

Try it out

Path Parameters

organizationId *

fabricId *

Query Parameters

scope

force

Custom Query Parameters

Custom Headers

Run the pre-upgrade compatibility checks against the appliance-based fabric. Includes the status of the checks in the fabric response.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Query Parameters

scope: string

Optional parameter to limit the scope of the pre-check operation.

default: all

force: string

Optional parameter to force run the pre-check. Supported values are 'true' or 'false'.

default: false

Response

json

Successful operation.

mTls: object

rtfRegistry: object

Examples

application/json

{ "mTls": { "status": "running", "actionId": "string" } }

Check Kubernetes compatibility getK8sCompatibilityCheck

GET

Try it out

Path Parameters

organizationId *

fabricId *

Custom Query Parameters

Custom Headers

Check fabric compatibility with a specific Kubernetes release.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

fabricId *: string

The fabric ID to identify the target resource.

Related Operations:

runtime-fabric#listFabrics.$[*].id

Response

json

Successful operation.

isCompatible *: boolean

Whether the fabric version is compatible with a specific Kubernetes release.

details *: string

The reason why the fabric version is not compatible with a specific Kubernetes release.

kubernetesVersion *: string

The fabric's current Kubernetes version.

Examples

application/json

{ "isCompatible": true, "details": "string", "kubernetesVersion": "string" }

List fabric groups listFabricGroups

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Get the list of Fabric Groups.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get fabric group by ID getFabricGroup

GET

Try it out

Path Parameters

organizationId *

groupId *

Custom Query Parameters

Custom Headers

Retrieves a groups.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

Response

json

Successful operation.

id *: string

name *: string

associations *: array

Examples

application/json

{ "id": "string", "name": "string", "associations": [ { "id": "string", "type": "string" } ] }

List environment associations listGroupAssociations

GET

Try it out

Path Parameters

organizationId *

groupId *

Custom Query Parameters

Custom Headers

Get the list of environment associations.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create environment association createAssociation

POST

Try it out

Path Parameters

organizationId *

groupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new association

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

Request Body

json

name *: string

environmentId *: string

organizationId *: string

Response

Resource created successfully.

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get environment association by ID getAssociation

GET

Try it out

Path Parameters

organizationId *

groupId *

associationId *

Custom Query Parameters

Custom Headers

Retrieves a associations.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

associationId *: string

The association ID to identify the target resource.

Response

json

Successful operation.

id *: string

name *: string

environmentId *: string

organizationId *: string

deploymentStatus *: string

errorMessage: string

Examples

application/json

{ "id": "string", "name": "string", "environmentId": "string", "organizationId": "string", "deploymentStatus": "string", "errorMessage": "string" }

Update environment association updateAssociation

PATCH

Try it out

Path Parameters

organizationId *

groupId *

associationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update an existing environment association.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

associationId *: string

The association ID to identify the target resource.

Request Body

json

Response

json

Successful operation.

id *: string

name *: string

environmentId *: string

organizationId *: string

deploymentStatus *: string

errorMessage: string

Examples

application/json

{ "id": "string", "name": "string", "environmentId": "string", "organizationId": "string", "deploymentStatus": "string", "errorMessage": "string" }

Delete environment association deleteAssociation

DELETE

Try it out

Path Parameters

organizationId *

groupId *

associationId *

Custom Query Parameters

Custom Headers

Deletes a associations.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

groupId *: integer

API Manager API group id (integer; not Exchange Maven groupId).

min: 0, max: 2147483647

Related Operations:

api-manager#listOrganizationsGroups.$.id exchange-experience#getAssetsSearch.$[*].groupId runtime-fabric#getOrganizationsByOrganizationidGroups.$[*].id

associationId *: string

The association ID to identify the target resource.

Response

Successful operation.

Delete organization Runtime Fabric data deleteOrganization

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Deletes a organizations.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Custom Headers

Retrieve short-lived credential to allow pulling Runtime Fabric Docker images

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

user *: string

Username for pulling Runtime Fabric Docker images

password: string

Password for pulling Runtime Fabric Docker images

endpoint *: string

Url of the image registry.

passwordExpirationTimestamp *: number

Password expiration timestamp

Examples

application/json

{ "user": "string", "password": "string", "endpoint": "string", "passwordExpirationTimestamp": 0.0 }

Get image registry properties getImageRegistryProperties

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Retrieve properties related to the image registry.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

RTF_IMAGE_REGISTRY_ENDPOINT *: string

The auth proxy url of the image registry for pulling Runtime Fabric Docker images.

RTF_IMAGE_REGISTRY_USER: string

The auth proxy username for pulling Runtime Fabric Docker images.

RTF_IMAGE_REGISTRY_PASSWORD: string

The auth proxy password for pulling Runtime Fabric Docker images.

Examples

application/json

{ "RTF_IMAGE_REGISTRY_ENDPOINT": "https://registry.example.com", "RTF_IMAGE_REGISTRY_USER": "string", "RTF_IMAGE_REGISTRY_PASSWORD": "string" }

Get agent manifest getAgentManifest

GET

Try it out

Path Parameters

version *

Custom Query Parameters

Custom Headers

Retrieve the agent manifest holding the dependency information a specific agent version uses for BYOK installations.

Path Parameters

version *: string

The agent release version to identify the target manifest.

Response

json

Successful operation.

agentVersion *: string

The version of the agent.

dependencies *: array

Lists the dependencies of the agent.

Examples

application/json

{ "agentVersion": "string", "dependencies": [ { "artifact": "string", "version": "string", "provider": "Generic" } ] }

List runtime support dates listRuntimeSupportDates

GET

Try it out

Custom Query Parameters

Custom Headers

List the support dates for the Mule runtime versions.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "version": "string", "channel": "string", "endOfStandardSupportDate": 0.0, "endOfExtendedSupportDate": 0.0, "endOfLifeSupportDate": 0.0 } ]

List supported Mule runtime versions listRuntimes

GET

Try it out

Query Parameters

search *

recommended *

Custom Query Parameters

Custom Headers

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

Query Parameters

search *: string

Search or filter expression to narrow results.

recommended *: boolean

The recommended query parameter.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get Mule runtime by name getRuntime

GET

Try it out

Path Parameters

name *

Custom Query Parameters

Custom Headers

Retrieve a single name

Path Parameters

name *: string

The name to identify the target resource.

Response

json

Successful operation.

name: string

recommended: boolean

endOfSupportDate: number

Examples

application/json

{ "name": "string", "recommended": true, "endOfSupportDate": 0.0 }

List tags for a runtime listRuntimeTags

GET

Try it out

Path Parameters

name *

Custom Query Parameters

Custom Headers

Retrieves tags for a name

Path Parameters

name *: string

The name to identify the target resource.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get runtime tag by ID getRuntimeTag

GET

Try it out

Path Parameters

name *

tagId *

Custom Query Parameters

Custom Headers

Retrieve a single name for a name

Path Parameters

name *: string

The name to identify the target resource.

tagId *: string

The tag ID to identify the target resource.

Response

json

Successful operation.

name: string

releaseDate: number

scope: array

minRtfVersion: string

gracePeriodDays: number

Examples

application/json

{ "name": "string", "releaseDate": 0.0, "scope": [ "string" ], "minRtfVersion": "string", "gracePeriodDays": 0.0 }

List available downloads getDownloads

GET

Try it out

Custom Query Parameters

Custom Headers

List the available downloads

Response

json

Successful operation.

agent *: object

scripts *: object

package *: object

rtfctl *: object

Examples

application/json

{ "agent": { "id": "string", "type": "string" }, "scripts": { "id": "string", "type": "string" }, "package": { "id": "string", "type": "string" }, "rtfctl": { "id": "string", "type": "string" } }

Download latest installer scripts getDownloadScriptsLatest

GET

Try it out

Custom Query Parameters

Custom Headers

json

Successful operation.

url *: string

Examples

application/json

{ "url": "string" }

Download latest agent helm chart getDownloadAgentLatest

GET

Try it out

Custom Query Parameters

Custom Headers

Download the latest rtf agent helm chart

Response

Successful operation.

Download latest rtfctl binary getDownloadRtfctlLatest

GET

Try it out

Custom Query Parameters

Custom Headers

Download the latest rtfctl binary

Response

Successful operation.

Overview

Servers

Authentication & Security

List Runtime Fabrics listFabrics

Try it out

Response

Path Parameters

Response

Register a Runtime Fabric registerFabric

Try it out

Response

Path Parameters

Request Body

Response

Get Runtime Fabric by ID getFabric

Try it out

Response

Path Parameters

Query Parameters

Response

Update Runtime Fabric updateFabric

Try it out

Response

Path Parameters

Request Body

Response

Delete Runtime Fabric deleteFabric

Try it out

Response

Path Parameters

Query Parameters

Response

Get log forwarding configuration getFabricLogForwarding

Try it out

Response

Path Parameters

Response

Update log forwarding configuration updateFabricLogForwarding

Try it out

Response

Path Parameters

Request Body

Response

Delete log forwarding configuration deleteFabricLogForwarding

Try it out

Response

Path Parameters

Response

Configure external log forwarding updateExternalLogForwarding

Try it out

Response

Path Parameters

Request Body

Response

Delete external log forwarding deleteExternalLogForwarding

Try it out

Response

Path Parameters

Response

Test external log forwarding delivery testExternalLogForwarding

Try it out

Response

Path Parameters

Response

List Runtime Fabric cluster events listFabricEvents

Try it out

Response

Path Parameters

Response

Get Runtime Fabric health getFabricHealth

Try it out

Response

Path Parameters

Response

Get OIDC issuers getFabricOidcIssuers

Try it out

Response

Path Parameters

Response