MQ on Cloud | IBM Cloud API Docs

Introduction

Last updated: 2023-10-02

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.

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

import (
  "github.com/IBM/mqcloud-go-sdk/mqcloudv1"
)

Go get

go get -u github.com/IBM/mqcloud-go-sdk/mqcloudv1

View on GitHub

https://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:

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.

When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:

Programmatically by constructing an IAM authenticator instance and supplying your IAM API key
By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key

In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.

For more information, see the Authentication section of the IBM Cloud SDK Common documentation.

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Assigning access to account management services.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey=<API_KEY>'
Copy to clipboard

Replace <API_KEY> with your IAM API key.

Setting client options through external configuration

Example environment variables, where <ENDPOINT_URL> is the endpoint URL and <API_KEY> is your IAM API key

export IBMCLOUD_MQCLOUD_CONFIG_ENDPOINT=<ENDPOINT_URL>
export IBMCLOUD_APIKEY=<API_KEY>
export IBMCLOUD_IAM_API_ENDPOINT="https://iam.cloud.ibm.com"
Copy to clipboard

Example of constructing the service client

import (
  "log"
  "os"

  "github.com/IBM/go-sdk-core/v5/core"
  "github.com/IBM/mqcloud-go-sdk/mqcloudv1"
)
...
authenticator := &core.IamAuthenticator{
  ApiKey: os.Getenv("IBMCLOUD_APIKEY"),
  URL:    os.Getenv("IBMCLOUD_IAM_API_ENDPOINT") + "/identity/token",
}

mqcloudV1Options := &mqcloudv1.MqcloudV1Options{
  URL:           os.Getenv("IBMCLOUD_MQCLOUD_CONFIG_ENDPOINT"),
  Authenticator: authenticator,
}

mqcloudService, err := mqcloudv1.NewMqcloudV1(mqcloudV1Options)
if err != nil {
  log.Fatalf("Failed to create MQ Cloud Service Client: %v", err)
}
Copy to clipboard

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 results
Next: The object containing the URL for requesting the next page of results. The Next field is omitted if there are no more results
Previous: The object containing the URL for requesting the previous page. The Previous 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 window
X-Ratelimit-Remaining: The number of requests remaining in the current time window
X-Ratelimit-Reset: The time the current timer expires (in UNIX epoch time)

HTTP status code 429 indicates that the rate limit has been exceeded.

Get the usage details.

GET /v1/{service_instance_guid}/usage

(mqcloud *MqcloudV1) GetUsageDetails(getUsageDetailsOptions *GetUsageDetailsOptions) (result *Usage, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetUsageDetailsWithContext(ctx context.Context, getUsageDetailsOptions *GetUsageDetailsOptions) (result *Usage, response *core.DetailedResponse, err error)

Request

Instantiate the GetUsageDetailsOptions struct and set the fields to provide parameter values for the GetUsageDetails method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

parameter

WithContext method only

GetUsageDetailsOptions

The GetUsageDetails options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/usage"
Copy to clipboard

Example request

getUsageDetailsOptions := mqcloudService.NewGetUsageDetailsOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
)

