Skip to main content
Tools Reference

Axcient Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Axcient Tools

axcient_ · 53 tools · Free 51 · Pro 2 Backup and continuity across the Axcient x360 suite on one x360Portal key. x360Recover: protected systems, backup jobs and run history (filter by status for failures), AutoVerify, restore points, vaults, appliances, clients and storage usage; integer ids (the ASIO endpoint id is a GUID) and epoch seconds; the device list carries no client id, so start from the client list. x360Cloud: Microsoft 365 and Google Workspace backup - clients, backup status, users, shared resources - with text-slug client ids, 0-based pages and ISO dates. x360Sync: file sync and share, needing an x360Sync company id saved on the connector or passed per call; the share-link tools return live links. Billing: actual and billable usage. Only two tools write, both x360Recover: setting a vault connectivity threshold replaces the value, and creating a direct-to-cloud agent token mints an enrollment credential.

All connector tools · Axcient setup guide

Axcient tool groups

Devices

ToolPlanAccessSummary
axcient_get_deviceFreeRead-onlyReturns one protected system by its numeric device ID, including protection status, thresholds, storage figures and the vaults it replicates to.
axcient_get_device_autoverifyFreeRead-onlyReturns AutoVerify results for one protected system.
axcient_list_client_devicesFreeRead-onlyLists the protected systems belonging to one client.
axcient_list_device_restore_pointsFreeRead-onlyLists a protected system's restore points, grouped by the cloud vault each one is replicated to.
axcient_list_devicesFreeRead-onlyLists every protected system in the organization, with its protection state, operating system, agent version and latest local and cloud restore point.
axcient_list_restore_points_by_asio_endpointFreeRead-onlyReturns the same restore-point data as axcient_list_device_restore_points, but keyed by ASIO endpoint ID instead of the Axcient device ID.

[Axcient x360Recover] Returns one protected system by its numeric device ID, including protection status, thresholds, storage figures and the vaults it replicates to. Discover device IDs with axcient_list_devices or axcient_list_client_devices.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555 — not a name or a GUID).

[Axcient x360Recover] Returns AutoVerify results for one protected system. AutoVerify boots a recovery point and checks that the operating system, services and file system come up, so this answers whether a backup is actually restorable rather than only whether it ran. Pair it with axcient_list_job_history, which answers whether the backup ran at all.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555).

[Axcient x360Recover] Lists the protected systems belonging to one client. This is the tool to use before any backup-job tool, because it is the only device listing that gives you the client ID and device ID together. Set d2cOnly to true to see only direct-to-cloud (D2C) devices, which back up straight to a cloud vault with no on-premises appliance. Discover client IDs with axcient_list_clients. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).
d2cOnlybooleannonullOptional. Set true to return only direct-to-cloud devices. Axcient's default is false, which returns all devices.
serviceIdstringnonullOptional. Filter to one appliance by its four-character service ID.

[Axcient x360Recover] Lists a protected system's restore points, grouped by the cloud vault each one is replicated to. Use it to answer how far back a client can be recovered and whether replication is current. Axcient declares no maximum page size on this endpoint, so StackJack applies its own safety cap of 500 records per call.

ParamTypeRequiredDefaultDescription
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555).
limitintegernonullOptional. Records per page, 1-500. The 500 ceiling is a StackJack safety cap; Axcient declares no maximum.
maxTimestampintegernonullOptional. Return only restore points at or before this time, as a Unix epoch timestamp in SECONDS (e.g. 1756115413), not an ISO 8601 date string.
offsetintegernonullOptional. Records to skip, for paging. Combine with limit.

[Axcient x360Recover] Lists every protected system in the organization, with its protection state, operating system, agent version and latest local and cloud restore point. IMPORTANT: these device records do NOT carry a client ID, and every backup-job tool needs one — to reach a device's jobs, call axcient_list_clients and then axcient_list_client_devices instead of starting here. Results are not sorted and carry no total count; page until a short page comes back.

ParamTypeRequiredDefaultDescription
limitintegernonullOptional. Records per page, 1-500. Axcient's own maximum and default are both 500.
localPsIdstringnonullOptional. Filter to devices under one local protected-system UUID.
offsetintegernonullOptional. Records to skip, for paging. Combine with limit.

