Skip to main content

API rate limits

The following rate limits apply to the GravityZone Public API.

Note

  • If a method is not listed in the tables below, a default rate limit of 10 requests per second per API key applies.

  • Separate rate limit counters are used for JSON-RPC methods and HTTP methods; therefore, requests made to a JSON-RPC endpoint are not counted against the rate limit for HTTP endpoints, and vice versa.

JSON-RPC methods:

Rate limit parameters

Requests per burst*

Delay**

API

Methods

10 requests per second per API key

10 requests

No delay

This rate limit applies to any API method that is not listed below.

5 requests per second per API Key

5 requests

No delay

Licensing API

  • getLicenseInfo

  • setLicenseKey

  • addProductKey

  • removeProductKey

  • getMonthlyUsage

  • getMonthlyUsagePerProductType

Companies API

  • deleteCompany

  • updateCompanyDetails

  • suspendCompany

  • activateCompany

  • createCustomFieldDefinition

  • updateCustomFieldDefinition

  • getCustomFieldsDefinitions

  • deleteCustomFieldDefinition

Network API

  • getnetworkinventoryitems

30 requests per minute per API Key

10 requests

No delay

Quarantine API

  • createRemoveQuarantineItemTask

  • createEmptyQuarantineTask

  • createRestoreQuarantineItemTask

  • createRestoreQuarantineExchangeItemTask

  • createAddFileToQuarantineTask

  • createReleaseQuarantineExchangeItemTask

Network API

  • createScanTask

  • createReconfigureClientTask

  • createScanTaskByMac

  • moveCompanyOrCompanyFolder

  • moveEndpointsBetweenCompanies

  • deleteEndpoint

  • createSubmitToSandboxAnalyzerTask

  • killProcess

Integrations API

  • configureAmazonEC2IntegrationUsingCrossAccountRole

Licensing API

  • setMonthlySubscription

Accounts API

  • createAccount

  • deleteAccount

  • updateAccount

  • configureNotificationsSettings

  • getNotificationsSettings

Reports API

  • createReport

5 requests per minute per API Key

Not available

No delay

Incidents API

  • addToBlocklist

  • removeFromBlocklist

  • createCustomRule

  • deleteCustomRule

Network API

  • assignPolicy

Event Push Service API

  • setPushEventSettings

  • getPushEventSettings

  • sendTestPushEvent

  • getPushEventStats

  • resetPushEventStats

Maintenance windows API

  • updatePatchManagementMaintenanceWindow

  • deleteMaintenanceWindow

  • assignMaintenanceWindows

  • unassignMaintenanceWindows

HTTP methods:

Rate limit parameters

Requests per burst*

Delay**

Methods

5 requests per minute per API Key

Not available

Not available

  • downloadReportZip

  • downloadPackageFullKit

  • downloadSandboxReport

  • downloadScanLogsZip

*The burst mechanism is based on a queue that stores a specific number of API requests that would normally exceed the rate limit applicable. Requests will be stored and ran in the order they were requested. If the burst queue is full, any additional requests will return a 429 HTTP error code.

Note

If the burst mechanism is not available for a specific API method, the requests will not be queued. Any request that exceeds the rate limit will return a 429 HTTP error code.

**An API request delay mechanism activates when the method rate limit is reached and will delay the processing of the request until the time limit has passed. If No delay is applicable to a method, the public API service will consume the queue as soon as it arrives.

In this section: