MQ SaaS

Introduction IBM® MQ is an enterprise grade messaging middleware service that gives independent and potentially non-concurrent applications secure messaging capabilities, such as point-to-point and publish/subscribe models. IBM MQ on IBM Cloud enables you to quickly and easily deploy queue managers in the cloud and connect your applications to them, providing reliable data transfer between different parts of your enterprise application landscape. Use the MQ on Cloud API to Get, Create, Delete and Configure MQ resources. Queue manager, User, App and Certificate interfaces enable convenient programmatic control of MQ on Cloud resource lifecycles and day two operations. For more information about how to use MQ on Cloud, see: Getting startedhttps://cloud.ibm.com/docs/mqcloud?topic=mqcloud-gettingstarted. Note: API access is restricted to users of the reserved deployment plan. SDK language support The MQ on Cloud API currently supports only Go. The SDK is available at the following repository | Language | Repository | |-|-| | Go | https://github.com/IBM/mqcloud-go-sdk | Installing the Go SDK Go modules recommended: Add the following import in your code, and then run go build or go mod tidy go import "github.com/IBM/mqcloud-go-sdk/mqcloudv1" Go get bash go get -u github.com/IBM/mqcloud-go-sdk/mqcloudv1 View on GitHub https://github.com/IBM/mqcloud-go-sdkhttps://github.com/IBM/mqcloud-go-sdk Endpoint URLs The base URLs for MQ on IBM Cloud API endpoints are specific to the region of your Service Instance. For example: bash https://api.private.

MethodPathSummary
GET/v1/{service_instance_guid}/usageGet the usage details
GET/v1/{service_instance_guid}/optionsReturn configuration options (eg, available deployment locations, queue manager sizes)
POST/v1/{service_instance_guid}/queue_managersCreate a new queue manager
GET/v1/{service_instance_guid}/queue_managersGet list of queue managers
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}Get details of a queue manager
DELETE/v1/{service_instance_guid}/queue_managers/{queue_manager_id}Delete a queue manager
PUT/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/versionUpgrade a queue manager
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/available_versionsGet the list of available versions that this queue manager can be upgraded to
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/connection_infoGet connection information for a queue manager
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/statusGet the status of the queue manager
GET/v1/{service_instance_guid}/usersGet a list of users for an instance
POST/v1/{service_instance_guid}/usersAdd a user to an instance
GET/v1/{service_instance_guid}/users/{user_id}Get a user for an instance
DELETE/v1/{service_instance_guid}/users/{user_id}Delete a user for an instance
PATCH/v1/{service_instance_guid}/users/{user_id}Update the name for a user
GET/v1/{service_instance_guid}/applicationsGet a list of applications for an instance
POST/v1/{service_instance_guid}/applicationsAdd an application to an instance
GET/v1/{service_instance_guid}/applications/{application_id}Get an application for an instance
DELETE/v1/{service_instance_guid}/applications/{application_id}Delete an application from an instance
PATCH/v1/{service_instance_guid}/applications/{application_id}Update the name for an application
POST/v1/{service_instance_guid}/applications/{application_id}/api_keyCreate a new apikey for an application
POST/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_storeUpload a trust store certificate
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_storeList trust store certificates
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}Get a trust store certificate
DELETE/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}Delete a trust store certificate
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}/downloadDownload a queue manager's certificate from its trust store
POST/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_storeUpload a key store certificate
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_storeList key store certificates
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}Get a key store certificate for queue manager
DELETE/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}Delete a queue manager's key store certificate
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}/downloadDownload a queue manager's certificate from its key store
GET/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}/config/amsGet the AMS channels that are configured with this key store certificate
PUT/v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}/config/amsUpdate the AMS channels that are configured with this key store certificate
POST/v1/{service_instance_guid}/virtual_private_endpoint_gatewayCreate a new virtual private endpoint gateway
GET/v1/{service_instance_guid}/virtual_private_endpoint_gatewayGet a list of information for all virtual private endpoint gateways
GET/v1/{service_instance_guid}/virtual_private_endpoint_gateway/{virtual_private_endpoint_gateway_guid}Display the information for a specific virtual private endpoint gateway
DELETE/v1/{service_instance_guid}/virtual_private_endpoint_gateway/{virtual_private_endpoint_gateway_guid}Delete a specific virtual private endpoint gateway