Users

• List users
• Get user
• Create user
• Delete user

List users

List users on a server.

GET /api/server/{id}/users

Example request :

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

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "smooth-winter-jXNdrJYKEylG5Ioz",
            "status": "installed",
            "server_id": 1,
            "created_at": "2022-08-23T16:54:12.000000Z"
        }
    ],
    "links": {
        "first": "https://cloud.boxydev.com/api/server/1/users?page=1",
        "last": "https://cloud.boxydev.com/api/server/1/users?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://cloud.boxydev.com/api/server/1/users",
        "per_page": 20,
        "to": 1,
        "total": 1
    }
}

Get user

Show a user.

GET /api/server-user/{id}

Example request :

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

Example response :

{
    "id": 1,
    "name": "smooth-winter-jXNdrJYKEylG5Ioz",
    "status": "installed",
    "server_id": 1,
    "created_at": "2022-08-23T16:54:12.000000Z"
}

Create user

Create a user.

POST /api/server/{id}/user

Parameters :

Example request :

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

Example response :

{
    "id": 1,
    "name": "fiorella",
    "status": "installing",
    "server_id": 1,
    "created_at": "2022-08-28T08:39:16.000000Z"
}

Delete user

Delete a user.

DELETE /api/server-user/{id}

Example request :

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