S3 Compatible Storage Integrations

Reseller API

Reseller API's Collection
Common Error Cases
Authorization Header API Key
Enums
User Operations
Storage Operations
Whitelabeling Operations
Subuser Operations

Reseller API's Collection

The IDrive^® e2 Reseller API is developed over REST architecture.

The IDrive^® e2 Reseller API accepts request bodies in the form of content type 'application/JSON' and returns 'application/JSON' responses.

Our API uses API Key Authentication mechanism. You can generate the API key from the profile section of the IDrive^® e2 account.

Add the API key generated from the profile section to all HTTP API calls header against key 'token'.

HTTP Response codes:

200 (Success)
500 (Server Error)
400 (Invalid Parameters)
401 (Unauthorized)
403 (Invalid request)

The Error response body would be of following structure:

                        Response (application/JSON) : { 

                                 error : { 

                                    string type; 

                                   string code; 

                                   string message; 

                                 } 

                           }

Possible values for 'error.type' are :

api_error
invalid_request_error
server_error

For further details 'error.code' and 'error.message' would explain what went wrong.

Common Error Cases

Following are the common error cases that can be returned by all APIs detailed below. Rest of the error cases will be documented with the specific APIs.

Server Error (HTTP 500)

 
                           Response (application/JSON) : {

                                    error:{ 

                                             type: 'api_error',

                                             code: 'request_processing_failed',

                                             message: 'Unable to process this request, please try again later' 

                                             }

                              }

Unauthorized (HTTP 401)

 
                              Response (application/JSON) : {

                                       error:{ 

                                                type: 'invalid_request_error',

                                                code: 'unauthorized',

                                                message: 'Authentication header missing/invalid' 

                                           }

                                 }

Invalid Parameters (HTTP 400)

 
                              Response (application/JSON) : {

                                       error:{ 

                                                type: 'invalid_request_error',

                                                code: 'invalid_parameters',

                                                message: 'Invalid parameter values, check errors for details', 

                                                errors: [] (array contain details of error) 

                                             }

                                 }

AUTHORIZATION Header API Key

Key	token
Value	<YOUR-API-KEY>

Enumerations used throughout API's are:

Enums:

Access Key Permissions:

                        {

                               0: Read access,

                               1: Write access,

                               2: Read/Write access

                           }

User Operations

List all users

GET
https://api.idrivee2.com/api/reseller/v1/usersClick to copyLink copied This displays all the users added under your profile.

Output

API returns array of the users added under your profile.
The structure of response is as following:

                           struct response {

                                      string id;

                                      List users[];

                              }


                              struct users{

                                         string email;

                                         string first_name;

                                         string last_name;

                                         string account_creation_timestamp;

                                         string invite_url;

                                         bool is_signed_up;

                                         bool is_active;

                                         double storage_used;

                                         int storage_quota;

                                 }

Note:
storage_used (bytes)
storage_quota (GB's) (0 : unlimited else > 0)
invite_url if not null can be used by the invited user to sign up

Curl Example Request:

curl --request GET 'https://api.idrivee2.com/api/reseller/v1/users' --header 'token: <your api key>'

Create User

PUT
https://api.idrivee2.com/api/reseller/v1/create_userClick to copyLink copied This API will create a user account on IDrive^® e2 which will be linked to your account.

Input

                              string email; 

                           string password; //base64 encoded string

                           string first_name; 

                           string last_name;  //last_name is an optional parameter

                           int quota;

                           bool email_notification; //email_notification is an optional parameter

Note:

Quota (GB's) (0 for unlimited else >0)
Password is a base64 encoded string.
email_notification Iff provided and set to false then no email notification would be send to the specified email address.

Length Parameters

Email [255]
Password [100]
First Name [64]
Last Name [64]

Output
On Success API Response (application/JSON) would be :

{ user_created: true }

Error Cases

Invalid Request (HTTP-403)

User already exists and is linked to your account.

                                    { 

                                           error:{

                                                    type: 'invalid_request_error',

                                                    code: 'user_signed_up',

                                                    message : 'User already signed up' 

                                                   }

                                    }

Email already in use (an independent account exists which is not linked to your account).

                                       { 

                                              error:{

                                                       type: 'invalid_request_error',

                                                       code: 'email_already_in_use',

                                                       message: 'Email already in use'  

                                                      }

                                       }

Example Request :Body (application/JSON)

                                       {

                                              "email": "e2reseller+1@idrivee2.com",

                                              "password":"dGVzdDEyMw==",

                                              "first_name":"dev",

                                              "quota": 1024,

                                              "email_notification": false

                                      }

Curl Example Request:

                                       curl  --request PUT 'https://api.idrivee2.com/api/reseller/v1/create_user' 

                                       --data '{

                                              "email": "e2reseller+1@idrivee2.com",

                                              "password":"dGVzdDEyMw==",

                                              "first_name":"dev",

                                              "quota": 1024

                                       }' --header 'token: <your api key>'

Disable User

POST
https://api.idrivee2.com/api/reseller/v1/disable_userClick to copyLink copied This API disables the user account. Users will not be able to login, access data, and perform any operations.

Input

string email;

Length Parameters

Email [255]

Precondition

User signed up.
Account enabled.

Output
On Success API Response (application/JSON) would be :

{ user_disabled : true }

Error Cases

Invalid Request (HTTP 403)

Account already disabled.

                                                   error:{ 

                                                             type: 'invalid_request_error',

                                                             code: 'user_account_already_disabled', 

                                                             message: 'Account already disabled for the user' 

                                                             }

                                                      }

