TapeArchiveApi.md

ElementsSDK.Api.TapeArchiveApi

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

Method	HTTP request	Description
ArchiveToTape	POST /api/2/archive/tape/archive
CancelAllTapeArchiveJobs	POST /api/2/archive/tape/jobs/cancel-all
CheckTape	POST /api/2/archive/tape/library/check
CreateTape	POST /api/2/archive/tape/tapes
CreateTapeGroup	POST /api/2/archive/tape/groups
DeleteTape	DELETE /api/2/archive/tape/tapes/{id}
DeleteTapeArchiveJob	DELETE /api/2/archive/tape/jobs/{id}
DeleteTapeGroup	DELETE /api/2/archive/tape/groups/{id}
FormatTape	POST /api/2/archive/tape/library/format
GetAllArchivedFileEntries	GET /api/2/archive/tape/files
GetAllTapeArchiveJobs	GET /api/2/archive/tape/jobs
GetAllTapeGroups	GET /api/2/archive/tape/groups
GetAllTapes	GET /api/2/archive/tape/tapes
GetArchivedFileEntry	GET /api/2/archive/tape/files/{id}
GetTape	GET /api/2/archive/tape/tapes/{id}
GetTapeArchiveJob	GET /api/2/archive/tape/jobs/{id}
GetTapeArchiveJobSources	GET /api/2/archive/tape/jobs/{id}/sources
GetTapeGroup	GET /api/2/archive/tape/groups/{id}
GetTapeLibraryState	GET /api/2/archive/tape/library
LoadTape	POST /api/2/archive/tape/library/load
MoveTape	POST /api/2/archive/tape/library/move
PatchTape	PATCH /api/2/archive/tape/tapes/{id}
PatchTapeGroup	PATCH /api/2/archive/tape/groups/{id}
PauseTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/pause
RefreshTapeLibraryState	POST /api/2/archive/tape/library/refresh
ReindexTape	POST /api/2/archive/tape/library/reindex
RemoveFinishedTapeArchiveJobs	POST /api/2/archive/tape/jobs/remove-finished
RestartTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/restart
RestoreFromTape	POST /api/2/archive/tape/restore
ResumeTapeArchiveJob	POST /api/2/archive/tape/jobs/{id}/resume
SearchTapeArchive	POST /api/2/archive/tape/search
UnloadTape	POST /api/2/archive/tape/library/unload
UpdateTape	PUT /api/2/archive/tape/tapes/{id}
UpdateTapeGroup	PUT /api/2/archive/tape/groups/{id}

ArchiveToTape

List<TapeJob> ArchiveToTape (ArchiveEndpointRequest archiveEndpointRequest)

Required permissions * User account permission: ltfs:backup * License component: ltfs

Example

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

