CLI for API Manager

--duration

Condition occurrence period duration.

--duration 60

--durationUnit

Condition occurrence period duration unit.
Supported values: days, hours, and minutes.

--durationUnit minutes

--email

Email to send alert notification to.
Pass this flag multiple times to specify multiple emails.

--email example@mulesoft.com

--enabled

Sets whether the alert is enabled. Include the flag to enable the alert.

--enabled

--operator

Condition operator that explains values in relation to threshold.
Supported values: gt, lt, eq.

--operator gt

--output

Specifies the response format, supported values are table (default) and json

--output json

--periods

Number of consecutive periods condition should occur for.

--periods 34

--policyId

ID of a policy applied to the API instance that triggers a policy-violation alert type.

--policyId http-basic-authentication

--recipient

Username to send alert notification to.
Pass this flag multiple times to specify multiple usernames.

--recipient mulesoftuser

--responseCode

Response codes to trigger response-code alert type.
Pass this flag multiple times to specify multiple codes.

--responseCode 400

--responseTime

Response time to trigger response-time alert type.

--responseTime 60

--severity

Alert severity.
Supported values: Info, Warning, Critical.

--severity Critical

--threshold

Condition occurrences threshold number.

--threshold 3

--type

Alert type/condition.
Supported values: request-count, response-code, policy-violation, response-time

--type response-code

--limit

Number of results to retrieve, default is 10 results

--limit 5

--offset

Offsets the amount of APIs passed

--offset 3

--output

Specifies the response format
Supported values are table (default) and json

--output json

--sort

Sorts the results in the field name passed
Supported values are: id, name, createdDate, and updatedDate

--sort name

--gatewayVersion

Specifies the gateway version to download

--gatewayVersion 4.0.1 643404 /tmp/

--output

Specifies the response format
Supported values are table (default) and json

--output table

--applicationName

Application name

--applicationName myMuleApp 643404

--environmentName

Target environment name, only for when deploying API instances from unclassified environments

--environmentName TestEnv 643404

--gatewayVersion

The CloudHub Gateway version

--gatewayVersion: 9.9.9.9 643404

--javaVersion

Gateway Java version
This flag only works if the target flag was set as RTF, CH, or CH2

--javaVersion 17 643404

--releaseChannel

Set the name of the release channel to be used for the selected Mule version. + Supported values are NONE, EDGE, and LTS
This flag only works if the target flag was set as RTF, CH, or CH2

--releaseChannel EDGE 643404

--overwrite

Update application if it exists
Include the flag to enable it

--overwrite

--output

Specifies the response format, supported values are table (default) and json

--output json

--target

Hybrid, RTF, CH, or CH2 deployment target ID

--target 1598794 643404

-f, --isFlex

Indicates whether this is a Flex Gateway API instance.
Include the flag to enable it

--isFlex

-m, --muleVersion4OrAbove

Indicates whether this is a Mule 4 API instance.
Include the flag to enable it

--muleVersionOrAbove

-p, --withProxy

Indicates whether the endpoint should use a proxy.
Include the flag to enable it

--withProxy

-r, --referencesUserDomain

Indicates whether a proxy should reference a user domain.
Include the flag to enable it

--referencesUserDomain

--apiInstanceLabel

API instance label

--apiInstanceLabel exampleLabel

--deploymentType

Deployment type
Options: cloudhub, hybrid, rtf (required)

--deploymentType cloudhub

--endpointUri

Consumer endpoint URI (required)

--endpointUri /udp://localhost:65432

--inboundSecretGroupId

Inbound secret group ID

--inboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--inboundTlsContextId

Outbound TLS Context ID
Supply the --inboundSecretGroupId of the TLS Context’s secret group. To remove a TLS Context, apply the flag with the following value: --inboundTlsContextId "null".

--inboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--outboundSecretGroupId

Outbound secret group ID.

--outboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--outboundTlsContextId

Outbound TLS Context ID.
Supply the --outboundSecretGroupId of the TLS Context’s secret group. To remove a TLS Context, apply the flag with the following value: --outboundTlsContextId "null".

--outboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--output

Specifies the response format, supported values are table (default) and json

--output json

--path

Proxy path (required)

--path /http://localhost:3000

--port

Proxy port (required)

--port 8080

--providerId

Client Identity Provider Id that the API is associated with
Default is Anypoint Platform Client Provider

--providerId 1787c36ab544466698e380131040faad

--responseTimeout

Maximum response timeout(required)

--responseTimeout 10

--routing

Configure upstream service

--routing 50e8400-e29b-41d4-a716-446655440000

--scheme

Proxy scheme (required)
Supported values: http, https.

--scheme http

--serviceName

WSDL service name
Flex Gateway does not support this flag

--serviceName ExampleServerName

--serviceNamespace

WSDL service namespace. Flex Gateway does not support this flag.

--serviceNamespace exampleServiceName

--servicePort

WSDL service port
Flex Gateway does not support this flag

--servicePort 443

--updateApisInSamePort

Updates the TLS context of API instances sharing the port of this API.

--updateApisInSamePort

--uri

Implementation URI.

--uri /udp://localhost:65432

--apiVersion

API version that filters results

--apiVersion 1.0.2

--assetId

Asset ID that filters results

--assetId ([group_id]/)<asset_id>/<version>

--instanceLabel

API instance label that filters results

--instanceLabel exampleLabel

--limit

Number of results to retrieve

--limit 50

--offset

Offsets the amount of APIs passed

--offset 3

--output

Specifies the response format, supported values are table (default) and json

--output json

--sort

Sorts the results in the field name passed
Supported values are: id, name, createdDate, and updatedDate

--sort updatedDate

-f, --isFlex

Indicates whether this is a Flex Gateway API instance.
Include the flag to enable it