Account does not exist.

                                                error:{ 

                                                          type: 'invalid_request_error',

                                                          code: 'account_non_existant', 

                                                          message: 'Account with this email does not exist' 

                                                          }

                                                   }

Example Request :Body (application/JSON)

                                       {

                                              "email":"e2reseller+1@idrivee2.com"

                                      }

Curl Example Request:

                                       curl --request POST 'https://api.idrivee2.com/api/reseller/v1/disable_user' 

                                       --data '{

                                              "email":"e2reseller+1@idrivee2.com"

                                       }'

Enable User

POST
https://api.idrivee2.com/api/reseller/v1/enable_userClick to copyLink copied This API reenables disabled user accounts. Users can login, access data, and perform normal operations.

Input

string email;

Length Parameters

Email [255]

Precondition

User signed up/created.
User account was disabled previously.

Output
On Success API Response(application/JSON) would be:

{ user_enabled : true }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

                                                   error:{ 

                                                             type: 'invalid_request_error',

                                                             code: 'account_non_existant', 

                                                             message: 'Account with this email does not exist' 

                                                             }

                                                      }

Account already enabled.

                                                error:{ 

                                                          type: 'invalid_request_error',

                                                          code: 'user_account_already_enabled', 

                                                          message: 'Account already enabled for the user' 

                                                          }

                                                   }

Example Request :Body (application/JSON)

                                      {

                                              "email":"e2reseller+1@idrivee2.com"

                                       }

Curl Example Request:

                                       curl  --request POST 'https://api.idrivee2.com/api/reseller/v1/enable_user' 

                                       --data '{

                                              "email":"e2reseller+1@idrivee2.com"

                                       }' --header 'token: <your api key>'

Remove User

POST
https://api.idrivee2.com/api/reseller/v1/remove_userClick to copyLink copied This API will permanently delete users from IDrive^® e2.

Note: The user data will be lost permanently on performing this operation.

Input

string email;

Length Parameters

Email [255]

Precondition

User must be disabled.

Output
On success API Response(JSON) would be :

{ user_removed : true }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

                                                   {

                                                            error:{ 

                                                                      type: 'invalid_request_error',

                                                                      code: 'account_non_existant',

                                                                      message:'Account with this email does not exist'

                                                                     }

                                                      }

Account not disabled.

                                                      {

                                                               error:{ 

                                                                         type: 'invalid_request_error',

                                                                         code: 'user_account_not_disabled',

                                                                         message: 'User account not disabled'

                                                                        }

                                                         }

Example Request :Body (application/JSON)

                                         {

                                                 "email":"e2reseller+1@idrivee2.com"


                                          }

Curl Example Request:

                                          curl  --request POST 'https://api.idrivee2.com/api/reseller/v1/remove_user' 

                                          --data '{

                                                 "email":"e2reseller+1@idrivee2.com"

                                          }' --header 'token: <your api key>'

Get Storage Usage

POST
https://api.idrivee2.com/api/reseller/v1/usage_statsClick to copyLink copied This API returns the array of IDrive^® e2 utilization for the user provided.

Input

                                          {

                                                 string email;

                                                 string date_from;

                                                 string date_to;

                                             }

date_from(ISO8601)(start date)
date_to(ISO8601) (end date)
Length Parameters

Email [255]

Preconditions

User must be signed up.

Output
Array of usage_stats structure

                                             struct usage_stats{ 

                                                       double downloads;

                                                       double uploads;

                                                       double disk_used;

                                                       string date;

                                                }

downloads, uploads, disk_used are in bytes
Error Cases

Invalid Request (HTTP 403)

Account does not exist.

                                                      {

                                                              error:{ 

                                                                       type: 'invalid_request_error',

                                                                       code: 'account_non_existant',

                                                                       message: 'Account with this email does not exist'

                                                                      }

                                                         }

Example Request :Body (application/JSON)

                                            {

                                                    "email":"e2reseller+1@idrivee2.com",

                                                    "date_to":"2022-08-31",

                                                    "date_from":"2022-08-01"

                                             }

Curl Example Request:

                                             curl  --request POST 'https://api.idrivee2.com/api/reseller/v1/usage_stats' 

                                             --data '{

                                                    "email": "DEV-TEST+1@idrivee2.com",

                                                    "date_to":"2022-08-31",

                                                    "date_from":"2022-08-01"

                                            }' --header 'token: <your api key>'

Get Activity Logs

POST
https://api.idrivee2.com/api/reseller/v1/user_activity_historyClick to copyLink copied This API will fetch the activity logs of a user for a date range.

Input

                                          string email;

                                          string start_date;

                                          string end_date;

                                          int page_no;

Length Parameters

Email [255]

Note

start_date (ISO8601) - Start Date
end_date (ISO8601) - End Date
page_no - API is paginated with each page consisting of 200 records
and page_no start from 1 onwards

Output
On Success API Response (application/JSON) would be :

                                           struct response {

                                               List[] logs;

                                               struct pagination;

                                           }



                                           struct logs {

                                               string timestamp;

                                               string description;

                                               string ip;

                                           }



                                           struct pagination {

                                               int total_records;

                                               int page_no;

                                               int records_per_page;

                                           }

Specific Error Case

Account does not exist.

                                             Response (application/JSON) : { 

                                                 error: {

                                                     type: 'invalid_request_error',

                                                     code: 'account_non_existant',

                                                     message: 'Account with this email does not exist'

                                                 }

                                             }

Example Request :Body (application/JSON)

                                                { 

                                                    "email": "abc1@example.com",

                                                    "start_date": "2025-04-05",

                                                    "end_date": "2025-05-28",

                                                    "page_no": 1

                                                }

