Introduction
Understand general concepts, response codes, and authentication strategies.
Base URL
Regions code list
For more info about supported region, please check here.
Name | Code | Example |
---|---|---|
Germany | api | https://api.jsonsilo.com/api/v1/ |
Singapore | sg-01-api | https://sg-01-api.jsonsilo.com/api/v1/ |
United States (Central) | usc-01-api | https://usc-01-api.jsonsilo.com/api/v1/ |
Authentication
API Keys
The JSONSilo Manage API uses API keys for authentication. Every request to the API must include your API key, used to authenticate your requests.
All API requests should include your API key in an X-MAN-API
or x-man-api
HTTP header as follows:
Generate Manage API Key
To generate or manage an API key, from the console screen, select Key from the drawer menu. This page will list all the keys, including the Access Key used to access the private silo.
Please do not confuse the Access Key with the Manage Key.
- Access Key: To access private silo
- Manage Key: To mange silo via API
Step 1: Create a new key
Click the +Add
button to add a new key.
Step 2: Generate Key
- Enter a key name (this field is optional; the default value is Secret Key).
- Select the key duration. For the free plan, only 1 month is available. Upgrade your plan if you want to increase the key duration.
- Click the Create button to generate the new key.
Step 3: Save Key
- Generated secret key; Please save this secret key somewhere safe and accessible. For security reasons, you won’t be able to view it again through your account.
- Copy the generated key.
- You can safely close the dialog once save the key.
Revoke Key
To revoke the key, click the Revoke
button. This will revoke your key and will affect any active silo currently using the key.
Making a requests
To revoke the key, click the Revoke
button. Please ensure that no silos are using the key, as this will interrupt the operation of any silos using it.