From 832be6e1ec75685d4d231612931b54ad8955aeea Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Tue, 17 Jun 2025 14:35:09 +0000 Subject: [PATCH] deploy: d1139ebfc11b13417aaf9acb289d7a0d0d93482b --- latest/404.html | 2 +- latest/CAPTCHA_SETUP.html | 2 +- latest/admin_api/account_validity.html | 2 +- latest/admin_api/event_reports.html | 2 +- latest/admin_api/experimental_features.html | 2 +- latest/admin_api/media_admin_api.html | 2 +- latest/admin_api/purge_history_api.html | 2 +- latest/admin_api/register_api.html | 2 +- latest/admin_api/room_membership.html | 2 +- latest/admin_api/rooms.html | 6 +- latest/admin_api/scheduled_tasks.html | 259 + latest/admin_api/server_notices.html | 6 +- latest/admin_api/statistics.html | 2 +- latest/admin_api/user_admin_api.html | 12 +- latest/admin_api/version_api.html | 2 +- latest/application_services.html | 2 +- latest/auth_chain_difference_algorithm.html | 2 +- latest/code_style.html | 2 +- latest/consent_tracking.html | 2 +- latest/delegate.html | 2 +- latest/deprecation_policy.html | 2 +- latest/development/cas.html | 2 +- latest/development/contributing_guide.html | 2 +- latest/development/database_schema.html | 2 +- latest/development/demo.html | 2 +- latest/development/dependencies.html | 2 +- latest/development/experimental_features.html | 2 +- latest/development/git.html | 2 +- .../internal_documentation/index.html | 2 +- latest/development/releases.html | 2 +- latest/development/reviews.html | 2 +- latest/development/room-dag-concepts.html | 2 +- latest/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../synapse_architecture/streams.html | 2 +- latest/federate.html | 2 +- latest/index.html | 2 +- latest/jwt.html | 2 +- latest/log_contexts.html | 2 +- latest/manhole.html | 2 +- latest/media_repository.html | 2 +- latest/message_retention_policies.html | 2 +- latest/metrics-howto.html | 2 +- latest/modules/account_data_callbacks.html | 2 +- .../modules/account_validity_callbacks.html | 2 +- ...xtra_fields_to_client_events_unsigned.html | 6 +- ...ackground_update_controller_callbacks.html | 2 +- latest/modules/index.html | 2 +- .../modules/media_repository_callbacks.html | 251 + .../password_auth_provider_callbacks.html | 2 +- latest/modules/porting_legacy_module.html | 6 +- latest/modules/presence_router_callbacks.html | 2 +- latest/modules/ratelimit_callbacks.html | 238 + latest/modules/spam_checker_callbacks.html | 39 +- .../modules/third_party_rules_callbacks.html | 2 +- latest/modules/writing_a_module.html | 2 +- latest/openid.html | 2 +- latest/opentracing.html | 2 +- ...ing_synapse_on_single_board_computers.html | 2 +- latest/password_auth_providers.html | 2 +- latest/postgres.html | 2 +- latest/print.html | 4602 ++++++++-------- latest/replication.html | 2 +- latest/reverse_proxy.html | 10 +- latest/room_and_user_statistics.html | 2 +- latest/schema/synapse-config.schema.json | 4812 +++++++++++++++++ latest/schema/v1/meta.schema.json | 29 + latest/schema/v1/vocab/documentation.html | 11 + latest/searchindex.js | 2 +- latest/searchindex.json | 2 +- latest/server_notices.html | 2 +- latest/setup/forward_proxy.html | 2 +- latest/setup/installation.html | 2 +- latest/setup/turn/coturn.html | 2 +- latest/setup/turn/eturnal.html | 2 +- latest/sso_mapping_providers.html | 2 +- latest/structured_logging.html | 2 +- latest/synctl_workers.html | 2 +- latest/systemd-with-workers/index.html | 2 +- latest/tcp_replication.html | 2 +- latest/templates.html | 2 +- latest/turn-howto.html | 2 +- latest/upgrade.html | 4 +- .../admin_api/background_updates.html | 2 +- .../administration/admin_api/federation.html | 2 +- .../usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- latest/usage/administration/admin_faq.html | 4 +- latest/usage/administration/backups.html | 2 +- .../database_maintenance_tools.html | 2 +- latest/usage/administration/index.html | 2 +- ...reporting_homeserver_usage_statistics.html | 2 +- .../administration/monthly_active_users.html | 2 +- latest/usage/administration/request_log.html | 2 +- latest/usage/administration/state_groups.html | 2 +- ...anding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/config_documentation.html | 4403 +++++++-------- .../homeserver_sample_config.html | 2 +- latest/usage/configuration/index.html | 2 +- .../configuration/logging_sample_config.html | 2 +- .../user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../single_sign_on/cas.html | 2 +- .../single_sign_on/index.html | 2 +- .../single_sign_on/saml.html | 2 +- latest/user_directory.html | 2 +- latest/welcome_and_overview.html | 2 +- latest/workers.html | 2 +- 110 files changed, 9946 insertions(+), 4938 deletions(-) create mode 100644 latest/admin_api/scheduled_tasks.html create mode 100644 latest/modules/media_repository_callbacks.html create mode 100644 latest/modules/ratelimit_callbacks.html create mode 100644 latest/schema/synapse-config.schema.json create mode 100644 latest/schema/v1/meta.schema.json create mode 100644 latest/schema/v1/vocab/documentation.html diff --git a/latest/404.html b/latest/404.html index e2406bcedd..830ba7276e 100644 --- a/latest/404.html +++ b/latest/404.html @@ -78,7 +78,7 @@ diff --git a/latest/CAPTCHA_SETUP.html b/latest/CAPTCHA_SETUP.html index a36375e14f..743f99b690 100644 --- a/latest/CAPTCHA_SETUP.html +++ b/latest/CAPTCHA_SETUP.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html index 3d2dc800f7..fd9bb9ed32 100644 --- a/latest/admin_api/account_validity.html +++ b/latest/admin_api/account_validity.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/event_reports.html b/latest/admin_api/event_reports.html index 5e3834b3e6..55b20a48ee 100644 --- a/latest/admin_api/event_reports.html +++ b/latest/admin_api/event_reports.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/experimental_features.html b/latest/admin_api/experimental_features.html index 64041216dd..eb5f6689e5 100644 --- a/latest/admin_api/experimental_features.html +++ b/latest/admin_api/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/media_admin_api.html b/latest/admin_api/media_admin_api.html index 09d60715d3..52f8d51309 100644 --- a/latest/admin_api/media_admin_api.html +++ b/latest/admin_api/media_admin_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/purge_history_api.html b/latest/admin_api/purge_history_api.html index 2d03d0b0a0..69e20823a5 100644 --- a/latest/admin_api/purge_history_api.html +++ b/latest/admin_api/purge_history_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/register_api.html b/latest/admin_api/register_api.html index 820f086bc2..9c04a0f432 100644 --- a/latest/admin_api/register_api.html +++ b/latest/admin_api/register_api.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/room_membership.html b/latest/admin_api/room_membership.html index dce6532eca..e5b5937e96 100644 --- a/latest/admin_api/room_membership.html +++ b/latest/admin_api/room_membership.html @@ -77,7 +77,7 @@ diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html index c933eaaff9..9611d6c497 100644 --- a/latest/admin_api/rooms.html +++ b/latest/admin_api/rooms.html @@ -77,7 +77,7 @@ @@ -1140,7 +1140,7 @@ that were deleted.

