Admin Filesystem

Generated admin filesystem operations.

GET/v1/admin/filesystemRead server filesystemadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_filesystem

Parameters

Name	In	Type
`path`	query	`string`
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–200
`includeFiles`	query	`string`
`showHidden`	query	`string`
`prefix`	query	`string`
`checkWritable`	query	`string`

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "entries": [
      {
        "bytes": 0,
        "hidden": true,
        "kind": "string",
        "name": "Fargo",
        "path": "string",
        "readable": true,
        "reason": "string",
        "symlink": true
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "parent": "string",
    "path": "string",
    "platform": "string",
    "reason": "string",
    "roots": [
      {
        "classification": "string",
        "description": "string",
        "driveType": "string",
        "kind": "string",
        "name": "Fargo",
        "networkTarget": "string",
        "path": "string"
      }
    ],
    "runsAs": "string",
    "separator": "string",
    "suggestions": [
      "string"
    ],
    "truncated": true,
    "writable": true,
    "writableChecked": true
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- entriesarray of objectrequired0–200 items
  - bytesinteger
  - hiddenbooleanrequired
  - kindstringrequired
  - namestringrequired
  - pathstringrequired
  - readablebooleanrequired
  - reasonstring
  - symlinkbooleanrequired
- nextCursorstringrequired
- parentstringrequired
- pathstringrequired
- platformstringrequired
- reasonstring
- rootsarray of objectrequired0–64 items
  - classificationstring
  - descriptionstringrequired
  - driveTypestring
  - kindstringrequired
  - namestringrequired
  - networkTargetstring
  - pathstringrequired
- runsAsstring
- separatorstringrequired
- suggestionsarray of stringrequired0–8 items
- truncatedbooleanrequired
- writablebooleanrequired
- writableCheckedbooleanrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/filesystem" \
  -H "Authorization: Bearer $PORTICO_API_KEY"