# Remote endpoints (Daemon-facing)

> 10 FeatherPanel Daemon-facing endpoints from quilld/remote.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Source: https://featherpanel.com/docs/api/reference/quilld/remote/

Defined in [`backend/app/routes/quilld/remote.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php). Authentication used here: **Quilld node token**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/rate-limits-and-errors/) for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

## Endpoints

### GET `/api/quilld-remote/config`

- Auth: Quilld node token
- Route name: `quilld-remote-config`
- Controller: [`FeatherQuilldConfigController::getConfig`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldConfigController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L27)

```bash
curl -X GET "$PANEL_URL/api/quilld-remote/config" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:config:retrieved`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-config-retrieved)

### GET `/api/quilld-remote/health`

- Auth: Quilld node token
- Route name: `quilld-remote-health`
- Controller: [`FeatherQuilldHealthController::getHealth`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldHealthController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L37)

```bash
curl -X GET "$PANEL_URL/api/quilld-remote/health" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

### GET `/api/quilld-remote/webspaces/{uuid}`

- Auth: Quilld node token
- Route name: `quilld-remote-webspace`
- Controller: [`FeatherQuilldWebSpaceController::getWebSpace`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldWebSpaceController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L47)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/quilld-remote/webspaces/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:webspace:retrieved`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-web-space-retrieved)

### PATCH `/api/quilld-remote/webspaces/{uuid}`

- Auth: Quilld node token
- Route name: `quilld-remote-webspace-patch`
- Controller: [`FeatherQuilldWebSpaceController::patchWebSpace`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldWebSpaceController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L62)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X PATCH "$PANEL_URL/api/quilld-remote/webspaces/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:webspace:updated`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-web-space-updated)

### GET `/api/quilld-remote/webspaces/{uuid}/install`

- Auth: Quilld node token
- Route name: `quilld-remote-webspace-install-get`
- Controller: [`FeatherQuilldWebSpaceController::getInstall`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldWebSpaceController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L77)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/quilld-remote/webspaces/$UUID/install" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:install:retrieved`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-install-retrieved)

### POST `/api/quilld-remote/webspaces/{uuid}/install`

- Auth: Quilld node token
- Route name: `quilld-remote-webspace-install-post`
- Controller: [`FeatherQuilldWebSpaceController::postInstall`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldWebSpaceController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L92)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/quilld-remote/webspaces/$UUID/install" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:install:completed`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-install-completed)

### POST `/api/quilld-remote/webspaces/{uuid}/acme-dns`

- Auth: Quilld node token
- Route name: `quilld-remote-webspace-acme-dns`
- Controller: [`FeatherQuilldWebSpaceController::acmeDns`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldWebSpaceController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L110)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/quilld-remote/webspaces/$UUID/acme-dns" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

### POST `/api/quilld-remote/sftp/auth`

- Auth: Quilld node token
- Route name: `quilld-remote-sftp-auth`
- Controller: `SftpAuthController::authenticate`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L125)

```bash
curl -X POST "$PANEL_URL/api/quilld-remote/sftp/auth" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

### POST `/api/quilld-remote/transfers/{uuid}`

- Auth: Quilld node token
- Route name: `quilld-remote-transfer-status`
- Controller: [`FeatherQuilldTransferController::postStatus`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/FeatherQuilldTransferController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L135)

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/quilld-remote/transfers/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:transfer:status`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-transfer-status-reported)

### POST `/api/quilld-remote/activity`

- Auth: Quilld node token
- Route name: `quilld-remote-activity`
- Controller: [`QuilldActivityController::logActivity`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Quilld/QuilldActivityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/quilld/remote.php#L153)

```bash
curl -X POST "$PANEL_URL/api/quilld-remote/activity" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"
```

Plugin events: [`featherpanel:quilld:activity:logged`](https://featherpanel.com/docs/plugins/events/quilld/#quilld-activity-logged)