Curl Example Request:

                                          curl --request POST 'https://api.idrivee2.com/api/reseller/v1/user_activity_history'

                                          --data '{

                                              "email": "abc1@example.com",

                                              "start_date": "2025-04-05",

                                              "end_date": "2025-05-28",

                                              "page_no": 1

                                          }' --header 'token: <your api key>'

Storage Operations

List Regions

GET
https://api.idrivee2.com/api/reseller/v1/regionsClick to copyLink copied This API returns an array of regions for IDrive^® e2.

Output

struct regions{ 

                                         string region_key;

                                         string region_name;

                                         string country;

                                         string region_code;

                                         bool active;

                                         bool hdd_storage;

                                         string cors;

								 }

Note: Only active regions can be enabled for the user.

Example Request: List Regions

curl --request GET 'https://api.idrivee2.com/api/reseller/v1/regions' --header 'token: <your api key>'

Enable Region for User

POST
https://api.idrivee2.com/api/reseller/v1/enable_user_regionClick to copyLink copied This API enables the regions for the user.

Input

{

                                   string email;

                                   string region;

                              }

region : region_key from list regions api. e.g "TX", "LDN" etc.

API returns the storage DN (domain name) for the enabled region through which user storage can be accessed using access key and secret key.

Length Parameters

Email [255]
Region[5]

Precondition

Existing user account.
Region must not be enabled for the user.

Output

On Success API Response(application/JSON) would be :

{ storage_added: true, storage_dn: /*user_storage_dns*/ }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

                                       {

                                                    error:{

                                                                type: 'invalid_request_error',

                                                                code: 'account_non_existant',

                                                                message: 'Account with this email does not exist'

                                                    }

                                       }

Storage region already enabled for the user.

                                       {

                                                    error:{

                                                                type: 'invalid_request_error',

                                                                code: 'region_already_enabled',

                                                                message: 'Storage region already enabled for user'

                                                    }

                                       }

User disabled.

                                       {

                                                    error:{

                                                                type: 'invalid_request_error',

                                                                code: 'user_disabled',

                                                                message: 'User Disabled'

                                                    }

                                       }

Payment for your account failed.

                                       {

                                                    error:{

                                                                type: 'invalid_request_error',

                                                                code: 'payment_failed',

                                                                message: 'Account expired please update payment info'

                                                    }

                                       }

Example Request :Body (application/JSON)

                           {

                                  "email":"e2reseller+1@idrivee2.com",

                                  "region": "NY"

                           }

Curl Example Request:

                            curl  --request POST 'https://api.idrivee2.com/api/reseller/v1/enable_user_region'

                            --data '{

                                "email":"e2reseller+1@idrivee2.com",

                                "region": "NY"

                              }'  --header 'token: <your api key>'

List User Enabled Regions

POST
https://api.idrivee2.com/api/reseller/v1/list_user_regionsClick to copyLink copied This API lists all enabled regions of the user.

Input

{
                                   

                                 string email;

                                 }

Length Parameters

Email [255]

Precondition

Existing user account.

Output

On Success API Response(application/JSON) would be :

                                 { 

                                      user_regions: /*lists user enabled regions*/ 

                                 }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

                                          {

                                                       error:{

                                                                   type: 'invalid_request_error',

                                                                   code: 'account_non_existant',

                                                                   message: 'Account with this email does not exist'

                                                       }

                                          }

User disabled..

                                          {

                                                       error:{

                                                                   type: 'invalid_request_error',

                                                                   code: 'user_disabled',

                                                                   message: 'User Disabled'

                                                       }

                                          }

Example Request :Body (application/JSON)

{
"email":"e2reseller+1@idrivee2.com"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/list_user_regions'
--data '{
"email":"e2reseller+1@idrivee2.com"
}' --header 'token: <your api key>'

Remove Region assigned to User

POST
https://api.idrivee2.com/api/reseller/v1/remove_user_regionClick to copyLink copied This API removes a region assigned to the user.

Input

{
string email;
string storage_dn;
}

'storage_dn' is the storage domain assigned to the user you wish to be removed.

Length Parameters

Email [255]

Storage_dn[128]

Precondition

User signed up.

Storage should be assigned to the user.

Please note this action will result in deletion of the user data.

API will allow you to remove user region if

User is in disabled state

No bucket created by the user

Output

On Success API will return Response (JSON) :

{removed : true}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Storage does not exist.

{
error:{
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exists'
}
}

Storage not empty.

{
error:{
type: 'invalid_request_error',
code: 'storage_not_empty',
message: 'Storage not empty. To avoid user data loss, this request will not be
processed. To remove this storage, please disable the user first and try again'
}
}

Example Request :Body (application/JSON)

{
"email":"e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test@idrivee2.com"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/remove_user_region'
--data '{
"email":"e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test@idrivee2.com"
}' --header 'token: <your api key>'

Update cors settings for user region

Method: POST
URL: https://api.idrivee2.com/api/reseller/v1/storage/set_corsClick to copyLink copied This API will update cors settings for a region.

Content type : application/json

Header API Key:

'token': <your token>

Required Parameter:

body : {
"email": "test@test.com",
"storage_dn": "cxan.tx21.edgedrive.com",
"cors": "test1.com,test2.com,test3.com",
}

Required Parameters: email,storage_dn,cors
Limits on parameters length: email[255],storage_dn[128], cors (up to 10 comma separated list of domains)
NOTE: For all cors you can set cors to "*" which is also the default cors on all regions

Output

On Success API would return Response (application/JSON):

{
cors_updated: true
}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Storage does not exist.

{
error:{
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exists'
}
}

