EzmaxApi::ObjectApikeyApi

Load the API package

use EzmaxApi::Object::ObjectApikeyApi;

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

Method	HTTP request	Description
apikey_create_object_v2	POST /2/object/apikey	Create a new Apikey
apikey_edit_object_v1	PUT /1/object/apikey/{pkiApikeyID}	Edit an existing Apikey
apikey_edit_permissions_v1	PUT /1/object/apikey/{pkiApikeyID}/editPermissions	Edit multiple Permissions
apikey_get_cors_v1	GET /1/object/apikey/{pkiApikeyID}/getCors	Retrieve an existing Apikey's cors
apikey_get_list_v1	GET /1/object/apikey/getList	Retrieve Apikey list
apikey_get_object_v2	GET /2/object/apikey/{pkiApikeyID}	Retrieve an existing Apikey
apikey_get_permissions_v1	GET /1/object/apikey/{pkiApikeyID}/getPermissions	Retrieve an existing Apikey's Permissions
apikey_get_subnets_v1	GET /1/object/apikey/{pkiApikeyID}/getSubnets	Retrieve an existing Apikey's subnets
apikey_regenerate_v1	POST /1/object/apikey/{pkiApikeyID}/regenerate	Regenerate the Apikey

apikey_create_object_v2

ApikeyCreateObjectV2Response apikey_create_object_v2(apikey_create_object_v2_request => $apikey_create_object_v2_request)

Create a new Apikey

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

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $apikey_create_object_v2_request = EzmaxApi::Object::ApikeyCreateObjectV2Request->new(); # ApikeyCreateObjectV2Request | 

eval {
    my $result = $api_instance->apikey_create_object_v2(apikey_create_object_v2_request => $apikey_create_object_v2_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_create_object_v2: $@\n";
}

Parameters

Name	Type	Description	Notes
apikey_create_object_v2_request	ApikeyCreateObjectV2Request

Return type

ApikeyCreateObjectV2Response

Authorization

HTTP request headers

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

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

apikey_edit_object_v1

ApikeyEditObjectV1Response apikey_edit_object_v1(pki_apikey_id => $pki_apikey_id, apikey_edit_object_v1_request => $apikey_edit_object_v1_request)

Edit an existing Apikey

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | The unique ID of the Apikey
my $apikey_edit_object_v1_request = EzmaxApi::Object::ApikeyEditObjectV1Request->new(); # ApikeyEditObjectV1Request | 

eval {
    my $result = $api_instance->apikey_edit_object_v1(pki_apikey_id => $pki_apikey_id, apikey_edit_object_v1_request => $apikey_edit_object_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_edit_object_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int	The unique ID of the Apikey
apikey_edit_object_v1_request	ApikeyEditObjectV1Request

Return type

ApikeyEditObjectV1Response

Authorization

HTTP request headers

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

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

apikey_edit_permissions_v1

ApikeyEditPermissionsV1Response apikey_edit_permissions_v1(pki_apikey_id => $pki_apikey_id, apikey_edit_permissions_v1_request => $apikey_edit_permissions_v1_request)

Edit multiple Permissions

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

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | 
my $apikey_edit_permissions_v1_request = EzmaxApi::Object::ApikeyEditPermissionsV1Request->new(); # ApikeyEditPermissionsV1Request | 

eval {
    my $result = $api_instance->apikey_edit_permissions_v1(pki_apikey_id => $pki_apikey_id, apikey_edit_permissions_v1_request => $apikey_edit_permissions_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_edit_permissions_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int
apikey_edit_permissions_v1_request	ApikeyEditPermissionsV1Request

Return type

ApikeyEditPermissionsV1Response

Authorization

HTTP request headers

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

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

apikey_get_cors_v1

ApikeyGetCorsV1Response apikey_get_cors_v1(pki_apikey_id => $pki_apikey_id)

Retrieve an existing Apikey's cors

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | 

eval {
    my $result = $api_instance->apikey_get_cors_v1(pki_apikey_id => $pki_apikey_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_get_cors_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int

Return type

ApikeyGetCorsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikey_get_list_v1

ApikeyGetListV1Response apikey_get_list_v1(e_order_by => $e_order_by, i_row_max => $i_row_max, i_row_offset => $i_row_offset, accept_language => $accept_language, s_filter => $s_filter)

Retrieve Apikey list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---|

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $e_order_by = "e_order_by_example"; # string | Specify how you want the results to be sorted
my $i_row_max = 56; # int | 
my $i_row_offset = 0; # int | 
my $accept_language = new EzmaxApi.HeaderAcceptLanguage(); # HeaderAcceptLanguage | 
my $s_filter = "s_filter_example"; # string | 

eval {
    my $result = $api_instance->apikey_get_list_v1(e_order_by => $e_order_by, i_row_max => $i_row_max, i_row_offset => $i_row_offset, accept_language => $accept_language, s_filter => $s_filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_get_list_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
e_order_by	string	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	string		[optional]

Return type

ApikeyGetListV1Response

Authorization

HTTP request headers

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

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

apikey_get_object_v2

ApikeyGetObjectV2Response apikey_get_object_v2(pki_apikey_id => $pki_apikey_id)

Retrieve an existing Apikey

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | The unique ID of the Apikey

eval {
    my $result = $api_instance->apikey_get_object_v2(pki_apikey_id => $pki_apikey_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_get_object_v2: $@\n";
}

Parameters

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

Return type

ApikeyGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikey_get_permissions_v1

ApikeyGetPermissionsV1Response apikey_get_permissions_v1(pki_apikey_id => $pki_apikey_id)

Retrieve an existing Apikey's Permissions

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | 

eval {
    my $result = $api_instance->apikey_get_permissions_v1(pki_apikey_id => $pki_apikey_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_get_permissions_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int

Return type

ApikeyGetPermissionsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikey_get_subnets_v1

ApikeyGetSubnetsV1Response apikey_get_subnets_v1(pki_apikey_id => $pki_apikey_id)

Retrieve an existing Apikey's subnets

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | 

eval {
    my $result = $api_instance->apikey_get_subnets_v1(pki_apikey_id => $pki_apikey_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_get_subnets_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int

Return type

ApikeyGetSubnetsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

apikey_regenerate_v1

ApikeyRegenerateV1Response apikey_regenerate_v1(pki_apikey_id => $pki_apikey_id, apikey_regenerate_v1_request => $apikey_regenerate_v1_request)

Regenerate the Apikey

Example

use Data::Dumper;
use EzmaxApi::ObjectApikeyApi;
my $api_instance = EzmaxApi::ObjectApikeyApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_apikey_id = 56; # int | 
my $apikey_regenerate_v1_request = EzmaxApi::Object::ApikeyRegenerateV1Request->new(); # ApikeyRegenerateV1Request | 

eval {
    my $result = $api_instance->apikey_regenerate_v1(pki_apikey_id => $pki_apikey_id, apikey_regenerate_v1_request => $apikey_regenerate_v1_request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectApikeyApi->apikey_regenerate_v1: $@\n";
}

Parameters

Name	Type	Description	Notes
pki_apikey_id	int
apikey_regenerate_v1_request	ApikeyRegenerateV1Request

Return type

ApikeyRegenerateV1Response

Authorization

HTTP request headers

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

[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::ObjectApikeyApi

Load the API package

apikey_create_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_edit_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_edit_permissions_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_get_cors_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_get_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_get_permissions_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_get_subnets_v1

Example

Parameters

Return type

Authorization

HTTP request headers

apikey_regenerate_v1

Example

Parameters

Return type

Authorization

HTTP request headers