API

API Status

The API status is reported on our status page.

Status Code

Every request made to the API returns the status of the communication with the API. This value is returned in the Status argument of the result.

Status  Description                      
-----   -----------------------------
 200    success    
 400    usage error                    
 500    system error

Status (of requests)

The request to generate an analysis (images) produces this status code. The value is returned in the retrieveRequestDetails(), retrieveRequestsHistory(), and retrieveRequestsInProgress() query results as part of the requests array.

Status	Message	Description
Submitted	Submitted request.	The request is in the queue and processing has not started.
SentinelQueue	Request currently in queue awaiting sentinel data download.	The request requires raw satellite data and is in the queue to retrieve that data.
SentinelConsumer	Request currently downloading sentinel data.	The necessary raw satellite data is being downloaded.
NonSentinelQueue	Request currently in queue awaiting processing.	The request has the required satellite data and is in the queue to process the analysis.
NonSentinelConsumer	Request currently being processed.	The requested analysis is being processed by the Vultus Platform.
Success	Successfully handled request.	The requested analysis has completed processing.
Error	Something went wrong processing your request. Please try again later.	There was an error while processing the request.
NoAvailableDate	There were no available dates found for your request.	There was no raw satellite data available for the dates of the request.