Edit

File API

文件API端点

获取Avatar仓库中的文件

get

直接获取Avatar仓库中的文件内容

Path parameters
pathstringRequired

文件路径

Responses
200

成功获取文件内容

*/*
Responsestring · binary
get
GET /Avatar/{path} HTTP/1.1
Host: files.pysio.online
Accept: */*

binary

获取Pysio-FontAwesome仓库中的文件

get

直接获取Pysio-FontAwesome仓库中的文件内容

Path parameters
pathstringRequired

文件路径

Responses
200

成功获取文件内容

*/*
Responsestring · binary
get
GET /Pysio-FontAwesome/{path} HTTP/1.1
Host: files.pysio.online
Accept: */*

binary

获取所有仓库的同步状态

get

返回所有配置的Git仓库的同步状态信息

Responses
200

成功获取同步状态

application/json
get
GET /api/files/sync/status HTTP/1.1
Host: files.pysio.online
Accept: */*

{
  "code": 200,
  "message": "success",
  "data": {
    "repo1": {
      "lastSync": "2023-01-01T12:00:00Z",
      "nextSync": "2023-01-01T13:00:00Z",
      "progress": 75.5,
      "totalFiles": 100,
      "currentFiles": 75,
      "status": "syncing",
      "error": ""
    }
  }
}

获取指定路径下的文件列表

get

返回指定路径下的文件和目录列表，支持分页

Path parameters
pathstringRequired

文件路径

Query parameters
pageintegerOptional

页码，默认为1

Default: 1
pageSizeinteger · max: 100Optional

每页大小，默认为20，最大为100

Default: 20
Responses
200

成功获取文件列表

application/json
get
GET /api/files/{path} HTTP/1.1
Host: files.pysio.online
Accept: */*

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "name": "example.jpg",
      "path": "images/example.jpg",
      "size": 1024,
      "lastModified": "2023-01-01T12:00:00Z",
      "isDirectory": false,
      "url": "https://files.pysio.online/images/example.jpg"
    }
  ],
  "pagination": {
    "current": 1,
    "pageSize": 20,
    "total": 100
  }
}

获取Images存储桶中的文件

get

直接获取Images存储桶中的文件内容

Path parameters
pathstringRequired

文件路径

Responses
200

成功获取文件内容

*/*
Responsestring · binary
get
GET /Images/{path} HTTP/1.1
Host: files.pysio.online
Accept: */*

binary

获取状态摘要

get

获取从外部URL同步的状态摘要信息

Responses
200

成功获取状态摘要

application/json
Responseobject
get
GET /status/summary.json HTTP/1.1
Host: files.pysio.online
Accept: */*

{}

获取指定桶中的文件信息

patch

获取指定存储桶中的文件信息

Path parameters
bucketstringRequired

存储桶名称

pathstringRequired

文件路径

Body
bucketstringRequired

存储桶名称

Example: Images
pathstringRequired

文件路径

Example: example.jpg
Responses
200

成功获取文件信息

application/json
patch
PATCH /{bucket}/{path} HTTP/1.1
Host: files.pysio.online
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "bucket": "Images",
  "path": "example.jpg"
}
{
  "code": 200,
  "message": "success",
  "data": {
    "name": "example.jpg",
    "path": "images/example.jpg",
    "size": 1024,
    "lastModified": "2023-01-01T12:00:00Z",
    "isDirectory": false,
    "url": "https://files.pysio.online/images/example.jpg"
  }
}

获取文件内容

get

直接获取文件内容，支持从配置的仓库或暴露路径访问

Path parameters
pathstringRequired

文件路径

Responses
200

成功获取文件内容

*/*
Responsestring · binary
get
GET /{path} HTTP/1.1
Host: files.pysio.online
Accept: */*

binary

Last updated

Was this helpful?