Online Tenant Status

In this article

    All tenant status pages are accessed in the same manner:

    GET https://sod.superoffice.com/api/state/Cust00000

    Each environment is accessed by changing the subdomain accordingly.

    SOD Available now https://sod.superoffice.com/api/state/Cust00000
    STAGE Available now https://stage.superoffice.com/api/state/Cust00000
    PRODUCTION Available now https://online.superoffice.com/api/state/Cust00000

    The response of each endpoint contains the context identifier, endpoint, functional state, whether the tenany is running or not and when the tenant infomation may expire.

    {
      "ContextIdentifier": "Cust33333",
      "Endpoint": null,
      "State": "Deleted",
      "IsRunning": false,
      "ValidUntil": "2019-09-13T10:25:19.252945Z"
    }

    All possible values are listed in the following table.

    Parameter Description
    ContextIdentifier Context identifier like Cust00000
    Endpoint Root path of customer installation will change from time to time, from "https://sod2.superoffice.com:443/Cust00000 "https://sod3.superoffice.com:443/Cust00000. Changes occur routinely to balance load and/or under special circumstances like incidents.
    State
    Value Description
    Unknown (0)

    Customer is unknown, or there is something wrong with the environment.  If the customer was previously in another state, we probably have an incident of sorts.

    Provisioning (1) We are in the state of provisioning the customer.  Should be ready in a short time.
    Running (2) Customer is running. All is good.
    Deleted (3) Customer has been deleted, forget all about it.
    Suspended (4) Customer is in termination.  API’s are not available, and the customer can still take action to reactivate his subscription.  Resuming a customer in termination typically occurs at night or by manual activation by the sales team.
    OnlineMaintenance (5) We are performing background tasks, but nothing preventing customer for performing normal operations.  API is available.  Background tasks might take some time before they start.
    OfflineMaintenance (6) Customer is offline for maintenance.  This typically happens during upgrade.  It usually take minutes for the customer to be online again.  API’s are not available.
    ProvisioningFailed (8) Provisioning has failed. 
    Deleting (10) We are in the process of deleting the customer.  Expect the customer to be deleted shortly.
    DeleteFailed (11) Deleting the customer failed.  Expect the customer to be deleted in a while.
    MigrationPending (12) This is a new migration to online that has not yet completed.  Expect the customer to be Running at a later time.  Customers are often in state MigrationPending for days or weeks.
    IsRunning Customer state is Running or OnlineMaintenance.  This indicates that API’s are up and running and all is good.
    ValidUntil When to check next time if an updated state is needed.

     

    Conclusion

    All applications should leverage the status page to ensure their applications and integrations remain stable and respond accordingly.