Symlinks

• List symlinks
• Get symlink
• Create symlink
• Delete symlink

List symlinks

List symlinks on a atomic site.

GET /api/site/{id}/symlinks

Example request :

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

Example response :

{
    "data": [
        {
            "id": 1,
            "from": "a",
            "to": "b",
            "file": false,
            "created_at": "2022-09-11T19:09:58.000000Z"
        }
    ],
    "links": {
        "first": "https://cloud.boxydev.com/api/site/1/symlinks?page=1",
        "last": "https://cloud.boxydev.com/api/site/1/symlinks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://cloud.boxydev.com/api/site/1/symlinks",
        "per_page": 20,
        "to": 1,
        "total": 1
    }
}

Get symlink

Show a symlink.

GET /api/symlink/{id}

Example request :

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

Example response :

{
    "id": 1,
    "from": "a",
    "to": "b",
    "file": false,
    "created_at": "2022-09-11T19:09:58.000000Z"
}

Create symlink

Create a symlink.

POST /api/site/{id}/symlink

Parameters :

Example request :

curl "https://cloud.boxydev.com/api/site/1/symlink" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{
        "from": "a",
        "to": "b",
        "file": true
    }'

Example response :

{
    "id": 1,
    "from": "a",
    "to": "b",
    "file": true,
    "created_at": "2022-09-11T19:20:42.000000Z"
}

Delete symlink

Delete a symlink.

DELETE /api/symlink/{id}

Example request :

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