Logo

View the Project on GitHub elements-storage/elements-sdk-dotnet

ElementsSDK.Api.MainApi

All URIs are relative to https://elements.local

Method HTTP request Description
ApplyConfiguration POST /api/2/configuration/apply  
Beep POST /api/2/system/beep  
CheckCertificate POST /api/2/system/certificate/check  
CheckChunkUploaded GET /api/2/uploads/chunk  
CheckInternetConnectivity POST /api/2/system/check-connectivity  
CheckStorNextLicense POST /api/2/stornext-license/check  
CollectDiagnostics POST /api/2/system/collect-diagnostics  
CreateArchive POST /api/2/download-archive/create  
CreateGroup POST /api/2/groups  
CreateHomeWorkspace POST /api/2/users/{id}/home  
CreateNTPServer POST /api/2/system/time/servers  
CreateUser POST /api/2/users  
CreateWorkstation POST /api/2/workstations  
DeleteDownloadArchive DELETE /api/2/download-archive/{id}  
DeleteGroup DELETE /api/2/groups/{id}  
DeleteHomeWorkspace DELETE /api/2/users/{id}/home  
DeleteNTPServer DELETE /api/2/system/time/servers/{id}  
DeleteUser DELETE /api/2/users/{id}  
DeleteWorkstation DELETE /api/2/workstations/{id}  
DisableUserTOTP DELETE /api/2/users/{id}/totp  
EnableUserTOTP POST /api/2/users/{id}/totp  
FinishUpload POST /api/2/uploads/finish  
FixLDAPGroupMemberships POST /api/2/ldap-servers/{id}/fix-memberships  
GetAllClientSessions GET /api/2/client-sessions  
GetAllDownloadArchives GET /api/2/download-archive  
GetAllDownloads GET /api/2/downloads  
GetAllGroups GET /api/2/groups  
GetAllLDAPServers GET /api/2/ldap-servers  
GetAllNTPServers GET /api/2/system/time/servers  
GetAllStorageNodes GET /api/2/nodes  
GetAllUsers GET /api/2/users  
GetAllWorkstations GET /api/2/workstations  
GetCertificateConfiguration GET /api/2/system/certificate  
GetClientDownloadFile GET /api/2/downloads/clients/{file}  
GetClientDownloads GET /api/2/downloads/clients  
GetClientSession GET /api/2/client-sessions/{id}  
GetCurrentWorkstation GET /api/2/workstations/current  
GetDownload GET /api/2/downloads/{id}  
GetDownloadArchive GET /api/2/download-archive/{id}  
GetDownloadArchiveFile GET /api/2/download-archive/{id}/download  
GetDownloadFile GET /api/2/downloads/{id}/download  
GetDownloadIcon GET /api/2/downloads/{id}/icon  
GetGroup GET /api/2/groups/{id}  
GetHomeWorkspace GET /api/2/users/{id}/home  
GetIPMIConfiguration GET /api/2/nodes/{id}/ipmi  
GetLDAPServer GET /api/2/ldap-servers/{id}  
GetLDAPServerGroups GET /api/2/ldap-servers/{id}/groups  
GetLDAPServerUsers GET /api/2/ldap-servers/{id}/users  
GetLicense GET /api/2/license  
GetLocalTime GET /api/2/system/time  
GetLog GET /api/2/system/log/{path}  
GetNTPServer GET /api/2/system/time/servers/{id}  
GetNodeIPMISensors GET /api/2/nodes/{id}/sensors  
GetNodeStats GET /api/2/nodes/{id}/stats  
GetParameters GET /api/2/parameters  
GetProfile GET /api/2/users/me  
GetReleaseNotes GET /api/2/release-notes  
GetSMTPConfiguration GET /api/2/system/smtp  
GetServiceStatus GET /api/2/nodes/{id}/services/{service}  
GetStorNextLicense GET /api/2/stornext-license  
GetStorageNode GET /api/2/nodes/{id}  
GetSystemInfo GET /api/2/system/info  
GetUser GET /api/2/users/{id}  
GetWorkstation GET /api/2/workstations/{id}  
InstallStorNextLicense POST /api/2/stornext-license  
PatchCurrentWorkstation PATCH /api/2/workstations/current  
PatchDownloadArchive PATCH /api/2/download-archive/{id}  
PatchGroup PATCH /api/2/groups/{id}  
PatchNTPServer PATCH /api/2/system/time/servers/{id}  
PatchProfile PATCH /api/2/users/me  
PatchUser PATCH /api/2/users/{id}  
PatchWorkstation PATCH /api/2/workstations/{id}  
PreviewUser POST /api/2/users/preview  
Reboot POST /api/2/system/reboot  
RegisterUpload POST /api/2/uploads/register  
RegisterUploadMetadata POST /api/2/uploads/metadata  
RenderEmailTemplatePreview POST /api/2/system/smtp/preview  
ResetUserPassword POST /api/2/users/{id}/password/reset  
RunServiceOperation POST /api/2/nodes/{id}/services/{service}/{operation}  
SetIPMIConfiguration PUT /api/2/nodes/{id}/ipmi  
SetLocalTime POST /api/2/system/time  
SetMyPassword POST /api/2/users/me/password  
SetUserPassword POST /api/2/users/{id}/password  
Shutdown POST /api/2/system/shutdown  
StartSolrReindex POST /api/2/system/solr/reindex  
StartSupportSession POST /api/2/system/support-session/start  
StartSystemBackup POST /api/2/system/backup/start  
SyncLDAPGroup POST /api/2/groups/{id}/ldap-sync  
SyncLDAPUsers POST /api/2/ldap-servers/{id}/sync-users  
SyncTime POST /api/2/system/time/sync  
SyncUserTOTP PUT /api/2/users/{id}/totp  
TestSMTPConfiguration POST /api/2/system/smtp/test  
UpdateCertificateConfiguration PUT /api/2/system/certificate  
UpdateCurrentWorkstation PUT /api/2/workstations/current  
UpdateDownloadArchive PUT /api/2/download-archive/{id}  
UpdateGroup PUT /api/2/groups/{id}  
UpdateNTPServer PUT /api/2/system/time/servers/{id}  
UpdateParameters PUT /api/2/parameters  
UpdateProfile PUT /api/2/users/me  
UpdateSMTPConfiguration PUT /api/2/system/smtp  
UpdateUser PUT /api/2/users/{id}  
UpdateWorkstation PUT /api/2/workstations/{id}  
UploadChunk POST /api/2/uploads/chunk  

