API Categories
Browse API categories to find the endpoints you need. Each category contains related API endpoints organized by functionality, making it easy to discover and integrate with cluster services.
Authentication
Authentication is required for most of our APIs. You'll need to use the access_token
provided after successful authentication to access these APIs. It's important to note that you cannot obtain the access_token
directly within blueprints. Users must log in through the appropriate APIs within your application to obtain a token.
Token Expiry
In order to streamline the user experience, we have automated the token expiry process. By default, tokens are valid for 14 days and are automatically extended when actively used. When you make API requests, access pages, or interact with modals created in blueprints, we will automatically update the user's last activity, last token activity, and token expiry. To extend the token's validity, multiple requests need to be made using the token.
Public API Rate Limiting
Some of our APIs are public and come with default rate-limiting restrictions. These APIs have a default rate limit of 100
requests per second. It's not possible to modify the rate-limiting behavior for these APIs on a cluster level. However, if you encounter rate-limiting issues and cannot address them through conventional means, you have the option to build your own custom APIs within blueprinting to circumvent these limitations.
API Content-Type
When making requests to system or cluster APIs, it is crucial to include a Content-Type
in your request headers. For most APIs, the Content-Type
should be application/json
. However, for File API endpoints, you should use multipart/form-data
and specify Accept: application/json
.
Adding Tokens to your requests
Once you have obtained an access_token
through the appropriate APIs, you need to include this token in your request. You can achieve this in several ways, as outlined below:
- In the header, you can pass the token as
Authorization
using theBearer
scheme. - In the header, you can pass the token as
x-authtoken
. - In the header, you can pass the token as
x-token
. - In the header, you can pass the token as a
cookie
with the nameaccess_token
. - In the URL, you can pass the token as
?access_token=
in the query string.
API Categories
API History Contains2
API endpoints. API History related API endpoints
Audit Logs
Contains 2
API endpoints. Audit Logs related API endpoints
Authentication
Contains 9
API endpoints. Authentication related API endpoints
Authentication Groups
Contains 4
API endpoints. Authentication Groups related API endpoints
Blueprint Action Types
Contains 3
API endpoints. Blueprint Action Types related API endpoints
Blueprint Actions
Contains 15
API endpoints. Blueprint Actions related API endpoints
Blueprint Activity
Contains 1
API endpoints. Blueprint Activity related API endpoints
Blueprint Changes
Contains 2
API endpoints. Blueprint Changes related API endpoints
Blueprint Events
Contains 3
API endpoints. Blueprint Events related API endpoints
Blueprint Fields
Contains 5
API endpoints. Blueprint Fields related API endpoints
Blueprint Flows
Contains 1
API endpoints. Blueprint Flows related API endpoints
Blueprint Snapshots
Contains 4
API endpoints. Blueprint Snapshots related API endpoints
Blueprint Tags
Contains 6
API endpoints. Blueprint Tags related API endpoints
Blueprint Templates
Contains 11
API endpoints. Blueprint Templates related API endpoints
Blueprint Validation
Contains 4
API endpoints. Blueprint Validation related API endpoints
Blueprints
Contains 11
API endpoints. Blueprints related API endpoints
Cache Management
Contains 4
API endpoints. Cache Management related API endpoints
Cluster Statistics
Contains 4
API endpoints. Cluster Statistics related API endpoints
Entity Management
Contains 6
API endpoints. Entity Management related API endpoints
IP Management
Contains 2
API endpoints. IP Management related API endpoints
Language
Contains 1
API endpoints. Language related API endpoints
Language Management
Contains 10
API endpoints. Language Management related API endpoints
Local Devices
Contains 5
API endpoints. Local Devices related API endpoints
Node Settings
Contains 3
API endpoints. Node Settings related API endpoints
Password Reset
Contains 2
API endpoints. Password Reset related API endpoints
Queue
Contains 4
API endpoints. Queue related API endpoints
React Components
Contains 5
API endpoints. React Components related API endpoints
Redis Keys
Contains 8
API endpoints. Redis Keys related API endpoints
Storage Events
Contains 1
API endpoints. Storage Events related API endpoints
System Assets
Contains 3
API endpoints. System Assets related API endpoints
System Deployments
Contains 1
API endpoints. System Deployments related API endpoints
System Hints
Contains 4
API endpoints. System Hints related API endpoints
System Information
Contains 1
API endpoints. System Information related API endpoints
System Key-Value
Contains 4
API endpoints. System Key-Value related API endpoints
System Nodes
Contains 1
API endpoints. System Nodes related API endpoints
System Security
Contains 9
API endpoints. System Security related API endpoints
System Storages
Contains 5
API endpoints. System Storages related API endpoints
System Upgrades
Contains 3
API endpoints. System Upgrades related API endpoints
System Users
Contains 1
API endpoints. System Users related API endpoints
User Activity
Contains 2
API endpoints. User Activity related API endpoints
User Logs
Contains 2
API endpoints. User Logs related API endpoints
Users
Contains 9
API endpoints. Users related API endpoints