/
Retrieve an application i...

Retrieve an application instance

Request

Retrieves an application instance with the specified ID.

Security
SecretApiKey or JWT
Path
applicationIdstring, <= 50 characters^[@~\-\.\w]+$required

Unique identifier of the application.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Application instance retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
statusstringread-only

Current status of the application instance.

Enum:"enabling""enabled""disabling""disabled"
isConfiguredbooleanread-only

Specifies if the configuration of the application instance is complete. Some applications require additional configuration after installation before they can be used. Configuration is completed using the Upsert an application instance configuration operation.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

settingsobjectread-onlydeprecated

Configuration settings submitted during installation.

Example:
{
  "color": "red",
  "limit": "5"
}
Response
{
  "status": "enabling",
  "isConfigured": true,
  "settings": {
    "color": "red",
    "limit": "5"
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}