Retrieve the Availability Status of a Marketing Cloud Account
You can use the GetSystemStatus API call to retrieve the status of the Marketing Cloud SOAP API.
Use this call in exception-handling circumstance, NOT prior to every API call. New SOAP faults provide more information on application issues resulting in failed logins.
Take the following actions based on the status of Marketing Cloud:
- If the GetSystemStatus call returns OK, no action is required.
- If the GetSystemStatus call returns InMaintenance, place your application into a queuing mode and periodically make the GetSystemStatus call until the status returns to OK.
- If the GetSystemStatus call returns UnplannedOutage, place your application into a queuing mode, contact Marketing Cloud, and periodically make the GetSystemStatus call until the status returns to OK.
Use the sample code below as a model to set up your own API call. The code uses the GetSystemStatus call, which returns one of the following three result messages:
- OK: All systems are up and running
- InMaintenance: Marketing Cloud systems are in planned maintenance
- UnplannedOutage: Marketing Cloud systems are having an unplanned outage
The SystemStatusResult object contains the applicable message.
Retrieving the System Status of Marketing Cloud
To properly understand and act upon the system status of Marketing Cloud, your environment must include the following elements:
Global Status Container
Your application must include a global Marketing Cloud status container. The value of this container allows your application to change code paths to ensure all messages are stored while waiting for Marketing Cloud's status to return to OK. If the global status container contains an **InMaintenance **or **UnplannedOutage **status, be sure to wait for the scheduled status call (described below) to update the global status container to the OK status.
Scheduled Status Calls
Your application must include a scheduled status-checking component that can respond to error situations and update the global status container if the status is different. Marketing Cloud recommends executing the GetCurrentStatus call every 10 minutes. Don't run the call prior to every API call or every 30 seconds.
Your application must execute the GetSystemStatus call when SOAP exceptions (or other unplanned exceptions) occur in your application. If the GetSystemStatus call returns anything other thanOK, the API updates the global status container to allow Marketing Cloud to safely respond to the exception scenario.