eZmaxAPI\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
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(ctx).ApikeyCreateObjectV2Request(apikeyCreateObjectV2Request).Execute()

Create a new Apikey

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	apikeyCreateObjectV2Request := *openapiclient.NewApikeyCreateObjectV2Request([]openapiclient.ApikeyRequestCompound{*openapiclient.NewApikeyRequestCompound(int32(70), *openapiclient.NewMultilingualApikeyDescription())}) // ApikeyCreateObjectV2Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyCreateObjectV2(context.Background()).ApikeyCreateObjectV2Request(apikeyCreateObjectV2Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyCreateObjectV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyCreateObjectV2`: ApikeyCreateObjectV2Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyCreateObjectV2`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApikeyCreateObjectV2Request struct via the builder pattern

Name	Type	Description	Notes
apikeyCreateObjectV2Request	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]

ApikeyEditObjectV1

ApikeyEditObjectV1Response ApikeyEditObjectV1(ctx, pkiApikeyID).ApikeyEditObjectV1Request(apikeyEditObjectV1Request).Execute()

Edit an existing Apikey

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | The unique ID of the Apikey
	apikeyEditObjectV1Request := *openapiclient.NewApikeyEditObjectV1Request(*openapiclient.NewApikeyRequestCompound(int32(70), *openapiclient.NewMultilingualApikeyDescription())) // ApikeyEditObjectV1Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyEditObjectV1(context.Background(), pkiApikeyID).ApikeyEditObjectV1Request(apikeyEditObjectV1Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyEditObjectV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyEditObjectV1`: ApikeyEditObjectV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyEditObjectV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32	The unique ID of the Apikey

Other Parameters

Other parameters are passed through a pointer to a apiApikeyEditObjectV1Request struct via the builder pattern

Name	Type	Description	Notes

apikeyEditObjectV1Request | 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]

ApikeyEditPermissionsV1

ApikeyEditPermissionsV1Response ApikeyEditPermissionsV1(ctx, pkiApikeyID).ApikeyEditPermissionsV1Request(apikeyEditPermissionsV1Request).Execute()

Edit multiple Permissions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | 
	apikeyEditPermissionsV1Request := *openapiclient.NewApikeyEditPermissionsV1Request([]openapiclient.PermissionRequestCompound{*openapiclient.NewPermissionRequestCompound(int32(53))}) // ApikeyEditPermissionsV1Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyEditPermissionsV1(context.Background(), pkiApikeyID).ApikeyEditPermissionsV1Request(apikeyEditPermissionsV1Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyEditPermissionsV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyEditPermissionsV1`: ApikeyEditPermissionsV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyEditPermissionsV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32

Other Parameters

Other parameters are passed through a pointer to a apiApikeyEditPermissionsV1Request struct via the builder pattern

Name	Type	Description	Notes

apikeyEditPermissionsV1Request | 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]

ApikeyGetCorsV1

ApikeyGetCorsV1Response ApikeyGetCorsV1(ctx, pkiApikeyID).Execute()

Retrieve an existing Apikey's cors

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyGetCorsV1(context.Background(), pkiApikeyID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyGetCorsV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyGetCorsV1`: ApikeyGetCorsV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyGetCorsV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32

Other Parameters

Other parameters are passed through a pointer to a apiApikeyGetCorsV1Request struct via the builder pattern

Name	Type	Description	Notes

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]

ApikeyGetListV1

ApikeyGetListV1Response ApikeyGetListV1(ctx).EOrderBy(eOrderBy).IRowMax(iRowMax).IRowOffset(iRowOffset).AcceptLanguage(acceptLanguage).SFilter(sFilter).Execute()

Retrieve Apikey list

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	eOrderBy := "eOrderBy_example" // string | Specify how you want the results to be sorted (optional)
	iRowMax := int32(56) // int32 |  (optional)
	iRowOffset := int32(56) // int32 |  (optional) (default to 0)
	acceptLanguage := openapiclient.Header-Accept-Language("*") // HeaderAcceptLanguage |  (optional)
	sFilter := "sFilter_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyGetListV1(context.Background()).EOrderBy(eOrderBy).IRowMax(iRowMax).IRowOffset(iRowOffset).AcceptLanguage(acceptLanguage).SFilter(sFilter).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyGetListV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyGetListV1`: ApikeyGetListV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyGetListV1`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApikeyGetListV1Request struct via the builder pattern

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

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]

ApikeyGetObjectV2

ApikeyGetObjectV2Response ApikeyGetObjectV2(ctx, pkiApikeyID).Execute()

Retrieve an existing Apikey

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | The unique ID of the Apikey

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyGetObjectV2(context.Background(), pkiApikeyID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyGetObjectV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyGetObjectV2`: ApikeyGetObjectV2Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyGetObjectV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32	The unique ID of the Apikey

Other Parameters

Other parameters are passed through a pointer to a apiApikeyGetObjectV2Request struct via the builder pattern

Name	Type	Description	Notes

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]

ApikeyGetPermissionsV1

ApikeyGetPermissionsV1Response ApikeyGetPermissionsV1(ctx, pkiApikeyID).Execute()

Retrieve an existing Apikey's Permissions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyGetPermissionsV1(context.Background(), pkiApikeyID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyGetPermissionsV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyGetPermissionsV1`: ApikeyGetPermissionsV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyGetPermissionsV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32

Other Parameters

Other parameters are passed through a pointer to a apiApikeyGetPermissionsV1Request struct via the builder pattern

Name	Type	Description	Notes

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]

ApikeyGetSubnetsV1

ApikeyGetSubnetsV1Response ApikeyGetSubnetsV1(ctx, pkiApikeyID).Execute()

Retrieve an existing Apikey's subnets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyGetSubnetsV1(context.Background(), pkiApikeyID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyGetSubnetsV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyGetSubnetsV1`: ApikeyGetSubnetsV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyGetSubnetsV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32

Other Parameters

Other parameters are passed through a pointer to a apiApikeyGetSubnetsV1Request struct via the builder pattern

Name	Type	Description	Notes

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]

ApikeyRegenerateV1

ApikeyRegenerateV1Response ApikeyRegenerateV1(ctx, pkiApikeyID).ApikeyRegenerateV1Request(apikeyRegenerateV1Request).Execute()

Regenerate the Apikey

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiApikeyID := int32(56) // int32 | 
	apikeyRegenerateV1Request := *openapiclient.NewApikeyRegenerateV1Request() // ApikeyRegenerateV1Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectApikeyAPI.ApikeyRegenerateV1(context.Background(), pkiApikeyID).ApikeyRegenerateV1Request(apikeyRegenerateV1Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectApikeyAPI.ApikeyRegenerateV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApikeyRegenerateV1`: ApikeyRegenerateV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectApikeyAPI.ApikeyRegenerateV1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiApikeyID	int32

Other Parameters

Other parameters are passed through a pointer to a apiApikeyRegenerateV1Request struct via the builder pattern

Name	Type	Description	Notes

apikeyRegenerateV1Request | 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

ApikeyCreateObjectV2

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyEditObjectV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyEditPermissionsV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyGetCorsV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyGetListV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyGetObjectV2

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyGetPermissionsV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyGetSubnetsV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApikeyRegenerateV1

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers