reserved instance

Add an application to an instance - curl

Add an application to an instance.

POST /v1/{service_instance_guid}/applications

Request

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 IBM® MQ as a 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
name
Required*
string

The name of the application - conforming to MQ rules.

Possible values: 1 ≤ length ≤ 12, Value must match regular expression ^[a-z][-a-z0-9]*$

Example: test-app

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"

Response

Response Body
ApplicationCreated
 A response to creating an application, giving the only chance to collect the apikey
id
Always included*
string
 The ID of the application which was allocated on creation, and can be used for delete calls.
name
Always included*
string

The name of the application - conforming to MQ rules.

Possible values: 1 ≤ length ≤ 12
iam_service_id
Always included*
string

The IAM ID of the application

Possible values: 5 ≤ length ≤ 50
create_api_key_uri
Always included*
string

The URI to create a new apikey for the application.
href
Always included*
string

The URL for the application.
api_key_name
string
 The name of the api key.
api_key_id
string
 The id of the api key.
api_key
Always included*
string
 The api key created.
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 response

Success 201

{
  "id": "0123456789ABCDEF0123456789ABCDEF",
  "name": "test-app",
  "iam_service_id": "IBMid-2700640RCGN",
  "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 SaaS API",
  "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636",
  "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc"
}