ForePaaS APIs#

In addition to the graphical user interface (GUI), you can also interact with your ForePaaS Project through the endpoints in the ForePaaS APIs. It provides a developer alternative to the GUI for building and managing ForePaaS Projects.

Below are the API references for each component.

#General formats

#Response format

• Data format: JSON see http://www.json.org
• Character set: UTF-8
• All non-empty responses are sent with the header: Content-Type: application/json; charset=utf-8

#HTTP response codes

#Error handling

In case of client-side (HTTP status code 4xx) or server-side (HTTP status code 5xx) error, the response body may contain a JSON object describing the error:

{
   "error": "Invalid parameter", // code 400, 403, 500
   "warning": "Action not found" // code 404
}

#Timestamp

All data endpoints return the timestamp associated with the data provided.

{
    "timestamp": 1435929960
}

#Duration

All data endpoints return the duration attribute. It represents the effective time taken by the system to execute a request in seconds.

{
    "duration": 0.056
}