-
@@ -1152,7 +1152,7 @@ that were deleted.

- diff --git a/latest/admin_api/scheduled_tasks.html b/latest/admin_api/scheduled_tasks.html new file mode 100644 index 0000000000..9cffdba9e3 --- /dev/null +++ b/latest/admin_api/scheduled_tasks.html @@ -0,0 +1,259 @@ + + + + + + Scheduled tasks - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

Show scheduled tasks

+

This API returns information about scheduled tasks.

+

To use it, you will need to authenticate by providing an access_token +for a server admin: see Admin API.

+

The api is:

+
GET /_synapse/admin/v1/scheduled_tasks
+
+

It returns a JSON body like the following:

+
{
+    "scheduled_tasks": [
+        {
+            "id": "GSA124oegf1",
+            "action": "shutdown_room",
+            "status": "complete",
+            "timestamp_ms": 23423523,
+            "resource_id": "!roomid",
+            "result": "some result",
+            "error": null
+        }
+      ]
+}
+
+

Query parameters:

+
    +
  • +

    action_name: string - Is optional. Returns only the scheduled tasks with the given action name.

    +
    • +
  • +

    resource_id: string - Is optional. Returns only the scheduled tasks with the given resource id.

    +
    • +
  • +

    status: string - Is optional. Returns only the scheduled tasks matching the given status, one of

    +
      +
    • "scheduled" - Task is scheduled but not active
      • +
    • "active" - Task is active and probably running, and if not will be run on next scheduler loop run
      • +
    • "complete" - Task has completed successfully
      • +
    • "failed" - Task is over and either returned a failed status, or had an exception
      • +
    +
    • +
  • +

    max_timestamp: int - Is optional. Returns only the scheduled tasks with a timestamp inferior to the specified one.

    +
    • +
+

Response

+

The following fields are returned in the JSON response body along with a 200 HTTP status code:

+
    +
  • id: string - ID of scheduled task.
    • +
  • action: string - The name of the scheduled task's action.
    • +
  • status: string - The status of the scheduled task.
    • +
  • timestamp_ms: integer - The timestamp (in milliseconds since the unix epoch) of the given task - If the status is "scheduled" then this represents when it should be launched. +Otherwise it represents the last time this task got a change of state.
    • +
  • resource_id: Optional string - The resource id of the scheduled task, if it possesses one
    • +
  • result: Optional Json - Any result of the scheduled task, if given
    • +
  • error: Optional string - If the task has the status "failed", the error associated with this failure
    • +
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html index 2d6dc8fbe7..b06c9720db 100644 --- a/latest/admin_api/server_notices.html +++ b/latest/admin_api/server_notices.html @@ -77,7 +77,7 @@ @@ -195,7 +195,7 @@ can be used. See the server notices documentati