Skip to main content
Tools Reference

Slide Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Slide Tools

slide_ · 79 tools · Free 38 · Pro 41 Backup and disaster recovery appliances, agents and restores. The credential is an API token sent as a bearer against a fixed host. Paging is offset and limit, default 10 and maximum 50, returning a pagination block with the next offset; the absence of that offset means the last page. A 429 carries no retry-after header, so the client backs off on its own. The error envelope is non-standard - it carries a codes array, a details array and a message. Slide is eventually consistent: a resource you just created or updated can briefly return 404 before it is readable. Prefer the addresses field on a device or agent over the deprecated IP address fields. Bodies are passed through as sent and there are no binary responses.

All connector tools · Slide setup guide

Slide tool groups

Accounts

ToolPlanAccessSummary
slide_get_accountFreeRead-onlyGet a single Slide account by account_id (from slide_list_accounts).
slide_list_accountsFreeRead-onlyList the Slide accounts visible to this API token.
slide_update_accountProWriteUpdate a Slide account by account_id (from slide_list_accounts).

[Slide] Get a single Slide account by account_id (from slide_list_accounts). Returns the raw account JSON including its alert-email configuration.

ParamTypeRequiredDefaultDescription
accountIdstringyesThe account id (from slide_list_accounts).

[Slide] List the Slide accounts visible to this API token. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]} — page again with offset when next_offset is present. Use slide_get_account for one account's full detail.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly accounts created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly accounts created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update a Slide account by account_id (from slide_list_accounts). Body (fieldsJson) is a JSON object; the only editable field is alert_emails (the set of addresses that receive account-level alert emails). Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated account JSON.

ParamTypeRequiredDefaultDescription
accountIdstringyesThe account id to update (from slide_list_accounts).
fieldsJsonstringyesJSON object body. Editable field: alert_emails (object controlling which addresses receive account alert emails).

Users

ToolPlanAccessSummary
slide_get_userFreeRead-onlyGet a single Slide Console user by user_id (from slide_list_users).
slide_get_user_avatarFreeRead-onlyGet a Slide Console user's avatar by user_id (from slide_list_users).
slide_list_usersFreeRead-onlyList the Slide Console users on the account.

[Slide] Get a single Slide Console user by user_id (from slide_list_users). Returns the raw user JSON (display name, email, role).

ParamTypeRequiredDefaultDescription
userIdstringyesThe user id (from slide_list_users).

[Slide] Get a Slide Console user's avatar by user_id (from slide_list_users). Returns a raw JSON Avatar object (typically an avatar URL) — this is JSON, not binary image bytes.

ParamTypeRequiredDefaultDescription
userIdstringyesThe user id whose avatar to fetch (from slide_list_users).

[Slide] List the Slide Console users on the account. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_get_user for one user's detail and slide_get_user_avatar for their avatar.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly users created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly users created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

Clients

ToolPlanAccessSummary
slide_create_clientProWriteCreate a client (end-customer grouping).
slide_delete_clientProDestructivePermanently delete a client by client_id (from slide_list_clients).
slide_get_clientFreeRead-onlyGet a single client by client_id (from slide_list_clients).
slide_list_clientsFreeRead-onlyList the clients (end-customer groupings) on the account.
slide_update_clientProWriteUpdate a client by client_id (from slide_list_clients).

[Slide] Create a client (end-customer grouping). Body (fieldsJson) is a JSON object; required: name. Optional: comments. Slide is eventually consistent — the new client may not be immediately readable by slide_get_client. Returns the raw created client JSON (including the new client_id).

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body. Required: name. Optional: comments.

[Slide] Permanently delete a client by client_id (from slide_list_clients). Destructive — the client grouping is removed. Devices/agents currently assigned to it must be reassigned first (see slide_update_device). Slide is eventually consistent — the deletion may not be immediately reflected. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe client id to delete (from slide_list_clients).

[Slide] Get a single client by client_id (from slide_list_clients). Returns the raw client JSON (name, comments, timestamps).

ParamTypeRequiredDefaultDescription
clientIdstringyesThe client id (from slide_list_clients).

[Slide] List the clients (end-customer groupings) on the account. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_get_client for one client's detail; a client_id is what slide_update_device uses to reassign a device.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly clients created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly clients created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update a client by client_id (from slide_list_clients). Body (fieldsJson) is a JSON object; editable fields: name, comments. Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated client JSON.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe client id to update (from slide_list_clients).
fieldsJsonstringyesJSON object body. Editable fields: name, comments.

Alerts

ToolPlanAccessSummary
slide_get_alertFreeRead-onlyGet a single alert by alert_id (from slide_list_alerts).
slide_list_alertsFreeRead-onlyList alerts raised across the fleet (backup failures, appliance health, etc.).
slide_update_alertProWriteUpdate an alert by alert_id (from slide_list_alerts).

[Slide] Get a single alert by alert_id (from slide_list_alerts). Returns the raw alert JSON (type, affected device/agent, created time, resolved flag).

ParamTypeRequiredDefaultDescription
alertIdstringyesThe alert id (from slide_list_alerts).

[Slide] List alerts raised across the fleet (backup failures, appliance health, etc.). Optional filters: resolved state, device_id, agent_id, created_after / created_before (RFC3339), and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_get_alert for one alert's detail and slide_update_alert to resolve it.

ParamTypeRequiredDefaultDescription
agentIdstringnonullFilter to alerts for this agent id (from slide_list_agents). Optional.
createdAfterstringnonullOnly alerts created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly alerts created before this RFC3339 instant. Omit for no upper bound.
deviceIdstringnonullFilter to alerts for this device id (from slide_list_devices). Optional.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
resolvedbooleannonullFilter by resolution state: true = only resolved alerts, false = only unresolved. Omit to return alerts regardless of state.
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update an alert by alert_id (from slide_list_alerts). Body (fieldsJson) is a JSON object; the editable field is resolved (boolean) — set true to mark the alert resolved. Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated alert JSON.

