api.bigfs.m7.org Endpoint Documentation

Generated on 2026-07-19 from cli/endpoints.php --json, config/general.json, and the PHP handlers under lib/php/thisProject/api.

Conventions

  • Base URL: https://api.bigfs.m7.org
  • Response format: json; error format: json.
  • Request parameters are read from the parsed request payload ($this->r), which may include query, form, or JSON body values depending on the router parser.
  • ANY means the route is registered without an HTTP-method constraint. Prefer POST for mutations and request bodies unless the caller contract says otherwise.
  • "Detected request fields" are statically extracted from handlers and delegated service methods; table-backed filters may accept additional fields.

Authentication

  • M7 token config: check hard, issuer id.m7.org; mode consumer; allowed algorithms RS512.
  • Principal route protection from config:
    • /v1/asset
    • /v1/bucket
    • /v1/handler -> admin, root
    • /v1/key
    • /v1/offline_access
    • /v1/remote_asset
    • /v1/task_queue
    • /v1/upload
    • /v1/vault
    • /v1/download/issue, /v1/download/pull, /v1/download/redir -> configured principal exact match

Endpoint Summary

Method Path Auth Handler
ANY /v1/asset/bykey principal route rule: configured principal; consumer M7 token required by base contro... asset\ByKey
ANY /v1/asset/delete principal route rule: configured principal; consumer M7 token required by base contro... asset\Delete
ANY /v1/asset/search principal route rule: configured principal; consumer M7 token required by base contro... asset\Search
ANY /v1/asset/view principal route rule: configured principal; consumer M7 token required by base contro... asset\View
ANY /v1/bucket/delete principal route rule: configured principal; consumer M7 token required by base contro... bucket\Delete
ANY /v1/bucket/search principal route rule: configured principal; consumer M7 token required by base contro... bucket\Search
ANY /v1/bucket/view principal route rule: configured principal; consumer M7 token required by base contro... bucket\View
ANY /v1/download/issue principal route rule: configured principal; consumer M7 token required by base contro... download\Issue
ANY /v1/download/link consumer M7 token required by base controller download\Link
ANY /v1/download/pull principal route rule: configured principal; consumer M7 token required by base contro... download\Pull
ANY /v1/download/redir principal route rule: configured principal; consumer M7 token required by base contro... download\Redir
ANY /v1/handler/delete principal route rule: admin, root; consumer M7 token required by base controller handler\Delete
ANY /v1/handler/search principal route rule: admin, root; consumer M7 token required by base controller handler\Search
ANY /v1/handler/view principal route rule: admin, root; consumer M7 token required by base controller handler\View
ANY /v1/key/bykey principal route rule: configured principal; consumer M7 token required by base contro... key\ByKey
ANY /v1/key/cleanup principal route rule: configured principal; consumer M7 token required by base contro... key\Cleanup
ANY /v1/key/delete principal route rule: configured principal; consumer M7 token required by base contro... key\Delete
ANY /v1/key/search principal route rule: configured principal; consumer M7 token required by base contro... key\Search
ANY /v1/key/view principal route rule: configured principal; consumer M7 token required by base contro... key\View
ANY /v1/offline_access/oauth/device/delete principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\Delete
ANY /v1/offline_access/oauth/device/issue principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\Issue
ANY /v1/offline_access/oauth/device/pickup principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\Pickup
ANY /v1/offline_access/oauth/device/search principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\Search
ANY /v1/offline_access/oauth/device/update principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\Update
ANY /v1/offline_access/oauth/device/view principal route rule: configured principal; consumer M7 token required by base contro... offline_access\oauth\device\View
ANY /v1/public/redir consumer M7 token required by base controller public\Redir
ANY /v1/remote_asset/byasset principal route rule: configured principal; consumer M7 token required by base contro... remote_asset\ByAsset
ANY /v1/remote_asset/delete principal route rule: configured principal; consumer M7 token required by base contro... remote_asset\Delete
ANY /v1/remote_asset/search principal route rule: configured principal; consumer M7 token required by base contro... remote_asset\Search
ANY /v1/remote_asset/view principal route rule: configured principal; consumer M7 token required by base contro... remote_asset\View
ANY /v1/task_queue/byasset principal route rule: configured principal; consumer M7 token required by base contro... task_queue\ByAsset
ANY /v1/task_queue/process principal route rule: configured principal; consumer M7 token required by base contro... task_queue\Process
ANY /v1/task_queue/search principal route rule: configured principal; consumer M7 token required by base contro... task_queue\Search
ANY /v1/task_queue/view principal route rule: configured principal; consumer M7 token required by base contro... task_queue\View
ANY /v1/upload/form_data principal route rule: configured principal; consumer M7 token required by base contro... upload\FormData
ANY /v1/upload/post_data principal route rule: configured principal; consumer M7 token required by base contro... upload\PostData
ANY /v1/vault/delete principal route rule: configured principal; consumer M7 token required by base contro... vault\Delete
ANY /v1/vault/search principal route rule: configured principal; consumer M7 token required by base contro... vault\Search
ANY /v1/vault/view principal route rule: configured principal; consumer M7 token required by base contro... vault\View

