CyberSift Drive API

FileOperations

retrieveFile

Download a file by ID

Download a file by ID


/app/retrieveFile

Usage and SDK Samples

curl -X POST\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: text/plain"\
-H "Content-Type: application/json"\
"//app/retrieveFile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileOperationsApi;

import java.io.File;
import java.util.*;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveFile_POST body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
        try {
            apiInstance.retrieveFile(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileOperationsApi;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveFile_POST body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
        try {
            apiInstance.retrieveFile(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];
RetrieveFile_POST *body = ; // Download a cleaned file which has previously been uploaded to the server.

FileOperationsApi *apiInstance = [[FileOperationsApi alloc] init];

// Download a file by ID
[apiInstance retrieveFileWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"

var api = new CyberSiftDriveApi.FileOperationsApi()
var body = ; // {{RetrieveFile_POST}} Download a cleaned file which has previously been uploaded to the server.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.retrieveFile(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveFileExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");

            var apiInstance = new FileOperationsApi();
            var body = new RetrieveFile_POST(); // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.

            try
            {
                // Download a file by ID
                apiInstance.retrieveFile(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileOperationsApi.retrieveFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiFileOperationsApi();
$body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.

try {
    $api_instance->retrieveFile($body);
} catch (Exception $e) {
    echo 'Exception when calling FileOperationsApi->retrieveFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileOperationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RetrieveFile_POST->new(); # RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.

eval { 
    $api_instance->retrieveFile(body => $body);
};
if ($@) {
    warn "Exception when calling FileOperationsApi->retrieveFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileOperationsApi()
body =  # RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.

try: 
    # Download a file by ID
    api_instance.retrieve_file(body)
except ApiException as e:
    print("Exception when calling FileOperationsApi->retrieveFile: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
Required: Id
id:
integer (int64)
example: 10
}

Responses

Status: 200 - Successful operation, returns a binary file corresponding to the supplied ID

Status: 401 - Invalid Token Supplied

string
example: NOK

Status: 500 - Invalid Request

string
example: NOK

retrieveFileStatus

Retrieve a file status by ID

Retrieve a file status by ID


/app/retrieveFileStatus

Usage and SDK Samples

curl -X POST\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: application/json,text/plain"\
-H "Content-Type: application/json"\
"//app/retrieveFileStatus"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileOperationsApi;

import java.io.File;
import java.util.*;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveFileStatus_POST body = ; // RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.
        try {
            FileStatus_RESPONSE result = apiInstance.retrieveFileStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveFileStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileOperationsApi;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveFileStatus_POST body = ; // RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.
        try {
            FileStatus_RESPONSE result = apiInstance.retrieveFileStatus(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveFileStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];
RetrieveFileStatus_POST *body = ; // Get details on a file status. This is used to see if a file has finished being cleaned.

FileOperationsApi *apiInstance = [[FileOperationsApi alloc] init];

// Retrieve a file status by ID
[apiInstance retrieveFileStatusWith:body
              completionHandler: ^(FileStatus_RESPONSE output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"

var api = new CyberSiftDriveApi.FileOperationsApi()
var body = ; // {{RetrieveFileStatus_POST}} Get details on a file status. This is used to see if a file has finished being cleaned.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveFileStatus(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveFileStatusExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");

            var apiInstance = new FileOperationsApi();
            var body = new RetrieveFileStatus_POST(); // RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.

            try
            {
                // Retrieve a file status by ID
                FileStatus_RESPONSE result = apiInstance.retrieveFileStatus(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileOperationsApi.retrieveFileStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiFileOperationsApi();
$body = ; // RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.

try {
    $result = $api_instance->retrieveFileStatus($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileOperationsApi->retrieveFileStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileOperationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RetrieveFileStatus_POST->new(); # RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.

eval { 
    my $result = $api_instance->retrieveFileStatus(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileOperationsApi->retrieveFileStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileOperationsApi()
body =  # RetrieveFileStatus_POST | Get details on a file status. This is used to see if a file has finished being cleaned.

try: 
    # Retrieve a file status by ID
    api_response = api_instance.retrieve_file_status(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileOperationsApi->retrieveFileStatus: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
Required: FileID
FileID:
integer (int64)
example: 10
}

Responses

Status: 200 - Successful operation, returns details on a file matching supplied ID

{
ID:
integer (int64)
example: 10
Timestamp:
integer (int64)
example: 10
@timestamp:
integer (int64)
example: 10
FileID:
string
example: demo
Uploader:
string
example: user
UserEmail:
string
example: demo@demo.com
ProfileName:
string
example: demo
Destination:
string
example: demo
FileSinkID:
integer
example: 10
Filename:
string
example: demo
Status:
string
example: demo
}

Status: 401 - Invalid Token Supplied

string
example: NOK

Status: 500 - Invalid Request

string
example: NOK

retrieveProfileFiles

Retrieve list of files

Retrieve list of files uploaded after certain time


/app/retrieveProfileFiles

Usage and SDK Samples

curl -X POST\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: application/json,text/plain"\
-H "Content-Type: application/json"\
"//app/retrieveProfileFiles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileOperationsApi;

import java.io.File;
import java.util.*;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveProfileFiles_POST body = ; // RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files
        try {
            array[ProfileFiles_RESPONSE] result = apiInstance.retrieveProfileFiles(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveProfileFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileOperationsApi;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        FileOperationsApi apiInstance = new FileOperationsApi();
        RetrieveProfileFiles_POST body = ; // RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files
        try {
            array[ProfileFiles_RESPONSE] result = apiInstance.retrieveProfileFiles(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#retrieveProfileFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];
RetrieveProfileFiles_POST *body = ; // Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

FileOperationsApi *apiInstance = [[FileOperationsApi alloc] init];

// Retrieve list of files
[apiInstance retrieveProfileFilesWith:body
              completionHandler: ^(array[ProfileFiles_RESPONSE] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"

var api = new CyberSiftDriveApi.FileOperationsApi()
var body = ; // {{RetrieveProfileFiles_POST}} Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveProfileFiles(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveProfileFilesExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");

            var apiInstance = new FileOperationsApi();
            var body = new RetrieveProfileFiles_POST(); // RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

            try
            {
                // Retrieve list of files
                array[ProfileFiles_RESPONSE] result = apiInstance.retrieveProfileFiles(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileOperationsApi.retrieveProfileFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiFileOperationsApi();
$body = ; // RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

try {
    $result = $api_instance->retrieveProfileFiles($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileOperationsApi->retrieveProfileFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileOperationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RetrieveProfileFiles_POST->new(); # RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

eval { 
    my $result = $api_instance->retrieveProfileFiles(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileOperationsApi->retrieveProfileFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileOperationsApi()
body =  # RetrieveProfileFiles_POST | Specify a time (`SinceID`) for which only files that have been modified after this time will be returned. Leave as "0" to get a full list of files

try: 
    # Retrieve list of files
    api_response = api_instance.retrieve_profile_files(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileOperationsApi->retrieveProfileFiles: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{
Required: SinceID
SinceID:
integer (int64)
example: 10
}

Responses

Status: 200 - Successful operation, returns a list of files, their current status and ID (which can be used to download the file using the `retrieveFile` endpoint)

[
{
Id:
integer
example: 10
Timestamp:
integer
example: 1678793426
FileID:
string
example: 13188e30-3291-4b9b-a2cb-6f84b69a9bd0
Uploader:
string
example: demo-user
Filename:
string
example: test.pdf
Status:
string
example: Success
}
]

Status: 401 - Invalid Token Supplied

string
example: NOK

Status: 500 - Invalid Request

string
example: NOK

uploadFile

Upload file/s

Upload file/s


/app/upload

Usage and SDK Samples

curl -X POST\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: application/json,text/plain"\
-H "Content-Type: multipart/form-data"\
"//app/upload"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileOperationsApi;

import java.io.File;
import java.util.*;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        FileOperationsApi apiInstance = new FileOperationsApi();
        array[byte[]] files[] = ; // array[byte[]] | 
        try {
            array[FileUpload_RESPONSE] result = apiInstance.uploadFile(files[]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#uploadFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileOperationsApi;

public class FileOperationsApiExample {

    public static void main(String[] args) {
        FileOperationsApi apiInstance = new FileOperationsApi();
        array[byte[]] files[] = ; // array[byte[]] | 
        try {
            array[FileUpload_RESPONSE] result = apiInstance.uploadFile(files[]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileOperationsApi#uploadFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];
array[byte[]] *files[] = ; // 

FileOperationsApi *apiInstance = [[FileOperationsApi alloc] init];

// Upload file/s
[apiInstance uploadFileWith:files[]
              completionHandler: ^(array[FileUpload_RESPONSE] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"

var api = new CyberSiftDriveApi.FileOperationsApi()
var files[] = ; // {{array[byte[]]}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadFile(files[], callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadFileExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");

            var apiInstance = new FileOperationsApi();
            var files[] = new array[byte[]](); // array[byte[]] | 

            try
            {
                // Upload file/s
                array[FileUpload_RESPONSE] result = apiInstance.uploadFile(files[]);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileOperationsApi.uploadFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiFileOperationsApi();
$files[] = ; // array[byte[]] | 

try {
    $result = $api_instance->uploadFile($files[]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileOperationsApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileOperationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileOperationsApi->new();
my $files[] = []; # array[byte[]] | 

eval { 
    my $result = $api_instance->uploadFile(files[] => $files[]);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileOperationsApi->uploadFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileOperationsApi()
files[] =  # array[byte[]] | 

try: 
    # Upload file/s
    api_response = api_instance.upload_file(files[])
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileOperationsApi->uploadFile: %s\n" % e)

Parameters

Form parameters
Name Description
files[]*
array[byte[]] (binary)
Required

Responses

Status: 200 - Successful operation, returns an array containing the file IDs and current status

[
{
FileID:
string
example: 101010
Filename:
string
example: test.pdf
DetectedExtension:
string
example: pdf
AllowedByPolicy:
boolean
example: true
Verdict:
string
example: Success / Failed
}
]

Status: 401 - Invalid Token Supplied

string
example: NOK

Status: 500 - Invalid Request

string
example: NOK

Status: 512 - Server Misconfigured - returned when sysadmin intervention required (see `verdict` field for more details)

[
{
FileID:
string
example: 101010
Filename:
string
example: test.pdf
DetectedExtension:
string
example: pdf
AllowedByPolicy:
boolean
example: true
Verdict:
string
example: Success / Failed
}
]

Meta

retrieveAppSettings

Retrieve settings for profile assigned to API key

Retrieve settings for profile assigned to API key


/app/retrieveAppSettings

Usage and SDK Samples

curl -X GET\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: application/json,text/plain"\
"//app/retrieveAppSettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        MetaApi apiInstance = new MetaApi();
        try {
            AppSettings result = apiInstance.retrieveAppSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#retrieveAppSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        try {
            AppSettings result = apiInstance.retrieveAppSettings();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#retrieveAppSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];

MetaApi *apiInstance = [[MetaApi alloc] init];

// Retrieve settings for profile assigned to API key
[apiInstance retrieveAppSettingsWithCompletionHandler: 
              ^(AppSettings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"

var api = new CyberSiftDriveApi.MetaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.retrieveAppSettings(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class retrieveAppSettingsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");

            var apiInstance = new MetaApi();

            try
            {
                // Retrieve settings for profile assigned to API key
                AppSettings result = apiInstance.retrieveAppSettings();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.retrieveAppSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiMetaApi();

try {
    $result = $api_instance->retrieveAppSettings();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->retrieveAppSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MetaApi->new();

eval { 
    my $result = $api_instance->retrieveAppSettings();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetaApi->retrieveAppSettings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MetaApi()

try: 
    # Retrieve settings for profile assigned to API key
    api_response = api_instance.retrieve_app_settings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetaApi->retrieveAppSettings: %s\n" % e)

Parameters

Responses

Status: 200 - Returns details on profile assigned to this API key

{
Id:
integer
example: 10
FriendlyName:
string
example: API-DEMO-KEY
Token:
string
example: abc123456asdasd
ProfileID:
integer
example: 1678716322
Profile:
{
Id:
integer
example: 10
FriendlyName:
string
example: demo
MaxFiles:
integer
example: 10
MaxSize:
integer
example: 10
Extensions:
string
example: demo
SanitizePdf:
string
example: no
ContentDisarm:
string
example: yes
QuarantineAction:
string
example: yes
AllowUploadLinks:
string
example: yes
AllowDownloadLinks:
string
example: yes
AdGroups:
string
example: yes
}
Exclusions:
string
example: *.pdf,*.ini
Mode:
string
example: generic
Folder:
string
example: demo
}

Status: 401 - Invalid Token Supplied

string
example: NOK