ParamTypeRequiredDefaultDescription
alertIdstringyesThe alert id to update (from slide_list_alerts).
fieldsJsonstringyesJSON object body. Editable field: resolved (boolean) — true marks the alert resolved.

Audit Logs

ToolPlanAccessSummary
slide_get_audit_logFreeRead-onlyGet a single audit-log entry by audit_id (from slide_list_audit_logs).
slide_list_audit_actionsFreeRead-onlyList the distinct audit action types recorded in the account (the vocabulary of actions that appear in slide_list_audit_logs).
slide_list_audit_logsFreeRead-onlyList audit-log entries (who did what, when) for the account.
slide_list_audit_resource_typesFreeRead-onlyList the distinct resource types that appear in the account's audit trail (the vocabulary of resources referenced by slide_list_audit_logs).

[Slide] Get a single audit-log entry by audit_id (from slide_list_audit_logs). Returns the raw audit entry JSON (actor, action, resource, timestamp, details).

ParamTypeRequiredDefaultDescription
auditIdstringyesThe audit-log entry id (from slide_list_audit_logs).

[Slide] List the distinct audit action types recorded in the account (the vocabulary of actions that appear in slide_list_audit_logs). Optional sort_by / sort_asc (this endpoint accepts only "name"). Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}.

ParamTypeRequiredDefaultDescription
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field. This endpoint accepts only "name". Omit for Slide's default ordering.

[Slide] List audit-log entries (who did what, when) for the account. Optional filters: audit_action_name and audit_resource_type_name (discover the vocabularies via slide_list_audit_actions / slide_list_audit_resource_types), the window audit_time_before / audit_time_after (RFC3339), and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_get_audit_log for one entry.

ParamTypeRequiredDefaultDescription
auditActionNamestringnonullFilter to a single audit action name (from slide_list_audit_actions). Omit to include all actions.
auditResourceTypeNamestringnonullFilter to a single audit resource-type name (from slide_list_audit_resource_types). Omit to include all resource types.
auditTimeAfterstringnonullLower time bound (RFC3339, e.g. 2026-07-01T00:00:00Z) — only entries after this instant. Omit for no lower bound.
auditTimeBeforestringnonullUpper time bound (RFC3339, e.g. 2026-07-19T00:00:00Z) — only entries before this instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] List the distinct resource types that appear in the account's audit trail (the vocabulary of resources referenced by slide_list_audit_logs). Optional sort_by / sort_asc (this endpoint accepts only "name"). Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}.

ParamTypeRequiredDefaultDescription
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field. This endpoint accepts only "name". Omit for Slide's default ordering.

Agents

ToolPlanAccessSummary
slide_add_agent_passphraseProWriteAdd a user-managed backup encryption passphrase to an agent.
slide_create_agentProWritePre-pair an agent: reserve an agent slot and mint a pair code that the machine's installer redeems.
slide_create_nas_agentProWriteCreate a NAS agent that backs up an SMB share.
slide_delete_agent_passphraseProDestructiveRemove a user-managed backup passphrase from an agent.
slide_get_agentFreeRead-onlyGet a single agent by agent_id (from slide_list_agents).
slide_list_agent_file_versionsFreeRead-onlyList the point-in-time versions (across snapshots) of a specific file path on an agent.
slide_list_agentsFreeRead-onlyList backup agents (protected machines).
slide_pair_agentProDestructiveBind a machine to a Slide appliance using a pair code.
slide_search_agent_filesFreeRead-onlySearch an agent's file index by filename/path fragment.
slide_update_agentProWriteUpdate an agent by agent_id (from slide_list_agents).

[Slide] Add a user-managed backup encryption passphrase to an agent. Provide agent_id (from slide_list_agents) and a body (fieldsJson) with required fields name and passphrase. The passphrase is write-only and cannot be recovered from the API — store it safely. Slide is eventually consistent. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id to add a passphrase to (from slide_list_agents).
fieldsJsonstringyesJSON object body. Required: name (label for the passphrase), passphrase (the secret; write-only).

[Slide] Pre-pair an agent: reserve an agent slot and mint a pair code that the machine's installer redeems. Body (fieldsJson) is a JSON object; required: display_name, device_id (the appliance, from slide_list_devices). Returns the raw agent JSON including the pair_code — then complete pairing on the endpoint or via slide_pair_agent. Slide is eventually consistent — the new agent may not be immediately readable. For NAS shares use slide_create_nas_agent instead.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body. Required: display_name, device_id (the appliance, from slide_list_devices).

[Slide] Create a NAS agent that backs up an SMB share. Body (fieldsJson) is a JSON object; required: device_id (the appliance, from slide_list_devices), display_name, nas_unc_path (UNC path to the SMB share), timezone (IANA). Optional: nas_smb_username and nas_smb_password (omit both for an anonymous share; the password is write-only). Slide is eventually consistent — the new NAS agent may not be immediately readable. Returns the raw created agent JSON.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body. Required: device_id, display_name, nas_unc_path, timezone. Optional: nas_smb_username, nas_smb_password (write-only; omit both for an anonymous share).