Invalid cors parameters.

{
error:{
type: 'invalid_request_error',
code: 'invalid_cors_policy',
message: 'The cors policy is invalid' / 'Maximum 10 cors are allowed'
}
}

Curl request example:

curl --location --request POST
https://api.idrivee2.com/api/reseller/v1/storage/set_cors\
--header 'token: <your token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"email":"test@test.com",
"storage_dn":"cxan.tx21.edgedrive.com",
"cors":"test1.com,test2.com,test3.com",
}'

Add Access Key

POST
https://api.idrivee2.com/api/reseller/v1/create_access_keyClick to copyLink copied This API creates an Access Key for storage access and returns the Access Key ID and Secret Key.

Input

{
string email;
string storage_dn;
string name;
int permissions;
array buckets; //buckets is an optional parameter
}

Buckets: Provide a list of bucket names to create an access key for specified buckets to access storage. 'buckets' input is not required if access key is for all buckets.

Precondition

User signed up/created and enabled.

Storage DN assigned to the respective user.

Buckets should not be empty if provided.

Length Parameters

Email [255]

storage_dn[128]

Name[64]

Access Key Permissions Enumeration:

{
0: Read access
1: Write access
2: Read/Write access
}

Output

On Success API would return Response (application/JSON):

{
created: true,
data: {
access_key: /access key/
secret_key: /* secret key*/
}
}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Storage does not exist.

{
error:{
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exists'
}
}

User disabled.

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled'
}
}

Example Request :Body (application/JSON)

{
"email":"e2reseller+1@idrivee2.com",
"storage_dn":"abcd.test@idrivee2.com",
"name":"myaccesskeyname",
"permissions":0
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/create_access_key'
--data '{
"email":"e2reseller+1@idrivee2.com",
"storage_dn":"abcd.test@idrivee2.com",
"name":"myaccesskeyname",
"permissions":0
}' --header 'token: <your api key>'

List Access Keys

POST
https://api.idrivee2.com/api/reseller/v1/list_access_keysClick to copyLink copied This API lists all the Access Keys for the storage.

Input

{
string email;
string storage_dn;
}

'storage_dn' is the storage domain assigned to the user of which you wish to list all access keys

Length Parameters

email [255]

storage_dn[128]

Precondition

User signed up/created and enabled.

Storage assigned to the user.

Output

On Success API would return Response(application/JSON) :

{
'storage_dn' : /*user_storage_dns*/,
'access_keys' : [
{
'key_id' : /*key_id*/,
'name' : /*key_name*/,
'creation_date' : /*date_of_key_creation*/,
'description' : /*description_of_access_key_permissions*/
},
{...},
…
]
}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Storage does not exist.

{
error:{
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exist'
}
}

User disabled.

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled '
}
}

Example Request : Body (application/JSON)

{
"email" : "e2reseller+1@idrivee2.com",
"storage_dn" : "abcd.test.idrivee2.com"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/list_access_keys'
--data '{
"email":"e2reseller+1@idrivee2.com",
"storage_dn":"abcd.test.idrivee2.com",
}' --header 'token:<your api key>'

Remove Access Key

POST
https://api.idrivee2.com/api/reseller/v1/storage/cname/updateClick to copyLink copied This API removes the Access Key for the storage.

Input

{
string email;
string storage_dn;
string access_key;
}

Length Parameters

Email [255]

storage_dn[128]

access_key[128]

Precondition

User signed up/created and enabled.

Storage assigned to user.

access key exists for the storage.

Output

On Success API would return Response(application/JSON) :

{removed : true}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Storage does not exist.

{
error:{
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exists'
}
}

User disabled.

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled'
}
}

Access key does not exist.

{
error:{
type: 'invalid_request_error',
code: 'access_key_non_existant',
message: 'Access key does not exist, please provide a valid access key'
}
}

Example Request :Body (application/JSON)

{
"email":"e2reseller+1@idrivee2.com",
"storage_dn":"abcd.test@idrivee2.com",
"access_key":"<ACCESS-KEY-ID>"
}

Curl Example Request:

curl --location --request POST 'https://api.idrivee2.com/api/reseller/v1/remove_access_key'
--data '{
"email":"e2reseller+1@idrivee2.com",
"storage_dn":"abcd.test@idrivee2.com",
"access_key":"<your access key>"
}' --header 'token: <your api key>'

Whitelabeling Operations

Add CNAMEs
POST
https://api.idrivee2.com/api/reseller/v1/storage/cname/addClick to copyLink copied This API adds CNAME for the specified storage dns.

Input

{
string email;
string storage_dn;
string cname;
string public_key;
string private_key;
string file_index;
string passphrase; // optional, need to be sent only in case of encrypted private key
}

'storage_dn' is the storage domain assigned to the user.

'CNAME' is the new CNAME needs to be assigned.

'file_index' is an optional parameter.

Length Parameters

email[255]

storage_dn[128]

CNAME[128]

public_key[10000]

private_key[6000]

file_index[64]

passphrase[255]

Precondition

User signed up/created and enabled.

Storage assigned to the user.

Output

On Success API would return Response(application/JSON) :

{ 'cname_added' : true }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

CNAME cannot be used

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'this CNAME cannot be used, please try changing your CNAME'
}
}

Storage Domain does not existIf storage_ dns is wrong

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Unable to retrieve storage info for given storage_dn'
}
}

If CNAME already configured

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'CNAME already configure'
}
}

Invalid CNAME or CertificatesIf public private keys are wrong

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Could not verify CNAME or certificates. Please try again'
}
}

Server Error (HTTP 500)

Unable to process this request

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'Unable to process this request, please try again later'
}
}