[Axcient x360Recover] Returns the same restore-point data as axcient_list_device_restore_points, but keyed by ASIO endpoint ID instead of the Axcient device ID. Use this when you are starting from Kaseya or ASIO tooling and hold an endpoint GUID rather than an Axcient device number. Axcient declares no maximum page size, so StackJack applies its own safety cap of 500 records per call.

ParamTypeRequiredDefaultDescription
asioEndpointIdstringyesThe ASIO endpoint ID. Unlike every other Axcient identifier, this one is a GUID string (e.g. 89fe5095-9f16-4aa2-9107-9586b5fe7036), not an integer.
limitintegernonullOptional. Records per page, 1-500. The 500 ceiling is a StackJack safety cap; Axcient declares no maximum.
maxTimestampintegernonullOptional. Return only restore points at or before this time, as a Unix epoch timestamp in SECONDS, not an ISO 8601 date string.
offsetintegernonullOptional. Records to skip, for paging. Combine with limit.

Backup Jobs

ToolPlanAccessSummary
axcient_get_device_jobFreeRead-onlyReturns one backup job's configuration and current state.
axcient_list_device_jobsFreeRead-onlyLists the backup jobs configured on one protected system, with each job's schedule and current state.
axcient_list_job_historyFreeRead-onlyReturns the run history of one backup job: when each run started, how long it took, how much data moved, and whether it succeeded.

[Axcient x360Recover] Returns one backup job's configuration and current state. Discover job IDs with axcient_list_device_jobs. For the job's run-by-run outcomes, including failures, call axcient_list_job_history instead.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555).
jobIdintegeryesThe numeric Axcient job ID (an integer, e.g. 777), from axcient_list_device_jobs.

[Axcient x360Recover] Lists the backup jobs configured on one protected system, with each job's schedule and current state. You need BOTH the client ID and the device ID: get them together from axcient_list_client_devices, because the organization-wide device listing does not carry a client ID. Job records come in two shapes depending on the backup engine (BRC or Replibit), so fields differ between jobs on the same device. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555).

[Axcient x360Recover] Returns the run history of one backup job: when each run started, how long it took, how much data moved, and whether it succeeded. This is the tool for finding failed backups — set status to failed. Get the client, device and job IDs from axcient_list_clients, then axcient_list_client_devices, then axcient_list_device_jobs. History records carry no total count; page until a short page comes back.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).
deviceIdintegeryesThe numeric Axcient device ID (an integer, e.g. 555).
jobIdintegeryesThe numeric Axcient job ID (an integer, e.g. 777), from axcient_list_device_jobs.
limitintegernonullOptional. Records per page, 1-500. Axcient's own maximum and default are both 500.
offsetintegernonullOptional. Records to skip, for paging. Combine with limit.
startTimeBeginintegernonullOptional. Return only runs that started at or after this time, as a Unix epoch timestamp in SECONDS (e.g. 1730281189), not an ISO 8601 date string.
statusstringnonullOptional. Filter to one outcome. Accepted values are exactly: in_progress, initial, successful, failed. Use failed to find backups that did not complete.

Clients

ToolPlanAccessSummary
axcient_get_clientFreeRead-onlyReturns one client by its numeric client ID.
axcient_get_client_usageFreeRead-onlyReturns storage usage for one client — local and cloud consumption.
axcient_list_clientsFreeRead-onlyLists every client of the organization.

[Axcient x360Recover] Returns one client by its numeric client ID. Discover client IDs with axcient_list_clients.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333 — not a company name).
includeAppliancesbooleannonullOptional. Set true to include a short summary of the client's appliances. Axcient's default is false.

[Axcient x360Recover] Returns storage usage for one client — local and cloud consumption. Use it for capacity planning and for reconciling what a client is billed for against what they actually store.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).

[Axcient x360Recover] Lists every client of the organization. This is usually the first call in any Axcient workflow: the organization-wide device listing does not carry a client ID, and every backup-job tool needs one, so start here and then call axcient_list_client_devices. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
includeAppliancesbooleannonullOptional. Set true to include a short summary of each client's appliances in the response. Axcient's default is false.

Appliances

ToolPlanAccessSummary
axcient_get_applianceFreeRead-onlyReturns one appliance by its numeric ID, including tunnel status, health status and reason, and storage figures.
axcient_list_appliancesFreeRead-onlyLists the organization's on-premises BDR appliances, with tunnel status, health status, IP address, software version and storage details.
axcient_list_client_appliancesFreeRead-onlyLists the appliances belonging to one client.