[Slide] Remove a user-managed backup passphrase from an agent. Provide agent_id and agent_passphrase_id (both from slide_get_agent / slide_list_agents), plus the agent's CURRENT passphrase (required by Slide to authorize the removal). Destructive — removing the passphrase that seals an agent can leave it unable to back up until re-sealed; the removed secret cannot be retrieved. Slide is eventually consistent. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id (from slide_list_agents).
agentPassphraseIdstringyesThe passphrase id to delete (from the agent's passphrase list on slide_get_agent).
passphrasestringyesRequired. The agent's CURRENT passphrase — Slide requires it in the request body to authorize removing the passphrase.

[Slide] Get a single agent by agent_id (from slide_list_agents). Returns the raw agent JSON (hostname, OS, backup schedule/state, volumes). Prefer the `addresses` field over the deprecated `ip_addresses`.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id (from slide_list_agents).

[Slide] List the point-in-time versions (across snapshots) of a specific file path on an agent. Provide agent_id (from slide_list_agents) and the exact path (required, from slide_search_agent_files). Optional sort_by (created_time | last_modified | file_size) / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id (from slide_list_agents).
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
pathstringyesRequired. The exact file path whose versions to list (from slide_search_agent_files).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field: created_time, last_modified, or file_size. Omit for Slide's default ordering.

[Slide] List backup agents (protected machines). Optional filters: device_id (the appliance the agent pairs to), client_id (the end-customer grouping), paired_before / paired_after (RFC3339), agent_type (windows | linux | nas), and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Prefer each agent's `addresses` field over the deprecated `ip_addresses`. Use slide_get_agent for one agent's full detail.

ParamTypeRequiredDefaultDescription
agentTypestringnonullFilter by agent type: windows, linux, or nas. Omit for all types.
clientIdstringnonullFilter to agents under this client id (from slide_list_clients). Omit for all clients.
deviceIdstringnonullFilter to agents paired to this device id (from slide_list_devices). Omit for all devices.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
pairedAfterstringnonullOnly agents paired after this RFC3339 instant. Omit for no lower bound.
pairedBeforestringnonullOnly agents paired before this RFC3339 instant. Omit for no upper bound.
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Bind a machine to a Slide appliance using a pair code. Body (fieldsJson) is a JSON object; required: pair_code (from the endpoint installer or slide_create_agent), device_id (the appliance, from slide_list_devices). Destructive — this activates the agent and begins claiming backup storage on the device; it cannot be silently undone. Slide is eventually consistent — the paired agent may not be immediately readable. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object body. Required: pair_code, device_id (the appliance, from slide_list_devices).

[Slide] Search an agent's file index by filename/path fragment. Provide agent_id (from slide_list_agents) and a search_term (required). File indexing must be enabled on the agent (file_index_enabled). Optional sort_by (path | last_modified | file_size) / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_list_agent_file_versions to see the point-in-time versions of a specific path.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id whose file index to search (from slide_list_agents).
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
searchTermstringyesRequired. Filename or path fragment to search for across the agent's indexed files.
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field: path, last_modified, or file_size. Omit for Slide's default ordering.

[Slide] Update an agent by agent_id (from slide_list_agents). Body (fieldsJson) is a JSON object; common editable fields: display_name, comments, timezone (IANA, e.g. America/New_York), backup_schedule, backup_paused_indefinite / backup_paused_until (RFC3339) / backup_resume, file_index_enabled, local_retention_policy, sealed (set false to unseal a passphrase-protected agent), volumes / volumes_include_default, and NAS fields (nas_unc_path, nas_smb_username, nas_smb_password). Pausing or changing the schedule alters live protection. Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated agent JSON.

ParamTypeRequiredDefaultDescription
agentIdstringyesThe agent id to update (from slide_list_agents).
fieldsJsonstringyesJSON object body of editable agent fields (e.g. display_name, backup_schedule, backup_paused_until, file_index_enabled, timezone, sealed).

Devices

ToolPlanAccessSummary
slide_create_device_vlanProWriteCreate a VLAN interface on a Slide appliance by device_id (from slide_list_devices).
slide_delete_device_vlanProDestructiveDelete a VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans).
slide_get_deviceFreeRead-onlyGet a single Slide appliance by device_id (from slide_list_devices).
slide_get_device_networkFreeRead-onlyGet the primary network configuration of a Slide appliance by device_id (from slide_list_devices).
slide_get_device_vlanFreeRead-onlyGet a single VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans).
slide_list_device_vlansFreeRead-onlyList the VLAN interfaces configured on a Slide appliance by device_id (from slide_list_devices).
slide_list_devicesFreeRead-onlyList Slide appliances (devices).
slide_poweroff_deviceProDestructivePower off a Slide appliance by device_id (from slide_list_devices).
slide_reboot_deviceProDestructiveReboot a Slide appliance by device_id (from slide_list_devices).
slide_update_deviceProWriteUpdate a Slide appliance by device_id (from slide_list_devices).
slide_update_device_networkProWriteUpdate the primary network configuration of a Slide appliance by device_id (from slide_list_devices).
slide_update_device_vlanProWriteUpdate a VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans).

[Slide] Create a VLAN interface on a Slide appliance by device_id (from slide_list_devices). Body (fieldsJson) is a JSON object; required: name, vlan_tag (802.1Q tag), network_mode (dhcp | static). Optional: ip_address, gateway (used when network_mode is static). Slide is eventually consistent — the new VLAN may not be immediately readable. Returns the raw created VLAN JSON.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id to add the VLAN to (from slide_list_devices).
fieldsJsonstringyesJSON object body. Required: name, vlan_tag, network_mode (dhcp|static). Optional: ip_address, gateway.

[Slide] Delete a VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans). Destructive — the VLAN interface is removed and any traffic relying on it is cut. Slide is eventually consistent — the deletion may not be immediately reflected. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id (from slide_list_devices).
vlanIdstringyesThe VLAN id to delete (from slide_list_device_vlans).

[Slide] Get a single Slide appliance by device_id (from slide_list_devices). Returns the raw device JSON (hostname, model, storage, health). Prefer the `addresses` field over the deprecated `ip_addresses`.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id (from slide_list_devices).