Data not found for given dns

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'data not found for given dns'
}
}

Example Request : Body (application/JSON)

{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io",
"public_key" : "...",
"private_key" : "...",
"file_index" : "1"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/storage/cname'
--data'{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io",
"public_key" : "...",
"private_key" : "...",
"file_index" : "1"
}'--header 'token:<your api key>'

List CNAMEs
POST
https://api.idrivee2.com/api/reseller/v1/storage/cnameClick to copyLink copied This API lists all the CNAMEs for the storage.

Input

{
string email;
string storage_dn;
}

'storage_dn' is the storage domain assigned to the user of which you wish to list all CNAMEs

Length Parameters

email[255]

storage_dn[128]

Precondition

User signed up/created and enabled.

Storage assigned to the user.

Output

On Success API would return Response(application/JSON) :

{
'cname_list' : [
{
file_index: /*file_index*/,
cname: /*cname*/,
certificate_info: /*isValidSsl.certInfo*/
creation_date: /*creation_date*/
}

{...},
]
}

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

User disabled.

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled'
}
}

Server Error (HTTP 500)

Unable to process this request

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'Unable to process this request, please try again later'
}
}

Data not found for given dns

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'data not found for given dns'
}
}

Example Request : Body (application/JSON)

{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/storage/cname'
--data'{
email: "e2reseller+1@idrivee2.com",
storage_dn: abcd.test.idrivee2.com,
}'--header 'token:<your api key>'

Update CNAMEs
POST
https://api.idrivee2.com/api/reseller/v1/storage/cname/updateClick to copyLink copied This API updates CNAME for the specified storage dns.

Input

{
string region_key;
string email;
string storage_dn;
string cname;
string public_key;
string private_key;
string file_index;
string passphrase; // optional, need to be sent only in case of encrypted private key
}

'storage_dn' is the storage domain assigned to the user.

'CNAME' is the new CNAME that needs to be replaced with the already existing CNAME.

'file_index is an optional parameter.

Length Parameters

email[255]

storage_dn[128]

CNAME[128]

public_key[10000]

private_key[6000]

file_index[64]

passphrase[255]

Precondition

User signed up/created and enabled.

Storage assigned to the user.

Output

On Success API would return Response(application/JSON) :

{ 'cname_updated' : true }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

CNAME cannot be usedIf CNAME is idrive domain

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'this CNAME cannot be used, please try changing your CNAME'
}
}

Storage Domain does not existIf storage_ dns is wrong

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Unable to retrieve storage info for given storage_dn'
}
}

If storage_dn is wrong

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Unable to retrieve storage info for given storage_dn'
}
}

Storage server cannot be reachedDomain does not existIf storage _dns is unavailable

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Storage server cannot be reached right now, please try again later'
}
}

If CNAME already configured

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'CNAME already configured'
}
}

Invalid CNAME or CertificatesIf public private keys are wrong

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Could not verify CNAME or certificates. Please try again'
}
}

User disabled

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled'
}
}

Server Error (HTTP 500)

Unable to process this request

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'Unable to process this request, please try again later'
}
}

Data not found for given dns

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'data not found for given dns'
}
}

Example Request : Body (application/JSON)

{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io",
"public_key" : "...",
"private_key" : "...",
"file_index" : "1"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/storage/cname/update
--data'{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io",
"public_key" : "...",
"private_key" : "...",
"file_index" : "1"
}'--header 'token:<your api key>'

Remove CNAMEs
POST
https://api.idrivee2.com/api/reseller/v1/storage/cname/removeClick to copyLink copied This API removes CNAME for the storage dns.

Input

{
string email;
string storage_dn;
string cname;
}

'storage_dn' is the storage domain assigned to the user.

CNAME: provide CNAME which needs to be removed.

Length Parameters

email[255]

storage_dn[128]

CNAME[128]

Precondition

User signed up/created and enabled.

Storage assigned to the user.

CNAME should be mapped to the storage domain.

Output

On Success API would return Response(application/JSON) :

{ 'cname_removed' : true }

Error Cases

Invalid Request (HTTP 403)

Account does not exist.

{
error:{
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

User disabled

{
error:{
type: 'invalid_request_error',
code: 'user_disabled',
message: 'User Disabled'
}
}

CNAME cannot be used

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'this CNAME cannot be used, please try changing your CNAME'
}
}

Storage Domain does not exist

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Unable to retrieve storage info for given storage_dn'
}
}

Storage server cannot be reached

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'Storage server cannot be reached right now, please try again later'
}
}

CNAME does not exist for the storage domain

{
error:{
type: 'invalid_request_error',
code: 'request_processing_failed',
message: 'cannot get cname details'
}
}

Failed to remove CNAMECannot remove CNAME

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'Unable to process this request, please try again later'
}
}

Server Error (HTTP 500)

Unable to process this request

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'Unable to process this request, please try again later'
}
}

Data not found for given dns

{
error:{
type: 'api_error',
code: 'request_processing_failed',
message: 'data not found for given dns'
}
}

Example Request : Body (application/JSON)

{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/reseller/v1/storage/cname/remove
--data'{
"email": "e2reseller+1@idrivee2.com",
"storage_dn": "abcd.test.idrivee2.com",
"cname" : "example.mycloud.io"
}'--header 'token:<your api key>'

Subuser Operations

The IDrive^® e2 Subuser API is supported for reseller accounts. A reseller administrator may invoke these APIs on behalf of any user under their account. In other words, the reseller admin can use their API key to perform subuser management operations for any of their associated users.

