From ab49ab4c528aaec71927f6e8aa3a8823a56dfd81 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Thu, 5 Jun 2025 14:06:28 +0000 Subject: [PATCH] deploy: 865d43b4b3af0be8ea06e87a8fd7b1b4cb1e764a --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- develop/admin_api/event_reports.html | 2 +- develop/admin_api/experimental_features.html | 2 +- develop/admin_api/media_admin_api.html | 2 +- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/register_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 6 +- develop/admin_api/scheduled_tasks.html | 259 ++++++++++++++++++ develop/admin_api/server_notices.html | 6 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 2 +- develop/admin_api/version_api.html | 2 +- develop/application_services.html | 2 +- develop/auth_chain_difference_algorithm.html | 2 +- develop/code_style.html | 2 +- develop/consent_tracking.html | 2 +- develop/delegate.html | 2 +- develop/deprecation_policy.html | 2 +- develop/development/cas.html | 2 +- develop/development/contributing_guide.html | 2 +- develop/development/database_schema.html | 2 +- develop/development/demo.html | 2 +- develop/development/dependencies.html | 2 +- .../development/experimental_features.html | 2 +- develop/development/git.html | 2 +- .../internal_documentation/index.html | 2 +- develop/development/releases.html | 2 +- develop/development/reviews.html | 2 +- develop/development/room-dag-concepts.html | 2 +- develop/development/saml.html | 2 +- .../synapse_architecture/cancellation.html | 2 +- .../synapse_architecture/faster_joins.html | 2 +- .../synapse_architecture/streams.html | 2 +- develop/federate.html | 2 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 2 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/modules/account_data_callbacks.html | 2 +- .../modules/account_validity_callbacks.html | 2 +- ...xtra_fields_to_client_events_unsigned.html | 2 +- ...ackground_update_controller_callbacks.html | 2 +- develop/modules/index.html | 2 +- .../modules/media_repository_callbacks.html | 2 +- .../password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 2 +- .../modules/presence_router_callbacks.html | 2 +- develop/modules/ratelimit_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- .../modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 2 +- ...ing_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 57 +++- develop/replication.html | 2 +- develop/reverse_proxy.html | 2 +- develop/room_and_user_statistics.html | 2 +- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- develop/server_notices.html | 2 +- develop/setup/forward_proxy.html | 2 +- develop/setup/installation.html | 2 +- develop/setup/turn/coturn.html | 2 +- develop/setup/turn/eturnal.html | 2 +- develop/sso_mapping_providers.html | 2 +- develop/structured_logging.html | 2 +- develop/synctl_workers.html | 2 +- develop/systemd-with-workers/index.html | 2 +- develop/tcp_replication.html | 2 +- develop/templates.html | 2 +- develop/turn-howto.html | 2 +- develop/upgrade.html | 2 +- .../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 +- develop/usage/administration/admin_faq.html | 2 +- develop/usage/administration/backups.html | 2 +- .../database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- ...reporting_homeserver_usage_statistics.html | 2 +- .../administration/monthly_active_users.html | 2 +- develop/usage/administration/request_log.html | 2 +- .../usage/administration/state_groups.html | 2 +- ...anding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/config_documentation.html | 2 +- .../homeserver_sample_config.html | 2 +- develop/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 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 107 files changed, 424 insertions(+), 110 deletions(-) create mode 100644 develop/admin_api/scheduled_tasks.html diff --git a/develop/404.html b/develop/404.html index 6fa4711b18..830ba7276e 100644 --- a/develop/404.html +++ b/develop/404.html @@ -78,7 +78,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index 5bb16a1607..743f99b690 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index 655bca95d1..fd9bb9ed32 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index ea281ade61..55b20a48ee 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/experimental_features.html b/develop/admin_api/experimental_features.html index 15e055f6e9..eb5f6689e5 100644 --- a/develop/admin_api/experimental_features.html +++ b/develop/admin_api/experimental_features.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index f12a411277..52f8d51309 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index a42453d478..69e20823a5 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index 1a019cfb66..9c04a0f432 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index cbd5f1b3ce..e5b5937e96 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -77,7 +77,7 @@ diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index 488fb83f47..9611d6c497 100644 --- a/develop/admin_api/rooms.html +++ b/develop/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/develop/admin_api/scheduled_tasks.html b/develop/admin_api/scheduled_tasks.html new file mode 100644 index 0000000000..9cffdba9e3 --- /dev/null +++ b/develop/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/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index 8ab3b8a8d7..b06c9720db 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -77,7 +77,7 @@ @@ -195,7 +195,7 @@ can be used. See the server notices documentati