--isFlex

-m, --muleVersion4OrAbove

Indicates whether this is a Mule 4 API instance.
Include the flag to enable it

--muleVersionOrAbove

-p, --withProxy

Indicates whether the endpoint should use a proxy.
Include the flag to enable it

--withProxy

-r, --referencesUserDomain

Indicates whether a proxy should reference a user domain.
Include the flag to enable it

--referencesUserDomain

`--apiInstanceLabel `

API instance label

--apiInstanceLabel exampleLabel

--deploymentType

Deployment type
Options: cloudhub2, cloudhub, hybrid, rtf (required)

--deploymentType hybrid

--endpointUri

Consumer endpoint URI (required)

--endpointUri /udp://localhost:65432

--inboundSecretGroupId

Inbound secret group ID

--inboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--inboundTlsContextId

Outbound TLS Context ID
Supply the --inboundSecretGroupId of the TLS Context’s secret group. To remove a TLS Context, apply the flag with the following value: --inboundTlsContextId "null".

--inboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--outboundSecretGroupId

Outbound secret group ID.

--outboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--outboundTlsContextId

Outbound TLS Context ID.
Supply the --outboundSecretGroupId of the TLS Context’s secret group. To remove a TLS Context, apply the flag with the following value: --outboundTlsContextId "null".

--outboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--output

Specifies the response format, supported values are table (default) and json

--output json

--path

Proxy path (required)

--path /http://localhost:3000

--port

Proxy port (required)

--port 8080

--providerId

Client Identity Provider Id that the API is associated with
Default is Anypoint Platform Client Provider

--providerId 1787c36ab544466698e380131040faad

--responseTimeout

Maximum response timeout(required)

--responseTimeout 10

--scheme

Proxy scheme (required)
Supported values: http, https.

--scheme http

--serviceName

WSDL service name
Flex Gateway does not support this flag

--serviceName ExampleServerName

--serviceNamespace

WSDL service namespace. Flex Gateway does not support this flag.

--serviceNamespace exampleServiceName

--servicePort

WSDL service port
Flex Gateway does not support this flag

--servicePort 443

--type

Endpoint type
Supported options: http, raml, wsdl

--type http

--uri

Implementation URI

--uri /udp://localhost:65432

-a, --copyAlerts

Indicates whether to copy alerts
Include the flag to enable it

--copyAlerts

-p, --copyPolicies

Indicates whether to copy policies
Include the flag to enable it

--copyPolicies

-t, --copyTiers

Indicates whether to copy tiers
Include the flag to enable it

--copyTiers

--output

Specifies the response format, supported values are table (default) and json

--output json

--providerId

Indicates the provider’s ID associated with the API.

--providerId 1787c36ab544466698e380131040faad

--applicationName

Application name

--applicationName Muleapp 643404

--environmentName

Target environment name
Include to redeploy APIs from unclassified environments

--environmentName mulesoftEnvironment 643404

--gatewayVersion

CloudHub Gateway version

--gatewayVersion 9.9.9 643404

--javaVersion

Gateway Java version
This flag only works if the target flag was set as RTF, CH, or CH2

--javaVersion 17 643404

--overwrite

Update application if it exists
Include the flag to enable it

--overwrite

--output

Specifies the response format, supported values are table (default) and json

--output json

--releaseChannel

Set the name of the release channel to be used for the selected Mule version. + Supported values are NONE, EDGE, and LTS
This flag only works if the target flag was set as RTF, CH, or CH2

--releaseChannel EDGE 643404

--target

Hybrid, RTF, CH, or CH2 deployment target ID

--target 1598794 643404

--limit

Number of results to retrieve

--limit 2

--offset

Offsets the amount of APIs passed

--offset 3

--output

Specifies the response format, supported values are table (default) and json

--output json

--sort

Sorts the contracts by the criteria associated with their client applications
Supported values are: id, name, createdDate, and updatedDate

--sort id

-c, --config

Pass the configuration data as a JSON string

--config '{\"username\":\"user\",\"password\":\"teste\"}'

--configFile

Pass the configuration data as a file

--configFile ./config.json

--groupId

Mule 4 policy group ID
This value defaults to the MuleSoft group ID.

--groupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--output

Specifies the response format, supported values are table (default) and json

--output json

-p, --pointcut [dataJSON]

Pass pointcut data as JSON strings

--pointcut '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'

--policyVersion

Mule 4 policy version.

--policyVersion 1.0.2

--upstreamId

Configure upstream

--upstreamId 550e8400-e29b-41d4-a716-446655440000

--groupId

Mule 4 policy group ID

+ Defaults to the MuleSoft group ID.

--groupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--policyVersion

Mule 4 policy version

--policyVersion 1.0.2

--output

Specifies the response format
Supported values are table (default) and json.

--output json

-c, --config

Pass the configuration data as a JSON string

--config '{\"username\":\"user\",\"password\":\"teste\"}'

--configFile

Pass the configuration data as a file

--configFile ./config.json

--output

Specifies the response format, supported values are table (default) and json

--output json

-p, --pointcut

Pass pointcut data as JSON strings

-p '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'

-a, --autoApprove

Indicates whether the SAL tier should be auto-approved
Include the flag to enable it

--autoApprove

--name

Tier name

--name muleSLAtier

--description

Tier description

--description tier example description

-l, --limit

Single instance of an SLA tier limit in the form --limit A,B,C where:

--limit true,100,min

--output

Specifies the response format, supported values are table (default) and json

--output json

--limit

Number of results to retrieve

--limit 2

--offset

Offsets the amount of APIs passed

--offset 3

--output

Specifies the response format, supported values are table (default) and json

--output json

--sort

Sorts the results in the field name passed
Supported values are: id, name, createdDate, and updatedDate

--sort id