Subtenant Applications Summary

Summary of the status of all applications.

This summary contains an aggregation of the status for all applications. It is intended to provide an overview of the state of the applications.

If the oper-status of an application is error, or all-sites-connected is false, more info can be found in Application Sites Summary.

If the deploying field is true, more info about the deployment can be found in Application Deployments.

Retrieve the application summary

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/tenants/{tenant-name}/application-status/summary
Response samples
applications:
  - name: popcorn-controller
    application-deployment: popcorn-controller-deployment
    oper-status: running
    selected-sites: 16
    deployed-to-sites: 16
    deploy-failed-to-sites: 0
    locally-modified-sites: 0
    deploying: false
    all-sites-connected: false
    sites-details:
      waiting-for-distribution: 0
      waiting-to-be-scheduled: 0
      starting: 0
      running: 15
      error: 1
  - name: ticket-manager
    application-deployment: ticket-manager-deployment
    oper-status: error
    selected-sites: 8
    deployed-to-sites: 3
    deploy-failed-to-sites: 2
    locally-modified-sites: 1
    deploying: true
    all-sites-connected: true
    sites-details:
      waiting-for-distribution: 0
      waiting-to-be-scheduled: 4
      starting: 0
      running: 4
      error: 0