[Axcient x360Recover] Returns one appliance by its numeric ID, including tunnel status, health status and reason, and storage figures. A tunnel status of DOWN is the usual first explanation when an on-premises client's backups stop reporting. Discover appliance IDs with axcient_list_appliances.

ParamTypeRequiredDefaultDescription
applianceIdintegeryesThe numeric Axcient appliance ID (an integer, e.g. 444).
includeDevicesbooleannonullOptional. Set false to omit the appliance's device list. Axcient's default is true.

[Axcient x360Recover] Lists the organization's on-premises BDR appliances, with tunnel status, health status, IP address, software version and storage details. Relevant to hybrid estates; a purely direct-to-cloud client has no appliances. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
includeDevicesbooleannonullOptional. Set false to omit each appliance's device list and get a lighter response. Axcient's default is true.
serviceIdstringnonullOptional. Filter to one appliance by its four-character service ID (e.g. abcd).

[Axcient x360Recover] Lists the appliances belonging to one client. Discover client IDs with axcient_list_clients. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID (an integer, e.g. 333).
includeDevicesbooleannonullOptional. Set false to omit each appliance's device list. Axcient's default is true.

Organization

ToolPlanAccessSummary
axcient_get_organizationFreeRead-onlyReturns the organization the configured API key belongs to.
axcient_get_userFreeRead-onlyReturns one organization user by numeric ID.
axcient_list_usersFreeRead-onlyLists the users of the Axcient organization — the people who can sign in to x360Portal, not the end users of a client.

[Axcient x360Recover] Returns the organization the configured API key belongs to. It takes no parameters at all, because Axcient resolves the organization from the key itself. Use it to confirm which Axcient tenant StackJack is talking to before running anything else; StackJack also uses this call to check the credential's health.

[Axcient x360Recover] Returns one organization user by numeric ID. Discover user IDs with axcient_list_users.

ParamTypeRequiredDefaultDescription
userIdintegeryesThe numeric Axcient user ID (an integer, e.g. 123 — not a username or an email address).

[Axcient x360Recover] Lists the users of the Axcient organization — the people who can sign in to x360Portal, not the end users of a client. Use it to audit who holds access, which matters here because any organization administrator can view or delete any API key. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
usernamestringnonullOptional. Filter to one user by username.

Vaults

ToolPlanAccessSummary
axcient_get_vaultFreeRead-onlyReturns one vault by its numeric ID, with the devices assigned to it.
axcient_get_vault_connectivity_thresholdFreeRead-onlyReturns the current connectivity threshold for one vault: how many minutes the vault may go without contact before Axcient flags it as having lost connectivity.
axcient_list_vaultsFreeRead-onlyLists the organization's vaults — the cloud and private destinations that protected systems replicate to.
axcient_set_vault_connectivity_thresholdProDestructiveDESTRUCTIVE.

[Axcient x360Recover] Returns one vault by its numeric ID, with the devices assigned to it. Discover vault IDs with axcient_list_vaults.

ParamTypeRequiredDefaultDescription
vaultIdintegeryesThe numeric Axcient vault ID (an integer, e.g. 222).

[Axcient x360Recover] Returns the current connectivity threshold for one vault: how many minutes the vault may go without contact before Axcient flags it as having lost connectivity. Read this before changing it, so you can restore the previous value.

ParamTypeRequiredDefaultDescription
vaultIdintegeryesThe numeric Axcient vault ID (an integer, e.g. 222).

[Axcient x360Recover] Lists the organization's vaults — the cloud and private destinations that protected systems replicate to. Direct-to-cloud devices back up straight into a vault, so this is where to look when backups run but stop arriving. Omit limit to get every vault: it caps the total number of results rather than paging, and Axcient offers no offset here, so a limited call returns a truncated list that cannot be continued.

ParamTypeRequiredDefaultDescription
activebooleannonullOptional. Filter by active state.
includeDevicesbooleannonullOptional. Set false to omit each vault's device list and get a lighter response. Axcient's default is true.
limitintegernonullOptional. Maximum number of vaults to return. This is a result cap, not a page: there is no offset on this endpoint, so anything beyond the limit is simply not returned and cannot be fetched afterwards. Leave it unset unless you deliberately want a short list.
vaultTypestringnonullOptional. Filter by vault type. Accepted values are exactly: Private, Cloud.
withUrlbooleannonullOptional. Filter to vaults that do or do not have a URL configured.

