Upsert an application instance

Creates or updates (upserts) an application instance.

SecuritySecretApiKey or JWT
Request
path Parameters
applicationId
required
string <= 50 characters ^[@~\-\.\w]+$

Application identifier string.

Request Body schema: application/json
required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

property name*
additional property
string
Responses
200

Application instance updated.

Response Schema: application/json
required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

property name*
additional property
string
status
string

Status of the application instance.

Enum: "enabling" "enabled" "disabling" "disabled"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
201

Application instance created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

property name*
additional property
string
status
string

Status of the application instance.

Enum: "enabling" "enabled" "disabling" "disabled"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

put/application-instances/{applicationId}
Request samples
application/json
{
  • "settings": {
    }
}
Response samples
application/json
{
  • "status": "enabling",
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}