reserved instance

Get a list of applications for an instance - curl

Get a list of applications for an instance.

GET /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
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

Example request

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

Response

Response Body
UserDetailsCollection

A list of user summaries.
offset
Always included*
integer
 Pagination offset.
limit
Always included*
integer

Results per page, same for all collections.

Possible values: value ≤ 50
First
Always included*
 Link to first page of results.
 
  • href
    string

    The URL of the page the link goes to.
applications
Always included*

List of applications.

Possible values: 0 ≤ number of items ≤ 50
 
  • 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 details.
next
Always included*
 Link to next page of results.
 
  • href
    string

    The URL of the page the link goes to.
previous
Always included*
 Link to previous page of results.
 
  • href
    string

    The URL of the page the link goes to.
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 response

Success 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",
      "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"
    }
  ]
}