[Axcient x360Recover] DESTRUCTIVE. Replaces the connectivity threshold on one vault — the number of minutes the vault may go without contact before Axcient warns that it has lost connectivity. This is a wholesale replace, not a merge, and raising the value SUPPRESSES the alerting an MSP relies on to notice that backups stopped reaching the cloud. Read the current value with axcient_get_vault_connectivity_threshold first so it can be restored.

ParamTypeRequiredDefaultDescription
thresholdMinutesintegeryesThe new threshold in MINUTES (e.g. 240 for four hours). A larger number means Axcient waits longer before warning.
vaultIdintegeryesThe numeric Axcient vault ID (an integer, e.g. 222).

Direct-to-Cloud Agents

ToolPlanAccessSummary
axcient_create_d2c_agent_tokenProDestructiveDESTRUCTIVE.

[Axcient x360Recover] DESTRUCTIVE. MINTS a new direct-to-cloud agent enrollment token for one client and vault, and returns it. Despite Axcient naming this operation as though it only reads an existing token, it creates one: anyone holding the returned token can enroll a machine into that client's vault. Treat the response as a credential — do not log it or paste it into a ticket. Use it only when you are about to install a direct-to-cloud agent. Get the client ID from axcient_list_clients and the vault ID from axcient_list_vaults.

ParamTypeRequiredDefaultDescription
clientIdintegeryesThe numeric Axcient client ID the agent will be enrolled under (an integer, e.g. 333).
vaultIdintegeryesThe numeric Axcient vault ID the agent will back up to (an integer, e.g. 222).

x360Cloud · Clients & Backup Status

ToolPlanAccessSummary
axcient_cloud_get_clientFreeRead-onlyReturns one x360Cloud client organization and its backup status from the latest backup report.
axcient_cloud_get_client_backup_statusFreeRead-onlyReturns the backup-status reports for one x360Cloud client organization — one report per backup run, each with its status and metrics.
axcient_cloud_list_clientsFreeRead-onlyLists the partner's x360Cloud client organizations — the customers whose Microsoft 365 or Google Workspace data Axcient backs up — with their protection settings and latest backup report.

[Axcient x360Cloud] Returns one x360Cloud client organization and its backup status from the latest backup report. Discover client IDs with axcient_cloud_list_clients.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it (e.g. sandmanandpartners). Not an x360Recover client number.

[Axcient x360Cloud] Returns the backup-status reports for one x360Cloud client organization — one report per backup run, each with its status and metrics. Axcient's SLA is one successful backup every 24 hours, so use this to see when a client last backed up successfully. The from and to filters are ISO date or date-time strings (e.g. 2024-12-11 or 2025-01-11T16:29:36Z), NOT the Unix epoch seconds the x360Recover tools take. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
backupStatusstringnonullOptional. Filter to one backup status. Accepted values are exactly: Successful, Failed, Partial, InProgress, Unavailable, Onboarding.
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it.
fromstringnonullOptional. The earliest report date to include, as an ISO date or date-time string (e.g. 2024-12-11 or 2024-12-11T00:00:00Z). Not epoch seconds.
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
tostringnonullOptional. The latest report date to include, as an ISO date or date-time string (e.g. 2025-01-11 or 2025-01-11T16:29:36Z). Not epoch seconds.

[Axcient x360Cloud] Lists the partner's x360Cloud client organizations — the customers whose Microsoft 365 or Google Workspace data Axcient backs up — with their protection settings and latest backup report. This is the first call in any x360Cloud workflow: the other x360Cloud client tools take the clientId it returns, which is a text slug (e.g. sandmanandpartners), not an x360Recover client number. Filter by backupStatus to find clients whose backups failed. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
backupStatusstringnonullOptional. Filter by the latest backup status. Accepted values are exactly: Successful, Failed, Partial, InProgress, Unavailable, Onboarding.
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
typestringnonullOptional. Which client organizations to list. Accepted values are exactly: AllTypes, Configured, Microsoft365, GoogleWorkspace, NotConfigured. Omit it for Configured (organizations configured to protect Microsoft 365 or Google Workspace data); use AllTypes to include organizations not fully set up.