[Slide] Get the primary network configuration of a Slide appliance by device_id (from slide_list_devices). Returns the raw network JSON (mode dhcp|static, address, gateway, DNS servers). Use slide_list_device_vlans for the device's VLAN interfaces.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id (from slide_list_devices).

[Slide] Get a single VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans). Returns the raw VLAN JSON (name, vlan_tag, network_mode, ip_address, gateway).

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id (from slide_list_devices).
vlanIdstringyesThe VLAN id (from slide_list_device_vlans).

[Slide] List the VLAN interfaces configured on a Slide appliance by device_id (from slide_list_devices). Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Use slide_get_device_vlan for one VLAN's detail.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id whose VLANs to list (from slide_list_devices).
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).

[Slide] List Slide appliances (devices). Optional filters: client_id (the end-customer grouping), created_after / created_before (RFC3339), and sort_by / sort_asc. Offset/limit paged (limit max 50); returns the raw envelope {pagination:, data:[...]}. Prefer each device's `addresses` field over the deprecated `ip_addresses`. Use slide_get_device for one device's detail, slide_get_device_network for its network config, and slide_list_device_vlans for its VLANs.

ParamTypeRequiredDefaultDescription
clientIdstringnonullFilter to devices under this client id (from slide_list_clients). Omit for all clients.
createdAfterstringnonullOnly devices created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly devices created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based row offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Power off a Slide appliance by device_id (from slide_list_devices). Takes no body. Destructive — the appliance stops running and cannot back up or serve restores until it is physically powered back on (there is no remote power-on). Slide is eventually consistent — the state change may not be immediately reflected. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id to power off (from slide_list_devices).

[Slide] Reboot a Slide appliance by device_id (from slide_list_devices). Takes no body. Destructive — the appliance restarts, interrupting any in-flight backups or active restores until it comes back online. Slide is eventually consistent — the state change may not be immediately reflected. Returns the raw Slide response.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id to reboot (from slide_list_devices).

[Slide] Update a Slide appliance by device_id (from slide_list_devices). Body (fieldsJson) is a JSON object; editable fields: display_name, hostname, client_id (assign the device to a client from slide_list_clients; pass an empty string to unassign). Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated device JSON.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id to update (from slide_list_devices).
fieldsJsonstringyesJSON object body. Editable fields: display_name, hostname, client_id (from slide_list_clients; empty string to unassign).

[Slide] Update the primary network configuration of a Slide appliance by device_id (from slide_list_devices). Body (fieldsJson) is a JSON object; editable fields: network_mode (dhcp | static), network_address, network_gateway, dns_server_primary, dns_server_secondary. Changing network settings can briefly interrupt the appliance's connectivity. Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated network JSON.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id whose network to update (from slide_list_devices).
fieldsJsonstringyesJSON object body. Editable fields: network_mode (dhcp|static), network_address, network_gateway, dns_server_primary, dns_server_secondary.

[Slide] Update a VLAN on a Slide appliance by device_id and vlan_id (both from slide_list_device_vlans). Body (fieldsJson) is a JSON object; editable fields: name, vlan_tag, network_mode (dhcp | static), ip_address, gateway. Slide is eventually consistent — the change may not be immediately readable back. Returns the raw updated VLAN JSON.

ParamTypeRequiredDefaultDescription
deviceIdstringyesThe device id (from slide_list_devices).
fieldsJsonstringyesJSON object body. Editable fields: name, vlan_tag, network_mode (dhcp|static), ip_address, gateway.
vlanIdstringyesThe VLAN id to update (from slide_list_device_vlans).

Backups

ToolPlanAccessSummary
slide_get_backupFreeRead-onlyGet a single backup run by its backup_id (from slide_list_backups).
slide_list_backupsFreeRead-onlyList backup runs across the account, newest first.
slide_start_backupProDestructiveTrigger an on-demand backup run for an agent.

[Slide] Get a single backup run by its backup_id (from slide_list_backups). Returns the run's status, device/agent linkage, timing, and the snapshot it produced.

ParamTypeRequiredDefaultDescription
backupIdstringyesThe backup_id to fetch (from slide_list_backups).

[Slide] List backup runs across the account, newest first. Optional filters: device_id, agent_id, snapshot_id, backup start/end time windows (RFC3339 timestamps), and sort_by / sort_asc. Returns the vendor envelope {pagination:, data:[...]} — pass the returned next_offset as the offset to page (page size max 50). Each backup carries a backup_id used by slide_get_backup; start a new run with slide_start_backup.

ParamTypeRequiredDefaultDescription
agentIdstringnonullFilter to backups for this agent id (from slide_list_agents). Optional.
deviceIdstringnonullFilter to backups for this device id (from slide_list_devices). Optional.
endedAfterstringnonullOnly backups ended after this RFC3339 timestamp. Optional.
endedBeforestringnonullOnly backups ended before this RFC3339 timestamp. Optional.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
snapshotIdstringnonullFilter to the backup that produced this snapshot id (from slide_list_snapshots). Optional.
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.
startedAfterstringnonullOnly backups started after this RFC3339 timestamp. Optional.
startedBeforestringnonullOnly backups started before this RFC3339 timestamp (e.g. 2026-07-19T00:00:00Z). Optional.

[Slide] Trigger an on-demand backup run for an agent. Provide fieldsJson as a JSON object — required: agent_id (from slide_list_agents). This starts real appliance activity (a backup job) and consumes device resources, so it is treated as destructive. Slide is eventually consistent: the resulting backup/snapshot may not be immediately readable via slide_list_backups / slide_list_snapshots — poll rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the backup run. Required: agent_id (from slide_list_agents).

Snapshots

ToolPlanAccessSummary
slide_get_snapshotFreeRead-onlyGet a single snapshot (recovery point) by its snapshot_id (from slide_list_snapshots).
slide_list_snapshotsFreeRead-onlyList snapshots (recovery points) across the account.

