API Endpoints for Applications
« Back to the list of API endpoints
Get a list of all applications
GET /applications.json
Example with curl:
curl -H "X-Api-Token: abcde123456" http://my-cartoque-server/applications.json
Expected response:
{
"applications": [
{
"id": "4abc33",
"name": "Main Webapp",
"description": "A shiny application description."
}
]
}
Parameters:
-
search=[term]
: filters on servers which name include [term]
Other formats: xml and csv formats used to be there but will be removed in a future release. Don't use them!
Show a specific server
GET /applications/:id.json
Example with curl:
curl -sLH "X-Api-Token: abcde123456" http://my-cartoque-server/applications/4abc33.json
Expected response:
{
"application": {
"id": "4abc33",
"name": "Main Webapp",
"description": "A shiny application description."
}
}
Parameters: none.