x360Cloud · Users

ToolPlanAccessSummary
axcient_cloud_get_userFreeRead-onlyReturns one user of an x360Cloud client organization, looked up by user ID or by email address.
axcient_cloud_list_all_usersFreeRead-onlyLists users across ALL x360Cloud client organizations at once — use it to find which client a person belongs to, or to audit which users are selected for protection.
axcient_cloud_list_client_usersFreeRead-onlyLists the users and shared mailboxes of one x360Cloud client organization, with whether each is selected for protection.
ParamTypeRequiredDefaultDescription
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it.
userIdstringyesThe user's x360Cloud ID as axcient_cloud_list_client_users returned it, or the user's email address (e.g. jane@contoso.com).

[Axcient x360Cloud] Lists users across ALL x360Cloud client organizations at once — use it to find which client a person belongs to, or to audit which users are selected for protection. To list one client's users, use axcient_cloud_list_client_users instead. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
emailContainsstringnonullOptional. Only users whose email address contains this text.
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
selectedForProtectionbooleannonullOptional. Set true for only users selected for protection, false for only users who are not.
statusstringnonullOptional. Filter by the user's status in Microsoft 365 or Google Workspace. Accepted values are exactly: active, deleted, inactive.

[Axcient x360Cloud] Lists the users and shared mailboxes of one x360Cloud client organization, with whether each is selected for protection. Discover client IDs with axcient_cloud_list_clients. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it.
emailContainsstringnonullOptional. Only users whose email address contains this text.
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
selectedForProtectionbooleannonullOptional. Set true for only users selected for protection, false for only users who are not.
statusstringnonullOptional. Filter by the user's status in Microsoft 365 or Google Workspace. Accepted values are exactly: active, deleted, inactive.

x360Cloud · Shared Resources

ToolPlanAccessSummary
axcient_cloud_get_shared_resourceFreeRead-onlyReturns one shared resource (a SharePoint site or a Google Workspace shared drive) of an x360Cloud client organization.
axcient_cloud_list_all_shared_resourcesFreeRead-onlyLists shared resources — Microsoft 365 SharePoint sites and Google Workspace shared drives — across ALL x360Cloud client organizations at once.
axcient_cloud_list_client_shared_resourcesFreeRead-onlyLists the shared resources — Microsoft 365 SharePoint sites and Google Workspace shared drives — of one x360Cloud client organization.

[Axcient x360Cloud] Returns one shared resource (a SharePoint site or a Google Workspace shared drive) of an x360Cloud client organization. Shared-resource IDs contain a # character (e.g. 68ad7339-f2f8-3432-9d06-3ce8762b7692#12cce07b-ba27-4861-6aaa-6cd6e4d46a80); pass the ID exactly as axcient_cloud_list_client_shared_resources returned it and StackJack encodes it.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it.
sharedResourceIdstringyesThe shared-resource ID exactly as axcient_cloud_list_client_shared_resources returned it, including its # (or %23) character.

[Axcient x360Cloud] Lists shared resources — Microsoft 365 SharePoint sites and Google Workspace shared drives — across ALL x360Cloud client organizations at once. To list one client's shared resources, use axcient_cloud_list_client_shared_resources instead. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
resourceTypestringnonullOptional. Filter by resource type. Accepted values are exactly: sharepoint_site, shared_drive.
statusstringnonullOptional. Filter by the resource's status in the source system. Accepted values are exactly: active, deleted, inactive.
urlContainsstringnonullOptional. Only resources whose URL contains this text.

[Axcient x360Cloud] Lists the shared resources — Microsoft 365 SharePoint sites and Google Workspace shared drives — of one x360Cloud client organization. Discover client IDs with axcient_cloud_list_clients. Results are paged: page is 0-based (the first page is 0, and omitting it also returns the first page), and pageSize defaults to 20; StackJack caps pageSize at 100, which is our limit rather than Axcient's. The response carries numberOfAvailableResults — combine it with pageSize to see how many pages there are.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe x360Cloud client organization ID, a text slug exactly as axcient_cloud_list_clients returned it.
pageintegernonullOptional. The 0-based page number: the first page is 0. Omit it for the first page.
pageSizeintegernonullOptional. Results per page. Axcient's default is 20; StackJack caps it at 100.
resourceTypestringnonullOptional. Filter by resource type. Accepted values are exactly: sharepoint_site, shared_drive.
statusstringnonullOptional. Filter by the resource's status in the source system. Accepted values are exactly: active, deleted, inactive.
urlContainsstringnonullOptional. Only resources whose URL contains this text.

