eZmaxApi.Api.ObjectApikeyApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ApikeyCreateObjectV2	POST /2/object/apikey	Create a new Apikey
ApikeyEditObjectV1	PUT /1/object/apikey/{pkiApikeyID}	Edit an existing Apikey
ApikeyEditPermissionsV1	PUT /1/object/apikey/{pkiApikeyID}/editPermissions	Edit multiple Permissions
ApikeyGenerateDelegatedCredentialsV1	POST /1/object/apikey/generateDelegatedCredentials	Generate a delegated credentials
ApikeyGetCorsV1	GET /1/object/apikey/{pkiApikeyID}/getCors	Retrieve an existing Apikey's cors
ApikeyGetListV1	GET /1/object/apikey/getList	Retrieve Apikey list
ApikeyGetObjectV2	GET /2/object/apikey/{pkiApikeyID}	Retrieve an existing Apikey
ApikeyGetPermissionsV1	GET /1/object/apikey/{pkiApikeyID}/getPermissions	Retrieve an existing Apikey's Permissions
ApikeyGetSubnetsV1	GET /1/object/apikey/{pkiApikeyID}/getSubnets	Retrieve an existing Apikey's subnets
ApikeyRegenerateV1	POST /1/object/apikey/{pkiApikeyID}/regenerate	Regenerate the Apikey

ApikeyCreateObjectV2

ApikeyCreateObjectV2Response ApikeyCreateObjectV2 (ApikeyCreateObjectV2Request apikeyCreateObjectV2Request)

Create a new Apikey

The endpoint allows to create one or many elements at once.

Example

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

namespace Example
{
    public class ApikeyCreateObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var apikeyCreateObjectV2Request = new ApikeyCreateObjectV2Request(); // ApikeyCreateObjectV2Request | 

            try
            {
                // Create a new Apikey
                ApikeyCreateObjectV2Response result = apiInstance.ApikeyCreateObjectV2(apikeyCreateObjectV2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyCreateObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyCreateObjectV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create a new Apikey
    ApiResponse<ApikeyCreateObjectV2Response> response = apiInstance.ApikeyCreateObjectV2WithHttpInfo(apikeyCreateObjectV2Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyCreateObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
apikeyCreateObjectV2Request	ApikeyCreateObjectV2Request

Return type

ApikeyCreateObjectV2Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

ApikeyEditObjectV1

ApikeyEditObjectV1Response ApikeyEditObjectV1 (int pkiApikeyID, ApikeyEditObjectV1Request apikeyEditObjectV1Request)

Edit an existing Apikey

Example

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

namespace Example
{
    public class ApikeyEditObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | The unique ID of the Apikey
            var apikeyEditObjectV1Request = new ApikeyEditObjectV1Request(); // ApikeyEditObjectV1Request | 

            try
            {
                // Edit an existing Apikey
                ApikeyEditObjectV1Response result = apiInstance.ApikeyEditObjectV1(pkiApikeyID, apikeyEditObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyEditObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyEditObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Edit an existing Apikey
    ApiResponse<ApikeyEditObjectV1Response> response = apiInstance.ApikeyEditObjectV1WithHttpInfo(pkiApikeyID, apikeyEditObjectV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyEditObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int	The unique ID of the Apikey
apikeyEditObjectV1Request	ApikeyEditObjectV1Request

Return type

ApikeyEditObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ApikeyEditPermissionsV1

ApikeyEditPermissionsV1Response ApikeyEditPermissionsV1 (int pkiApikeyID, ApikeyEditPermissionsV1Request apikeyEditPermissionsV1Request)

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

Example

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

namespace Example
{
    public class ApikeyEditPermissionsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | 
            var apikeyEditPermissionsV1Request = new ApikeyEditPermissionsV1Request(); // ApikeyEditPermissionsV1Request | 

            try
            {
                // Edit multiple Permissions
                ApikeyEditPermissionsV1Response result = apiInstance.ApikeyEditPermissionsV1(pkiApikeyID, apikeyEditPermissionsV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyEditPermissionsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyEditPermissionsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Edit multiple Permissions
    ApiResponse<ApikeyEditPermissionsV1Response> response = apiInstance.ApikeyEditPermissionsV1WithHttpInfo(pkiApikeyID, apikeyEditPermissionsV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyEditPermissionsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int
apikeyEditPermissionsV1Request	ApikeyEditPermissionsV1Request

Return type

ApikeyEditPermissionsV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ApikeyGenerateDelegatedCredentialsV1

ApikeyGenerateDelegatedCredentialsV1Response ApikeyGenerateDelegatedCredentialsV1 (ApikeyGenerateDelegatedCredentialsV1Request apikeyGenerateDelegatedCredentialsV1Request)

Generate a delegated credentials

Example

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

namespace Example
{
    public class ApikeyGenerateDelegatedCredentialsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var apikeyGenerateDelegatedCredentialsV1Request = new ApikeyGenerateDelegatedCredentialsV1Request(); // ApikeyGenerateDelegatedCredentialsV1Request | 

            try
            {
                // Generate a delegated credentials
                ApikeyGenerateDelegatedCredentialsV1Response result = apiInstance.ApikeyGenerateDelegatedCredentialsV1(apikeyGenerateDelegatedCredentialsV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGenerateDelegatedCredentialsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGenerateDelegatedCredentialsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Generate a delegated credentials
    ApiResponse<ApikeyGenerateDelegatedCredentialsV1Response> response = apiInstance.ApikeyGenerateDelegatedCredentialsV1WithHttpInfo(apikeyGenerateDelegatedCredentialsV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGenerateDelegatedCredentialsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
apikeyGenerateDelegatedCredentialsV1Request	ApikeyGenerateDelegatedCredentialsV1Request

Return type

ApikeyGenerateDelegatedCredentialsV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

ApikeyGetCorsV1

ApikeyGetCorsV1Response ApikeyGetCorsV1 (int pkiApikeyID)

Retrieve an existing Apikey's cors

Example

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

namespace Example
{
    public class ApikeyGetCorsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | 

            try
            {
                // Retrieve an existing Apikey's cors
                ApikeyGetCorsV1Response result = apiInstance.ApikeyGetCorsV1(pkiApikeyID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetCorsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGetCorsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing Apikey's cors
    ApiResponse<ApikeyGetCorsV1Response> response = apiInstance.ApikeyGetCorsV1WithHttpInfo(pkiApikeyID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetCorsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int

Return type

ApikeyGetCorsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

ApikeyGetListV1

ApikeyGetListV1Response ApikeyGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Apikey list

Example

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

namespace Example
{
    public class ApikeyGetListV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var eOrderBy = "pkiApikeyID_ASC";  // string? | Specify how you want the results to be sorted (optional) 
            var iRowMax = 56;  // int? |  (optional) 
            var iRowOffset = 0;  // int? |  (optional)  (default to 0)
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 
            var sFilter = "sFilter_example";  // string? |  (optional) 

            try
            {
                // Retrieve Apikey list
                ApikeyGetListV1Response result = apiInstance.ApikeyGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGetListV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve Apikey list
    ApiResponse<ApikeyGetListV1Response> response = apiInstance.ApikeyGetListV1WithHttpInfo(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
eOrderBy	string?	Specify how you want the results to be sorted	[optional]
iRowMax	int?		[optional]
iRowOffset	int?		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage?		[optional]
sFilter	string?		[optional]

Return type

ApikeyGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

ApikeyGetObjectV2

ApikeyGetObjectV2Response ApikeyGetObjectV2 (int pkiApikeyID)

Retrieve an existing Apikey

Example

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

namespace Example
{
    public class ApikeyGetObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | The unique ID of the Apikey

            try
            {
                // Retrieve an existing Apikey
                ApikeyGetObjectV2Response result = apiInstance.ApikeyGetObjectV2(pkiApikeyID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGetObjectV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing Apikey
    ApiResponse<ApikeyGetObjectV2Response> response = apiInstance.ApikeyGetObjectV2WithHttpInfo(pkiApikeyID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int	The unique ID of the Apikey

Return type

ApikeyGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

ApikeyGetPermissionsV1

ApikeyGetPermissionsV1Response ApikeyGetPermissionsV1 (int pkiApikeyID)

Retrieve an existing Apikey's Permissions

Example

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

namespace Example
{
    public class ApikeyGetPermissionsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | 

            try
            {
                // Retrieve an existing Apikey's Permissions
                ApikeyGetPermissionsV1Response result = apiInstance.ApikeyGetPermissionsV1(pkiApikeyID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetPermissionsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGetPermissionsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing Apikey's Permissions
    ApiResponse<ApikeyGetPermissionsV1Response> response = apiInstance.ApikeyGetPermissionsV1WithHttpInfo(pkiApikeyID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetPermissionsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int

Return type

ApikeyGetPermissionsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

ApikeyGetSubnetsV1

ApikeyGetSubnetsV1Response ApikeyGetSubnetsV1 (int pkiApikeyID)

Retrieve an existing Apikey's subnets

Example

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

namespace Example
{
    public class ApikeyGetSubnetsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | 

            try
            {
                // Retrieve an existing Apikey's subnets
                ApikeyGetSubnetsV1Response result = apiInstance.ApikeyGetSubnetsV1(pkiApikeyID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetSubnetsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyGetSubnetsV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing Apikey's subnets
    ApiResponse<ApikeyGetSubnetsV1Response> response = apiInstance.ApikeyGetSubnetsV1WithHttpInfo(pkiApikeyID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyGetSubnetsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int

Return type

ApikeyGetSubnetsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

ApikeyRegenerateV1

ApikeyRegenerateV1Response ApikeyRegenerateV1 (int pkiApikeyID, ApikeyRegenerateV1Request apikeyRegenerateV1Request)

Regenerate the Apikey

Example

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

namespace Example
{
    public class ApikeyRegenerateV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            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 ObjectApikeyApi(config);
            var pkiApikeyID = 56;  // int | 
            var apikeyRegenerateV1Request = new ApikeyRegenerateV1Request(); // ApikeyRegenerateV1Request | 

            try
            {
                // Regenerate the Apikey
                ApikeyRegenerateV1Response result = apiInstance.ApikeyRegenerateV1(pkiApikeyID, apikeyRegenerateV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectApikeyApi.ApikeyRegenerateV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ApikeyRegenerateV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Regenerate the Apikey
    ApiResponse<ApikeyRegenerateV1Response> response = apiInstance.ApikeyRegenerateV1WithHttpInfo(pkiApikeyID, apikeyRegenerateV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectApikeyApi.ApikeyRegenerateV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiApikeyID	int
apikeyRegenerateV1Request	ApikeyRegenerateV1Request

Return type

ApikeyRegenerateV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

Files

ObjectApikeyApi.md

Latest commit

History

ObjectApikeyApi.md

File metadata and controls

eZmaxApi.Api.ObjectApikeyApi

ApikeyCreateObjectV2

Example

Using the ApikeyCreateObjectV2WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyEditObjectV1

Example

Using the ApikeyEditObjectV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyEditPermissionsV1

Example

Using the ApikeyEditPermissionsV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGenerateDelegatedCredentialsV1

Example

Using the ApikeyGenerateDelegatedCredentialsV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGetCorsV1

Example

Using the ApikeyGetCorsV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGetListV1

Example

Using the ApikeyGetListV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGetObjectV2

Example

Using the ApikeyGetObjectV2WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGetPermissionsV1

Example

Using the ApikeyGetPermissionsV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyGetSubnetsV1

Example

Using the ApikeyGetSubnetsV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ApikeyRegenerateV1