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 started.
Note: API access is restricted to users of the reserved deployment plan.
Endpoint URLs
The base URLs for MQ on IBM Cloud API endpoints are specific to the region of your Service Instance. For example:
https://api.private.<region>.mq2.cloud.ibm.com
For a list of regions and their short-names, see: Deployment Locations.
Authentication
To work with the API, authenticate your app or service by including your IBM Cloud IAM access token, and service instance GUID (ID) in API requests.
You can use the IBM Cloud CLI to quickly generate your personal Cloud IAM access token.
-
Log in to IBM Cloud with the IBM Cloud CLI.
ibmcloud login
If the login fails, run the
ibmcloud login --sso
command to try again. The--sso
parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time pass code. -
Select the account, region, and resource group that contain your provisioned instance of MQ on IBM Cloud.
-
Run the following command to retrieve your Cloud IAM access token.
ibmcloud iam oauth-tokens
The following truncated example shows a retrieved IAM token.
IAM token: Bearer eyJraWQiOiIyM...
To retrieve your Service Instance GUID:
Run the following command substituting in your Service Instance name here {service-instance-name}
and extract the value of the field guid
.
ibmcloud resource service-instance {service-instance-name} --output JSON
You can build your API request by pairing a service endpoint with your authentication credentials. For example, if you created a MQ on Cloud service instance for the eu-de
region, use the following endpoint and API headers to retrieve queue managers in your service instance:
curl -X GET \
-H "Accept: application/json" \
-H "Authorization: Bearer <access_token>" \
"https://api.private.eu-de.mq2.cloud.ibm.com/v1/<guid>/queue_managers"
Replace <access_token>
with your IBM Cloud IAM token, and <guid>
with the Service Instance GUID (ID) that identifies your MQ on Cloud service instance.
Auditing
You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker.
For more information about how to track MQ activity, see Activity Tracker events.
Error handling
This API uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that can't be resolved by the user. The following table describes the HTTP error codes.
HTTP Error Code | Description | Recovery |
---|---|---|
400 |
Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |
401 |
Unauthorized | You are not authorized to make this request. Log in to IBM Cloud to get an IAM token and try again. If this error persists, contact the account owner to check your permissions. |
404 |
Not Found | The requested resource could not be found or you do not have permission to discover the requested resource. If this error persists, contact the account owner to check your permissions. |
405 |
Method Not Allowed | The provided HTTP method is not supported by the endpoint. Review your chosen method against the API documentation. |
409 |
Conflict | A resource with this name already exists or is already in the requested state. For a new resource, choose a unique name. |
429 |
Too Many Requests | Overuse of the API. Inspect the response headers to find the retry-after time. |
500 |
Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. If this error persists, contact the support team. |
503 |
Service unavailable | MQ on Cloud is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |
Understanding error models
This API follows IBM Cloud API Handbook Errors standards, ensuring consistency across error models. Where possible, error responses will include information to assist in understanding the root cause of the error. For example:
{
"errors": [
{
"code": "bad_request",
"message": "Bad request for service instance 6b79b864-a049-4d9e-862d-99bc79759396, channel [CLOUD.APP.FAKE] is not configurable as an AMS channel for target queuemanager",
"more_info": "https://cloud.ibm.com/apidocs/mq-on-cloud#set-certificate-ams-channels",
"target": {
"type": "field",
"name": "channels"
}
}
],
"trace": "afe0399f-d99a-4723-a5f1-6deb1e8e1703",
"status_code": 400
}
At a minimum, the code
, message
, trace
and status_code
fields will be provided. If you need to raise a support ticket for an error, include these fields in the support ticket to enable timely debug and resolution. If more information is available, such as which field is incomplete, invalid or otherwise erroneous, the more_info
and target
fields will be populated to focus the user towards the problem area(s).
Pagination
Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:
/v1/{sid}/queue_managers
/v1/{sid}/users
/v1/{sid}/applications
The default page size is 25 objects. To use a different page size, use the limit
query parameter. The pagination strategy in use is limit and offset.
For any request that uses pagination, the response includes First
and where applicable Next
and Previous
objects containing URLs to make subsequent requests:
First
: The object containing the URL for requesting the first page of resultsNext
: The object containing the URL for requesting the next page of results. TheNext
field is omitted if there are no more resultsPrevious
: The object containing the URL for requesting the previous page. ThePrevious
field is omitted if the response is the first page (offset=0
)
These URLs retain the same limit
parameter that was used for the initial request.
Rate limiting
Rate limits for API requests are enforced on a per-server basis. If the number of requests to the server reaches the request limit within the specified time window, no further requests are accepted until the timer expires. After the timer expires, a new time window begins with the next accepted request.
The response to each HTTP request includes headers that you can use to determine whether you are close to the rate limit:
Retry-after
: The time to wait before trying the request again (in seconds)X-Ratelimit-Limit
: The total number of requests allowed within the time windowX-Ratelimit-Remaining
: The number of requests remaining in the current time windowX-Ratelimit-Reset
: The time the current timer expires (in UNIX epoch time)
HTTP status code 429
indicates that the rate limit has been exceeded.
Methods
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/usage'
Return configuration options (eg, available deployment locations, queue manager sizes)
Return configuration options (eg, available deployment locations, queue manager sizes).
GET /v1/{service_instance_guid}/options
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/options'
Response
Configuration options (eg, available deployment locations, queue manager sizes).
List of deployment locations.
Possible values: 1 ≤ number of items ≤ 20, 2 ≤ length ≤ 150, Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$
List of queue manager sizes.
Possible values: [
lite
,xsmall
,small
,medium
,large
]Possible values: 1 ≤ number of items ≤ 20
List of queue manager versions.
Possible values: 1 ≤ number of items ≤ 12
Status Code
Configuration options.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "locations": [ "ibmcloud_eu_de" ], "sizes": [ "xsmall", "small", "medium", "large" ], "versions": [ "9.3.3_1" ] }
Create a new queue manager
Create a new queue manager.
POST /v1/{service_instance_guid}/queue_managers
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Queue manager to add to the list.
The name of the queue manager - conforming to MQ rules.
Possible values: 1 ≤ length ≤ 48, Value must match regular expression
^[a-zA-Z0-9_.]*$
Example:
testqm
The locations in which the queue manager could be deployed.
Possible values: 2 ≤ length ≤ 150, Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$
Example:
reserved-eu-de-cluster-f884
The queue manager sizes of deployment available. Deployment of lite queue managers for aws_us_east_1 and aws_eu_west_1 locations is not available.
Allowable values: [
lite
,xsmall
,small
,medium
,large
]A displayable name for the queue manager - limited only in length.
Possible values: 0 ≤ length ≤ 150, Value must match regular expression
^.*$
Example:
A test queue manager
The IBM MQ version of the Queue Manager to deploy if not supplied the latest version will be deployed.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^[0-9]+.[0-9]+.[0-9]+_[0-9]+$
Example:
9.3.2_2
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "size": "small", "name": "qmtest", "display_name": "qmTest", "location": "ibmcloud_eu_de" }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers'
Response
A URI for status that can be queried periodically to get the status of the queue manager.
Uri for the details of the queue manager.
Uri for the status of the queue manager.
The queue manager id.
Status Code
Returns url to track progress of the queue manager deployment.
URI has permanently Moved
Bad Request
Unauthorized
Method not allowed
Conflict
Service Is Overused
Internal Server Error
Service Unavailable Error
{ "queue_manager_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers", "queue_manager_status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status", "queue_manager_id": "b8e1aeda078009cf3db74e90d5d42328" }
Get list of queue managers
Get a list of the queue manager summaries which exist in this service instance.
GET /v1/{service_instance_guid}/queue_managers
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Query Parameters
Pagination offset.
Possible values: 0 ≤ value ≤ 99999
Default:
0
The numbers of resources to return.
Possible values: 0 ≤ value ≤ 100
Default:
25
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers'
Response
A list of queue manager summaries.
Pagination offset.
Results per page, same for all collections.
Possible values: value ≤ 50
Link to first page of results.
List of queue managers.
Possible values: 0 ≤ number of items ≤ 50
Link to next page of results.
Link to previous page of results.
Status Code
An object containing a list of queue managers.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "offset": 25, "limit": 25, "first": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers?limit=25" }, "next": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers?offset=50&limit=25" }, "previous": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers?offset=25&limit=25" }, "queue_managers": [ { "id": "b8e1aeda078009cf3db74e90d5d42328", "name": "testqm", "display_name": "Test QM", "location": "ibmcloud_us_south", "size": "xsmall", "status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status", "version": "9.3.2_2", "web_console_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/console", "rest_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/messaging/qmgr/testqm/queues/<queue_name>/message", "administrator_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/admin/qmgr/testqm", "connection_info_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/connection_info", "date_created": "2023-07-19T14:46:05Z", "upgrade_available": false, "available_upgrade_versions_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/available_versions", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328" } ] }
Get details of a queue manager
Get the details of a given queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>'
Response
The details of the queue manager.
The ID of the queue manager which was allocated on creation, and can be used for delete calls.
A queue manager name conforming to MQ restrictions.
Possible values: 1 ≤ length ≤ 48, Value must match regular expression
^[a-zA-Z0-9._]*$
A displayable name for the queue manager - limited only in length.
Possible values: length ≤ 150
The locations in which the queue manager could be deployed.
Possible values: 2 ≤ length ≤ 150, Value must match regular expression
^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$
Example:
reserved-eu-de-cluster-f884
The queue manager sizes of deployment available. Deployment of lite queue managers for aws_us_east_1 and aws_eu_west_1 locations is not available.
Possible values: [
lite
,xsmall
,small
,medium
,large
]A reference uri to get deployment status of the queue manager.
The MQ version of the queue manager.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^[0-9]+.[0-9]+.[0-9]+_[0-9]+$
Example:
9.3.2_2
The url through which to access the web console for this queue manager.
The url through which to access REST APIs for this queue manager.
The url through which to access the Admin REST APIs for this queue manager.
The uri through which the CDDT for this queue manager can be obtained.
RFC3339 formatted UTC date for when the queue manager was created.
Example:
2020-01-13T15:39:35.000Z
Describes whether an upgrade is available for this queue manager.
Example:
true
The uri through which the available versions to upgrade to can be found for this queue manager.
The URL for this queue manager.
Status Code
Description of the queue manager.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "b8e1aeda078009cf3db74e90d5d42328", "name": "testqm", "display_name": "Test QM", "location": "ibmcloud_us_south", "size": "xsmall", "status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status", "version": "9.3.2_2", "web_console_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/console", "rest_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/messaging/qmgr/testqm/queues/<queue_name>/message", "administrator_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/admin/qmgr/testqm", "connection_info_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/connection_info", "date_created": "2023-07-19T14:46:05Z", "upgrade_available": false, "available_upgrade_versions_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/available_versions", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328" }
Delete a queue manager
Delete a queue manager.
DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X DELETE -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>'
Response
A URI for status that can be queried periodically to get the status of the queue manager.
Uri for the details of the queue manager.
Uri for the status of the queue manager.
The queue manager id.
Status Code
Returns url to track progress for delete queue manager.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "queue_manager_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers", "queue_manager_status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status", "queue_manager_id": "b8e1aeda078009cf3db74e90d5d42328" }
Upgrade a queue manager
Upgrade a queue manager.
PUT /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/version
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
Version to upgrade Queue Manager to.
The version upgrade to apply to the queue manager.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^[0-9]+.[0-9]+.[0-9]+_[0-9]+$
Example:
9.3.2_2
curl -X PUT -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "version": "9.3.2_2" }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/version'
Response
A URI for status that can be queried periodically to get the status of the queue manager.
Uri for the details of the queue manager.
Uri for the status of the queue manager.
The queue manager id.
Status Code
Returns url to track progress of the queue manager upgrade.
URI has permanently Moved
Bad Request
Unauthorized
Method not allowed
Conflict
Service Is Overused
Internal Server Error
Service Unavailable Error
{ "queue_manager_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers", "queue_manager_status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status", "queue_manager_id": "b8e1aeda078009cf3db74e90d5d42328" }
Get the list of available versions that this queue manager can be upgraded to
Get the list of available versions that this queue manager can be upgraded to.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/available_versions
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/available_versions'
Response
The list of available versions that this queue manger can upgrade to.
Total count of versions available.
The list of available versions that this queue manger can upgrade to.
Possible values: 0 ≤ number of items ≤ 12
Status Code
Returns information about the available versions that this queue manager can be upgraded to.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "total_count": 1, "versions": [ { "version": "9.3.2_2", "target_date": "2023-01-13T15:39:35.000Z" } ] }
Get connection information for a queue manager
Get connection information for a queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/connection_info
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/connection_info'
Response
Responds with JSON CCDT of the connection information for the queue manager.
A collection of channel connection details.
Possible values: 0 ≤ number of items ≤ 999999999
Status Code
Response of the connection information for the queue manager.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "channel": [ { "name": "CLOUD.ADMIN.SVRCONN", "clientConnection": { "connection": [ { "host": "myqm-fre.qm1.eu-de.mq2.cloud.ibm.com", "port": 30446 } ], "queueManager": "myqm" }, "transmissionSecurity": { "cipherSpecification": "ANY_TLS12_OR_HIGHER" }, "type": "clientConnection" } ] }
Get the status of the queue manager
Get the status of the queue manager instance.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/status
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/status'
Response
Queue manager status.
The deploying and failed states are not queue manager states, they are states which can occur when the request to deploy has been fired, or with that request has failed without producing a queue manager to have any state. The other states map to the queue manager states. State "ending" is either quiesing or ending immediately. State "ended" is either ended normally or endedimmediately. The others map one to one with queue manager states.
Possible values: [
initializing
,deploying
,starting
,running
,stopping
,stopped
,status_not_available
,deleting
,failed
,upgrading_version
,updating_revision
,initialization_failed
,restoring_queue_manager
,restoring_config
,restore_failed
,suspended
,resumable
]
Status Code
Current status for the queue manager.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "status": "running" }
Get a list of users for an instance
Get a list of users for an instance.
GET /v1/{service_instance_guid}/users
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Query Parameters
Pagination offset.
Possible values: 0 ≤ value ≤ 99999
Default:
0
The numbers of resources to return.
Possible values: 0 ≤ value ≤ 100
Default:
25
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/users'
Response
A list of user summaries.
Pagination offset.
Results per page, same for all collections.
Link to first page of results.
List of users.
Possible values: 0 ≤ number of items ≤ 50
Link to next page of results.
Link to previous page of results.
Status Code
Summary of the returned users.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "offset": 25, "limit": 25, "first": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?limit=25" }, "next": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?offset=50&limit=25" }, "previous": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?offset=25&limit=25" }, "users": [ { "id": "31a413dd84346effc8895b6ba4641641", "name": "t0scie98o57a", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "email": "user@example.com" } ] }
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
User to add to the list.
The email of the user to be created.
Possible values: 5 ≤ length ≤ 253
Example:
user@example.com
The shortname of the user to be created.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
Example:
t0scie98o57a
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "name": "testuser", "email": "testuser@ibm.com" }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/users'
Response
A summary of the user for use in a list of users.
The ID of the user which was allocated on creation, and can be used for delete calls.
The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
The email of the user.
Possible values: 5 ≤ length ≤ 253
The URL for the user details.
Status Code
Created User
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Conflict
Service Is Overused
Internal Server Error
{ "id": "31a413dd84346effc8895b6ba4641641", "name": "t0scie98o57a", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "email": "user@example.com" }
Get a user for an instance
Get a user for an instance.
GET /v1/{service_instance_guid}/users/{user_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the user.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
31a413dd84346effc8895b6ba4641641
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/users/<user_id>'
Response
A summary of the user for use in a list of users.
The ID of the user which was allocated on creation, and can be used for delete calls.
The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
The email of the user.
Possible values: 5 ≤ length ≤ 253
The URL for the user details.
Status Code
Description of the returned user.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "31a413dd84346effc8895b6ba4641641", "name": "t0scie98o57a", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "email": "user@example.com" }
Delete a user for an instance
Delete a user for an instance.
DELETE /v1/{service_instance_guid}/users/{user_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the user.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
31a413dd84346effc8895b6ba4641641
curl -X DELETE -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/users/<user_id>'
Get a list of applications for an instance
Get a list of applications for an instance.
GET /v1/{service_instance_guid}/applications
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Query Parameters
Pagination offset.
Possible values: 0 ≤ value ≤ 99999
Default:
0
The numbers of resources to return.
Possible values: 0 ≤ value ≤ 100
Default:
25
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/applications'
Response
A list of application summaries.
Pagination offset.
Results per page, same for all collections.
Possible values: value ≤ 50
Link to first page of results.
List of applications.
Possible values: 0 ≤ number of items ≤ 50
Link to next page of results.
Link to previous page of results.
Status Code
Summary of the returned applications.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "offset": 25, "limit": 25, "first": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?limit=25" }, "next": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?offset=50&limit=25" }, "previous": { "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?offset=25&limit=25" }, "applications": [ { "id": "0123456789ABCDEF0123456789ABCDEF", "name": "test-app", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "create_api_key_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641/api_key" } ] }
Add an application to an instance
Add an application to an instance.
POST /v1/{service_instance_guid}/applications
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Application to add to the list.
The name of the application - conforming to MQ rules.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
Example:
test-app
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "name": "test-app" }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/applications'
Response
A response to creating an application, giving the only chance to collect the apikey.
The ID of the application which was allocated on creation, and can be used for delete calls.
The name of the application - conforming to MQ rules.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
The URI to create a new apikey for the application.
The URL for this application.
The api key created.
The name of the api key.
The id of the api key.
Status Code
Created Application
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "0123456789ABCDEF0123456789ABCDEF", "name": "test-app", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "create_api_key_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641/api_key", "api_key_name": "MQ on Cloud API", "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636", "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc" }
Get an application for an instance
Get an application for an instance.
GET /v1/{service_instance_guid}/applications/{application_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the application.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
0123456789ABCDEF0123456789ABCDEF
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/applications/<application_id>'
Response
A summary of the application for use in a list of applications.
The ID of the application which was allocated on creation, and can be used for delete calls.
The name of the application - conforming to MQ rules.
Possible values: 1 ≤ length ≤ 12
The URI to create a new apikey for the application.
The URL for this application.
Status Code
Description of the returned application.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "0123456789ABCDEF0123456789ABCDEF", "name": "test-app", "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641", "create_api_key_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641/api_key" }
Delete an application from an instance
Delete an application from an instance.
DELETE /v1/{service_instance_guid}/applications/{application_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the application.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
0123456789ABCDEF0123456789ABCDEF
curl -X DELETE -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/applications/<application_id>'
Create a new apikey for an application
Create a new apikey for an application.
POST /v1/{service_instance_guid}/applications/{application_id}/api_key
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the application.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
0123456789ABCDEF0123456789ABCDEF
Application APIKey to add to the application.
The short name of the application api key - conforming to MQ rules.
Possible values: 1 ≤ length ≤ 12, Value must match regular expression
^[a-z][-a-z0-9]*$
Example:
test-api-key
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "name": "apikeyq4" }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/applications/<application_id>/api_key'
Response
A response to creating a new api key, giving the only chance to collect the new apikey.
The id of the api key.
The api key created.
The name of the api key.
Status Code
Created
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "api_key_name": "test_api_key", "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc", "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636" }
Upload a certificate
Import TLS certificate from a single self-contained PEM file to the truststore.
POST /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
Form Parameters
The label to use for the certificate to be uploaded.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The filename and path of the certificate to be uploaded.
Possible values: 1500 ≤ length ≤ 65537
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -F 'label=<certificate_label>' -F 'certificate_file=@/fully/qualified/path/to/keystore.pem' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/trust_store'
Response
The details of a trust store certificate in a queue manager certificate trust store.
Id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Certificate label in queue manager store.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The type of certificate.
Possible values: [
trust_store
]Fingerprint SHA256.
Possible values: Value must match regular expression
^[A-F0-9]{2}(:[A-F0-9]{2}){31}$
Subject's Distinguished Name.
Subject's Common Name.
Issuer's Distinguished Name.
Issuer's Common Name.
The Date the certificate was issued.
Expiry date for the certificate.
Indicates whether a certificate is trusted.
The URL for this trust store certificate.
Status Code
An object containing details of the uploaded trust store certificate.
URI has permanently Moved
Bad Request
Unauthorized
Method not allowed
Conflict
Service Is Overused
Internal Server Error
Service Unavailable Error
{ "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "trust_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "trusted": true, "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/trust_store/693d09e6f00e89d" }
List certificates
Get the list of certificates in the queue manager's certificate trust store.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/trust_store'
Response
A list of certificates in a queue manager's certificate trust store.
The total count of trust store certificates.
Example:
1
The list of trust store certificates.
Possible values: 0 ≤ number of items ≤ 50
Status Code
An object containing a list of trust store certificates.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "total_count": 1, "trust_store": [ { "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "trust_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "trusted": true, "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/trust_store/693d09e6f00e89d" } ] }
Get a trust store certificate
Get a trust store certificate from a queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/trust_store/<certificate_id>'
Response
The details of a trust store certificate in a queue manager certificate trust store.
Id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Certificate label in queue manager store.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The type of certificate.
Possible values: [
trust_store
]Fingerprint SHA256.
Possible values: Value must match regular expression
^[A-F0-9]{2}(:[A-F0-9]{2}){31}$
Subject's Distinguished Name.
Subject's Common Name.
Issuer's Distinguished Name.
Issuer's Common Name.
The Date the certificate was issued.
Expiry date for the certificate.
Indicates whether a certificate is trusted.
The URL for this trust store certificate.
Status Code
An object containing details of the trust store certificate.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "trust_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "trusted": true, "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/trust_store/693d09e6f00e89d" }
Delete a trust store certificate
Delete a trust store certificate.
DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X DELETE -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/trust_store/<certificate_id>'
Download a queue manager's certificate from its trust store
Download the specified trust store certificate PEM file from the queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}/download
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X GET -H 'Authorization: Bearer <iam_access_token>' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/trust_store/<certificate_id>/download'
Upload a certificate
Import TLS certificate from a single self-contained PEM file into the queue manager's key store.
POST /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
Form Parameters
The label to use for the certificate to be uploaded.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The filename and path of the certificate to be uploaded.
Possible values: 1500 ≤ length ≤ 65537
curl -X POST -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -F 'label=<certificate_label>' -F 'certificate_file=@/fully/qualified/path/to/keystore.pem' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store'
Response
The details of a key store certificate in a queue manager certificate key store.
ID of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Certificate label in queue manager store.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The type of certificate.
Possible values: [
key_store
]Fingerprint SHA256.
Possible values: Value must match regular expression
^[A-F0-9]{2}(:[A-F0-9]{2}){31}$
Subject's Distinguished Name.
Subject's Common Name.
Issuer's Distinguished Name.
Issuer's Common Name.
Date certificate was issued.
Expiry date for the certificate.
Indicates whether it is the queue manager's default certificate.
The total count of dns names.
The list of DNS names.
Possible values: 0 ≤ number of items ≤ 200
The URL for this key store certificate.
Status Code
An object containing details of the queue manager's key store certificate.
URI has permanently Moved
Bad Request
Unauthorized
Method not allowed
Conflict
Service Is Overused
Internal Server Error
Service Unavailable Error
{ "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "key_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "is_default": true, "dns_names_total_count": 1, "dns_names": [ "*.qm1.eu-de.mq.appdomain.cloud" ], "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/key_store/693d09e6f00e89d" }
List certificates
Get a list of certificates in the queue manager's certificate key store.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store'
Response
A list of certificates in a queue manager's certificate key store.
The total count of key store certificates.
Example:
1
The list of key store certificates.
Possible values: 0 ≤ number of items ≤ 50
Status Code
An object containing a list of key store certificates for a queue manager.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "total_count": 1, "key_store": [ { "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "key_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "is_default": true, "dns_names_total_count": 1, "dns_names": [ "*.qm1.eu-de.mq.appdomain.cloud" ], "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/key_store/693d09e6f00e89d" } ] }
Get a key store certificate for queue manager
Get a key store certificate for queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store/<certificate_id>'
Response
The details of a key store certificate in a queue manager certificate key store.
ID of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Certificate label in queue manager store.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[a-zA-Z0-9_.]*$
The type of certificate.
Possible values: [
key_store
]Fingerprint SHA256.
Possible values: Value must match regular expression
^[A-F0-9]{2}(:[A-F0-9]{2}){31}$
Subject's Distinguished Name.
Subject's Common Name.
Issuer's Distinguished Name.
Issuer's Common Name.
Date certificate was issued.
Expiry date for the certificate.
Indicates whether it is the queue manager's default certificate.
The total count of dns names.
The list of DNS names.
Possible values: 0 ≤ number of items ≤ 200
The URL for this key store certificate.
Status Code
An object containing details of the queue manager key store certificate.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "id": "693d09e6f00e89d", "label": "qmgrcert", "certificate_type": "key_store", "fingerprint_sha256": "BB:C2:09:2B:0C:68:EC:D2:1A:09:DA:F7:51:8D:29:F3:64:88:21:65:40:02:BD:20:1B:11:91:50:8D:90:8B:66", "subject_dn": "CN=*.qm1.eu-de.mq.appdomain.cloud", "subject_cn": "*.qm1.eu-de.mq.appdomain.cloud", "issuer_dn": "CN=R3,O=Let's Encrypt,C=US", "issuer_cn": "R3", "issued": "2023-05-29T11:17:00Z", "expiry": "2023-08-27T11:16:59Z", "is_default": true, "dns_names_total_count": 1, "dns_names": [ "*.qm1.eu-de.mq.appdomain.cloud" ], "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/certificates/key_store/693d09e6f00e89d" }
Delete a queue manager's key store certificate
Delete a queue manager's key store certificate.
DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X DELETE -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store/<certificate_id>'
Download a queue manager's certificate from its key store
Download the specified key store certificate PEM file from the queue manager.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}/download
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
curl -X GET -H 'Authorization: Bearer <iam_access_token>' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store/<certificate_id>/download'
Get the AMS channels that are configured with this key store certificate
Get the AMS channels that are configured with this key store certificate.
GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}/config/ams
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
curl -X GET -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store/<certificate_id>/config/ams'
Response
A list of channels that are configured with this certificate.
A list of channels that are configured with this certificate.
Possible values: 0 ≤ number of items ≤ 999999999
Status Code
Details of AMS channels that are configured with the given certificate.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "channels": [ { "name": "CLOUD.DEV.AMS1" } ] }
Update the AMS channels that are configured with this key store certificate
Update 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/ams
Request
Custom Headers
The acceptable list of languages supported in the client.
Possible values: 1 ≤ length ≤ 256, Value must match regular expression
[a-zA-Z0-9\-]*
Path Parameters
The id of the queue manager to retrieve its full details.
Possible values: length = 32, Value must match regular expression
^[0-9a-fA-F]{32}$
Example:
b8e1aeda078009cf3db74e90d5d42328
The id of the certificate.
Possible values: 1 ≤ length ≤ 16, Value must match regular expression
^[0-9a-fA-F]*$
Example:
9b7d1e723af8233
The GUID that uniquely identifies the MQ on Cloud service instance.
Possible values: length = 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Certificate AMS Channel to replace or append to.
The list of AMS channels that are using this certificate.
Possible values: 0 ≤ number of items ≤ 999999999
Strategy for how the supplied channels should be applied.
Allowable values: [
replace
,append
]
curl -X PUT -H 'Authorization: Bearer <iam_access_token>' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "update_strategy": "append", "channels": [ { "name": "CLOUD.DEV.AMS1" } ] }' 'https://api.private.<region>.mq2.cloud.ibm.com/v1/<service_instance_guid>/queue_managers/<queue_manager_id>/certificates/key_store/<certificate_id>/config/ams'
Response
A list of channels that are configured with this certificate.
A list of channels that are configured with this certificate.
Possible values: 0 ≤ number of items ≤ 999999999
Status Code
The updated list of AMS channels that are using this certificate.
URI has permanently Moved
Bad Request
Unauthorized
Resource not found
Service Is Overused
Internal Server Error
{ "channels": [ { "name": "CLOUD.DEV.AMS1" } ] }