[Slide] Get a single snapshot (recovery point) by its snapshot_id (from slide_list_snapshots). Returns the snapshot's agent/device linkage, backup timing, verification state, and storage locations. Use the snapshot_id to start a file restore, image export, or recovery VM.

ParamTypeRequiredDefaultDescription
snapshotIdstringyesThe snapshot_id to fetch (from slide_list_snapshots).

[Slide] List snapshots (recovery points) across the account. Optional filters: agent_id, snapshot_location (e.g. local vs cloud), the backup start/end time windows (RFC3339), and sort_by / sort_asc. To scope to a device, filter by the device's agent id via agent_id (Slide's snapshot list does not filter by device_id directly). Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). A snapshot_id feeds slide_get_snapshot, slide_create_file_restore, slide_create_image_export, and slide_create_virtual_machine.

ParamTypeRequiredDefaultDescription
agentIdstringnonullFilter to snapshots for this agent id (from slide_list_agents). Optional.
backupEndedAfterstringnonullOnly snapshots whose backup ended after this RFC3339 timestamp. Optional.
backupEndedBeforestringnonullOnly snapshots whose backup ended before this RFC3339 timestamp. Optional.
backupStartedAfterstringnonullOnly snapshots whose backup started after this RFC3339 timestamp. Optional.
backupStartedBeforestringnonullOnly snapshots whose backup started before this RFC3339 timestamp. Optional.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
snapshotLocationstringnonullFilter by snapshot storage location (e.g. local, cloud). Optional.
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

File Restores

ToolPlanAccessSummary
slide_browse_file_restoreFreeRead-onlyBrowse the file/folder tree inside a mounted file restore, identified by its file_restore_id (from slide_list_file_restores).
slide_create_file_restoreProWriteMount a snapshot as a browsable file restore so individual files can be inspected and pushed back.
slide_create_file_restore_pushProDestructivePush a recovered file from a mounted file restore back onto a protected system — this WRITES a file onto the live target and can overwrite existing data, so it is destructive.
slide_delete_file_restoreProDestructiveTear down a file restore (unmount the browsable snapshot) by its file_restore_id (from slide_list_file_restores).
slide_get_file_restoreFreeRead-onlyGet a single file restore by its file_restore_id (from slide_list_file_restores).
slide_get_file_restore_pushFreeRead-onlyGet the status of a single file-restore push by its file_restore_id and file_restore_push_id (both from slide_list_file_restore_pushes).
slide_list_file_restore_pushesFreeRead-onlyList the push-back operations for a file restore (identified by file_restore_id) — each attempt to copy a recovered file onto a protected system.
slide_list_file_restoresFreeRead-onlyList the active file restores (mounted, browsable snapshots) in the account.
slide_update_file_restore_pushProWriteUpdate an in-progress file-restore push — currently used to cancel it.

[Slide] Browse the file/folder tree inside a mounted file restore, identified by its file_restore_id (from slide_list_file_restores). Pass path to list a specific directory (omit for the root). Returns entries with names and types; the path of a file here is the source_file_path used by slide_create_file_restore_push. Page with offset (max page size 50).

