Use the mqsipushapis command to create or update the definition of one or more deployed REST APIs on IBM® API Connect.
You can use the mqsipushapis command to push (export) the definition of one or more deployed REST APIs into IBM API Connect. If you want to push a single deployed REST API to IBM API Management Version 4, you can use the IBM Integration Toolkit, as described in Pushing a REST API to IBM API Management or IBM API Connect by using the IBM Integration Toolkit. Support for pushing multiple REST APIs is provided for IBM API Connect Version 5 and later.
You can use IBM API Connect to manage and publish APIs. It provides additional features such as monitoring and fine-grained control over access and workload management, such as the ability to control the number of requests per second for a given client application. IBM API Connect works in conjunction with an IBM DataPower® Gateway appliance; IBM API Connect pushes configuration to the IBM DataPower Gateway, which in turn proxies the requests back to the IBM Integration Bus integration server that hosts the deployed REST API.
>>-mqsipushapis-------------------------------------------------> >--| integrationNodeSpec |-- -e --integrationServerName---------> >-- -t --apiConnectHost-- -g --apiConnectPort-------------------> >-- -u --apiConnectUser-- -a --apiConnectPassword---------------> >-- -o --apiConnectOrganization-- -r --apiConnectProductTitle---> >-- -k --restAPIs--+--------------------------------+-----------> '- -c --apiConnectProductCatalog-' >--+-----------------------------+------------------------------> '- -d --apiConnectProductName-' >--+--------------------------------+---------------------------> '- -s --apiConnectProductVersion-' >--+----------------------------+-------------------------------> '- -x --httpInboundProxyHost-' >--+-----------------------------+--+---------------------+-----> '- -y --httpsInboundProxyHost-' '- -v --traceFileName-' >--+-------------------+--------------------------------------->< '- -w --timeoutSecs-' integrationNodeSpec |--+- integrationNodeName ---------+----------------------------| +- -n --integrationNodeFileName-+ +- -i --ipAddress-- -p --port---+ '-+- -i --ipAddress-+-----------' '- -p --port------'
Use this option if multiple users want to connect to the same integration node, or if you are using advanced connection parameters such as SSL. To learn more about creating and using a .broker file, see Connecting to an integration node by creating a .broker file.
If you want to run a command that uses SSL to administer a remote integration node over a secured channel, you must specify the keystore and truststore password for the connection that is using the IBM_JAVA_OPTIONS environment variable. For more information, see Resolving problems when running commands.
Use this option for connections to remote integration nodes that do not require advanced connection parameters.
If you are connecting to a remote integration node, you can additionally prefix integrationNodeName to explicitly set which integration node to connect to. You cannot use -n integrationNodeFileName in the same command.
Parameters that you omit assume default values:
If you want to connect to a secured integration server as a specific user, provide the security credentials as a URI in the following format: tcp://user:password@hostname. If your password contains URI Reserved characters, you must convert these characters to the percent-encoded format. For more information, see A correct URL and password returns error BIP1939 when you attempt to connect to a remote host name in Resolving problems when running commands.
Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.
mqsipushapis IBNODE -e default -t mysystem -g 443 -u testuser -a mypassword -o myOrg –c "MyCatalog" -r "MyProduct" –s 1.0.0 -k myapi
mqsipushapis IBNODE -e default -t mysystem -g 443 -u testuser -a mypassword -o myOrg –c "MyCatalog" -r "MyProduct" –d "ProdName" –s 2.0.0 -k myapi1:myapi2:myapi3