x360Sync · Organizations

ToolPlanAccessSummary
axcient_sync_get_organization_usageFreeRead-onlyReturns the space usage and counts of one x360Sync organization — storage used and the numbers of accounts, guests and machines.
axcient_sync_list_child_organizationsFreeRead-onlyLists the child organizations under an x360Sync organization — for an MSP, its client tree.

[Axcient x360Sync] Returns the space usage and counts of one x360Sync organization — storage used and the numbers of accounts, guests and machines. Use it for capacity planning or to reconcile what a client is billed for.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.

[Axcient x360Sync] Lists the child organizations under an x360Sync organization — for an MSP, its client tree. Each child carries its own x360Sync company ID, which the other x360Sync tools take as companyId. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

x360Sync · Accounts & Groups

ToolPlanAccessSummary
axcient_sync_get_accountFreeRead-onlyReturns one x360Sync user account, looked up by its numeric ID or by email address.
axcient_sync_get_groupFreeRead-onlyReturns one x360Sync group by its numeric ID.
axcient_sync_list_accountsFreeRead-onlyLists the user accounts of one x360Sync organization.
axcient_sync_list_groupsFreeRead-onlyLists the groups of one x360Sync organization.

[Axcient x360Sync] Returns one x360Sync user account, looked up by its numeric ID or by email address. The response's company_id is the account's x360Sync organization, so calling this with your own x360Sync admin email is how to find the company ID the other x360Sync tools need.

ParamTypeRequiredDefaultDescription
includePermissionsbooleannonullOptional. Set true to include the account's permissions in the response.
personIdentifierstringyesThe account's numeric x360Sync ID (e.g. 78901) or its email address (e.g. admin@acme.com).

[Axcient x360Sync] Returns one x360Sync group by its numeric ID. Discover group IDs with axcient_sync_list_groups.

ParamTypeRequiredDefaultDescription
groupIdintegeryesThe numeric x360Sync group ID (a whole number).

[Axcient x360Sync] Lists the user accounts of one x360Sync organization. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

[Axcient x360Sync] Lists the groups of one x360Sync organization. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

x360Sync · Guests

ToolPlanAccessSummary
axcient_sync_get_guestFreeRead-onlyReturns one x360Sync guest account, looked up by its numeric ID or by email address.
axcient_sync_list_guestsFreeRead-onlyLists the guest accounts of one x360Sync organization — external people files have been shared with.
ParamTypeRequiredDefaultDescription
guestIdentifierstringyesThe guest's numeric x360Sync ID (e.g. 78904) or its email address.

[Axcient x360Sync] Lists the guest accounts of one x360Sync organization — external people files have been shared with. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

x360Sync · Machines

ToolPlanAccessSummary
axcient_sync_get_machineFreeRead-onlyReturns one synced machine by its numeric x360Sync ID.
axcient_sync_list_account_machinesFreeRead-onlyLists the machines one x360Sync account syncs from.
axcient_sync_list_machinesFreeRead-onlyLists the machines syncing with one x360Sync organization — the computers running the x360Sync client, with their last-seen details.

[Axcient x360Sync] Returns one synced machine by its numeric x360Sync ID. Discover machine IDs with axcient_sync_list_machines or axcient_sync_list_account_machines.

ParamTypeRequiredDefaultDescription
machineIdintegeryesThe numeric x360Sync machine ID (a whole number).

[Axcient x360Sync] Lists the machines one x360Sync account syncs from. The account ID is the numeric id axcient_sync_get_account or axcient_sync_list_accounts returned. This endpoint has no paging.

ParamTypeRequiredDefaultDescription
personIdintegeryesThe numeric x360Sync account (person) ID, a whole number — not an email address.

[Axcient x360Sync] Lists the machines syncing with one x360Sync organization — the computers running the x360Sync client, with their last-seen details. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

x360Sync · Folders & Activity

ToolPlanAccessSummary
axcient_sync_get_activityFreeRead-onlyReturns one x360Sync activity record by its numeric ID.
axcient_sync_list_activityFreeRead-onlyLists the activity feed of one x360Sync organization — who did what to which file, folder, account or share, and when.
axcient_sync_list_root_foldersFreeRead-onlyLists the root folders of one x360Sync organization.