To enable this functionality, all API requests must include an additional required parameter: admin_email. Without the inclusion of admin_email parameter in the request body, the APIs will not process requests made by reseller accounts.

Enums:

Subuser Permissions:
{
0: Read access,
1: Write access,
2: Read/Write access
}

Invite subuser
PUT
https://api.idrivee2.com/api/subusers/v1/inviteClick to copyLink copied This API sends a subuser account creation invite to the subuser email mentioned in request.

Input

string subuser_email;
boolean disable_delete_object; // optional
int permissions;
boolean is_admin;
boolean sso_login; // optional
boolean allow_session_timeout_settings;
int idle_timeout;
boolean concurrent_sessions;
boolean allow_concurrent_session_settings;
Object[] storage_access; // optional
string admin_email;

Note:

"subuser_email" - the email address of the subuser you want to send the invitation to

"disable_delete_object" - a boolean that lets the subuser perform deletion of objects if sent as false, default is true

"pemissions" - an enum parameter where 0 = Read only permission, 1 = Upload only permission and 2 = Read and Write permissions

"is_admin" - a boolean that is used to make the subuser as an admin subuser if sent as true. Setting this flag true will give all storage access (Read & Write) permissions to the subusers.

"sso_login" - a boolean that sets whether SSO login is enabled for the subuser or not

"allow_session_timeout_settings" - a boolean that lets the subuser configure the session timeout settings if sent as true

"idle_timeout" - if admin user wants to configure the session timeout(in seconds) for the subusers. Maximum allowed value is 3600 secs (1 hr)

"concurrent_sessions" - a boolean that allows subuser to have multiple concurrent sessions if sent as true

"allow_concurrent_session_settings" - a boolean that lets the subuser configure multiple concurrent session settings if sent as true

"storage_access" - an array of permission objects, if admin wants subuser to have access to only limited buckets. For example, if admin user wants the subuser to have access to "bucket1" and "bucket2" in Chicago Region and "bucket3" and "bucket4" in Ireland region, the admin should set the storage_access array as following:
[
{
"storage_dn": "h4l1.ch.idrivee2-29.com", // S3 endpoint of your Chicago Region
"buckets": [
"bucket1", "bucket2"
]
},
{
"storage_dn": "r8l2.ie.idrivee2-44.com", // S3 endpoint of your Ireland Region
"buckets": [
"bucket3", "bucket4"
]
}
]

Please note that "storage_access" is an optional parameter and should only be sent if the admin user wants to control bucket level access to the subuser.

Output
On Success API Response (application/JSON) would be :

{
result: "invite successful",
invite_url: "invitation url string"
}

Length Parameters

email[255]

Specific Error Case

If you exceed the limit of number of sub-users allowed for your account
Response (application/JSON) :{
error: {
type: 'invalid_request_error',
code: 'maximum_limit_reached',
message: <information about your limit>
}
}

If sso_login is sent as true and SSO is not configured
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'sso_not_configured',
message: 'SSO is not configured'
}
}

Example Request :Body (application/JSON)

{
"subuser_email": "abc1@example.com",
"storage_access": [
{
"storage_dn": "h4l1.ch.idrivee2-29.com",
"buckets": [
"bucket1",
"bucket2"
]
},
{
"storage_dn": "r8l2.ie.idrivee2-44.com",
"buckets": [
"bucket3",
"bucket4"
]
}
],
"disable_delete_object": true,
"permissions": 0,
"is_admin": false,
"sso_login": false,
"allow_session_timeout_settings": false,
"idle_timeout": 300,
"concurrent_sessions": true,
"allow_concurrent_session_settings": false,
"admin_email": "abc@example.com"
}

Curl Example Request:

curl --request PUT 'https://api.idrivee2.com/api/subusers/v1/invite'
--data '{
"subuser_email": "abc1@example.com",
"storage_access": [
{
"storage_dn": "h4l1.ch.idrivee2-29.com",
"buckets": [
"bucket1",
"bucket2"
]
},
{
"storage_dn": "r8l2.ie.idrivee2-44.com",
"buckets": [
"bucket3",
"bucket4"
]
}
],
"disable_delete_object": true,
"permissions": 0,
"is_admin": false,
"sso_login": false,
"allow_session_timeout_settings": false,
"idle_timeout": 300,
"concurrent_sessions": true,
"allow_concurrent_session_settings": false,
"admin_email": "abc@example.com"
}' --header 'token: <your api key>'

List all subusers
POST
https://api.idrivee2.com/api/subusers/v1/listClick to copyLink copied This displays all the subusers added under your profile.

Input

string admin_email;

Output
API returns array of the users added under your profile.
The structure of response is as following:

struct response {
List users[];
}

struct users {
string email;
string first_name;
string last_name;
Object[] storage_access;
string account_creation_timestamp;
string invite_url;
bool is_admin;
bool signed_up;
int permissions;
bool disable_delete_object;
bool sso_login;
int idle_timeout;
bool concurrent_sessions;
bool allow_session_timeout_settings;
bool allow_concurrent_session_settings;
}

Note
User object parameters correspond to request body parameters explained in the invite API. Please refer to the invite API for reference.

Curl Example Request

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/list'
--data '{
"admin_email": "abc@example.com"
}'
--header 'token: <your api key>'

Create subuser
PUT
https://api.idrivee2.com/api/subusers/v1/create_accountClick to copyLink copied This creates a subuser account which will be linked to your account.

Input

string subuser_email;
boolean disable_delete_object; // optional
int permissions;
boolean is_admin;
boolean sso_login; // optional
boolean allow_session_timeout_settings;
int idle_timeout;
boolean concurrent_sessions;
boolean allow_concurrent_session_settings;
Object[] storage_access; // optional
string admin_email;
string first_name;
string last_name; // optional
string password; // base64 encoded string