namespace Example
{
    public class ArchiveToTapeExample
    {
        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 TapeArchiveApi(config);
            var archiveEndpointRequest = new ArchiveEndpointRequest(); // ArchiveEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
archiveEndpointRequest	ArchiveEndpointRequest

Return type

List<TapeJob>

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

CancelAllTapeArchiveJobs

void CancelAllTapeArchiveJobs ()

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class CancelAllTapeArchiveJobsExample
    {
        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 TapeArchiveApi(config);

            try
            {
                apiInstance.CancelAllTapeArchiveJobs();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.CancelAllTapeArchiveJobs: " + 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

• Content-Type: Not defined
• Accept: Not defined

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]

CheckTape

void CheckTape (TapeLibraryFsckEndpointRequest tapeLibraryFsckEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class CheckTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryFsckEndpointRequest = new TapeLibraryFsckEndpointRequest(); // TapeLibraryFsckEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryFsckEndpointRequest	TapeLibraryFsckEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

CreateTape

Tape CreateTape (Tape tape)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class CreateTapeExample
    {
        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 TapeArchiveApi(config);
            var tape = new Tape(); // Tape | 

            try
            {
                Tape result = apiInstance.CreateTape(tape);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.CreateTape: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
tape	Tape

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

CreateTapeGroup

TapeGroup CreateTapeGroup (TapeGroup tapeGroup)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class CreateTapeGroupExample
    {
        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 TapeArchiveApi(config);
            var tapeGroup = new TapeGroup(); // TapeGroup | 

            try
            {
                TapeGroup result = apiInstance.CreateTapeGroup(tapeGroup);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.CreateTapeGroup: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
tapeGroup	TapeGroup

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

DeleteTape

void DeleteTape (int id)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class DeleteTapeExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape.

            try
            {
                apiInstance.DeleteTape(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.DeleteTape: " + 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 tape.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

DeleteTapeArchiveJob

void DeleteTapeArchiveJob (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class DeleteTapeArchiveJobExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

DeleteTapeGroup

void DeleteTapeGroup (int id)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class DeleteTapeGroupExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape group.

            try
            {
                apiInstance.DeleteTapeGroup(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.DeleteTapeGroup: " + 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 tape group.

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

FormatTape

void FormatTape (TapeLibraryFormatEndpointRequest tapeLibraryFormatEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class FormatTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryFormatEndpointRequest = new TapeLibraryFormatEndpointRequest(); // TapeLibraryFormatEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryFormatEndpointRequest	TapeLibraryFormatEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

GetAllArchivedFileEntries

List<TapeFile> GetAllArchivedFileEntries (decimal? id = null, string isDir = null, string name = null, string fullpath = null, string parent = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: ltfs:search (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetAllArchivedFileEntriesExample
    {
        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 TapeArchiveApi(config);
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var isDir = isDir_example;  // string | Filter the returned list by `is_dir`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var fullpath = fullpath_example;  // string | Filter the returned list by `fullpath`. (optional) 
            var parent = parent_example;  // string | Filter the returned list by `parent`. (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<TapeFile> result = apiInstance.GetAllArchivedFileEntries(id, isDir, name, fullpath, parent, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetAllArchivedFileEntries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	decimal?	Filter the returned list by `id`.	[optional]
isDir	string	Filter the returned list by `is_dir`.	[optional]
name	string	Filter the returned list by `name`.	[optional]
fullpath	string	Filter the returned list by `fullpath`.	[optional]
parent	string	Filter the returned list by `parent`.	[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<TapeFile>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetAllTapeArchiveJobs

List<TapeJob> GetAllTapeArchiveJobs (string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetAllTapeArchiveJobsExample
    {
        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 TapeArchiveApi(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<TapeJob> result = apiInstance.GetAllTapeArchiveJobs(ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetAllTapeArchiveJobs: " + 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<TapeJob>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetAllTapeGroups

List<TapeGroup> GetAllTapeGroups (decimal? id = null, string name = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetAllTapeGroupsExample
    {
        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 TapeArchiveApi(config);
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (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<TapeGroup> result = apiInstance.GetAllTapeGroups(id, name, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetAllTapeGroups: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	decimal?	Filter the returned list by `id`.	[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<TapeGroup>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetAllTapes

List<Tape> GetAllTapes (decimal? id = null, string name = null, string group = null, string groupIsnull = null, string ordering = null, int? limit = null, int? offset = null)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetAllTapesExample
    {
        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 TapeArchiveApi(config);
            var id = 8.14;  // decimal? | Filter the returned list by `id`. (optional) 
            var name = name_example;  // string | Filter the returned list by `name`. (optional) 
            var group = group_example;  // string | Filter the returned list by `group`. (optional) 
            var groupIsnull = groupIsnull_example;  // string | Filter the returned list by `group__isnull`. (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<Tape> result = apiInstance.GetAllTapes(id, name, group, groupIsnull, ordering, limit, offset);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetAllTapes: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	decimal?	Filter the returned list by `id`.	[optional]
name	string	Filter the returned list by `name`.	[optional]
group	string	Filter the returned list by `group`.	[optional]
groupIsnull	string	Filter the returned list by `group__isnull`.	[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<Tape>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetArchivedFileEntry

TapeFile GetArchivedFileEntry (int id)

Required permissions * User account permission: ltfs:search (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetArchivedFileEntryExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this Archived file entry.

            try
            {
                TapeFile result = apiInstance.GetArchivedFileEntry(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetArchivedFileEntry: " + 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 Archived file entry.

Return type

TapeFile

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetTape

Tape GetTape (int id)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetTapeExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape.

            try
            {
                Tape result = apiInstance.GetTape(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetTape: " + 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 tape.

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetTapeArchiveJob

TapeJob GetTapeArchiveJob (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetTapeArchiveJobExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

TapeJob

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetTapeArchiveJobSources

List<TapeJobSource> GetTapeArchiveJobSources (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetTapeArchiveJobSourcesExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

List<TapeJobSource>

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetTapeGroup

TapeGroup GetTapeGroup (int id)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class GetTapeGroupExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape group.

            try
            {
                TapeGroup result = apiInstance.GetTapeGroup(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.GetTapeGroup: " + 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 tape group.

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

GetTapeLibraryState

TapeLibraryEndpointResponse GetTapeLibraryState ()

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class GetTapeLibraryStateExample
    {
        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 TapeArchiveApi(config);

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

Parameters

This endpoint does not need any parameter.

Return type

TapeLibraryEndpointResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

LoadTape

void LoadTape (TapeLibraryLoadEndpointRequest tapeLibraryLoadEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class LoadTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryLoadEndpointRequest = new TapeLibraryLoadEndpointRequest(); // TapeLibraryLoadEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryLoadEndpointRequest	TapeLibraryLoadEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

MoveTape

void MoveTape (TapeLibraryMoveEndpointRequest tapeLibraryMoveEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class MoveTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryMoveEndpointRequest = new TapeLibraryMoveEndpointRequest(); // TapeLibraryMoveEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryMoveEndpointRequest	TapeLibraryMoveEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

PatchTape

Tape PatchTape (int id, TapePartialUpdate tapePartialUpdate)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class PatchTapeExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape.
            var tapePartialUpdate = new TapePartialUpdate(); // TapePartialUpdate | 

            try
            {
                Tape result = apiInstance.PatchTape(id, tapePartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.PatchTape: " + 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 tape.
tapePartialUpdate	TapePartialUpdate

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

PatchTapeGroup

TapeGroup PatchTapeGroup (int id, TapeGroupPartialUpdate tapeGroupPartialUpdate)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class PatchTapeGroupExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape group.
            var tapeGroupPartialUpdate = new TapeGroupPartialUpdate(); // TapeGroupPartialUpdate | 

            try
            {
                TapeGroup result = apiInstance.PatchTapeGroup(id, tapeGroupPartialUpdate);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.PatchTapeGroup: " + 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 tape group.
tapeGroupPartialUpdate	TapeGroupPartialUpdate

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

PauseTapeArchiveJob

void PauseTapeArchiveJob (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class PauseTapeArchiveJobExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

RefreshTapeLibraryState

void RefreshTapeLibraryState ()

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class RefreshTapeLibraryStateExample
    {
        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 TapeArchiveApi(config);

            try
            {
                apiInstance.RefreshTapeLibraryState();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.RefreshTapeLibraryState: " + 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

• Content-Type: Not defined
• Accept: Not defined

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]

ReindexTape

void ReindexTape (TapeLibraryReindexEndpointRequest tapeLibraryReindexEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class ReindexTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryReindexEndpointRequest = new TapeLibraryReindexEndpointRequest(); // TapeLibraryReindexEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryReindexEndpointRequest	TapeLibraryReindexEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

RemoveFinishedTapeArchiveJobs

void RemoveFinishedTapeArchiveJobs ()

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class RemoveFinishedTapeArchiveJobsExample
    {
        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 TapeArchiveApi(config);

            try
            {
                apiInstance.RemoveFinishedTapeArchiveJobs();
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.RemoveFinishedTapeArchiveJobs: " + 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

• Content-Type: Not defined
• Accept: Not defined

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]

RestartTapeArchiveJob

void RestartTapeArchiveJob (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class RestartTapeArchiveJobExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

RestoreFromTape

TapeJob RestoreFromTape (RestoreEndpointRequest restoreEndpointRequest)

Required permissions * User account permission: ltfs:restore * License component: ltfs

Example

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

namespace Example
{
    public class RestoreFromTapeExample
    {
        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 TapeArchiveApi(config);
            var restoreEndpointRequest = new RestoreEndpointRequest(); // RestoreEndpointRequest | 

            try
            {
                TapeJob result = apiInstance.RestoreFromTape(restoreEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.RestoreFromTape: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
restoreEndpointRequest	RestoreEndpointRequest

Return type

TapeJob

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

ResumeTapeArchiveJob

void ResumeTapeArchiveJob (string id)

Required permissions * User account permission: None (read) / ltfs:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class ResumeTapeArchiveJobExample
    {
        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 TapeArchiveApi(config);
            var id = id_example;  // string | 

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

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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]

SearchTapeArchive

SearchEndpointResponse SearchTapeArchive (SearchEndpointRequest searchEndpointRequest)

Required permissions * User account permission: ltfs:search * License component: ltfs

Example

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

namespace Example
{
    public class SearchTapeArchiveExample
    {
        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 TapeArchiveApi(config);
            var searchEndpointRequest = new SearchEndpointRequest(); // SearchEndpointRequest | 

            try
            {
                SearchEndpointResponse result = apiInstance.SearchTapeArchive(searchEndpointRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.SearchTapeArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
searchEndpointRequest	SearchEndpointRequest

Return type

SearchEndpointResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

UnloadTape

void UnloadTape (TapeLibraryUnloadEndpointRequest tapeLibraryUnloadEndpointRequest)

Required permissions * User account permission: ltfs:manage * License component: ltfs

Example

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

namespace Example
{
    public class UnloadTapeExample
    {
        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 TapeArchiveApi(config);
            var tapeLibraryUnloadEndpointRequest = new TapeLibraryUnloadEndpointRequest(); // TapeLibraryUnloadEndpointRequest | 

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

Parameters

Name	Type	Description	Notes
tapeLibraryUnloadEndpointRequest	TapeLibraryUnloadEndpointRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

UpdateTape

Tape UpdateTape (int id, Tape tape)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class UpdateTapeExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape.
            var tape = new Tape(); // Tape | 

            try
            {
                Tape result = apiInstance.UpdateTape(id, tape);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.UpdateTape: " + 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 tape.
tape	Tape

Return type

Tape

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

UpdateTapeGroup

TapeGroup UpdateTapeGroup (int id, TapeGroup tapeGroup)

Required permissions * User account permission: None (read) / ltfs:tapegroups:manage (write) * License component: ltfs

Example

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

namespace Example
{
    public class UpdateTapeGroupExample
    {
        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 TapeArchiveApi(config);
            var id = 56;  // int | A unique integer value identifying this tape group.
            var tapeGroup = new TapeGroup(); // TapeGroup | 

            try
            {
                TapeGroup result = apiInstance.UpdateTapeGroup(id, tapeGroup);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling TapeArchiveApi.UpdateTapeGroup: " + 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 tape group.
tapeGroup	TapeGroup

Return type

TapeGroup

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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