ParamTypeRequiredDefaultDescription
fileRestoreIdstringyesThe file_restore_id to browse (from slide_list_file_restores).
limitintegerno10Maximum rows to return (default 10, vendor max 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
pathstringnonullDirectory path inside the restore to list (e.g. /Users/jsmith/Documents). Omit for the root. Optional.

[Slide] Mount a snapshot as a browsable file restore so individual files can be inspected and pushed back. Provide fieldsJson as a JSON object — required: snapshot_id (from slide_list_snapshots) and device_id (from slide_list_devices); optional: passphrase (required if the agent has a user passphrase set — see slide_add_agent_passphrase). This mounts a read-only view and does not alter the protected system, so it is not destructive. Slide is eventually consistent: the new file_restore_id may briefly 404 before slide_browse_file_restore succeeds — poll rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the restore. Required: snapshot_id, device_id. Optional: passphrase (if the agent is passphrase-protected).

[Slide] Push a recovered file from a mounted file restore back onto a protected system — this WRITES a file onto the live target and can overwrite existing data, so it is destructive. Identify the mount by file_restore_id (from slide_list_file_restores) and provide fieldsJson as a JSON object — required: source_file_path (the file's path as it appears inside the mounted restore, from slide_browse_file_restore) and destination_folder (the folder on the protected system where the file is written). Slide is eventually consistent: track completion via slide_list_file_restore_pushes / slide_get_file_restore_push rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: source_file_path (from slide_browse_file_restore), destination_folder (target folder on the protected system).
fileRestoreIdstringyesThe file_restore_id to push from (from slide_list_file_restores).

[Slide] Tear down a file restore (unmount the browsable snapshot) by its file_restore_id (from slide_list_file_restores). This permanently removes the mount and any in-progress browse session; it does NOT delete the underlying snapshot. Slide is eventually consistent, so the restore may still appear briefly in slide_list_file_restores after deletion.

ParamTypeRequiredDefaultDescription
fileRestoreIdstringyesThe file_restore_id to delete (from slide_list_file_restores).

[Slide] Get a single file restore by its file_restore_id (from slide_list_file_restores). Returns the mount's snapshot/device linkage, status, and expiry.

ParamTypeRequiredDefaultDescription
fileRestoreIdstringyesThe file_restore_id to fetch (from slide_list_file_restores).

[Slide] Get the status of a single file-restore push by its file_restore_id and file_restore_push_id (both from slide_list_file_restore_pushes). Returns the push's state (e.g. in_progress, completed, canceled), source/destination, and timing.

ParamTypeRequiredDefaultDescription
fileRestoreIdstringyesThe parent file_restore_id (from slide_list_file_restores).
fileRestorePushIdstringyesThe file_restore_push_id to fetch (from slide_list_file_restore_pushes).

[Slide] List the push-back operations for a file restore (identified by file_restore_id) — each attempt to copy a recovered file onto a protected system. Optionally filter by start/end time windows (RFC 3339). Optional sort_by (this endpoint accepts only "start_time") / sort_asc. Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). Each file_restore_push_id feeds slide_get_file_restore_push and slide_update_file_restore_push.

ParamTypeRequiredDefaultDescription
endTimeAfterstringnonullOnly pushes ended after this RFC 3339 timestamp. Optional.
endTimeBeforestringnonullOnly pushes ended before this RFC 3339 timestamp. Optional.
fileRestoreIdstringyesThe file_restore_id whose pushes to list (from slide_list_file_restores).
limitintegerno10Maximum rows to return (default 10, vendor max 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field. This endpoint accepts only "start_time". Omit for Slide's default ordering.
startTimeAfterstringnonullOnly pushes started after this RFC 3339 timestamp. Optional.
startTimeBeforestringnonullOnly pushes started before this RFC 3339 timestamp. Optional.

[Slide] List the active file restores (mounted, browsable snapshots) in the account. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). Each file_restore_id feeds slide_get_file_restore, slide_browse_file_restore, slide_create_file_restore_push, and slide_delete_file_restore.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly file restores created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly file restores created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update an in-progress file-restore push — currently used to cancel it. Identify it by file_restore_id and file_restore_push_id (from slide_list_file_restore_pushes) and provide fieldsJson as a JSON object — required: state, whose only accepted value is "canceled" (transitions an in_progress push to canceled). Slide is eventually consistent: confirm the new state via slide_get_file_restore_push rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: state — the only accepted value is "canceled".
fileRestoreIdstringyesThe parent file_restore_id (from slide_list_file_restores).
fileRestorePushIdstringyesThe file_restore_push_id to update (from slide_list_file_restore_pushes).

Image Exports

ToolPlanAccessSummary
slide_browse_image_exportFreeRead-onlyBrowse the contents of an exported image by its image_export_id (from slide_list_image_exports).
slide_create_image_exportProDestructiveStart an image export — render a snapshot as a bootable disk image and boot/serve it.
slide_delete_image_exportProDestructivePermanently delete an image export by its image_export_id (from slide_list_image_exports), tearing down the exported image and any NFS share.
slide_get_image_exportFreeRead-onlyGet a single image export by its image_export_id (from slide_list_image_exports).
slide_list_image_exportsFreeRead-onlyList the image exports in the account.
slide_update_image_exportProWriteUpdate an image export's NFS sharing settings by its image_export_id (from slide_list_image_exports).

[Slide] Browse the contents of an exported image by its image_export_id (from slide_list_image_exports). Returns the entries in the exported image; page with offset (max page size 50).

ParamTypeRequiredDefaultDescription
imageExportIdstringyesThe image_export_id to browse (from slide_list_image_exports).
limitintegerno10Maximum rows to return (default 10, vendor max 50).
offsetintegerno0Zero-based result offset for pagination (default 0).

[Slide] Start an image export — render a snapshot as a bootable disk image and boot/serve it. This kicks off real recovery activity (image build, optional NFS share/boot) and consumes appliance resources, so it is treated as destructive. Provide fieldsJson as a JSON object — required: snapshot_id (from slide_list_snapshots), device_id (from slide_list_devices), image_type (one of vhdx, vhdx-dynamic, vhd, vmdk, vmdk-flat, qcow2, raw); optional: passphrase (if the agent is passphrase-protected), boot_mods (array), nfs (bool), nfs_clients (array). Slide is eventually consistent: poll slide_get_image_export for readiness rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: snapshot_id, device_id, image_type (vhdx|vhdx-dynamic|vhd|vmdk|vmdk-flat|qcow2|raw). Optional: passphrase, boot_mods, nfs, nfs_clients.

[Slide] Permanently delete an image export by its image_export_id (from slide_list_image_exports), tearing down the exported image and any NFS share. This does NOT delete the underlying snapshot. Slide is eventually consistent, so the export may still appear briefly in slide_list_image_exports after deletion.

ParamTypeRequiredDefaultDescription
imageExportIdstringyesThe image_export_id to delete (from slide_list_image_exports).

[Slide] Get a single image export by its image_export_id (from slide_list_image_exports). Returns the export's snapshot/device linkage, image_type, status, NFS settings, and access details.

ParamTypeRequiredDefaultDescription
imageExportIdstringyesThe image_export_id to fetch (from slide_list_image_exports).

[Slide] List the image exports in the account. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). Each image_export_id feeds slide_get_image_export, slide_browse_image_export, slide_update_image_export, and slide_delete_image_export.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly image exports created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly image exports created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update an image export's NFS sharing settings by its image_export_id (from slide_list_image_exports). Provide fieldsJson as a JSON object with the fields to change — nfs (bool, whether to share the image over NFS) and/or nfs_clients (array of client addresses allowed to mount it). Slide is eventually consistent: confirm via slide_get_image_export rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: nfs (bool), nfs_clients (array).
imageExportIdstringyesThe image_export_id to update (from slide_list_image_exports).

Recovery Virtual Machines

ToolPlanAccessSummary
slide_create_virtual_machineProDestructiveBoot a recovery virtual machine from a snapshot (a test or disaster VM).
slide_delete_virtual_machineProDestructivePermanently delete (shut down and discard) a recovery virtual machine by its virt_id (from slide_list_virtual_machines).
slide_get_virtual_machineFreeRead-onlyGet a single recovery virtual machine by its virt_id (from slide_list_virtual_machines).
slide_list_virtual_machinesFreeRead-onlyList the recovery virtual machines booted from snapshots.
slide_update_virtual_machineProWriteUpdate a running recovery virtual machine by its virt_id (from slide_list_virtual_machines).