[Axcient x360Sync] Returns one x360Sync activity record by its numeric ID. Discover activity IDs with axcient_sync_list_activity.

ParamTypeRequiredDefaultDescription
activityIdintegeryesThe numeric x360Sync activity ID (a whole number).

[Axcient x360Sync] Lists the activity feed of one x360Sync organization — who did what to which file, folder, account or share, and when. Use it to investigate a deleted file or an unexpected share. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

[Axcient x360Sync] Lists the root folders of one x360Sync organization. Each folder carries a hash, which may work as an access link to the folder, so handle the response with the same care as the share-link tools and do not paste it into tickets or chat. Results come in vendor-sized pages: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.

ParamTypeRequiredDefaultDescription
companyIdintegernonullOptional. The x360Sync organization (company) ID, a whole number such as 12345. Omit it to use the x360Sync company ID saved on the Axcient connector. This is an x360Sync ID, not an x360Recover client ID; if you do not know it, axcient_sync_get_account with your own x360Sync admin email returns it as company_id.
offsetintegernonullOptional. How many results to skip; omit it or pass 0 for the start. x360Sync returns vendor-sized pages as {offset, total, results}: call again with offset set to offset plus the number of results returned, and stop when offset reaches total.
ToolPlanAccessSummary
axcient_sync_get_share_linkFreeRead-onlyReturns one x360Sync share link, looked up by its numeric ID or its hash, with its settings (expiry, whether sign-in is required, whether anonymous editing is allowed) and optionally its subscribers.
axcient_sync_list_account_share_links_createdFreeRead-onlyLists the share links one x360Sync account created, with their subscribers.
axcient_sync_list_account_share_links_receivedFreeRead-onlyLists the share links shared WITH one x360Sync account.
axcient_sync_list_guest_share_linksFreeRead-onlyLists the share links shared with one x360Sync guest.
axcient_sync_list_share_linksFreeRead-onlyLists the share links of one x360Sync organization — every file and folder shared by link, with who created it, when it expires and how often it was viewed or downloaded.

Billing · Usage

ToolPlanAccessSummary
axcient_billing_get_actual_usageFreeRead-onlyReturns ACTUAL usage for the partner company and each child company — per-product counters such as appliances, cloud and direct-to-cloud protected servers and workstations, storage tiers, and…
axcient_billing_get_billable_usageFreeRead-onlyReturns monthly BILLABLE usage for the partner company and each child company — what Axcient bills the partner for — plus the partner's own company details (name, address, phone, website).

[Axcient Billing] Returns ACTUAL usage for the partner company and each child company — per-product counters such as appliances, cloud and direct-to-cloud protected servers and workstations, storage tiers, and x360Cloud seats and storage. Use it to reconcile what each client consumes against what they are invoiced. The response carries quantities only, never prices. Dates are optional YYYY-MM-DD strings (e.g. 2024-04-01), not epoch seconds; what Axcient reports when they are omitted is not documented. Axcient says this report covers x360Recover and x360Cloud today, with x360Sync coming later. Child IDs in the response are strings and do not match x360Recover or x360Cloud IDs.

ParamTypeRequiredDefaultDescription
endDatestringnonullOptional. The last day of the window, as YYYY-MM-DD (e.g. 2024-04-30).
startDatestringnonullOptional. The first day of the window, as YYYY-MM-DD (e.g. 2024-04-01).

[Axcient Billing] Returns monthly BILLABLE usage for the partner company and each child company — what Axcient bills the partner for — plus the partner's own company details (name, address, phone, website). Compare it with axcient_billing_get_actual_usage to find clients billed for more or less than they use. The response carries quantities only, never prices. Dates are optional YYYY-MM-DD strings (e.g. 2024-04-01), not epoch seconds; what Axcient reports when they are omitted is not documented. Axcient says this report covers x360Recover and x360Cloud today, with x360Sync coming later. Child IDs in the response are strings and do not match x360Recover or x360Cloud IDs.

ParamTypeRequiredDefaultDescription
endDatestringnonullOptional. The last day of the window, as YYYY-MM-DD (e.g. 2024-04-30).
startDatestringnonullOptional. The first day of the window, as YYYY-MM-DD (e.g. 2024-04-01).