Create a new apikey for an application - curl

Create a new apikey for an application.

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

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*
CreateApplicationAPIKeyBody
 Application APIKey to add to the application
name
Required*
string

The short name of the application api key - conforming to MQ rules.

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

Example 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"

Response

Response Body
ApplicationAPIKeyCreated

A response to creating a new api key, giving the only chance to collect the new apikey
api_key
Always included*
string
 The api key created.
api_key_name
string
 The name of the api key.
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

Response example

Status 201

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