Queued Applications

Applications waiting to be scheduled.

When a new application is distributed to a site, it enters the application queue. It will be scheduled for upgrade immediately provided the current time falls within an application upgrade window (if one exists) and the upgrade path from the currently running version to the new version is valid.

If multiple versions of an application are present in the queue when it's time to upgrade, the latest version that can be upgraded from the current version will be selected. This means that some intermediate versions may be skipped.

Retrieve the queued applications

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/application-queue
Response samples
applications:
  - name: app1
    time: 2024-02-19T09:44:58.392Z
    application-deployment: app-dep1
    version: "1.0"
  - name: app1
    time: 2024-02-19T09:44:59.392Z
    application-deployment: app-dep-1
    version: "1.1"

Invoke the delete operation

Deletes applications that are waiting to be scheduled.

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
application-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of an application.

version
string <version> ^[a-zA-Z0-9\-.+]+$

The version of the application.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/application-queue/delete
Request samples
application-name: alpine
version: 1.1.0

Invoke the force-upgrade operation

Forces the upgrade of an application waiting to be scheduled. If no specific version is provided, or if multiple entries with the same version exist in the queue, the latest entry is selected for upgrade.

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
application-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

The name of an application.

version
string <version> ^[a-zA-Z0-9\-.+]+$

The version of the application.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/application-queue/force-upgrade
Request samples
application-name: alpine
version: 1.1.0

Invoke the force-upgrades operation

Forces the upgrade of applications waiting to be scheduled. The latest queued entry for each application is used. If no specific application is provided, all applications are selected for upgrade.

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
application-names
Array of strings <name>

Names of applications.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/application-queue/force-upgrades
Request samples
application-names:
  - alpine
  - other-app