API Manager plugin
npm install anypoint-cli-api-manager-pluginanypoint-cli-api-mgr-plugin
===========================
API Manager plugin
* Usage
* Local development
* or npm run build
* node bin/run command --parameters
* example
* npm run buildAndRun --
* example:
* Commands
sh-session
$ npm install -g @mulesoft/anypoint-cli-api-mgr-plugin
$ @mulesoft/anypoint-cli-api-mgr-plugin COMMAND
running command...
$ @mulesoft/anypoint-cli-api-mgr-plugin (--version|-v)
@mulesoft/anypoint-cli-api-mgr-plugin/0.4.0 darwin-x64 node-v16.14.2
$ @mulesoft/anypoint-cli-api-mgr-plugin --help [COMMAND]
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin COMMAND
...
`
Local development
You can run the commands directly from your copy without installing it.First of all install dependencies:
sh-session
npm ci
`Then you need to build the plugin from the sources:
sh-session
npm run dev
or npm run build
`
Please note that you will need to re-build to see your changes working.Now you can run your commands calling:
sh-session
node bin/run command --parameters
example
node bin/run api-mgr:api:list --username 'username' --password 'password' --environment 'Sandbox' --host qax.anypoint.mulesoft.com
`Please note that
is only mandatory if you want to hit other environments that are not PROD US.You can improve the experience export some env vars to not provide the same parameters in each command
`sh-session
export ANYPOINT_ENV='Sandbox'
export ANYPOINT_USERNAME='username'
export ANYPOINT_PASSWORD='password'
export ANYPOINT_HOST='qax.anypoint.mulesoft.com'
node bin/run api-mgr:api:list
`For each command you can export other env vars, check Commands section to see each one.
Please note that in current state of the development running the tests with envar
will cause a lot of fails, it seems the nocks are based on the default uri and the tests are using the env var causing calls to a different URIs.Re-build on run
There is a npm command that allow us to re-build the code each time we want to run a command, it's the current easiest way of be sure that the running code is the latest.You can run your commands calling:
`sh-session
npm run buildAndRun -- -- extraParameters
example:
npm run buildAndRun -- api-mgr:api:list --host stgx.anypoint.mulesoft.com
`
Please note that to make it work you need to add before the command you want to run.Enable debug with source maps
The default configuration of tsconfig.json and tsconfig.lib.json doesn't create the source maps to debug typescript files.In order to enable sourcemaps you need to add the
"sourceMap": true property to both files.Example:
`typescript
{
"compilerOptions": {
"declaration": true,
"importHelpers": true,
"module": "commonjs",
"outDir": "lib",
"rootDir": "src",
"strict": true,
"target": "es2019",
"useUnknownInCatchVariables": false,
"skipLibCheck": true,
"sourceMap": true
},
"include": [
"src/*/"
]
}
`Tests
Please be sure that
is not set. You can run unset ANYPOINT_HOST to clean that env var. Then you can use the command npm run test to run all the tests.$3
The command npm run test run all the tests, and will fail if there is a .only in one of your test files. It will also run a linter.If you want a fast feedback about your changes you can use the command
npm run localTest it allows .only on your test files and won't run the linter.
Commands
* @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:abstract-api-mgr-command
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* [](#mulesoftanypoint-cli-api-mgr-plugin-api-mgrapimanage-assetid-assetversion-groupid)
* @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:promote APIINSTANCEID SOURCEENVID
*
*
*
*
*
*
*
* [](#mulesoftanypoint-cli-api-mgr-plugin-api-mgrcontractlist-apiinstanceid-searchtext)
* @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:policy:apply APIINSTANCEID POLICYID
*
*
*
*
* [](#mulesoftanypoint-cli-api-mgr-plugin-api-mgrpolicylist-apiinstanceid)
* [@mulesoft/anypoint-cli-api-mgr-plugin api-mgr:policy:order APIINSTANCEID [ORDER]](#mulesoftanypoint-cli-api-mgr-plugin-api-mgrpolicyorder-apiinstanceid-order)
* @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:policy:remove APIINSTANCEID POLICYID
*
*
*
* [](#mulesoftanypoint-cli-api-mgr-plugin-api-mgrtierlist-apiinstanceid-searchtext)
* @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:upstream:add APIINSTANCEID URI
*
*
*
*
* [](#mulesoftanypoint-cli-api-mgr-plugin-conf-key-value)
* [@mulesoft/anypoint-cli-api-mgr-plugin help [COMMAND]](#mulesoftanypoint-cli-api-mgr-plugin-help-command)
* @mulesoft/anypoint-cli-api-mgr-plugin version
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:abstract-api-mgr-command [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-o ]FLAGS
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
_See code: src/commands/api-mgr/abstract-api-mgr-command.ts_
Create API instance alert
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:abstract-alert-add [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-o ]FLAGS
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Create API instance alert
_See code: src/commands/api-mgr/alert/abstract-alert-add.ts_
List alerts for an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:abstract-alert-list [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [--limit ] [--offset ] [--sort ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--limit= [default: 10] Number of results to retrieve
--offset= Offset
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--sort= [default: id] Field to sort results
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
List alerts for an API instance
_See code: src/commands/api-mgr/alert/abstract-alert-list.ts_
Create API instance alert
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:add [APIINSTANCEID] [NAME] --severity info|warning|critical
--type request-count|response-code|policy-violation|response-time --operator eq|ab|abeq|bleq|bl --threshold
--periods [--password [--username | --client_id | ]] [--client_secret ]
[--bearer | | ] [--organization ] [--environment ] [--host ] [--collectMetrics] [-o
] [-h] [--recipient ] [--email ] [--responseTime ] [--responseCode ] [--policyId
] [--subject ] [--message ]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--email=... Email to send alert notification to. Can be used multiple times to specify multiple
emails
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--message= Message of the alert notification
--operator=
DESCRIPTION
Create API instance alert
_See code: src/commands/api-mgr/alert/add.ts_
Create API instance alert
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:add-legacy [APIINSTANCEID] [NAME] --severity Info|Warning|Critical
--type request-count|response-code|policy-violation|response-time --operator gt|lt|eq --threshold --periods
--duration --durationUnit days|hours|minutes [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-o ] [-h] [--enabled] [--recipient ] [--email ]
[--responseTime ] [--responseCode ] [--policyId ]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--duration= (required) Condition occurrence period duration
--durationUnit=
DESCRIPTION
Create API instance alert
_See code: src/commands/api-mgr/alert/add-legacy.ts_
List alerts for an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:list [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [--limit ] [--offset ] [--sort ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--limit= [default: 10] Number of results to retrieve
--offset= Offset
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--sort= [default: id] Field to sort results
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
List alerts for an API instance
_See code: src/commands/api-mgr/alert/list.ts_
List alerts for an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:alert:list-legacy [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [--limit ] [--offset ] [--sort ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--limit= [default: 10] Number of results to retrieve
--offset= Offset
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--sort= [default: id] Field to sort results
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
List alerts for an API instance
_See code: src/commands/api-mgr/alert/list-legacy.ts_
Show details of an API autodiscovery
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:autodiscovery [APIINSTANCEID] [GATEWAYVERSION] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Show details of an API autodiscovery
_See code: src/commands/api-mgr/api/autodiscovery.ts_
Change asset version for an API instance by choosing a new version from Exchange
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:change-specification [APIINSTANCEID] [ASSETVERSION] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Change asset version for an API instance by choosing a new version from Exchange
_See code: src/commands/api-mgr/api/change-specification.ts_
Classify an API instance in a given environment
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:classify [DESTENVNAME] [APIINSTANCEID] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Classify an API instance in a given environment
_See code: src/commands/api-mgr/api/classify.ts_
Deletes an API
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:delete [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Deletes an API
_See code: src/commands/api-mgr/api/delete.ts_
Deploy an API to Cloudhub, Hybrid server or Runtime Fabric
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:deploy [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [--target ] [--applicationName ]
[--environmentName ] [--gatewayVersion ] [--overwrite] [--javaVersion ] [--releaseChannel
]FLAGS
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--applicationName= Application name
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--environmentName= Target environment name. Must be provided to deploy APIs from unclassified environments.
--gatewayVersion= Cloudhub Gateway version
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--javaVersion= Gateway java version
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--overwrite Update application if exists
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--releaseChannel= Gateway release channel
--target= Hybrid or RTF deployment target ID
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Deploy an API to Cloudhub, Hybrid server or Runtime Fabric
_See code: src/commands/api-mgr/api/deploy.ts_
Deprecate an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:deprecate [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Deprecate an API instance
_See code: src/commands/api-mgr/api/deprecate.ts_
Show details of an API
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:describe [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Show details of an API
_See code: src/commands/api-mgr/api/describe.ts_
Download API proxy zip file to a local directory
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:download-proxy [APIINSTANCEID] [TARGETPATH] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-h] [--gatewayVersion ]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--gatewayVersion= Gateway Version. Defaults to the latest version.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Download API proxy zip file to a local directory
_See code: src/commands/api-mgr/api/download-proxy.ts_
Edit an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:edit [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [-p] [-r] [-m] [--deploymentType
cloudhub|cloudhub2|hybrid|rtf] [--uri ] [--scheme http|https] [--port ] [--path ] [--providerId
] [--responseTimeout ] [--apiInstanceLabel ] [--serviceName ] [--serviceNamespace
] [--servicePort ] [--endpointUri ] [--type http|raml|wsdl|mcp|a2a|llm|grpc] [-f]
[--inboundSecretGroupId --inboundTlsContextId ] [--outboundSecretGroupId
--outboundTlsContextId ] [--routing ] [--updateApisInSamePort]FLAGS
-f, --isFlex Indicates whether you are managing this API in FlexGateway.
-m, --muleVersion4OrAbove Indicates whether you are managing this API in Mule 4 or above.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
-p, --withProxy Indicates whether the endpoint should use a proxy.
-r, --referencesUserDomain Indicates whether a proxy should reference a user domain
--apiInstanceLabel= API instance label. Optional. String.
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment
variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--deploymentType=
DESCRIPTION
Edit an API instance
_See code: src/commands/api-mgr/api/edit.ts_
Lists all APIs in API Manager
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:list [--password [--username | --client_id
| ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment ]
[--host ] [--collectMetrics] [-o ] [--limit ] [--offset ] [--sort ] [-h]
[--assetId ] [--apiVersion ] [--instanceLabel ]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--apiVersion= API version to filter results by
--assetId= Asset ID to filter results by
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--instanceLabel= API instance label to filter results by
--limit= [default: 10] Number of results to retrieve
--offset= Offset
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--sort= How to sort the results
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Lists all APIs in API Manager
_See code: src/commands/api-mgr/api/list.ts_
Manage a new API or API version or new instance with an asset from exchange. When [groupId] param is not specified the current organization is used.
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:manage [ASSETID] [ASSETVERSION] [GROUPID] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-p] [-r] [-m] [--deploymentType
cloudhub|cloudhub2|hybrid|rtf] [--uri ] [--scheme http|https] [--port ] [--path ] [--providerId
] [--responseTimeout ] [--apiInstanceLabel ] [--serviceName ] [--serviceNamespace
] [--servicePort ] [--endpointUri ] [--type http|raml|wsdl|mcp|a2a|llm|grpc] [-f]
[--inboundSecretGroupId --inboundTlsContextId ] [--outboundSecretGroupId
--outboundTlsContextId ] [--routing ]FLAGS
-f, --isFlex Indicates whether you are managing this API in FlexGateway.
-m, --muleVersion4OrAbove Indicates whether you are managing this API in Mule 4 or above.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
-p, --withProxy Indicates whether the endpoint should use a proxy.
-r, --referencesUserDomain Indicates whether a proxy should reference a user domain
--apiInstanceLabel= API instance label. Optional. String.
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment
variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--deploymentType=
DESCRIPTION
Manage a new API or API version or new instance with an asset from exchange. When [groupId] param is not specified the
current organization is used.
_See code: src/commands/api-mgr/api/manage.ts_
Promote an API instance from source environment
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:promote [APIINSTANCEID] [SOURCEENVID] [--password
[--username | --client_id | ]] [--client_secret ] [--bearer | | ] [--organization
] [--environment ] [--host ] [--collectMetrics] [-o ] [-h] [-a true|false] [-p
true|false] [-t true|false] [--providerId ]FLAGS
-a, --copyAlerts=
DESCRIPTION
Promote an API instance from source environment
_See code: src/commands/api-mgr/api/promote.ts_
Deploy an API to Cloudhub, Hybrid server or Runtime Fabric
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:redeploy [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [--target ] [--applicationName ]
[--environmentName ] [--gatewayVersion ] [--overwrite] [--javaVersion ] [--releaseChannel
]FLAGS
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--applicationName= Application name
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--environmentName= Target environment name. Must be provided to deploy APIs from unclassified environments.
--gatewayVersion= Cloudhub Gateway version
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--javaVersion= Gateway java version
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--overwrite Update application if exists
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--releaseChannel= Gateway release channel
--target= Hybrid or RTF deployment target ID
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Deploy an API to Cloudhub, Hybrid server or Runtime Fabric
_See code: src/commands/api-mgr/api/redeploy.ts_
Undeprecate an API instance
USAGE
$ @mulesoft/anypoint-cli-api-mgr-plugin api-mgr:api:undeprecate [APIINSTANCEID] [--password [--username |
--client_id | ]] [--client_secret ] [--bearer | | ] [--organization ] [--environment
] [--host ] [--collectMetrics] [-o ] [-h]FLAGS
-h, --help Show CLI help.
-o, --output= [default: table] Format for commands output. Supported values are table (default) and
json
--bearer= Token Bearer. You can define this in the ANYPOINT_BEARER environment variable.
--client_id= Client ID. You can define this in the ANYPOINT_CLIENT_ID environment variable.
--client_secret= Client Secret. You can define this in the ANYPOINT_CLIENT_SECRET environment variable.
--[no-]collectMetrics collect metrics. You can define this in the COLLECT_METRICS environment variable.
--environment= Environment Name. You can define this in the ANYPOINT_ENV environment variable.
--host=anypoint.mulesoft.com [default: anypoint.mulesoft.com] Host URL. You can define this in the ANYPOINT_HOST
environment variable.
--organization= Organization Name. You can define this in the ANYPOINT_ORG environment variable.
--password= Password. You can define this in the ANYPOINT_PASSWORD environment variable.
--username= Username. You can define this in the ANYPOINT_USERNAME environment variable.
DESCRIPTION
Undeprecate an API instance
_See code: src/commands/api-mgr/api/undeprecate.ts_
Add an owner to a client application