usage, response, err := mqcloudService.GetUsageDetails(getUsageDetailsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(usage, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Usage

Usage details.

Usage

Usage details.

Examples:

Status Code

200
Usage details for an account.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "vpc_entitlement": 4,
  "vpc_usage": 3.5
}
Copy to clipboard

Success example

{
  "vpc_entitlement": 4,
  "vpc_usage": 3.5
}
Copy to clipboard

Return configuration options (eg, available deployment locations, queue manager sizes).

GET /v1/{service_instance_guid}/options

(mqcloud *MqcloudV1) GetOptions(getOptionsOptions *GetOptionsOptions) (result *ConfigurationOptions, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetOptionsWithContext(ctx context.Context, getOptionsOptions *GetOptionsOptions) (result *ConfigurationOptions, response *core.DetailedResponse, err error)

Request

Instantiate the GetOptionsOptions struct and set the fields to provide parameter values for the GetOptions method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

parameter

WithContext method only

GetOptionsOptions

The GetOptions options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/options"
Copy to clipboard

Example request

getOptionsOptions := mqcloudService.NewGetOptionsOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
)

configurationOptions, response, err := mqcloudService.GetOptions(getOptionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(configurationOptions, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ConfigurationOptions

Configuration options (eg, available deployment locations, queue manager sizes).

ConfigurationOptions

Configuration options (eg, available deployment locations, queue manager sizes).

Examples:

Status Code

200
Configuration options.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "locations": [
    "ibmcloud_eu_de"
  ],
  "sizes": [
    "xsmall",
    "small",
    "medium",
    "large"
  ],
  "versions": [
    "9.3.3_1"
  ],
  "latest_version": "9.3.3_1"
}
Copy to clipboard

Success example

{
  "locations": [
    "ibmcloud_eu_de"
  ],
  "sizes": [
    "xsmall",
    "small",
    "medium",
    "large"
  ],
  "versions": [
    "9.3.3_1"
  ],
  "latest_version": "9.3.3_1"
}
Copy to clipboard

Create a new queue manager.

POST /v1/{service_instance_guid}/queue_managers

(mqcloud *MqcloudV1) CreateQueueManager(createQueueManagerOptions *CreateQueueManagerOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateQueueManagerWithContext(ctx context.Context, createQueueManagerOptions *CreateQueueManagerOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

Request

Instantiate the CreateQueueManagerOptions struct and set the fields to provide parameter values for the CreateQueueManager method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

Request Body

Required*

QueueManagerDetailsPrototype

Queue manager to add to the list.

parameter

WithContext method only

CreateQueueManagerOptions

The CreateQueueManager options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "testqm", "location": "reserved-eu-de-cluster-f884", "size": "xsmall" }'   "${base_url}/v1/${service_instance_guid}/queue_managers"
Copy to clipboard

Example request

createQueueManagerOptions := mqcloudService.NewCreateQueueManagerOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "testqm",
  "reserved-eu-de-cluster-f884",
  "xsmall",
)

queueManagerTaskStatus, response, err := mqcloudService.CreateQueueManager(createQueueManagerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerTaskStatus, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

Examples:

Status Code

202
Returns url to track progress of the queue manager deployment.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
405
Method not allowed
409
Conflict
429
Service Is Overused
500
Internal Server Error
503
Service Unavailable Error

Example responses

Status 202

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Get a list of the queue manager summaries which exist in this service instance.

GET /v1/{service_instance_guid}/queue_managers

(mqcloud *MqcloudV1) ListQueueManagers(listQueueManagersOptions *ListQueueManagersOptions) (result *QueueManagerDetailsCollection, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) ListQueueManagersWithContext(ctx context.Context, listQueueManagersOptions *ListQueueManagersOptions) (result *QueueManagerDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListQueueManagersOptions struct and set the fields to provide parameter values for the ListQueueManagers method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

offset
integer
Pagination offset.

Possible values: 0 ≤ value ≤ 99999
Default: 0
limit
integer
The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100
Default: 25

parameter

WithContext method only

ListQueueManagersOptions

The ListQueueManagers options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers"
Copy to clipboard

Example request

listQueueManagersOptions := &mqcloudv1.ListQueueManagersOptions{
  ServiceInstanceGuid: core.StringPtr("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := mqcloudService.NewQueueManagersPager(listQueueManagersOptions)
if err != nil {
  panic(err)
}

var allResults []mqcloudv1.QueueManagerDetails
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerDetailsCollection

A list of queue manager summaries.

QueueManagerDetailsCollection

A list of queue manager summaries.

Examples:

Status Code

200
An object containing a list of queue managers.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success example

{
  "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"
    }
  ]
}
Copy to clipboard

Get the details of a given queue manager.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}

(mqcloud *MqcloudV1) GetQueueManager(getQueueManagerOptions *GetQueueManagerOptions) (result *QueueManagerDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetQueueManagerWithContext(ctx context.Context, getQueueManagerOptions *GetQueueManagerOptions) (result *QueueManagerDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetQueueManagerOptions struct and set the fields to provide parameter values for the GetQueueManager method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

GetQueueManagerOptions

The GetQueueManager options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}"
Copy to clipboard

Example request

getQueueManagerOptions := mqcloudService.NewGetQueueManagerOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

queueManagerDetails, response, err := mqcloudService.GetQueueManager(getQueueManagerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerDetails

The details of the queue manager.

QueueManagerDetails

The details of the queue manager.

Examples:

Status Code

200
Description of the queue manager.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Delete a queue manager.

DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}

(mqcloud *MqcloudV1) DeleteQueueManager(deleteQueueManagerOptions *DeleteQueueManagerOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DeleteQueueManagerWithContext(ctx context.Context, deleteQueueManagerOptions *DeleteQueueManagerOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

Request

Instantiate the DeleteQueueManagerOptions struct and set the fields to provide parameter values for the DeleteQueueManager method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

DeleteQueueManagerOptions

The DeleteQueueManager options.

Example request

curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}"
Copy to clipboard

Example request

deleteQueueManagerOptions := mqcloudService.NewDeleteQueueManagerOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

queueManagerTaskStatus, response, err := mqcloudService.DeleteQueueManager(deleteQueueManagerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerTaskStatus, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

Examples:

Status Code

202
Returns url to track progress for delete queue manager.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 202

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Upgrade a queue manager.

PUT /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/version

(mqcloud *MqcloudV1) SetQueueManagerVersion(setQueueManagerVersionOptions *SetQueueManagerVersionOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) SetQueueManagerVersionWithContext(ctx context.Context, setQueueManagerVersionOptions *SetQueueManagerVersionOptions) (result *QueueManagerTaskStatus, response *core.DetailedResponse, err error)

Request

Instantiate the SetQueueManagerVersionOptions struct and set the fields to provide parameter values for the SetQueueManagerVersion method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

Request Body

Required*

UpgradeQueueManagerBody

Version to upgrade Queue Manager to.

Examples:

parameter

WithContext method only

SetQueueManagerVersionOptions

The SetQueueManagerVersion options.

Example request

curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"version":"9.3.2_2"}'   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/version"
Copy to clipboard

Example request

setQueueManagerVersionOptions := mqcloudService.NewSetQueueManagerVersionOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9.3.2_2",
)

queueManagerTaskStatus, response, err := mqcloudService.SetQueueManagerVersion(setQueueManagerVersionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerTaskStatus, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

QueueManagerTaskStatus

A URI for status that can be queried periodically to get the status of the queue manager.

Examples:

Status Code

202
Returns url to track progress of the queue manager upgrade.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
405
Method not allowed
409
Conflict
429
Service Is Overused
500
Internal Server Error
503
Service Unavailable Error

Example responses

Status 202

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

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

(mqcloud *MqcloudV1) GetQueueManagerAvailableUpgradeVersions(getQueueManagerAvailableUpgradeVersionsOptions *GetQueueManagerAvailableUpgradeVersionsOptions) (result *QueueManagerVersionUpgrades, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetQueueManagerAvailableUpgradeVersionsWithContext(ctx context.Context, getQueueManagerAvailableUpgradeVersionsOptions *GetQueueManagerAvailableUpgradeVersionsOptions) (result *QueueManagerVersionUpgrades, response *core.DetailedResponse, err error)

Request

Instantiate the GetQueueManagerAvailableUpgradeVersionsOptions struct and set the fields to provide parameter values for the GetQueueManagerAvailableUpgradeVersions method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

GetQueueManagerAvailableUpgradeVersionsOptions

The GetQueueManagerAvailableUpgradeVersions options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/available_versions"
Copy to clipboard

Example request

getQueueManagerAvailableUpgradeVersionsOptions := mqcloudService.NewGetQueueManagerAvailableUpgradeVersionsOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

queueManagerVersionUpgrades, response, err := mqcloudService.GetQueueManagerAvailableUpgradeVersions(getQueueManagerAvailableUpgradeVersionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerVersionUpgrades, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerVersionUpgrades

The list of available versions that this queue manger can upgrade to.

QueueManagerVersionUpgrades

The list of available versions that this queue manger can upgrade to.

Examples:

Status Code

200
Returns information about the available versions that this queue manager can be upgraded to.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "total_count": 1,
  "versions": [
    {
      "version": "9.3.2_2",
      "target_date": "2023-01-13T15:39:35.000Z"
    }
  ]
}
Copy to clipboard

Success example

{
  "total_count": 1,
  "versions": [
    {
      "version": "9.3.2_2",
      "target_date": "2023-01-13T15:39:35.000Z"
    }
  ]
}
Copy to clipboard

Get connection information for a queue manager.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/connection_info

(mqcloud *MqcloudV1) GetQueueManagerConnectionInfo(getQueueManagerConnectionInfoOptions *GetQueueManagerConnectionInfoOptions) (result *ConnectionInfo, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetQueueManagerConnectionInfoWithContext(ctx context.Context, getQueueManagerConnectionInfoOptions *GetQueueManagerConnectionInfoOptions) (result *ConnectionInfo, response *core.DetailedResponse, err error)

Request

Instantiate the GetQueueManagerConnectionInfoOptions struct and set the fields to provide parameter values for the GetQueueManagerConnectionInfo method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

GetQueueManagerConnectionInfoOptions

The GetQueueManagerConnectionInfo options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/connection_info"
Copy to clipboard

Example request

getQueueManagerConnectionInfoOptions := mqcloudService.NewGetQueueManagerConnectionInfoOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

connectionInfo, response, err := mqcloudService.GetQueueManagerConnectionInfo(getQueueManagerConnectionInfoOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(connectionInfo, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ConnectionInfo

Responds with JSON CCDT of the connection information for the queue manager.

ConnectionInfo

Responds with JSON CCDT of the connection information for the queue manager.

Status Code

200
Response of the connection information for the queue manager.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success example

{
  "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"
    }
  ]
}
Copy to clipboard

Get the status of the queue manager instance.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/status

(mqcloud *MqcloudV1) GetQueueManagerStatus(getQueueManagerStatusOptions *GetQueueManagerStatusOptions) (result *QueueManagerStatus, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetQueueManagerStatusWithContext(ctx context.Context, getQueueManagerStatusOptions *GetQueueManagerStatusOptions) (result *QueueManagerStatus, response *core.DetailedResponse, err error)

Request

Instantiate the GetQueueManagerStatusOptions struct and set the fields to provide parameter values for the GetQueueManagerStatus method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

GetQueueManagerStatusOptions

The GetQueueManagerStatus options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/status"
Copy to clipboard

Example request

getQueueManagerStatusOptions := mqcloudService.NewGetQueueManagerStatusOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

queueManagerStatus, response, err := mqcloudService.GetQueueManagerStatus(getQueueManagerStatusOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(queueManagerStatus, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

QueueManagerStatus

Queue manager status.

QueueManagerStatus

Queue manager status.

Examples:

Status Code

200
Current status for the queue manager.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

{ "status": "running" }
{ "status": "running" }

Get a list of users for an instance.

GET /v1/{service_instance_guid}/users

(mqcloud *MqcloudV1) ListUsers(listUsersOptions *ListUsersOptions) (result *UserDetailsCollection, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) ListUsersWithContext(ctx context.Context, listUsersOptions *ListUsersOptions) (result *UserDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListUsersOptions struct and set the fields to provide parameter values for the ListUsers method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

offset
integer
Pagination offset.

Possible values: 0 ≤ value ≤ 99999
Default: 0
limit
integer
The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100
Default: 25

parameter

WithContext method only

ListUsersOptions

The ListUsers options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/users"
Copy to clipboard

Example request

listUsersOptions := &mqcloudv1.ListUsersOptions{
  ServiceInstanceGuid: core.StringPtr("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := mqcloudService.NewUsersPager(listUsersOptions)
if err != nil {
  panic(err)
}

var allResults []mqcloudv1.UserDetails
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

UserDetailsCollection

A list of user summaries.

UserDetailsCollection

A list of user summaries.

Examples:

Status Code

200
Summary of the returned users.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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": "testuser",
      "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
      "email": "testuser@ibm.com"
    }
  ]
}
Copy to clipboard

Success example

{
  "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": "testuser",
      "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
      "email": "testuser@ibm.com"
    }
  ]
}
Copy to clipboard

Add a user to an instance.

POST /v1/{service_instance_guid}/users

(mqcloud *MqcloudV1) CreateUser(createUserOptions *CreateUserOptions) (result *UserDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateUserWithContext(ctx context.Context, createUserOptions *CreateUserOptions) (result *UserDetails, response *core.DetailedResponse, err error)

Request

Instantiate the CreateUserOptions struct and set the fields to provide parameter values for the CreateUser method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

Request Body

Required*

UserDetailsPrototype

User to add to the list.

parameter

WithContext method only

CreateUserOptions

The CreateUser options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "email": "testuser@ibm.com", "name": "testuser" }'   "${base_url}/v1/${service_instance_guid}/users"
Copy to clipboard

Example request

createUserOptions := mqcloudService.NewCreateUserOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "testuser@ibm.com",
  "testuser",
)

userDetails, response, err := mqcloudService.CreateUser(createUserOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(userDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

UserDetails

A summary of the user for use in a list of users.

UserDetails

A summary of the user for use in a list of users.

Examples:

Status Code

201
Created User
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
409
Conflict
429
Service Is Overused
500
Internal Server Error

Example responses

Status 201

{
  "id": "31a413dd84346effc8895b6ba4641641",
  "name": "testuser",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
  "email": "testuser@ibm.com"
}
Copy to clipboard

Success example

{
  "id": "31a413dd84346effc8895b6ba4641641",
  "name": "testuser",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
  "email": "testuser@ibm.com"
}
Copy to clipboard

Get a user for an instance.

GET /v1/{service_instance_guid}/users/{user_id}

(mqcloud *MqcloudV1) GetUser(getUserOptions *GetUserOptions) (result *UserDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetUserWithContext(ctx context.Context, getUserOptions *GetUserOptions) (result *UserDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetUserOptions struct and set the fields to provide parameter values for the GetUser method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
The id of the user.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$
Example: 31a413dd84346effc8895b6ba4641641

parameter

WithContext method only

GetUserOptions

The GetUser options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/users/${user_id}"
Copy to clipboard

Example request

getUserOptions := mqcloudService.NewGetUserOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "31a413dd84346effc8895b6ba4641641",
)

userDetails, response, err := mqcloudService.GetUser(getUserOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(userDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

UserDetails

A summary of the user for use in a list of users.

UserDetails

A summary of the user for use in a list of users.

Examples:

Status Code

200
Description of the returned user.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "id": "31a413dd84346effc8895b6ba4641641",
  "name": "testuser",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
  "email": "testuser@ibm.com"
}
Copy to clipboard

Success example

{
  "id": "31a413dd84346effc8895b6ba4641641",
  "name": "testuser",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
  "email": "testuser@ibm.com"
}
Copy to clipboard

Delete a user for an instance.

DELETE /v1/{service_instance_guid}/users/{user_id}

(mqcloud *MqcloudV1) DeleteUser(deleteUserOptions *DeleteUserOptions) (response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DeleteUserWithContext(ctx context.Context, deleteUserOptions *DeleteUserOptions) (response *core.DetailedResponse, err error)

Request

Instantiate the DeleteUserOptions struct and set the fields to provide parameter values for the DeleteUser method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
The id of the user.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$
Example: 31a413dd84346effc8895b6ba4641641

parameter

WithContext method only

DeleteUserOptions

The DeleteUser options.

Example request

curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   "${base_url}/v1/${service_instance_guid}/users/${user_id}"
Copy to clipboard

Example request

deleteUserOptions := mqcloudService.NewDeleteUserOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "31a413dd84346effc8895b6ba4641641",
)

response, err := mqcloudService.DeleteUser(deleteUserOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteUser(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Resource was deleted successfully.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get a list of applications for an instance.

GET /v1/{service_instance_guid}/applications

(mqcloud *MqcloudV1) ListApplications(listApplicationsOptions *ListApplicationsOptions) (result *ApplicationDetailsCollection, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) ListApplicationsWithContext(ctx context.Context, listApplicationsOptions *ListApplicationsOptions) (result *ApplicationDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListApplicationsOptions struct and set the fields to provide parameter values for the ListApplications method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

offset
integer
Pagination offset.

Possible values: 0 ≤ value ≤ 99999
Default: 0
limit
integer
The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100
Default: 25

parameter

WithContext method only

ListApplicationsOptions

The ListApplications options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/applications"
Copy to clipboard

Example request

listApplicationsOptions := &mqcloudv1.ListApplicationsOptions{
  ServiceInstanceGuid: core.StringPtr("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := mqcloudService.NewApplicationsPager(listApplicationsOptions)
if err != nil {
  panic(err)
}

var allResults []mqcloudv1.ApplicationDetails
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ApplicationDetailsCollection

A list of application summaries.

ApplicationDetailsCollection

A list of application summaries.

Examples:

Status Code

200
Summary of the returned applications.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success example

{
  "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"
    }
  ]
}
Copy to clipboard

Add an application to an instance.

POST /v1/{service_instance_guid}/applications

(mqcloud *MqcloudV1) CreateApplication(createApplicationOptions *CreateApplicationOptions) (result *ApplicationCreated, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateApplicationWithContext(ctx context.Context, createApplicationOptions *CreateApplicationOptions) (result *ApplicationCreated, response *core.DetailedResponse, err error)

Request

Instantiate the CreateApplicationOptions struct and set the fields to provide parameter values for the CreateApplication method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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

Request Body

Required*

ApplicationDetailsPrototype

Application to add to the list.

parameter

WithContext method only

CreateApplicationOptions

The CreateApplication options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "test-app" }'   "${base_url}/v1/${service_instance_guid}/applications"
Copy to clipboard

Example request

createApplicationOptions := mqcloudService.NewCreateApplicationOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "test-app",
)

applicationCreated, response, err := mqcloudService.CreateApplication(createApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationCreated, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ApplicationCreated

A response to creating an application, giving the only chance to collect the apikey.

ApplicationCreated

A response to creating an application, giving the only chance to collect the apikey.

Examples:

Status Code

201
Created Application
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 201

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Get an application for an instance.

GET /v1/{service_instance_guid}/applications/{application_id}

(mqcloud *MqcloudV1) GetApplication(getApplicationOptions *GetApplicationOptions) (result *ApplicationDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetApplicationWithContext(ctx context.Context, getApplicationOptions *GetApplicationOptions) (result *ApplicationDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetApplicationOptions struct and set the fields to provide parameter values for the GetApplication method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
The id of the application.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$
Example: 0123456789ABCDEF0123456789ABCDEF

parameter

WithContext method only

GetApplicationOptions

The GetApplication options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/applications/${application_id}"
Copy to clipboard

Example request

getApplicationOptions := mqcloudService.NewGetApplicationOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "0123456789ABCDEF0123456789ABCDEF",
)

applicationDetails, response, err := mqcloudService.GetApplication(getApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ApplicationDetails

A summary of the application for use in a list of applications.

ApplicationDetails

A summary of the application for use in a list of applications.

Examples:

Status Code

200
Description of the returned application.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Delete an application from an instance.

DELETE /v1/{service_instance_guid}/applications/{application_id}

(mqcloud *MqcloudV1) DeleteApplication(deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DeleteApplicationWithContext(ctx context.Context, deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)

Request

Instantiate the DeleteApplicationOptions struct and set the fields to provide parameter values for the DeleteApplication method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
The id of the application.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$
Example: 0123456789ABCDEF0123456789ABCDEF

parameter

WithContext method only

DeleteApplicationOptions

The DeleteApplication options.

Example request

curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   "${base_url}/v1/${service_instance_guid}/applications/${application_id}"
Copy to clipboard

Example request

deleteApplicationOptions := mqcloudService.NewDeleteApplicationOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "0123456789ABCDEF0123456789ABCDEF",
)

response, err := mqcloudService.DeleteApplication(deleteApplicationOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteApplication(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Resource was deleted successfully.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Create a new apikey for an application.

POST /v1/{service_instance_guid}/applications/{application_id}/api_key

(mqcloud *MqcloudV1) CreateApplicationApikey(createApplicationApikeyOptions *CreateApplicationApikeyOptions) (result *ApplicationAPIKeyCreated, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateApplicationApikeyWithContext(ctx context.Context, createApplicationApikeyOptions *CreateApplicationApikeyOptions) (result *ApplicationAPIKeyCreated, response *core.DetailedResponse, err error)

Request

Instantiate the CreateApplicationApikeyOptions struct and set the fields to provide parameter values for the CreateApplicationApikey method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
The id of the application.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$
Example: 0123456789ABCDEF0123456789ABCDEF

Request Body

Required*

CreateApplicationAPIKeyBody

Application APIKey to add to the application.

parameter

WithContext method only

CreateApplicationApikeyOptions

The CreateApplicationApikey options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "test-api-key" }'   "${base_url}/v1/${service_instance_guid}/applications/${application_id}/api_key"
Copy to clipboard

Example request

createApplicationApikeyOptions := mqcloudService.NewCreateApplicationApikeyOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "0123456789ABCDEF0123456789ABCDEF",
  "test-api-key",
)

applicationApiKeyCreated, response, err := mqcloudService.CreateApplicationApikey(createApplicationApikeyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationApiKeyCreated, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ApplicationAPIKeyCreated

A response to creating a new api key, giving the only chance to collect the new apikey.

ApplicationAPIKeyCreated

A response to creating a new api key, giving the only chance to collect the new apikey.

Examples:

Status Code

201
Created
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 201

{
  "api_key_name": "test_api_key",
  "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc",
  "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636"
}
Copy to clipboard

Success example

{
  "api_key_name": "test_api_key",
  "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc",
  "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636"
}
Copy to clipboard

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

(mqcloud *MqcloudV1) CreateTrustStorePemCertificate(createTrustStorePemCertificateOptions *CreateTrustStorePemCertificateOptions) (result *TrustStoreCertificateDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateTrustStorePemCertificateWithContext(ctx context.Context, createTrustStorePemCertificateOptions *CreateTrustStorePemCertificateOptions) (result *TrustStoreCertificateDetails, response *core.DetailedResponse, err error)

Request

Instantiate the CreateTrustStorePemCertificateOptions struct and set the fields to provide parameter values for the CreateTrustStorePemCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

label
Required*
string
The label to use for the certificate to be uploaded.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[a-zA-Z0-9_.]*$
Example: certlabel
certificate_file
Required*
binary
The filename and path of the certificate to be uploaded.

Possible values: 1500 ≤ length ≤ 65537
Example: THA0R1pZNFs2a1Q7RCA0TFBGai1PbHNLUlNfaSh8LktDRyI9MGdLNVx6Yj9qIkBgb3JuYFFudD4tKGIzPG5ZfWgtXj86UF8jfXBZMmUveVxjej8zZUIwKT85YD5cREcgbkRpeDhiV1ppcyptSjF5VytEN1FYX3gnaV0qSk1rNDhWYSBQZ2pFbGpVbTRFQCVNMkwmRi9bfW00Y3t0bVc8S1s+V0ZxMldLRyh6azksdXApcCUtOEBKNTIgYmhyY0E1Jk1dNWlSOEs2YWAwcUhbU10sXG1ZJUsiYlo7XTE8X0BqVFxkW3hAbSw8ZSleXlxpcGFEXCI9UkU7ayUoMjsiekNJekBVRU54ZEdPa3siI19sSnVmVHRZSTFOdmFkLXJKQShVYCd6QzlSNk8qcy9pfVZkQUFRISZUPkcyQjhmLztPcWY3MkwxXE0oJC5IUy52UXw7Qjk0SiluMkEmKjF+YUpWJDYuPidjXSt9dTNAdlVCQEl0JCEuU0YhSEQgc1NZKkhQY1g9T3chPHJiWmhHJCkjU0o0JWJyNnAvXmNSNlw7SzJ7P1N5IV4nXmQgLUJZOF52OzNgalRJQVU8JzUnRGc5XV9FIUBNNGxjcChaOzBSOWtCXUQgfl5tNDcwbyQxNFw2IFA4NidcLXU8O0NnUCUrdG0gW2EnajNdVW1VbWRiWG1UK1ZoPCJKKUBbVnBNMnEsJXdyJ0ZnJ1VHVEl4RFAvLVplXk8tWD10K3Jmb2J+K00kTnFqNy49SEFENyFuLjhRJjVyKDF+T3o/IzdgTG9IW2N5QV8iWVBsWU1ySF93dFlzdCs8fn0nXTBeTzNtOl07Izl7Wi8kRDUmVkh6LCdwaixyYSlGMUFecV43V2c4cFFfN0xtb2Z+bTUrWFtoNyEwYX5US2tnO2kyIn1WMEw0ejZpPzwmIXxGfEJqNDNze0hVWmhXOFB+byx0NzBacTovWT4sJnAsYTJ+ZXMgJ3s0R3JJPU9caHYqdiV6PGc9XTcsO3E1Q2BSaEhEUydvQ1R4L2IuPntdfjsheS88Wid8PFJEW2Q5QVFHQWJTTyslMi00RVkpTTx0WzstM0NKUDJCJzdSQGk0N1hpcHNBayVJP309QFc8OSgzT281bnM0bX1JXD1MVmRcbVheL1U6L3FAN3lMWEJUTFlxKzhzIHB1NjxFUGhzZGYvI2JWJyNSS3YnIiZoVlRkTk5DezVnVWRKXWl3MVluV11vVVxoZic+I1c4bzxbXSppJCVxRH5OS3pzaSkhLjVmdTtJOD42WDJXPnYzV0NzWHgqQDA+K2xLeUN0czx5USZgKDhlayYxLEo+MjsmWzMhUSxLRmZ3XzxVPUIlcjhxYnFKNXBrJiQhQGBxWmlNYCA7L0pvK1MuUDY3Ly4mX1VNXlJ6W2xQVlZKPVxRQFw0QDN5SThcUihTaispM1knX31FNE8hcXI+dX1qKnBsWXtfNFJmJzZOd1VhKiR2SE0tZk0kITdec2ZLMW48JUY1ezI6M21fZ3stfUUhMFZebypeJ0dUfiorYkJYVG1GMSIhYXs9JUBeMUUjb0Y9TVJRZD5yQE92R3NwYEIyajN6KHUoLEMtdyQ1J1BZTT5YNWlCXV1JKW14OWN7RDpGPnxgPHU0OCRyTyR5UkFPYypQYDNvKScrY3E6MEg4NHVHOHBBTWFadlRgUFt0WkA5KktnRTJ6d3opVV4kYnYxPzprfm10UzdGfFBKSCxYWWQ3K0MkaDk6SFlDT0p5NilrKyY5QWMwYCBlNzslKSksbiJ2SmJFMWdNS3NTZWtccTMnXCJLPmBEbDo9YUd3ZSRFLD8jT1F1b2tpNG9UV0ElLS50PzAnSWNheUNreEtpKU5hbVQxLSQ4KVEgNFQ0OiRXJEJfN1Q2Pjwxak1IJi91YyRWLDc8NyVwO3BNZ2Zsb1t1fnZMQyFpPUU6Zlw7VG4mYnpqIFY3PlNIWCMhJWtHSU8ueHlXXTkpS3RoR2N5U0FCLlw/aHhYVV8mPXhsdHY2TCIhIHlDbG9KR2BKJVxBciNrWCxee3Z4RWhddG5HYls+fW9udGJPXC98MXclSSl2IWRGNTogXUl8MiRsdHRYUmpvd2dvUmFuIjh7IXBAWC9lRlFibS1jTVBnXGt7MCVGY2BsNk1AI1B1VzdgZDFPMidQV1c3J2Y7XHNlKydvaiBuJXQiKiw6VkNHTzYqPydrLzNvXnRgJDc4NjIsS1NtPX1fUjIxZmE/O1B1Q25iSXN9S0JhWlV1LiA1aHxKOjMiJWJZYnYvUyhQUFFpRjNUTydsLVpmMlFCRz06fjFXN0ggZDdHLChmVDFLam5MKTllRjExXTtfY29TS3d1ZnBJMmlZIDVycGBcMGM2QFw1I1EkXTtiakx2bHV0ZylyNUlWdWY0ZX0sWSovOlosOTQsTURsKyFpejNtOTUsWFQlZUg4RlNxb3k2aE54NFthKko6b1pXIiZTOyo0IVVhUjNQaW1KQ2B+OnZoRkRAeCwmcn5ISGZXcSgpMXldVWY6UkhNLnZVejEyKnd4aFJcV0MgO2Msc3M9YS48O20jU3pUcG1ybFVERFBjaU5BU0tObURtRSE0Ni9eZUkyLFo+a3FNOVlPMi9qYEhfL3d9K3lITC1wazYuaHtyN3pnOkY9Nz5lKns4bERGazR9dmdqMkYuc3FJKyFCdkA/Q1s0YDVSKWAxRywjNU1hcWJbIF9QaWU4MUhoLHFpbnlXZD41XXZYeWxjVnp0cCdpICB4YGJ3fGMkeXJccFJQTi1QW3h8WXY+MXRgb0p3eHIxfGRaYEYnPzwsbEgpI0ooTkZ7R0xFYGJwQl9ESTVDST0zeCJ3dHFNJj8jM3ZGXys3KUktRUhdK0VuezZ4TnB6JFhBInYreG4zKFtfPCVPL2dqIlNPOl9lJXdoIDJ9NSAuWHZMazx8WlZEUShZKiQrdWN3cShdOXclbjtYbjUqdX5xRWo8fFhPXTxiOj9fNksid0YyPnx6anVoIzMtWXVNfUdKYk56LnhMYygidy43QykoST5CODA/aEInfWtFamZlI1lDQy03Xi14U0NBcWxHJmZbYyFIWClgZFFNeiIjKXJxJUouSCJ4OjRaLDRRTEVDJ3F8W1FnZFdnPl4oTC0rLlpWfFtqUktqQjRXMFA/ZTxUMz1GM0RMVWlDZU4hTkZhMz9nNXc/QypxM3dGMFUxaj1MI3IjUHdcJHdUYyo9TEs/dDU5REtPan4gQTdyOGExQnchLD1bMG5rcDp3eC0gYDZ2X0dHQkgxR0Ytc2w2VUxafGFVZElmNnE1JD4jdENvQyxEXC8/I31vLCdjcklDcW5afXw6cGFhJC0

parameter

WithContext method only

CreateTrustStorePemCertificateOptions

The CreateTrustStorePemCertificate options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: multipart/form-data"   --form 'label=certlabel'   --form 'certificate_file=@tempdir/test-file.txt;type=application/octet-stream'   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/trust_store"
Copy to clipboard

Example request

createTrustStorePemCertificateOptions := mqcloudService.NewCreateTrustStorePemCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "certlabel",
  CreateMockReader("This is a mock file."),
)

trustStoreCertificateDetails, response, err := mqcloudService.CreateTrustStorePemCertificate(createTrustStorePemCertificateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(trustStoreCertificateDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

TrustStoreCertificateDetails

The details of a trust store certificate in a queue manager certificate trust store.

TrustStoreCertificateDetails

The details of a trust store certificate in a queue manager certificate trust store.

Examples:

Status Code

201
An object containing details of the uploaded trust store certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
405
Method not allowed
409
Conflict
429
Service Is Overused
500
Internal Server Error
503
Service Unavailable Error

Example responses

Status 201

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

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

(mqcloud *MqcloudV1) ListTrustStoreCertificates(listTrustStoreCertificatesOptions *ListTrustStoreCertificatesOptions) (result *TrustStoreCertificateDetailsCollection, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) ListTrustStoreCertificatesWithContext(ctx context.Context, listTrustStoreCertificatesOptions *ListTrustStoreCertificatesOptions) (result *TrustStoreCertificateDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListTrustStoreCertificatesOptions struct and set the fields to provide parameter values for the ListTrustStoreCertificates method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

ListTrustStoreCertificatesOptions

The ListTrustStoreCertificates options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/trust_store"
Copy to clipboard

Example request

listTrustStoreCertificatesOptions := mqcloudService.NewListTrustStoreCertificatesOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

trustStoreCertificateDetailsCollection, response, err := mqcloudService.ListTrustStoreCertificates(listTrustStoreCertificatesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(trustStoreCertificateDetailsCollection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

TrustStoreCertificateDetailsCollection

A list of certificates in a queue manager's certificate trust store.

TrustStoreCertificateDetailsCollection

A list of certificates in a queue manager's certificate trust store.

Examples:

Status Code

200
An object containing a list of trust store certificates.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
    }
  ]
}
Copy to clipboard

Success example

{
  "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"
    }
  ]
}
Copy to clipboard

Get a trust store certificate from a queue manager.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}

(mqcloud *MqcloudV1) GetTrustStoreCertificate(getTrustStoreCertificateOptions *GetTrustStoreCertificateOptions) (result *TrustStoreCertificateDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetTrustStoreCertificateWithContext(ctx context.Context, getTrustStoreCertificateOptions *GetTrustStoreCertificateOptions) (result *TrustStoreCertificateDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetTrustStoreCertificateOptions struct and set the fields to provide parameter values for the GetTrustStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

GetTrustStoreCertificateOptions

The GetTrustStoreCertificate options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/trust_store/${certificate_id}"
Copy to clipboard

Example request

getTrustStoreCertificateOptions := mqcloudService.NewGetTrustStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

trustStoreCertificateDetails, response, err := mqcloudService.GetTrustStoreCertificate(getTrustStoreCertificateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(trustStoreCertificateDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

TrustStoreCertificateDetails

The details of a trust store certificate in a queue manager certificate trust store.

TrustStoreCertificateDetails

The details of a trust store certificate in a queue manager certificate trust store.

Examples:

Status Code

200
An object containing details of the trust store certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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"
}
Copy to clipboard

Success example

{
  "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"
}
Copy to clipboard

Delete a trust store certificate.

DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/trust_store/{certificate_id}

(mqcloud *MqcloudV1) DeleteTrustStoreCertificate(deleteTrustStoreCertificateOptions *DeleteTrustStoreCertificateOptions) (response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DeleteTrustStoreCertificateWithContext(ctx context.Context, deleteTrustStoreCertificateOptions *DeleteTrustStoreCertificateOptions) (response *core.DetailedResponse, err error)

Request

Instantiate the DeleteTrustStoreCertificateOptions struct and set the fields to provide parameter values for the DeleteTrustStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

DeleteTrustStoreCertificateOptions

The DeleteTrustStoreCertificate options.

Example request

curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/trust_store/${certificate_id}"
Copy to clipboard

Example request

deleteTrustStoreCertificateOptions := mqcloudService.NewDeleteTrustStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

response, err := mqcloudService.DeleteTrustStoreCertificate(deleteTrustStoreCertificateOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteTrustStoreCertificate(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Resource was deleted successfully.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

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

(mqcloud *MqcloudV1) DownloadTrustStoreCertificate(downloadTrustStoreCertificateOptions *DownloadTrustStoreCertificateOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DownloadTrustStoreCertificateWithContext(ctx context.Context, downloadTrustStoreCertificateOptions *DownloadTrustStoreCertificateOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

Request

Instantiate the DownloadTrustStoreCertificateOptions struct and set the fields to provide parameter values for the DownloadTrustStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

DownloadTrustStoreCertificateOptions

The DownloadTrustStoreCertificate options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/octet-stream"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/trust_store/${certificate_id}/download"
Copy to clipboard

Example request

downloadTrustStoreCertificateOptions := mqcloudService.NewDownloadTrustStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

result, response, err := mqcloudService.DownloadTrustStoreCertificate(downloadTrustStoreCertificateOptions)
if err != nil {
  panic(err)
}
if result != nil {
  defer result.Close()
  outFile, err := os.Create("result.out")
  if err != nil { panic(err) }
  defer outFile.Close()
  _, err = io.Copy(outFile, result)
  if err != nil { panic(err) }
}
Copy to clipboard

Response

Response type: io.ReadCloser

Response Body

binary

Response of a certificate file.

Status Code

200
OK
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

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

(mqcloud *MqcloudV1) CreateKeyStorePemCertificate(createKeyStorePemCertificateOptions *CreateKeyStorePemCertificateOptions) (result *KeyStoreCertificateDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) CreateKeyStorePemCertificateWithContext(ctx context.Context, createKeyStorePemCertificateOptions *CreateKeyStorePemCertificateOptions) (result *KeyStoreCertificateDetails, response *core.DetailedResponse, err error)

Request

Instantiate the CreateKeyStorePemCertificateOptions struct and set the fields to provide parameter values for the CreateKeyStorePemCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

label
Required*
string
The label to use for the certificate to be uploaded.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[a-zA-Z0-9_.]*$
Example: certlabel
certificate_file
Required*
binary
The filename and path of the certificate to be uploaded.

Possible values: 1500 ≤ length ≤ 65537
Example: KHA0R1pZNFs2a1Q7RCA0TFBGai1PbHNLUlNfaSh8LktDRyI9MGdLNVx6Yj9qIkBgb3JuYFFudD4tKGIzPG5ZfWgtXj86UF8jfXBZMmUveVxjej8zZUIwKT85YD5cREcgbkRpeDhiV1ppcyptSjF5VytEN1FYX3gnaV0qSk1rNDhWYSBQZ2pFbGpVbTRFQCVNMkwmRi9bfW00Y3t0bVc8S1s+V0ZxMldLRyh6azksdXApcCUtOEBKNTIgYmhyY0E1Jk1dNWlSOEs2YWAwcUhbU10sXG1ZJUsiYlo7XTE8X0BqVFxkW3hAbSw8ZSleXlxpcGFEXCI9UkU7ayUoMjsiekNJekBVRU54ZEdPa3siI19sSnVmVHRZSTFOdmFkLXJKQShVYCd6QzlSNk8qcy9pfVZkQUFRISZUPkcyQjhmLztPcWY3MkwxXE0oJC5IUy52UXw7Qjk0SiluMkEmKjF+YUpWJDYuPidjXSt9dTNAdlVCQEl0JCEuU0YhSEQgc1NZKkhQY1g9T3chPHJiWmhHJCkjU0o0JWJyNnAvXmNSNlw7SzJ7P1N5IV4nXmQgLUJZOF52OzNgalRJQVU8JzUnRGc5XV9FIUBNNGxjcChaOzBSOWtCXUQgfl5tNDcwbyQxNFw2IFA4NidcLXU8O0NnUCUrdG0gW2EnajNdVW1VbWRiWG1UK1ZoPCJKKUBbVnBNMnEsJXdyJ0ZnJ1VHVEl4RFAvLVplXk8tWD10K3Jmb2J+K00kTnFqNy49SEFENyFuLjhRJjVyKDF+T3o/IzdgTG9IW2N5QV8iWVBsWU1ySF93dFlzdCs8fn0nXTBeTzNtOl07Izl7Wi8kRDUmVkh6LCdwaixyYSlGMUFecV43V2c4cFFfN0xtb2Z+bTUrWFtoNyEwYX5US2tnO2kyIn1WMEw0ejZpPzwmIXxGfEJqNDNze0hVWmhXOFB+byx0NzBacTovWT4sJnAsYTJ+ZXMgJ3s0R3JJPU9caHYqdiV6PGc9XTcsO3E1Q2BSaEhEUydvQ1R4L2IuPntdfjsheS88Wid8PFJEW2Q5QVFHQWJTTyslMi00RVkpTTx0WzstM0NKUDJCJzdSQGk0N1hpcHNBayVJP309QFc8OSgzT281bnM0bX1JXD1MVmRcbVheL1U6L3FAN3lMWEJUTFlxKzhzIHB1NjxFUGhzZGYvI2JWJyNSS3YnIiZoVlRkTk5DezVnVWRKXWl3MVluV11vVVxoZic+I1c4bzxbXSppJCVxRH5OS3pzaSkhLjVmdTtJOD42WDJXPnYzV0NzWHgqQDA+K2xLeUN0czx5USZgKDhlayYxLEo+MjsmWzMhUSxLRmZ3XzxVPUIlcjhxYnFKNXBrJiQhQGBxWmlNYCA7L0pvK1MuUDY3Ly4mX1VNXlJ6W2xQVlZKPVxRQFw0QDN5SThcUihTaispM1knX31FNE8hcXI+dX1qKnBsWXtfNFJmJzZOd1VhKiR2SE0tZk0kITdec2ZLMW48JUY1ezI6M21fZ3stfUUhMFZebypeJ0dUfiorYkJYVG1GMSIhYXs9JUBeMUUjb0Y9TVJRZD5yQE92R3NwYEIyajN6KHUoLEMtdyQ1J1BZTT5YNWlCXV1JKW14OWN7RDpGPnxgPHU0OCRyTyR5UkFPYypQYDNvKScrY3E6MEg4NHVHOHBBTWFadlRgUFt0WkA5KktnRTJ6d3opVV4kYnYxPzprfm10UzdGfFBKSCxYWWQ3K0MkaDk6SFlDT0p5NilrKyY5QWMwYCBlNzslKSksbiJ2SmJFMWdNS3NTZWtccTMnXCJLPmBEbDo9YUd3ZSRFLD8jT1F1b2tpNG9UV0ElLS50PzAnSWNheUNreEtpKU5hbVQxLSQ4KVEgNFQ0OiRXJEJfN1Q2Pjwxak1IJi91YyRWLDc8NyVwO3BNZ2Zsb1t1fnZMQyFpPUU6Zlw7VG4mYnpqIFY3PlNIWCMhJWtHSU8ueHlXXTkpS3RoR2N5U0FCLlw/aHhYVV8mPXhsdHY2TCIhIHlDbG9KR2BKJVxBciNrWCxee3Z4RWhddG5HYls+fW9udGJPXC98MXclSSl2IWRGNTogXUl8MiRsdHRYUmpvd2dvUmFuIjh7IXBAWC9lRlFibS1jTVBnXGt7MCVGY2BsNk1AI1B1VzdgZDFPMidQV1c3J2Y7XHNlKydvaiBuJXQiKiw6VkNHTzYqPydrLzNvXnRgJDc4NjIsS1NtPX1fUjIxZmE/O1B1Q25iSXN9S0JhWlV1LiA1aHxKOjMiJWJZYnYvUyhQUFFpRjNUTydsLVpmMlFCRz06fjFXN0ggZDdHLChmVDFLam5MKTllRjExXTtfY29TS3d1ZnBJMmlZIDVycGBcMGM2QFw1I1EkXTtiakx2bHV0ZylyNUlWdWY0ZX0sWSovOlosOTQsTURsKyFpejNtOTUsWFQlZUg4RlNxb3k2aE54NFthKko6b1pXIiZTOyo0IVVhUjNQaW1KQ2B+OnZoRkRAeCwmcn5ISGZXcSgpMXldVWY6UkhNLnZVejEyKnd4aFJcV0MgO2Msc3M9YS48O20jU3pUcG1ybFVERFBjaU5BU0tObURtRSE0Ni9eZUkyLFo+a3FNOVlPMi9qYEhfL3d9K3lITC1wazYuaHtyN3pnOkY9Nz5lKns4bERGazR9dmdqMkYuc3FJKyFCdkA/Q1s0YDVSKWAxRywjNU1hcWJbIF9QaWU4MUhoLHFpbnlXZD41XXZYeWxjVnp0cCdpICB4YGJ3fGMkeXJccFJQTi1QW3h8WXY+MXRgb0p3eHIxfGRaYEYnPzwsbEgpI0ooTkZ7R0xFYGJwQl9ESTVDST0zeCJ3dHFNJj8jM3ZGXys3KUktRUhdK0VuezZ4TnB6JFhBInYreG4zKFtfPCVPL2dqIlNPOl9lJXdoIDJ9NSAuWHZMazx8WlZEUShZKiQrdWN3cShdOXclbjtYbjUqdX5xRWo8fFhPXTxiOj9fNksid0YyPnx6anVoIzMtWXVNfUdKYk56LnhMYygidy43QykoST5CODA/aEInfWtFamZlI1lDQy03Xi14U0NBcWxHJmZbYyFIWClgZFFNeiIjKXJxJUouSCJ4OjRaLDRRTEVDJ3F8W1FnZFdnPl4oTC0rLlpWfFtqUktqQjRXMFA/ZTxUMz1GM0RMVWlDZU4hTkZhMz9nNXc/QypxM3dGMFUxaj1MI3IjUHdcJHdUYyo9TEs/dDU5REtPan4gQTdyOGExQnchLD1bMG5rcDp3eC0gYDZ2X0dHQkgxR0Ytc2w2VUxafGFVZElmNnE1JD4jdENvQyxEXC8/I31vLCdjcklDcW5afXw6cGFhJC0

parameter

WithContext method only

CreateKeyStorePemCertificateOptions

The CreateKeyStorePemCertificate options.

Example request

curl -X POST --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: multipart/form-data"   --form 'label=certlabel'   --form 'certificate_file=@tempdir/test-file.txt;type=application/octet-stream'   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store"
Copy to clipboard

Example request

createKeyStorePemCertificateOptions := mqcloudService.NewCreateKeyStorePemCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "certlabel",
  CreateMockReader("This is a mock file."),
)

keyStoreCertificateDetails, response, err := mqcloudService.CreateKeyStorePemCertificate(createKeyStorePemCertificateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(keyStoreCertificateDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

KeyStoreCertificateDetails

The details of a key store certificate in a queue manager certificate key store.

KeyStoreCertificateDetails

The details of a key store certificate in a queue manager certificate key store.

Examples:

Status Code

201
An object containing details of the queue manager's key store certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
405
Method not allowed
409
Conflict
429
Service Is Overused
500
Internal Server Error
503
Service Unavailable Error

Example responses

Status 201

{
  "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",
  "config": {
    "ams": {
      "channels": [
        {
          "name": "CLOUD.APP.SVRCONN"
        }
      ]
    }
  }
}
Copy to clipboard

Success example

{
  "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",
  "config": {
    "ams": {
      "channels": [
        {
          "name": "CLOUD.APP.SVRCONN"
        }
      ]
    }
  }
}
Copy to clipboard

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

(mqcloud *MqcloudV1) ListKeyStoreCertificates(listKeyStoreCertificatesOptions *ListKeyStoreCertificatesOptions) (result *KeyStoreCertificateDetailsCollection, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) ListKeyStoreCertificatesWithContext(ctx context.Context, listKeyStoreCertificatesOptions *ListKeyStoreCertificatesOptions) (result *KeyStoreCertificateDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListKeyStoreCertificatesOptions struct and set the fields to provide parameter values for the ListKeyStoreCertificates method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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

parameter

WithContext method only

ListKeyStoreCertificatesOptions

The ListKeyStoreCertificates options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store"
Copy to clipboard

Example request

listKeyStoreCertificatesOptions := mqcloudService.NewListKeyStoreCertificatesOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
)

keyStoreCertificateDetailsCollection, response, err := mqcloudService.ListKeyStoreCertificates(listKeyStoreCertificatesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(keyStoreCertificateDetailsCollection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

KeyStoreCertificateDetailsCollection

A list of certificates in a queue manager's certificate key store.

KeyStoreCertificateDetailsCollection

A list of certificates in a queue manager's certificate key store.

Examples:

Status Code

200
An object containing a list of key store certificates for a queue manager.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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",
      "config": {
        "ams": {
          "channels": [
            {
              "name": "CLOUD.APP.SVRCONN"
            }
          ]
        }
      }
    }
  ]
}
Copy to clipboard

Success example

{
  "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",
      "config": {
        "ams": {
          "channels": [
            {
              "name": "CLOUD.APP.SVRCONN"
            }
          ]
        }
      }
    }
  ]
}
Copy to clipboard

Get a key store certificate for queue manager.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}

(mqcloud *MqcloudV1) GetKeyStoreCertificate(getKeyStoreCertificateOptions *GetKeyStoreCertificateOptions) (result *KeyStoreCertificateDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetKeyStoreCertificateWithContext(ctx context.Context, getKeyStoreCertificateOptions *GetKeyStoreCertificateOptions) (result *KeyStoreCertificateDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetKeyStoreCertificateOptions struct and set the fields to provide parameter values for the GetKeyStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

GetKeyStoreCertificateOptions

The GetKeyStoreCertificate options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store/${certificate_id}"
Copy to clipboard

Example request

getKeyStoreCertificateOptions := mqcloudService.NewGetKeyStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

keyStoreCertificateDetails, response, err := mqcloudService.GetKeyStoreCertificate(getKeyStoreCertificateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(keyStoreCertificateDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

KeyStoreCertificateDetails

The details of a key store certificate in a queue manager certificate key store.

KeyStoreCertificateDetails

The details of a key store certificate in a queue manager certificate key store.

Examples:

Status Code

200
An object containing details of the queue manager key store certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "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",
  "config": {
    "ams": {
      "channels": [
        {
          "name": "CLOUD.APP.SVRCONN"
        }
      ]
    }
  }
}
Copy to clipboard

Success example

{
  "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",
  "config": {
    "ams": {
      "channels": [
        {
          "name": "CLOUD.APP.SVRCONN"
        }
      ]
    }
  }
}
Copy to clipboard

Delete a queue manager's key store certificate.

DELETE /v1/{service_instance_guid}/queue_managers/{queue_manager_id}/certificates/key_store/{certificate_id}

(mqcloud *MqcloudV1) DeleteKeyStoreCertificate(deleteKeyStoreCertificateOptions *DeleteKeyStoreCertificateOptions) (response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DeleteKeyStoreCertificateWithContext(ctx context.Context, deleteKeyStoreCertificateOptions *DeleteKeyStoreCertificateOptions) (response *core.DetailedResponse, err error)

Request

Instantiate the DeleteKeyStoreCertificateOptions struct and set the fields to provide parameter values for the DeleteKeyStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

DeleteKeyStoreCertificateOptions

The DeleteKeyStoreCertificate options.

Example request

curl -X DELETE --location --header "Authorization: Bearer ${iam_token}"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store/${certificate_id}"
Copy to clipboard

Example request

deleteKeyStoreCertificateOptions := mqcloudService.NewDeleteKeyStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

response, err := mqcloudService.DeleteKeyStoreCertificate(deleteKeyStoreCertificateOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteKeyStoreCertificate(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Resource was deleted successfully.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

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

(mqcloud *MqcloudV1) DownloadKeyStoreCertificate(downloadKeyStoreCertificateOptions *DownloadKeyStoreCertificateOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) DownloadKeyStoreCertificateWithContext(ctx context.Context, downloadKeyStoreCertificateOptions *DownloadKeyStoreCertificateOptions) (result io.ReadCloser, response *core.DetailedResponse, err error)

Request

Instantiate the DownloadKeyStoreCertificateOptions struct and set the fields to provide parameter values for the DownloadKeyStoreCertificate method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

service_instance_guid
Required*
string
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_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233

parameter

WithContext method only

DownloadKeyStoreCertificateOptions

The DownloadKeyStoreCertificate options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/octet-stream"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store/${certificate_id}/download"
Copy to clipboard

Example request

downloadKeyStoreCertificateOptions := mqcloudService.NewDownloadKeyStoreCertificateOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
)

result, response, err := mqcloudService.DownloadKeyStoreCertificate(downloadKeyStoreCertificateOptions)
if err != nil {
  panic(err)
}
if result != nil {
  defer result.Close()
  outFile, err := os.Create("result.out")
  if err != nil { panic(err) }
  defer outFile.Close()
  _, err = io.Copy(outFile, result)
  if err != nil { panic(err) }
}
Copy to clipboard

Response

Response type: io.ReadCloser

Response Body

binary

Response of a certificate file.

Status Code

200
OK
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

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

(mqcloud *MqcloudV1) GetCertificateAmsChannels(getCertificateAmsChannelsOptions *GetCertificateAmsChannelsOptions) (result *ChannelsDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetCertificateAmsChannelsWithContext(ctx context.Context, getCertificateAmsChannelsOptions *GetCertificateAmsChannelsOptions) (result *ChannelsDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetCertificateAmsChannelsOptions struct and set the fields to provide parameter values for the GetCertificateAmsChannels method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

queue_manager_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233
service_instance_guid
Required*
string
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

parameter

WithContext method only

GetCertificateAmsChannelsOptions

The GetCertificateAmsChannels options.

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store/${certificate_id}/config/ams"
Copy to clipboard

Example request

getCertificateAmsChannelsOptions := mqcloudService.NewGetCertificateAmsChannelsOptions(
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
)

channelsDetails, response, err := mqcloudService.GetCertificateAmsChannels(getCertificateAmsChannelsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(channelsDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ChannelsDetails

A list of channels that are configured with this certificate.

ChannelsDetails

A list of channels that are configured with this certificate.

Examples:

Status Code

200
Details of AMS channels that are configured with the given certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "channels": [
    {
      "name": "CLOUD.APP.SVRCONN"
    }
  ]
}
Copy to clipboard

Success example

{
  "channels": [
    {
      "name": "CLOUD.APP.SVRCONN"
    }
  ]
}
Copy to clipboard

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

(mqcloud *MqcloudV1) SetCertificateAmsChannels(setCertificateAmsChannelsOptions *SetCertificateAmsChannelsOptions) (result *ChannelsDetails, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) SetCertificateAmsChannelsWithContext(ctx context.Context, setCertificateAmsChannelsOptions *SetCertificateAmsChannelsOptions) (result *ChannelsDetails, response *core.DetailedResponse, err error)

Request

Instantiate the SetCertificateAmsChannelsOptions struct and set the fields to provide parameter values for the SetCertificateAmsChannels method.

Custom Headers

Accept-Language
string
The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*
Example: en-US,en;q=0.5

Path Parameters

queue_manager_id
Required*
string
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
certificate_id
Required*
string
The id of the certificate.

Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[0-9a-fA-F]*$
Example: 9b7d1e723af8233
service_instance_guid
Required*
string
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

Request Body

Required*

UpdateChannelsBody

Certificate AMS Channel to replace or append to.

parameter

WithContext method only

SetCertificateAmsChannelsOptions

The SetCertificateAmsChannels options.

Example request

curl -X PUT --location --header "Authorization: Bearer ${iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "channels": [] }'   "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}/certificates/key_store/${certificate_id}/config/ams"
Copy to clipboard

Example request

channelDetailsModel := &mqcloudv1.ChannelDetails{
}

setCertificateAmsChannelsOptions := mqcloudService.NewSetCertificateAmsChannelsOptions(
  "b8e1aeda078009cf3db74e90d5d42328",
  "9b7d1e723af8233",
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  []mqcloudv1.ChannelDetails{*channelDetailsModel},
)

channelsDetails, response, err := mqcloudService.SetCertificateAmsChannels(setCertificateAmsChannelsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(channelsDetails, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ChannelsDetails

A list of channels that are configured with this certificate.

ChannelsDetails

A list of channels that are configured with this certificate.

Examples:

Status Code

200
The updated list of AMS channels that are using this certificate.
301
URI has permanently Moved
400
Bad Request
401
Unauthorized
404
Resource not found
429
Service Is Overused
500
Internal Server Error

Example responses

Status 200

{
  "channels": [
    {
      "name": "CLOUD.APP.SVRCONN"
    }
  ]
}
Copy to clipboard

Success example

{
  "channels": [
    {
      "name": "CLOUD.APP.SVRCONN"
    }
  ]
}
Copy to clipboard

Introduction

SDK language support

Endpoint URLs

Authentication

Auditing

Error handling

Understanding error models

Pagination

Rate limiting

Methods

Get the usage details

Request

Custom Headers

Accept-Language

Path Parameters

service_instance_guid

parameter

ctx

GetUsageDetailsOptions

ServiceInstanceGuid

Response

Response Body

vpc_entitlement

vpc_usage

Usage

VpcEntitlement

VpcUsage

Status Code

200

301

400

401

404

429

500

Return configuration options (eg, available deployment locations, queue manager sizes)

Request

Custom Headers

Accept-Language

Path Parameters

service_instance_guid

parameter

ctx

GetOptionsOptions

ServiceInstanceGuid

Response

Response Body

locations

sizes

versions

latest_version

ConfigurationOptions

Locations

Sizes

Versions

LatestVersion

Status Code

200

301

400

401

404

429

500

Create a new queue manager

Request

Custom Headers

Accept-Language

Path Parameters

service_instance_guid

Request Body

name

location

size

display_name

version

parameter

ctx

CreateQueueManagerOptions

ServiceInstanceGuid