[Slide] Boot a recovery virtual machine from a snapshot (a test or disaster VM). This starts a live VM consuming appliance CPU/memory, so it is treated as destructive. Provide fieldsJson as a JSON object — required: snapshot_id (from slide_list_snapshots), device_id (from slide_list_devices); optional: purpose (test|disaster), cpu_count, memory_in_mb, disk_bus (sata|virtio), network_type (network-none|network-nat-shared|network-nat-isolated|network-hostonly|bridge|network-id), network_source (a network id from slide_list_networks when network_type is network-id), network_model (hypervisor_default|e1000|rtl8139|virtio), boot_mods (array), force_boot_menu (bool), vnc_enabled (bool), passphrase (if the agent is passphrase-protected). Slide is eventually consistent: poll slide_get_virtual_machine for readiness rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: snapshot_id, device_id. Optional: purpose (test|disaster), cpu_count, memory_in_mb, disk_bus, network_type, network_source, network_model, boot_mods, force_boot_menu, vnc_enabled, passphrase.

[Slide] Permanently delete (shut down and discard) a recovery virtual machine by its virt_id (from slide_list_virtual_machines). This stops the live VM and removes it; it does NOT delete the underlying snapshot. Slide is eventually consistent, so the VM may still appear briefly in slide_list_virtual_machines after deletion.

ParamTypeRequiredDefaultDescription
virtIdstringyesThe virt_id to delete (from slide_list_virtual_machines).

[Slide] Get a single recovery virtual machine by its virt_id (from slide_list_virtual_machines). Returns the VM's snapshot/device linkage, power state, resource allocation, network config, and VNC/expiry details.

ParamTypeRequiredDefaultDescription
virtIdstringyesThe virt_id to fetch (from slide_list_virtual_machines).

[Slide] List the recovery virtual machines booted from snapshots. Optional filters: created_after / created_before (RFC3339) and sort_by / sort_asc. Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). Each virt_id feeds slide_get_virtual_machine, slide_update_virtual_machine, and slide_delete_virtual_machine.

ParamTypeRequiredDefaultDescription
createdAfterstringnonullOnly recovery VMs created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly recovery VMs created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update a running recovery virtual machine by its virt_id (from slide_list_virtual_machines). Provide fieldsJson as a JSON object with the fields to change — notably state (running|stopped|paused) which CHANGES the VM's live power state, plus cpu_count, memory_in_mb, network_type/network_source/network_model, purpose (test|disaster), force_boot_menu, vnc_enabled, expires_at. Changing state or resources affects a live VM. Slide is eventually consistent: confirm via slide_get_virtual_machine rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: state (running|stopped|paused), cpu_count, memory_in_mb, network_type, network_source, network_model, purpose, force_boot_menu, vnc_enabled, expires_at.
virtIdstringyesThe virt_id to update (from slide_list_virtual_machines).

Networks

ToolPlanAccessSummary
slide_create_networkProWriteCreate a disaster-recovery network.
slide_create_network_ipsec_connectionProWriteAdd an IPsec site-to-site connection to a disaster-recovery network (network_id from slide_list_networks).
slide_create_network_port_forwardProWriteAdd a port-forward rule to a disaster-recovery network (network_id from slide_list_networks).
slide_create_network_wg_peerProWriteAdd a WireGuard peer (client) to a disaster-recovery network (network_id from slide_list_networks; the network must have WireGuard enabled).
slide_delete_networkProDestructivePermanently delete a disaster-recovery network by its network_id (from slide_list_networks).
slide_delete_network_ipsec_connectionProDestructivePermanently delete an IPsec connection from a network by its network_id and ipsec_id, tearing down the site-to-site tunnel.
slide_delete_network_port_forwardProDestructivePermanently delete a port-forward rule from a network by its network_id and port_forward_id.
slide_delete_network_wg_peerProDestructivePermanently delete a WireGuard peer from a network by its network_id and wg_peer_id, revoking that client's tunnel access.
slide_get_networkFreeRead-onlyGet a single disaster-recovery network by its network_id (from slide_list_networks).
slide_list_networksFreeRead-onlyList the disaster-recovery networks in the account.
slide_update_networkProWriteUpdate a disaster-recovery network by its network_id (from slide_list_networks).
slide_update_network_ipsec_connectionProWriteUpdate an IPsec connection on a network by its network_id and ipsec_id.
slide_update_network_port_forwardProWriteUpdate a port-forward rule on a network by its network_id and port_forward_id.
slide_update_network_wg_peerProWriteUpdate a WireGuard peer on a network by its network_id and wg_peer_id.

[Slide] Create a disaster-recovery network. Provide fieldsJson as a JSON object — required: name and type (standard | bridge-lan); optional: client_id (owning client, or empty string), comments, internet (bool), dhcp (bool) with dhcp_range_start/dhcp_range_end, nameservers (array of DNS servers), router_prefix (router IP + netmask), bridge_device_id (device id for a bridge-LAN network), vlan_tag (0 = untagged, 1-4094 = tagged), wg (bool, enable WireGuard) with wg_prefix. Slide is eventually consistent: the new network_id may briefly 404 before slide_get_network succeeds — poll rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: name, type (standard|bridge-lan). Optional: client_id, comments, internet, dhcp, dhcp_range_start, dhcp_range_end, nameservers, router_prefix, bridge_device_id, vlan_tag, wg, wg_prefix.

[Slide] Add an IPsec site-to-site connection to a disaster-recovery network (network_id from slide_list_networks). Provide fieldsJson as a JSON object — required: name, remote_addrs (array of the partner-side router/firewall public IPs), remote_networks (array of partner-side networks reachable through the tunnel). Slide is eventually consistent: confirm via slide_get_network rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: name, remote_addrs (array of public IPs), remote_networks (array of CIDR networks).
networkIdstringyesThe parent network_id (from slide_list_networks).

