Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Tim Moore <[email protected]>
  • Loading branch information
kmoore134 and Mrt134 authored Jan 30, 2025
1 parent 312a58c commit 6ecbadb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ By default, communication facilitated by the API between the client and middlewa

**NOTE:**

The TrueNAS API enforces strict security checking and auditing in place to detect and prevent brute force or malicious API behaivor.
The TrueNAS API enforces strict security checking and auditing in place to detect and prevent brute force or malicious API behavior.

Connections to the API are currently limited to 20 Auth attempts AND/OR unauthenticated API requests in a 60 second period (Subject to future change). Exceeding this limit will result in a 10 minute rate limit cooldown before API connections can be re-established.
Connections to the API are currently limited to 20 Auth attempts AND/OR unauthenticated API requests in a 60 second period (subject to future change). Exceeding this limit results in a 10-minute rate limit cooldown before API connections can be re-established.

Developers are highly recommended to architect their tools in a way that uses a single persistent websocket connection that remains connected for subsequent API calls to be issued without a re-auth.

Developers needing to issue large quantities of subsequent operations (Example: Massive bulk dataset creations) are highly encouraged to leverage the `core.bulk` endpoint for queuing actions.
Developers that need to issue large quantities of subsequent operations (example: massive bulk dataset creations) are highly encouraged to leverage the `core.bulk` endpoint for queuing actions.

## Getting Started

Expand Down

0 comments on commit 6ecbadb

Please sign in to comment.