Sharetru API: Call Limits and Plan Availability

Who this is for: administrators and developers using the Sharetru API.

Summary

Nothing about how you authenticate or which endpoints you call has changed. What has changed is that your usage is now measured against your plan's allocation, and requests are throttled or blocked once you pass it.

What Changed and Why

The Sharetru API began as an administrative API. It let you manage the things around your file transfers — users, groups, folders, permissions, network rules, and the activity and administrative logs — but it could not move files.

That is no longer true. The API is now a file transfer API as well as an administrative one, and it is continuing to expand. Because the API can now carry file payloads and support automated, high-volume workflows, usage varies enormously between accounts. Published per-plan limits let us keep the service fast and predictable for everyone and give you a clear, purchasable path when you need more capacity.

What the API can do

At a high level, the API covers two areas.

Administration

• Read your site's information and configuration, and view or update its file transfer services.
• Create, retrieve, update, and delete users, including sending password reset emails.
• Create and delete groups and manage group membership.
• Create, retrieve, update, and delete folders.
• Manage permissions at both the user and the group level.
• Manage network rules that control which addresses can reach your site.
• Read the file activity log and the administrative log.

File Transfer

• List, download, move, rename, and delete files, and read file metadata.

• Upload files, including chunked upload sessions for large files that can be started, continued, and finalized.

• Create, retrieve, update, and delete secure shares, individually or in batches.

For the full endpoint reference — request and response formats, parameters, authentication, and code examples — see developer.sharetru.com.

Call Limits by Plan

Monthly allowances reset at the start of each billing cycle. The calls-per-second figure is the maximum sustained request rate for your account, measured across all API clients using it.

Expansion capacity is additional monthly calls you can purchase for an added cost. Rollover is unused capacity you keep for one month at no cost. Neither raises your calls-per-second ceiling — both sections below explain how they work.

Current Plans

Other Plans With API Access

These plans include API access and retain the allocations below. They are not available for new subscriptions or plan changes.

If Your Plan is not Listed Above

Plans that do not appear in either table do not currently include API access.

If you are on one of those plans and you want API access, the way to get it is to upgrade to a current offering — Core or Complete. You cannot move onto one of the other plans listed in this article; those allocations exist only for accounts already on them.

To discuss an upgrade, contact your Sharetru account representative or our support team.

Rollover

If you do not use your full monthly allowance, part of the remainder carries into the following month at no cost. Every plan can roll over up to half of its monthly allocation — the exact figure is in the Rollover allowed column above.

• Rollover lasts one month. Calls carried into a month must be used in that month; whatever is left at the end of it does not carry again. Rollover never accumulates past the cap.

• Rollover is consumed first. Each month the API draws down your rolled-over balance before it touches your regular allowance, so the balance closest to expiring is the one you use up.

• Rollover does not raise your calls-per-second limit. It gives you more calls in the month, not a faster rate.

Example: A Complete account has a 250,000-call monthly allowance and a 125,000-call rollover cap. In January it uses 100,000 calls, leaving 150,000 unused — but only 125,000 of that can roll over. February therefore opens with 375,000 available calls: the 125,000 rolled over, which is spent first, followed by February's own 250,000. Any of the rolled-over 125,000 still unspent on 28 February is lost.

Adding Capacity

If you expect to exceed your monthly allowance and your rollover balance, you can purchase an expansion block for your plan at an additional cost. The Expansion will be available to you for the remainder of your current term. The amount available to you is shown in the Expansion available column above.

• Expansion adds monthly calls only. Your calls-per-second limit is unchanged.

• Plans showing “Not available” cannot add expansion capacity. Those plans still get rollover.

• If you consistently need more than your allowance plus rollover and expansion, a plan with a higher allocation is the better fit — talk to your account representative.

What Happens When You Reach Your Limits

The two limits behave differently, and the API tells you which one you hit.

Both responses include a Retry-After header. Build your integration to read it rather than retrying on a fixed interval — that is the difference between recovering cleanly and compounding the problem.

Staying Within Your Limits

• Cache what does not change. User, group, and folder listings rarely need to be re-fetched on every run.

• Poll less often, or not at all. Long polling intervals consume allowance quickly for very little return.

• Batch where the API supports it. Creating several shares in one request costs one call, not several.

• Limit concurrency in your client. Parallel workers are the most common cause of a 429.

• Retry on the header, with backoff. Never retry immediately in a tight loop.

• Time heavy work to follow a light month. Rolled-over calls are spent first and expire after one month, so a large batch job costs you least in the month right after a quiet one.

• Watch your trend, not just your total. Rising month-over-month usage is your signal to plan for expansion before you are blocked.

Questions

For endpoint documentation, visit developer.sharetru.com. For questions about your own allocation, current usage, expansion pricing, or upgrading your plan, contact Sharetru support or your account representative.