[Slide] Add a port-forward rule to a disaster-recovery network (network_id from slide_list_networks). Provide fieldsJson as a JSON object — required: proto (tcp | udp) and dest (destination IP address and port pair, e.g. 10.0.0.5:3389). Slide is eventually consistent: confirm via slide_get_network rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: proto (tcp|udp), dest (IP:port, e.g. 10.0.0.5:3389).
networkIdstringyesThe parent network_id (from slide_list_networks).

[Slide] Add a WireGuard peer (client) to a disaster-recovery network (network_id from slide_list_networks; the network must have WireGuard enabled). Provide fieldsJson as a JSON object — required: peer_name; optional: remote_networks (array of remote networks reachable via this peer). Slide is eventually consistent: confirm via slide_get_network rather than assuming read-after-write.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object. Required: peer_name. Optional: remote_networks (array).
networkIdstringyesThe parent network_id (from slide_list_networks).

[Slide] Permanently delete a disaster-recovery network by its network_id (from slide_list_networks). This also removes its IPsec connections, port-forwards, and WireGuard peers, and disconnects any recovery VMs bound to it. Slide is eventually consistent, so the network may still appear briefly in slide_list_networks after deletion.

ParamTypeRequiredDefaultDescription
networkIdstringyesThe network_id to delete (from slide_list_networks).

[Slide] Permanently delete an IPsec connection from a network by its network_id and ipsec_id, tearing down the site-to-site tunnel. Slide is eventually consistent, so the connection may still appear briefly under slide_get_network after deletion.

ParamTypeRequiredDefaultDescription
ipsecIdstringyesThe ipsec_id of the connection to delete.
networkIdstringyesThe parent network_id (from slide_list_networks).

[Slide] Permanently delete a port-forward rule from a network by its network_id and port_forward_id. Slide is eventually consistent, so the rule may still appear briefly under slide_get_network after deletion.

ParamTypeRequiredDefaultDescription
networkIdstringyesThe parent network_id (from slide_list_networks).
portForwardIdstringyesThe port_forward_id of the rule to delete.

[Slide] Permanently delete a WireGuard peer from a network by its network_id and wg_peer_id, revoking that client's tunnel access. Slide is eventually consistent, so the peer may still appear briefly under slide_get_network after deletion.

ParamTypeRequiredDefaultDescription
networkIdstringyesThe parent network_id (from slide_list_networks).
wgPeerIdstringyesThe wg_peer_id of the peer to delete.

[Slide] Get a single disaster-recovery network by its network_id (from slide_list_networks). Returns the network's type, DHCP/DNS/router config, WireGuard settings, and owning client.

ParamTypeRequiredDefaultDescription
networkIdstringyesThe network_id to fetch (from slide_list_networks).

[Slide] List the disaster-recovery networks in the account. Optional filters: client_id (the owning client), created_after / created_before (RFC3339), and sort_by / sort_asc. Returns the vendor envelope {pagination:, data:[...]}; page with offset (max page size 50). Each network_id feeds slide_get_network, slide_update_network, slide_delete_network, and the nested IPsec / port-forward / WireGuard-peer tools.

ParamTypeRequiredDefaultDescription
clientIdstringnonullFilter to networks owned by this client id (from slide_list_clients). Omit for all clients.
createdAfterstringnonullOnly networks created after this RFC3339 instant. Omit for no lower bound.
createdBeforestringnonullOnly networks created before this RFC3339 instant. Omit for no upper bound.
limitintegerno50Max results to return (1-50, default 50).
offsetintegerno0Zero-based result offset for pagination (default 0).
sortAscbooleannonullSort ascending when true, descending when false. Omit for Slide's default order.
sortBystringnonullSort field (a per-resource enum; see Slide docs). Omit for Slide's default ordering.

[Slide] Update a disaster-recovery network by its network_id (from slide_list_networks). Provide fieldsJson as a JSON object with only the fields to change — name, client_id, comments, internet, dhcp, dhcp_range_start, dhcp_range_end, nameservers (array), router_prefix, vlan_tag, wg, wg_prefix (the network type is fixed at creation and cannot be changed here). Slide is eventually consistent: confirm via slide_get_network rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: name, client_id, comments, internet, dhcp, dhcp_range_start, dhcp_range_end, nameservers, router_prefix, vlan_tag, wg, wg_prefix.
networkIdstringyesThe network_id to update (from slide_list_networks).

[Slide] Update an IPsec connection on a network by its network_id and ipsec_id. Provide fieldsJson as a JSON object with the fields to change — name, remote_addrs (array), remote_networks (array). Slide is eventually consistent: confirm via slide_get_network rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: name, remote_addrs (array), remote_networks (array).
ipsecIdstringyesThe ipsec_id of the connection to update.
networkIdstringyesThe parent network_id (from slide_list_networks).

[Slide] Update a port-forward rule on a network by its network_id and port_forward_id. Provide fieldsJson as a JSON object with the fields to change — proto (tcp|udp), dest (IP:port). Slide is eventually consistent: confirm via slide_get_network rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: proto (tcp|udp), dest (IP:port).
networkIdstringyesThe parent network_id (from slide_list_networks).
portForwardIdstringyesThe port_forward_id of the rule to update.

[Slide] Update a WireGuard peer on a network by its network_id and wg_peer_id. Provide fieldsJson as a JSON object with the fields to change — peer_name, remote_networks (array). Slide is eventually consistent: confirm via slide_get_network rather than assuming immediate effect.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object of fields to change. Optional: peer_name, remote_networks (array).
networkIdstringyesThe parent network_id (from slide_list_networks).
wgPeerIdstringyesThe wg_peer_id of the peer to update.