Note
You can refer to Invite subuser API for the request body parameters details.

Length Parameters

Email [255]

Password [100]

First Name [64]

Last Name [64]

Output
On Success API Response (application/JSON) would be :

{ success: true }

Specific Error Case

If you exceed the limit of number of sub-users allowed for your account
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'maximum_limit_reached',
message: 'information about your limit'
}
}

Storage does not exist.
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'storage_non_existant',
message: 'Storage does not exist'
}
}

User already exists
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_already_signedup',
message: 'User signed up'
}
}

If sso_login is sent as true and SSO is not configured
Response (application/JSON) : {
    error: {
        type: 'invalid_request_error',
        code: 'sso_not_configured',
        message: 'SSO is not configured'
    }
}

Example Request :Body (application/JSON)

{
"subuser_email": "abc1@example.com",
"storage_access": [
{
"storage_dn": "h4l1.ch.idrivee2-29.com",
"buckets": [
"bucket1",
"bucket2"
]
},
{
"storage_dn": "r8l2.ie.idrivee2-44.com",
"buckets": [
"bucket3",
"bucket4"
]
}
],
"disable_delete_object": true,
"permissions": 0,
"is_admin": false,
"sso_login": false,
"allow_session_timeout_settings": false,
"idle_timeout": 300,
"concurrent_sessions": true,
"allow_concurrent_session_settings": false,
"first_name": "jack",
"last_name": "russell",
"password": "dGVzdDEyMw==",
"admin_email": “abc@example.com”
}

Curl Example Request:

curl --request PUT 'https://api.idrivee2.com/api/subusers/v1/create_account'
--data '{
"subuser_email": "abc1@example.com",
"storage_access": [
{
"storage_dn": "h4l1.ch.idrivee2-29.com",
"buckets": [
"bucket1",
"bucket2"
]
},
{
"storage_dn": "r8l2.ie.idrivee2-44.com",
"buckets": [
"bucket3",
"bucket4"
]
}
],
"disable_delete_object": true,
"permissions": 0,
"is_admin": false,
"sso_login": false,
"allow_session_timeout_settings": false,
"idle_timeout": 300,
"concurrent_sessions": true,
"allow_concurrent_session_settings": false,
"first_name": "jack",
"last_name": "russell",
"password": "dGVzdDEyMw==",
"admin_email": “abc@example.com”
}' --header 'token: <your api key>'

Disable subuser
POST
https://api.idrivee2.com/api/subusers/v1/disableClick to copyLink copied This API disables the subuser account. Subusers will not be able to login, access data, and perform any operations.

Input

string subuser_email;
string admin_email;
bool email_notification; // email notification to the subuser will be sent only if this parameter is set to true

Length Parameters

Email [255]

Precondition

User signed up.

Account enabled.

Output
On Success API Response (application/JSON) would be :

{ success: true }

Specific Error Case

If subuser is not signed up
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_not_signed_up',
message: 'Subuser is not signed up'
}
}

If subuser account already disabled
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_account_already_disabled',
message: 'Account already disabled for the user'
}
}

Account does not exist
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Example Request :Body (application/JSON)

{
"subuser_email": "abc1@example.com",
"admin_email": "admin1@example.com",
"email_notification": true
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/disable'
--data '{
"subuser_email": "abc1@example.com",
"admin_email": "admin1@example.com",
"email_notification": true
}' --header 'token: <your api key>'

Enable subuser
POST
https://api.idrivee2.com/api/subusers/v1/enableClick to copyLink copied This API re-enables disabled subuser accounts. Subusers can login, access data, and perform normal operations after being enabled.

Input

string subuser_email;
string admin_email;
bool email_notification; // email notification to the subuser will be sent only if this parameter is set to true

Output
On Success API Response (application/JSON) would be :

{ success: true }

Length Parameters

Email [255]

Precondition

User signed up/created.

User account was disabled previously.

Specific Error Case

If subuser is not signed up
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_not_signed_up',
message: 'Subuser is not signed up'
}
}

If subuser account is already enabled
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_account_already_enabled',
message: 'Account already enabled for the user'
}
}

Account does not exist.
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
}
}

Example Request :Body (application/JSON)

{
"subuser_email": "abc1@example.com",
"admin_email": "admin1@example.com",
"email_notification": true
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/enable'
--data '{
    "subuser_email": "abc1@example.com",
    "admin_email": "admin1@example.com",
    "email_notification": true
}' --header 'token: <your api key>'

Remove subuser
POST
https://api.idrivee2.com/api/subusers/v1/removeClick to copyLink copied This API will permanently delete users from IDrive^® e2.
Note: The user data will be lost permanently on performing this operation.

Input

string subuser_email;
string admin_email;
bool email_notification; // email notification to the subuser will be sent only if this parameter is set to true

Length Parameters

Email [255]

Precondition

User must be disabled.

Output
On Success API Response (application/JSON) would be :

{ success: true }

Length Parameters

Email [255]

Specific Error Case

If subuser is not signed up
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'user_not_signed_up',
message: 'Subuser is not signed up'
} }

If subuser account not disabled
Response (application/JSON) : { error: {
type: 'invalid_request_error',
code: 'user_account_not_disabled',
message: 'User account not disabled'
} }

Account does not exist
Response (application/JSON) : {
error: {
type: 'invalid_request_error',
code: 'account_non_existant',
message: 'Account with this email does not exist'
} }

Example Request :Body (application/JSON)