ApplyConfiguration

void ApplyConfiguration ()

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ApplyConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                apiInstance.ApplyConfiguration();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.ApplyConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Beep

void Beep ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class BeepExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                apiInstance.Beep();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.Beep: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckCertificate

void CheckCertificate (Certificate certificate)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CheckCertificateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var certificate = new Certificate(); // Certificate | 

            try
            {
                apiInstance.CheckCertificate(certificate);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CheckCertificate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
certificate Certificate    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckChunkUploaded

void CheckChunkUploaded (string uploadId = null, string chunkNumber = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CheckChunkUploadedExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var uploadId = uploadId_example;  // string |  (optional) 
            var chunkNumber = chunkNumber_example;  // string |  (optional) 

            try
            {
                apiInstance.CheckChunkUploaded(uploadId, chunkNumber);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CheckChunkUploaded: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
uploadId string   [optional]
chunkNumber string   [optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckInternetConnectivity

CheckConnectivityEndpointResponse CheckInternetConnectivity ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CheckInternetConnectivityExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                CheckConnectivityEndpointResponse result = apiInstance.CheckInternetConnectivity();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CheckInternetConnectivity: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CheckConnectivityEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckStorNextLicense

List<StorNextLicenseCheckEndpointResponse> CheckStorNextLicense (StornextLicense stornextLicense)

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CheckStorNextLicenseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var stornextLicense = new StornextLicense(); // StornextLicense | 

            try
            {
                List<StorNextLicenseCheckEndpointResponse> result = apiInstance.CheckStorNextLicense(stornextLicense);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CheckStorNextLicense: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
stornextLicense StornextLicense    

Return type

List<StorNextLicenseCheckEndpointResponse>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CollectDiagnostics

DownloadArchive CollectDiagnostics ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CollectDiagnosticsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                DownloadArchive result = apiInstance.CollectDiagnostics();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CollectDiagnostics: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateArchive

DownloadArchive CreateArchive (CreateDownloadArchive createDownloadArchive)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var createDownloadArchive = new CreateDownloadArchive(); // CreateDownloadArchive | 

            try
            {
                DownloadArchive result = apiInstance.CreateArchive(createDownloadArchive);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
createDownloadArchive CreateDownloadArchive    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateGroup

ElementsGroupDetail CreateGroup (ElementsGroupDetail elementsGroupDetail)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var elementsGroupDetail = new ElementsGroupDetail(); // ElementsGroupDetail | 

            try
            {
                ElementsGroupDetail result = apiInstance.CreateGroup(elementsGroupDetail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
elementsGroupDetail ElementsGroupDetail    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateHomeWorkspace

Workspace CreateHomeWorkspace (int id, CreateHomeWorkspaceRequest createHomeWorkspaceRequest)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateHomeWorkspaceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var createHomeWorkspaceRequest = new CreateHomeWorkspaceRequest(); // CreateHomeWorkspaceRequest | 

            try
            {
                Workspace result = apiInstance.CreateHomeWorkspace(id, createHomeWorkspaceRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateHomeWorkspace: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
createHomeWorkspaceRequest CreateHomeWorkspaceRequest    

Return type

Workspace

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateNTPServer

NTPServer CreateNTPServer (NTPServer nTPServer)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateNTPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var nTPServer = new NTPServer(); // NTPServer | 

            try
            {
                NTPServer result = apiInstance.CreateNTPServer(nTPServer);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateNTPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
nTPServer NTPServer    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUser

ElementsUserDetail CreateUser (ElementsUserDetail elementsUserDetail)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var elementsUserDetail = new ElementsUserDetail(); // ElementsUserDetail | 

            try
            {
                ElementsUserDetail result = apiInstance.CreateUser(elementsUserDetail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
elementsUserDetail ElementsUserDetail    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateWorkstation

Workstation CreateWorkstation (Workstation workstation)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class CreateWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var workstation = new Workstation(); // Workstation | 

            try
            {
                Workstation result = apiInstance.CreateWorkstation(workstation);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.CreateWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteDownloadArchive

void DeleteDownloadArchive (Guid id)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteDownloadArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = new Guid(); // Guid | A UUID string identifying this download archive.

            try
            {
                apiInstance.DeleteDownloadArchive(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteDownloadArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid A UUID string identifying this download archive.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteGroup

void DeleteGroup (int id)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Group.

            try
            {
                apiInstance.DeleteGroup(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Group.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteHomeWorkspace

void DeleteHomeWorkspace (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteHomeWorkspaceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                apiInstance.DeleteHomeWorkspace(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteHomeWorkspace: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNTPServer

void DeleteNTPServer (int id)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteNTPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this NTP Server.

            try
            {
                apiInstance.DeleteNTPServer(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteNTPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this NTP Server.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUser

void DeleteUser (int id)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                apiInstance.DeleteUser(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteWorkstation

void DeleteWorkstation (string id)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DeleteWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = id_example;  // string | A unique value identifying this workstation.

            try
            {
                apiInstance.DeleteWorkstation(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DeleteWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string A unique value identifying this workstation.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableUserTOTP

void DisableUserTOTP (int id)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class DisableUserTOTPExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                apiInstance.DisableUserTOTP(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.DisableUserTOTP: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableUserTOTP

void EnableUserTOTP (int id, EnableTOTPRequest enableTOTPRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class EnableUserTOTPExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var enableTOTPRequest = new EnableTOTPRequest(); // EnableTOTPRequest | 

            try
            {
                apiInstance.EnableUserTOTP(id, enableTOTPRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.EnableUserTOTP: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
enableTOTPRequest EnableTOTPRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FinishUpload

void FinishUpload (FinishUploadEndpointRequest finishUploadEndpointRequest)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class FinishUploadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var finishUploadEndpointRequest = new FinishUploadEndpointRequest(); // FinishUploadEndpointRequest | 

            try
            {
                apiInstance.FinishUpload(finishUploadEndpointRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.FinishUpload: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
finishUploadEndpointRequest FinishUploadEndpointRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FixLDAPGroupMemberships

void FixLDAPGroupMemberships (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class FixLDAPGroupMembershipsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this LDAP Server.

            try
            {
                apiInstance.FixLDAPGroupMemberships(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.FixLDAPGroupMemberships: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this LDAP Server.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllClientSessions

List<ClientSession> GetAllClientSessions (string user = null, string mountedWorkspacesMountNode = null, string workstation = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: system:status:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllClientSessionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var user = user_example;  // string | Filter the returned list by `user`. (optional) 
            var mountedWorkspacesMountNode = mountedWorkspacesMountNode_example;  // string | Filter the returned list by `mounted_workspaces__mount_node`. (optional) 
            var workstation = workstation_example;  // string | Filter the returned list by `workstation`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<ClientSession> result = apiInstance.GetAllClientSessions(user, mountedWorkspacesMountNode, workstation, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllClientSessions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
user string Filter the returned list by `user`. [optional]
mountedWorkspacesMountNode string Filter the returned list by `mounted_workspaces__mount_node`. [optional]
workstation string Filter the returned list by `workstation`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<ClientSession>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllDownloadArchives

List<DownloadArchive> GetAllDownloadArchives (string ordering = null, int? limit = null, int? offset = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllDownloadArchivesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<DownloadArchive> result = apiInstance.GetAllDownloadArchives(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllDownloadArchives: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<DownloadArchive>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllDownloads

List<Download> GetAllDownloads (string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: downloads:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllDownloadsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Download> result = apiInstance.GetAllDownloads(name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllDownloads: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<Download>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllGroups

List<ElementsGroup> GetAllGroups (string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllGroupsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<ElementsGroup> result = apiInstance.GetAllGroups(name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllGroups: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<ElementsGroup>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllLDAPServers

List<LDAPServer> GetAllLDAPServers (string ordering = null, int? limit = null, int? offset = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllLDAPServersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<LDAPServer> result = apiInstance.GetAllLDAPServers(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllLDAPServers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<LDAPServer>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllNTPServers

List<NTPServer> GetAllNTPServers (string address = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllNTPServersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var address = address_example;  // string | Filter the returned list by `address`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<NTPServer> result = apiInstance.GetAllNTPServers(address, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllNTPServers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
address string Filter the returned list by `address`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<NTPServer>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllStorageNodes

List<StorageNode> GetAllStorageNodes (string type = null, string backend = null, string name = null, string address = null, string ordering = null, int? limit = null, int? offset = null, bool? includeStatus = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllStorageNodesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var type = type_example;  // string | Filter the returned list by `type`. (optional) 
            var backend = backend_example;  // string | Filter the returned list by `backend`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var address = address_example;  // string | Filter the returned list by `address`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var includeStatus = true;  // bool? |  (optional) 

            try
            {
                List<StorageNode> result = apiInstance.GetAllStorageNodes(type, backend, name, address, ordering, limit, offset, includeStatus);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllStorageNodes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
type string Filter the returned list by `type`. [optional]
backend string Filter the returned list by `backend`. [optional]
name string Filter the returned list by `name`. [optional]
address string Filter the returned list by `address`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
includeStatus bool?   [optional]

Return type

List<StorageNode>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllUsers

List<ElementsUser> GetAllUsers (string username = null, string home = null, string fullName = null, string ordering = null, int? limit = null, int? offset = null, bool? includeAllowedFsPaths = null)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllUsersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var username = username_example;  // string | Filter the returned list by `username`. (optional) 
            var home = home_example;  // string | Filter the returned list by `home`. (optional) 
            var fullName = fullName_example;  // string | Filter the returned list by `full_name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 
            var includeAllowedFsPaths = true;  // bool? |  (optional) 

            try
            {
                List<ElementsUser> result = apiInstance.GetAllUsers(username, home, fullName, ordering, limit, offset, includeAllowedFsPaths);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllUsers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
username string Filter the returned list by `username`. [optional]
home string Filter the returned list by `home`. [optional]
fullName string Filter the returned list by `full_name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]
includeAllowedFsPaths bool?   [optional]

Return type

List<ElementsUser>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllWorkstations

List<Workstation> GetAllWorkstations (string hostname = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetAllWorkstationsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var hostname = hostname_example;  // string | Filter the returned list by `hostname`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                List<Workstation> result = apiInstance.GetAllWorkstations(hostname, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetAllWorkstations: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
hostname string Filter the returned list by `hostname`. [optional]
name string Filter the returned list by `name`. [optional]
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

List<Workstation>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCertificateConfiguration

Certificate GetCertificateConfiguration ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetCertificateConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                Certificate result = apiInstance.GetCertificateConfiguration();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetCertificateConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Certificate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientDownloadFile

void GetClientDownloadFile (string file)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetClientDownloadFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var file = file_example;  // string | 

            try
            {
                apiInstance.GetClientDownloadFile(file);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetClientDownloadFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
file string    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientDownloads

List<ClientsEndpointResponse> GetClientDownloads ()

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetClientDownloadsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                List<ClientsEndpointResponse> result = apiInstance.GetClientDownloads();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetClientDownloads: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<ClientsEndpointResponse>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClientSession

ClientSession GetClientSession (int id)

Required permissions * User account permission: system:status:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetClientSessionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this client session.

            try
            {
                ClientSession result = apiInstance.GetClientSession(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetClientSession: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this client session.  

Return type

ClientSession

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCurrentWorkstation

Workstation GetCurrentWorkstation (string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetCurrentWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                Workstation result = apiInstance.GetCurrentWorkstation(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetCurrentWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDownload

Download GetDownload (int id)

Required permissions * User account permission: downloads:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetDownloadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this download.

            try
            {
                Download result = apiInstance.GetDownload(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetDownload: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this download.  

Return type

Download

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDownloadArchive

DownloadArchive GetDownloadArchive (Guid id)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetDownloadArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = new Guid(); // Guid | A UUID string identifying this download archive.

            try
            {
                DownloadArchive result = apiInstance.GetDownloadArchive(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetDownloadArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid A UUID string identifying this download archive.  

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDownloadArchiveFile

void GetDownloadArchiveFile (Guid id)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetDownloadArchiveFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = new Guid(); // Guid | A UUID string identifying this download archive.

            try
            {
                apiInstance.GetDownloadArchiveFile(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetDownloadArchiveFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid A UUID string identifying this download archive.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDownloadFile

void GetDownloadFile (int id)

Required permissions * User account permission: downloads:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetDownloadFileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this download.

            try
            {
                apiInstance.GetDownloadFile(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetDownloadFile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this download.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDownloadIcon

void GetDownloadIcon (int id)

Required permissions * User account permission: downloads:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetDownloadIconExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this download.

            try
            {
                apiInstance.GetDownloadIcon(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetDownloadIcon: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this download.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroup

ElementsGroupDetail GetGroup (int id)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Group.

            try
            {
                ElementsGroupDetail result = apiInstance.GetGroup(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Group.  

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHomeWorkspace

Workspace GetHomeWorkspace (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetHomeWorkspaceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                Workspace result = apiInstance.GetHomeWorkspace(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetHomeWorkspace: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

Workspace

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIPMIConfiguration

Ipmi GetIPMIConfiguration (int id)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetIPMIConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.

            try
            {
                Ipmi result = apiInstance.GetIPMIConfiguration(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetIPMIConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  

Return type

Ipmi

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLDAPServer

LDAPServer GetLDAPServer (int id)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLDAPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this LDAP Server.

            try
            {
                LDAPServer result = apiInstance.GetLDAPServer(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLDAPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this LDAP Server.  

Return type

LDAPServer

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLDAPServerGroups

LDAPServerGroups GetLDAPServerGroups (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLDAPServerGroupsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this LDAP Server.

            try
            {
                LDAPServerGroups result = apiInstance.GetLDAPServerGroups(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLDAPServerGroups: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this LDAP Server.  

Return type

LDAPServerGroups

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLDAPServerUsers

LDAPServerUsers GetLDAPServerUsers (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLDAPServerUsersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this LDAP Server.

            try
            {
                LDAPServerUsers result = apiInstance.GetLDAPServerUsers(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLDAPServerUsers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this LDAP Server.  

Return type

LDAPServerUsers

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLicense

License GetLicense ()

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLicenseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                License result = apiInstance.GetLicense();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLicense: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

License

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLocalTime

TimeEndpointResponse GetLocalTime ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLocalTimeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                TimeEndpointResponse result = apiInstance.GetLocalTime();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLocalTime: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

TimeEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLog

void GetLog (string path, int? offset = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetLogExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var path = path_example;  // string | 
            var offset = 56;  // int? |  (optional) 

            try
            {
                apiInstance.GetLog(path, offset);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetLog: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
path string    
offset int?   [optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNTPServer

NTPServer GetNTPServer (int id)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetNTPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this NTP Server.

            try
            {
                NTPServer result = apiInstance.GetNTPServer(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetNTPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this NTP Server.  

Return type

NTPServer

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeIPMISensors

Sensors GetNodeIPMISensors (int id)

Required permissions * User account permission: system:status:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetNodeIPMISensorsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.

            try
            {
                Sensors result = apiInstance.GetNodeIPMISensors(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetNodeIPMISensors: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  

Return type

Sensors

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeStats

Stats GetNodeStats (int id)

Required permissions * User account permission: system:status:view

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetNodeStatsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.

            try
            {
                Stats result = apiInstance.GetNodeStats(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetNodeStats: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  

Return type

Stats

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetParameters

Parameters GetParameters (string ordering = null, int? limit = null, int? offset = null)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetParametersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                Parameters result = apiInstance.GetParameters(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetParameters: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

Parameters

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProfile

ElementsUserProfile GetProfile (string ordering = null, int? limit = null, int? offset = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var ordering = ordering_example;  // string | Which field to use when ordering the results. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 
            var offset = 56;  // int? | The initial index from which to return the results. (optional) 

            try
            {
                ElementsUserProfile result = apiInstance.GetProfile(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
ordering string Which field to use when ordering the results. [optional]
limit int? Number of results to return per page. [optional]
offset int? The initial index from which to return the results. [optional]

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReleaseNotes

List<ReleaseNotesEndpointResponse> GetReleaseNotes ()

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetReleaseNotesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                List<ReleaseNotesEndpointResponse> result = apiInstance.GetReleaseNotes();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetReleaseNotes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<ReleaseNotesEndpointResponse>

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSMTPConfiguration

SMTPConfiguration GetSMTPConfiguration ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSMTPConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                SMTPConfiguration result = apiInstance.GetSMTPConfiguration();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetSMTPConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SMTPConfiguration

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceStatus

ServiceStatus GetServiceStatus (int id, string service)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetServiceStatusExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.
            var service = service_example;  // string | 

            try
            {
                ServiceStatus result = apiInstance.GetServiceStatus(id, service);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetServiceStatus: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  
service string    

Return type

ServiceStatus

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStorNextLicense

StorNextLicenseEndpointResponse GetStorNextLicense ()

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetStorNextLicenseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                StorNextLicenseEndpointResponse result = apiInstance.GetStorNextLicense();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetStorNextLicense: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

StorNextLicenseEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStorageNode

StorageNode GetStorageNode (int id, bool? includeStatus = null)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetStorageNodeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.
            var includeStatus = true;  // bool? |  (optional) 

            try
            {
                StorageNode result = apiInstance.GetStorageNode(id, includeStatus);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetStorageNode: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  
includeStatus bool?   [optional]

Return type

StorageNode

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSystemInfo

SystemInfoEndpointResponse GetSystemInfo ()

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetSystemInfoExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                SystemInfoEndpointResponse result = apiInstance.GetSystemInfo();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetSystemInfo: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SystemInfoEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUser

ElementsUserDetail GetUser (int id)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                ElementsUserDetail result = apiInstance.GetUser(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWorkstation

Workstation GetWorkstation (string id)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class GetWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = id_example;  // string | A unique value identifying this workstation.

            try
            {
                Workstation result = apiInstance.GetWorkstation(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.GetWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string A unique value identifying this workstation.  

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InstallStorNextLicense

StorNextLicenseEndpointResponse InstallStorNextLicense (StornextLicense stornextLicense)

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class InstallStorNextLicenseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var stornextLicense = new StornextLicense(); // StornextLicense | 

            try
            {
                StorNextLicenseEndpointResponse result = apiInstance.InstallStorNextLicense(stornextLicense);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.InstallStorNextLicense: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
stornextLicense StornextLicense    

Return type

StorNextLicenseEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchCurrentWorkstation

Workstation PatchCurrentWorkstation (WorkstationPartialUpdate workstationPartialUpdate)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchCurrentWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var workstationPartialUpdate = new WorkstationPartialUpdate(); // WorkstationPartialUpdate | 

            try
            {
                Workstation result = apiInstance.PatchCurrentWorkstation(workstationPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchCurrentWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
workstationPartialUpdate WorkstationPartialUpdate    

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchDownloadArchive

DownloadArchive PatchDownloadArchive (Guid id, DownloadArchivePartialUpdate downloadArchivePartialUpdate)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchDownloadArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = new Guid(); // Guid | A UUID string identifying this download archive.
            var downloadArchivePartialUpdate = new DownloadArchivePartialUpdate(); // DownloadArchivePartialUpdate | 

            try
            {
                DownloadArchive result = apiInstance.PatchDownloadArchive(id, downloadArchivePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchDownloadArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid A UUID string identifying this download archive.  
downloadArchivePartialUpdate DownloadArchivePartialUpdate    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchGroup

ElementsGroupDetail PatchGroup (int id, ElementsGroupDetailPartialUpdate elementsGroupDetailPartialUpdate)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Group.
            var elementsGroupDetailPartialUpdate = new ElementsGroupDetailPartialUpdate(); // ElementsGroupDetailPartialUpdate | 

            try
            {
                ElementsGroupDetail result = apiInstance.PatchGroup(id, elementsGroupDetailPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Group.  
elementsGroupDetailPartialUpdate ElementsGroupDetailPartialUpdate    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchNTPServer

NTPServer PatchNTPServer (int id, NTPServerPartialUpdate nTPServerPartialUpdate)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchNTPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this NTP Server.
            var nTPServerPartialUpdate = new NTPServerPartialUpdate(); // NTPServerPartialUpdate | 

            try
            {
                NTPServer result = apiInstance.PatchNTPServer(id, nTPServerPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchNTPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this NTP Server.  
nTPServerPartialUpdate NTPServerPartialUpdate    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchProfile

ElementsUserProfile PatchProfile (ElementsUserProfilePartialUpdate elementsUserProfilePartialUpdate)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var elementsUserProfilePartialUpdate = new ElementsUserProfilePartialUpdate(); // ElementsUserProfilePartialUpdate | 

            try
            {
                ElementsUserProfile result = apiInstance.PatchProfile(elementsUserProfilePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
elementsUserProfilePartialUpdate ElementsUserProfilePartialUpdate    

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchUser

ElementsUserDetail PatchUser (int id, ElementsUserDetailPartialUpdate elementsUserDetailPartialUpdate)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var elementsUserDetailPartialUpdate = new ElementsUserDetailPartialUpdate(); // ElementsUserDetailPartialUpdate | 

            try
            {
                ElementsUserDetail result = apiInstance.PatchUser(id, elementsUserDetailPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
elementsUserDetailPartialUpdate ElementsUserDetailPartialUpdate    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchWorkstation

Workstation PatchWorkstation (string id, WorkstationPartialUpdate workstationPartialUpdate)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PatchWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = id_example;  // string | A unique value identifying this workstation.
            var workstationPartialUpdate = new WorkstationPartialUpdate(); // WorkstationPartialUpdate | 

            try
            {
                Workstation result = apiInstance.PatchWorkstation(id, workstationPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PatchWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string A unique value identifying this workstation.  
workstationPartialUpdate WorkstationPartialUpdate    

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PreviewUser

UserPreviewResponse PreviewUser (UserPreviewRequest userPreviewRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class PreviewUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var userPreviewRequest = new UserPreviewRequest(); // UserPreviewRequest | 

            try
            {
                UserPreviewResponse result = apiInstance.PreviewUser(userPreviewRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.PreviewUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
userPreviewRequest UserPreviewRequest    

Return type

UserPreviewResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reboot

void Reboot ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RebootExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                apiInstance.Reboot();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.Reboot: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterUpload

void RegisterUpload (RegisterUploadEndpointRequest registerUploadEndpointRequest)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RegisterUploadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var registerUploadEndpointRequest = new RegisterUploadEndpointRequest(); // RegisterUploadEndpointRequest | 

            try
            {
                apiInstance.RegisterUpload(registerUploadEndpointRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.RegisterUpload: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
registerUploadEndpointRequest RegisterUploadEndpointRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterUploadMetadata

void RegisterUploadMetadata (RegisterUploadMetadataEndpointRequest registerUploadMetadataEndpointRequest)

Required permissions * User account permission: media:access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RegisterUploadMetadataExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var registerUploadMetadataEndpointRequest = new RegisterUploadMetadataEndpointRequest(); // RegisterUploadMetadataEndpointRequest | 

            try
            {
                apiInstance.RegisterUploadMetadata(registerUploadMetadataEndpointRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.RegisterUploadMetadata: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
registerUploadMetadataEndpointRequest RegisterUploadMetadataEndpointRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenderEmailTemplatePreview

void RenderEmailTemplatePreview (EmailPreview emailPreview)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RenderEmailTemplatePreviewExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var emailPreview = new EmailPreview(); // EmailPreview | 

            try
            {
                apiInstance.RenderEmailTemplatePreview(emailPreview);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.RenderEmailTemplatePreview: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
emailPreview EmailPreview    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetUserPassword

void ResetUserPassword (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ResetUserPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.

            try
            {
                apiInstance.ResetUserPassword(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.ResetUserPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RunServiceOperation

void RunServiceOperation (int id, string operation, string service)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class RunServiceOperationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.
            var operation = operation_example;  // string | 
            var service = service_example;  // string | 

            try
            {
                apiInstance.RunServiceOperation(id, operation, service);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.RunServiceOperation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  
operation string    
service string    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetIPMIConfiguration

Ipmi SetIPMIConfiguration (int id, Ipmi ipmi)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SetIPMIConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Storage Node.
            var ipmi = new Ipmi(); // Ipmi | 

            try
            {
                Ipmi result = apiInstance.SetIPMIConfiguration(id, ipmi);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SetIPMIConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Storage Node.  
ipmi Ipmi    

Return type

Ipmi

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetLocalTime

TimeEndpointResponse SetLocalTime (TimeEndpointRequest timeEndpointRequest)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SetLocalTimeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var timeEndpointRequest = new TimeEndpointRequest(); // TimeEndpointRequest | 

            try
            {
                TimeEndpointResponse result = apiInstance.SetLocalTime(timeEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SetLocalTime: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
timeEndpointRequest TimeEndpointRequest    

Return type

TimeEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMyPassword

void SetMyPassword (ChangeOwnPasswordRequest changeOwnPasswordRequest)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SetMyPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var changeOwnPasswordRequest = new ChangeOwnPasswordRequest(); // ChangeOwnPasswordRequest | 

            try
            {
                apiInstance.SetMyPassword(changeOwnPasswordRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SetMyPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
changeOwnPasswordRequest ChangeOwnPasswordRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetUserPassword

void SetUserPassword (int id, ChangePasswordRequest changePasswordRequest)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SetUserPasswordExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var changePasswordRequest = new ChangePasswordRequest(); // ChangePasswordRequest | 

            try
            {
                apiInstance.SetUserPassword(id, changePasswordRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SetUserPassword: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
changePasswordRequest ChangePasswordRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Shutdown

void Shutdown ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class ShutdownExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                apiInstance.Shutdown();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.Shutdown: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartSolrReindex

SolrReindexEndpointResponse StartSolrReindex ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartSolrReindexExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                SolrReindexEndpointResponse result = apiInstance.StartSolrReindex();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.StartSolrReindex: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SolrReindexEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartSupportSession

TaskInfo StartSupportSession ()

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartSupportSessionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);

            try
            {
                TaskInfo result = apiInstance.StartSupportSession();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.StartSupportSession: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartSystemBackup

TaskInfo StartSystemBackup (Path path)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class StartSystemBackupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var path = new Path(); // Path | 

            try
            {
                TaskInfo result = apiInstance.StartSystemBackup(path);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.StartSystemBackup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
path Path    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncLDAPGroup

void SyncLDAPGroup (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SyncLDAPGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Group.

            try
            {
                apiInstance.SyncLDAPGroup(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SyncLDAPGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Group.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncLDAPUsers

void SyncLDAPUsers (int id)

Required permissions * User account permission: users:manage

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SyncLDAPUsersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this LDAP Server.

            try
            {
                apiInstance.SyncLDAPUsers(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SyncLDAPUsers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this LDAP Server.  

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncTime

TimeSyncEndpointResponse SyncTime (TimeSyncEndpointRequest timeSyncEndpointRequest)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SyncTimeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var timeSyncEndpointRequest = new TimeSyncEndpointRequest(); // TimeSyncEndpointRequest | 

            try
            {
                TimeSyncEndpointResponse result = apiInstance.SyncTime(timeSyncEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SyncTime: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
timeSyncEndpointRequest TimeSyncEndpointRequest    

Return type

TimeSyncEndpointResponse

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SyncUserTOTP

SyncTOTP SyncUserTOTP (int id, SyncTOTPRequest syncTOTPRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class SyncUserTOTPExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var syncTOTPRequest = new SyncTOTPRequest(); // SyncTOTPRequest | 

            try
            {
                SyncTOTP result = apiInstance.SyncUserTOTP(id, syncTOTPRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.SyncUserTOTP: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
syncTOTPRequest SyncTOTPRequest    

Return type

SyncTOTP

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestSMTPConfiguration

void TestSMTPConfiguration (TestSMTP testSMTP)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class TestSMTPConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var testSMTP = new TestSMTP(); // TestSMTP | 

            try
            {
                apiInstance.TestSMTPConfiguration(testSMTP);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.TestSMTPConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
testSMTP TestSMTP    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCertificateConfiguration

Certificate UpdateCertificateConfiguration (Certificate certificate)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateCertificateConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var certificate = new Certificate(); // Certificate | 

            try
            {
                Certificate result = apiInstance.UpdateCertificateConfiguration(certificate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateCertificateConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
certificate Certificate    

Return type

Certificate

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCurrentWorkstation

Workstation UpdateCurrentWorkstation (Workstation workstation)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateCurrentWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var workstation = new Workstation(); // Workstation | 

            try
            {
                Workstation result = apiInstance.UpdateCurrentWorkstation(workstation);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateCurrentWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDownloadArchive

DownloadArchive UpdateDownloadArchive (Guid id, DownloadArchive downloadArchive)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateDownloadArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = new Guid(); // Guid | A UUID string identifying this download archive.
            var downloadArchive = new DownloadArchive(); // DownloadArchive | 

            try
            {
                DownloadArchive result = apiInstance.UpdateDownloadArchive(id, downloadArchive);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateDownloadArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id Guid A UUID string identifying this download archive.  
downloadArchive DownloadArchive    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateGroup

ElementsGroupDetail UpdateGroup (int id, ElementsGroupDetail elementsGroupDetail)

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateGroupExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this Group.
            var elementsGroupDetail = new ElementsGroupDetail(); // ElementsGroupDetail | 

            try
            {
                ElementsGroupDetail result = apiInstance.UpdateGroup(id, elementsGroupDetail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this Group.  
elementsGroupDetail ElementsGroupDetail    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNTPServer

NTPServer UpdateNTPServer (int id, NTPServer nTPServer)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateNTPServerExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this NTP Server.
            var nTPServer = new NTPServer(); // NTPServer | 

            try
            {
                NTPServer result = apiInstance.UpdateNTPServer(id, nTPServer);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateNTPServer: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this NTP Server.  
nTPServer NTPServer    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateParameters

Parameters UpdateParameters (Parameters parameters)

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateParametersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var parameters = new Parameters(); // Parameters | 

            try
            {
                Parameters result = apiInstance.UpdateParameters(parameters);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateParameters: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
parameters Parameters    

Return type

Parameters

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateProfile

ElementsUserProfile UpdateProfile (ElementsUserProfile elementsUserProfile)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateProfileExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var elementsUserProfile = new ElementsUserProfile(); // ElementsUserProfile | 

            try
            {
                ElementsUserProfile result = apiInstance.UpdateProfile(elementsUserProfile);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateProfile: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
elementsUserProfile ElementsUserProfile    

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSMTPConfiguration

SMTPConfiguration UpdateSMTPConfiguration (SMTPConfiguration sMTPConfiguration)

Required permissions * User account permission: system:admin-access

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateSMTPConfigurationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var sMTPConfiguration = new SMTPConfiguration(); // SMTPConfiguration | 

            try
            {
                SMTPConfiguration result = apiInstance.UpdateSMTPConfiguration(sMTPConfiguration);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateSMTPConfiguration: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
sMTPConfiguration SMTPConfiguration    

Return type

SMTPConfiguration

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUser

ElementsUserDetail UpdateUser (int id, ElementsUserDetail elementsUserDetail)

Required permissions * User account permission: None (read) / users:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = 56;  // int | A unique integer value identifying this User.
            var elementsUserDetail = new ElementsUserDetail(); // ElementsUserDetail | 

            try
            {
                ElementsUserDetail result = apiInstance.UpdateUser(id, elementsUserDetail);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id int A unique integer value identifying this User.  
elementsUserDetail ElementsUserDetail    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateWorkstation

Workstation UpdateWorkstation (string id, Workstation workstation)

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UpdateWorkstationExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var id = id_example;  // string | A unique value identifying this workstation.
            var workstation = new Workstation(); // Workstation | 

            try
            {
                Workstation result = apiInstance.UpdateWorkstation(id, workstation);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UpdateWorkstation: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string A unique value identifying this workstation.  
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadChunk

void UploadChunk (UploadChunkEndpointRequest uploadChunkEndpointRequest)

Required permissions * Authenticated user

Example

using System.Collections.Generic;
using System.Diagnostics;
using ElementsSDK.Api;
using ElementsSDK.Client;
using ElementsSDK.Model;

namespace Example
{
    public class UploadChunkExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://elements.local";
            // Configure API key authorization: Bearer
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new MainApi(config);
            var uploadChunkEndpointRequest = new UploadChunkEndpointRequest(); // UploadChunkEndpointRequest | 

            try
            {
                apiInstance.UploadChunk(uploadChunkEndpointRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MainApi.UploadChunk: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
uploadChunkEndpointRequest UploadChunkEndpointRequest    

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | No body | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]