Endpoints

ANY /v1/asset/bykey

Handles asset bykey.

  • Handler: thisProject\api\asset\ByKey
  • Source: lib/php/thisProject/api/asset/ByKey.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
    • key (optional/detected). Key id/name or drop encryption key depending on the endpoint.
  • Response: data key(s): status, data.

ANY /v1/asset/delete

Deletes asset.

  • Handler: thisProject\api\asset\Delete
  • Source: lib/php/thisProject/api/asset/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • key (optional/detected). Key id/name or drop encryption key depending on the endpoint.
  • Response: data key(s): status, comment, data.

ANY /v1/asset/search

Searches asset.

  • Handler: thisProject\api\asset\Search
  • Source: lib/php/thisProject/api/asset/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, data.

ANY /v1/asset/view

Gets asset.

  • Handler: thisProject\api\asset\View
  • Source: lib/php/thisProject/api/asset/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • key (optional/detected). Key id/name or drop encryption key depending on the endpoint.
  • Response: data key(s): status, data.

ANY /v1/bucket/delete

Deletes bucket.

  • Handler: thisProject\api\bucket\Delete
  • Source: lib/php/thisProject/api/bucket/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • action (optional/detected). Action selector for handlers that multiplex behavior.
  • Response: data key(s): status, comment, data.
  • Notable errors: no id specified.

ANY /v1/bucket/search

Searches bucket.

  • Handler: thisProject\api\bucket\Search
  • Source: lib/php/thisProject/api/bucket/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • Response: data key(s): status, data.

ANY /v1/bucket/view

Gets bucket.

  • Handler: thisProject\api\bucket\View
  • Source: lib/php/thisProject/api/bucket/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data.

ANY /v1/download/issue

Issues download.

  • Handler: thisProject\api\download\Issue
  • Source: lib/php/thisProject/api/download/Issue.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller; consumer M7 token required by handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /v1/download/link

Consumes a link for download.

  • Handler: thisProject\api\download\Link
  • Source: lib/php/thisProject/api/download/Link.php
  • Auth: consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: JSON response from the handler/delegated service.

ANY /v1/download/pull

Pulls download.

  • Handler: thisProject\api\download\Pull
  • Source: lib/php/thisProject/api/download/Pull.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller; consumer M7 token required by handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: JSON response from the handler/delegated service.

ANY /v1/download/redir

Returns redirect data for download.

  • Handler: thisProject\api\download\Redir
  • Source: lib/php/thisProject/api/download/Redir.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller; consumer M7 token required by handler
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: JSON response from the handler/delegated service.

ANY /v1/handler/delete

Deletes handler.

  • Handler: thisProject\api\handler\Delete
  • Source: lib/php/thisProject/api/handler/Delete.php
  • Auth: principal route rule: admin, root; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, comment, data.

ANY /v1/handler/search

Searches handler.

  • Handler: thisProject\api\handler\Search
  • Source: lib/php/thisProject/api/handler/Search.php
  • Auth: principal route rule: admin, root; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /v1/handler/view

Gets handler.

  • Handler: thisProject\api\handler\View
  • Source: lib/php/thisProject/api/handler/View.php
  • Auth: principal route rule: admin, root; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data.

ANY /v1/key/bykey

Handles key bykey.

  • Handler: thisProject\api\key\ByKey
  • Source: lib/php/thisProject/api/key/ByKey.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
    • key (optional/detected). Key id/name or drop encryption key depending on the endpoint.
  • Response: data key(s): status, data.

ANY /v1/key/cleanup