{
"subuser_email": "abc1@example.com",
"admin_email": "admin1@example.com",
"email_notification": true
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/remove'
--data '{
    "subuser_email": "abc1@example.com",
    "admin_email": "admin1@example.com",
    "email_notification": true
}' --header 'token: <your api key>'

Cancel Invite
POST
https://api.idrivee2.com/api/subusers/v1/invite/cancelClick to copyLink copied This API will cancel the invitation sent to the subuser.

Input

string subuser_email;
string admin_email;

Length Parameters

Email [255]

Precondition

User must not already be signed up.

Output
On Success API Response (application/JSON) would be :

{ success: true }

Specific Error Case

If subuser is already signed up
Response (application/JSON) : {
    error: {
        type: 'invalid_request_error',
        code: 'user_already_signedup',
        message: 'User signed up'
    }
}

Example Request :Body (application/JSON)

{
    "subuser_email": "abc1@example.com",
    "admin_email": "admin1@example.com"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/invite/cancel'
--data '{
    "subuser_email": "abc1@example.com",
    "admin_email": "admin1@example.com"
}' --header 'token: <your api key>'

Update Subuser
POST
https://api.idrivee2.com/api/subusers/v1/updateClick to copyLink copied This API updates subusers access, permissions, SSO, and session control. The API can be used to update both invited and signed-up subusers.

Input

string subuser_email;
boolean disable_delete_object; // optional
int permissions; // optional
boolean is_admin; // optional
boolean sso_login; // optional
boolean allow_session_timeout_settings; // optional
int idle_timeout; // optional
boolean concurrent_sessions; // optional
boolean allow_concurrent_session_settings; // optional
Object[] storage_access; // optional
string admin_email;
boolean expire_subuser_sessions; // optional, if true will expire existing user sessions

Note

You can refer to Invite subuser API for the request body parameter details. Only the parameters that need to be updated should be included in the request body.

Output
On Success API Response (application/JSON) would be :

{ success: true }

Length Parameters

Email [255]

Specific Error Case

Storage does not exist
Response (application/JSON) : {
    error: {
        type: 'invalid_request_error',
        code: 'storage_non_existant',
        message: 'Storage does not exist'
    }
}

Account does not exist
Response (application/JSON) : {
    error: {
        type: 'invalid_request_error',
        code: 'account_non_existant',
        message: 'Account with this email does not exist'
    }
}

If sso_login is sent as true and SSO is not configured
Response (application/JSON) : {
    error: {
        type: 'invalid_request_error',
        code: 'sso_not_configured',
        message: 'SSO is not configured'
    }
}

Example Request :Body (application/JSON)

{
    "subuser_email": "abc1@example.com",
    "storage_access": [
        {
            "storage_dn": "h4l1.ch.idrivee2-29.com",
            "buckets": [
              "bucket1",
              "bucket2"
             ]
        },
        {
            "storage_dn": "r8l2.ie.idrivee2-44.com",
            "buckets": [
              "bucket3",
              "bucket4"
             ]
        }
    ],
    "is_admin": false,
    "sso_login": false,
    "expire_subuser_sessions": false,
    "admin_email": "abc@example.com"
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/update'
--data '{
    "subuser_email": "abc1@example.com",
    "storage_access": [
        {
            "storage_dn": "h4l1.ch.idrivee2-29.com",
            "buckets": [
              "bucket1",
              "bucket2"
             ]
        },
        {
            "storage_dn": "r8l2.ie.idrivee2-44.com",
            "buckets": [
              "bucket3",
              "bucket4"
             ]
        }
    ],
    "is_admin": false,
    "sso_login": false,
    "expire_subuser_sessions": false,
    "admin_email": "abc@example.com"
}' --header 'token: <your api key>'

Get Activity Logs
POST
https://api.idrivee2.com/api/subusers/v1/user_activity_historyClick to copyLink copied This API will fetch the activity logs of a subuser for a date range.

Input

string subuser_email;
string admin_email;
string start_date;
string end_date;
int page_no;

Length Parameters

Email [255]

Note

start_date (ISO8601) - Start Date
end_date (ISO8601) - End Date
page_no - API is paginated with each page consisting of 200 records
and page_no start from 1 onwards

Output
On Success API Response (application/JSON) would be:

struct response {
    List[] logs;
    struct pagination;
}

struct logs {
    string timestamp;
    string description;
    string ip;
}

struct pagination {
    int total_records;
    int page_no;
    int records_per_page;
}

Specific Error Case

If subuser is not signed up
Response (application/JSON) : {
    error:{
        type: 'invalid_request_error',
        code: 'user_not_signed_up',
        message: 'Subuser is not signed up'
    }
}

Account does not exist
Response (application/JSON) : {
    error:{
        type: 'invalid_request_error',
        code: 'account_non_existant',
        message: 'Account with this email does not exist'
    }
}

Example Request : Body (application/JSON)

{
    "subuser_email": "abc1@example.com",
    "admin_email": "admin1@example.com",
    "start_date": "2025-04-05",
    "end_date": "2025-05-28",
    "page_no": 1
}

Curl Example Request:

curl --request POST 'https://api.idrivee2.com/api/subusers/v1/user_activity_history'
--data '{
    "subuser_email": "abc1@example.com",
    "admin_email" : "admin1@example.com",
    "start_date" : "2025-04-05",
    "end_date" : "2025-05-28",
    "page_no" : 1
}' --header 'token: <your api key>'

Reseller API

Reseller API's Collection

Common Error Cases

AUTHORIZATION Header API Key

Enums:

User Operations

Storage Operations

Whitelabeling Operations

Subuser Operations

E2-logo

Solutions

Get Started

Services