reserved instance

Update the name for an application - curl

Update the name assigned to an IBM® MQ as a Service application.

PATCH /v1/{service_instance_guid}/applications/{application_id}

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
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*
UpdateApplicationBody
 Application to add to the list
name
Required*
string

The new name to update the application with

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

Example request

curl -X PATCH --location --header "Authorization: Bearer ${iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "name": "testString" }' "${base_url}/v1/${service_instance_guid}/applications/${application_id}"

Response

Response Body
ApplicationDetailsCollection

A list of application summaries
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.
Status code  
200 Application name was updated successfully
400 Bad Request
401 Unauthorized
404 Resource not found
429 Service Is Overused
500 Internal Server Error

Response example

Status 200

{
  "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"
}