Application

Install application

Install an application.

POST /api/site/{id}/application

Parameters :

Parameter Description
name The application type: wordpress, prestashop, phpmyadmin or phppgadmin.
meta.database The database name if app is WordPress.
meta.user The database user if app is WordPress: cloud or database user id.

Example request :

curl "https://cloud.boxydev.com/api/site/1/application" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "wordpress",
        "meta": {
            "database": "wordpress",
            "user": "cloud"
        }
    }'

Example response :

{
    "id": 1,
    "domain": "website.com",
    "test_domain": null,
    "wildcard": false,
    "aliases": null,
    "directory": "/www",
    "published": false,
    "user": "cloud",
    "status": "installed",
    "type": "laravel",
    "application": {
        "name": "wordpress",
        "meta": {
            "database": "wordpress",
            "user": "cloud"
        },
        "status": "installing"
    },
    "repository": null,
    "deployment_script": null,
    "build_script": null,
    "activate_script": null,
    "atomic": false,
    "php_version": "8.1",
    "server_id": 1,
    "created_at": "2022-08-17T18:10:37.000000Z",
    "secure": false,
    "hook_url": "...",
    "last_deployment": {
        "id": 1,
        "type": "manual",
        "branch": "main",
        "commit": {
            "hash": "1234",
            "author": "Matthieu Mota",
            "avatar": "https://avatars.githubusercontent.com/u/2427947?v=4",
            "message": "Commit",
            "url": "https://github.com/vendor/repository/commit/1234"
        },
        "output": "From github.com:vendor/repository\n * branch            main       -> FETCH_HEAD\nAlready up to date.",
        "status": "finished",
        "site_id": 1,
        "started_at": "2022-09-09T19:58:12.000000Z",
        "ended_at": "2022-09-09T19:58:31.000000Z"
    },
    "balancing_method": null,
    "tags": []
}

Uninstall application

Uninstall an application.

DELETE /api/site/{id}/application

Example request :

curl -X DELETE "https://cloud.boxydev.com/api/site/1/application" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json"