Cleans up key.

  • Handler: thisProject\api\key\Cleanup
  • Source: lib/php/thisProject/api/key/Cleanup.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, comment, data.

ANY /v1/key/delete

Deletes key.

  • Handler: thisProject\api\key\Delete
  • Source: lib/php/thisProject/api/key/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, comment, data.

ANY /v1/key/search

Searches key.

  • Handler: thisProject\api\key\Search
  • Source: lib/php/thisProject/api/key/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, data.

ANY /v1/key/view

Gets key.

  • Handler: thisProject\api\key\View
  • Source: lib/php/thisProject/api/key/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • bucket (optional/detected). Bucket id/name.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data, last.

ANY /v1/offline_access/oauth/device/delete

Deletes offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Delete
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /v1/offline_access/oauth/device/issue

Issues offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Issue
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Issue.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /v1/offline_access/oauth/device/pickup

Picks up offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Pickup
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Pickup.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /v1/offline_access/oauth/device/search

Searches offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Search
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /v1/offline_access/oauth/device/update

Updates offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Update
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Update.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /v1/offline_access/oauth/device/view

Gets offline access oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\View
  • Source: lib/php/thisProject/api/offline_access/oauth/device/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /v1/public/redir

Returns redirect data for redir.

  • Handler: thisProject\api\public\Redir
  • Source: lib/php/thisProject/api/public/Redir.php
  • Auth: consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /v1/remote_asset/byasset

Handles remote asset byasset.

  • Handler: thisProject\api\remote_asset\ByAsset
  • Source: lib/php/thisProject/api/remote_asset/ByAsset.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • asset (optional/detected). Asset id.
  • Response: data key(s): status, data.

ANY /v1/remote_asset/delete

Deletes remote asset.

  • Handler: thisProject\api\remote_asset\Delete
  • Source: lib/php/thisProject/api/remote_asset/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, comment, data.

ANY /v1/remote_asset/search

Searches remote asset.

  • Handler: thisProject\api\remote_asset\Search
  • Source: lib/php/thisProject/api/remote_asset/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, data.

ANY /v1/remote_asset/view

Gets remote asset.

  • Handler: thisProject\api\remote_asset\View
  • Source: lib/php/thisProject/api/remote_asset/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data.

ANY /v1/task_queue/byasset

Handles task queue byasset.

  • Handler: thisProject\api\task_queue\ByAsset
  • Source: lib/php/thisProject/api/task_queue/ByAsset.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • asset (optional/detected). Asset id.
  • Response: data key(s): status, data.

ANY /v1/task_queue/process

Processes task queue.

  • Handler: thisProject\api\task_queue\Process
  • Source: lib/php/thisProject/api/task_queue/Process.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior. Default: ''.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • process (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value. Default: ''.
  • Response: data key(s): status, comment, data.

ANY /v1/task_queue/search

Searches task queue.

  • Handler: thisProject\api\task_queue\Search
  • Source: lib/php/thisProject/api/task_queue/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /v1/task_queue/view

Gets task queue.

  • Handler: thisProject\api\task_queue\View
  • Source: lib/php/thisProject/api/task_queue/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data.

ANY /v1/upload/form_data

Handles upload form data.

  • Handler: thisProject\api\upload\FormData
  • Source: lib/php/thisProject/api/upload/FormData.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, data.

ANY /v1/upload/post_data

Handles upload post data.

  • Handler: thisProject\api\upload\PostData
  • Source: lib/php/thisProject/api/upload/PostData.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • bucket (optional/detected). Bucket id/name.
  • Response: data key(s): status, data.

ANY /v1/vault/delete

Deletes vault.

  • Handler: thisProject\api\vault\Delete
  • Source: lib/php/thisProject/api/vault/Delete.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • action (optional/detected). Action selector for handlers that multiplex behavior.
  • Response: data key(s): status, comment, data.
  • Notable errors: no id specified.

ANY /v1/vault/search

Searches vault.

  • Handler: thisProject\api\vault\Search
  • Source: lib/php/thisProject/api/vault/Search.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • Response: data key(s): status, data.

ANY /v1/vault/view

Gets vault.

  • Handler: thisProject\api\vault\View
  • Source: lib/php/thisProject/api/vault/View.php
  • Auth: principal route rule: configured principal; consumer M7 token required by base controller
  • Detected request fields:
    • action (optional/detected). Action selector for handlers that multiplex behavior.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: data key(s): status, data, log.
1