Upsert an application instance

Request

Creates or updates (upserts) an application instance.

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

Unique identifier of the application.

Bodyapplication/json
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/application-instances/{applicationId}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Application instance updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
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": [ {} ] }