\AccessKeysAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
CreateAccesskey	Post /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys	Create/Upload Access Key for onprem provider region - deprecated
DeleteAccesskey	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Delete an access key
EditAccesskey	Put /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Modify the existing access Key
Index	Get /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Get an access key
List	Get /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys	List access keys for a specific provider
ListAllForCustomer	Get /api/v1/customers/{cUUID}/access_keys	List access keys for all providers of a customer

CreateAccesskey

AccessKey CreateAccesskey(ctx, cUUID, pUUID).AccessKeyFormData(accessKeyFormData).Request(request).Execute()

Create/Upload Access Key for onprem provider region - deprecated

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	accessKeyFormData := *openapiclient.NewAccessKeyFormData("KeyCode_example", "KeyContent_example", "KeyType_example") // AccessKeyFormData | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessKeysAPI.CreateAccesskey(context.Background(), cUUID, pUUID).AccessKeyFormData(accessKeyFormData).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessKeysAPI.CreateAccesskey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateAccesskey`: AccessKey
	fmt.Fprintf(os.Stdout, "Response from `AccessKeysAPI.CreateAccesskey`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
pUUID	string

Other Parameters

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

Name	Type	Description	Notes

accessKeyFormData | AccessKeyFormData | | request | interface{} | |

Return type

AccessKey

Authorization

apiKeyAuth

HTTP request headers

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

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

DeleteAccesskey

YBPSuccess DeleteAccesskey(ctx, cUUID, pUUID, keyCode).Request(request).Execute()

Delete an access key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	keyCode := "keyCode_example" // string | 
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessKeysAPI.DeleteAccesskey(context.Background(), cUUID, pUUID, keyCode).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessKeysAPI.DeleteAccesskey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteAccesskey`: YBPSuccess
	fmt.Fprintf(os.Stdout, "Response from `AccessKeysAPI.DeleteAccesskey`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
pUUID	string
keyCode	string

Other Parameters

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

Name	Type	Description	Notes

request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

EditAccesskey

AccessKey EditAccesskey(ctx, cUUID, pUUID, keyCode).Accesskey(accesskey).Request(request).Execute()

Modify the existing access Key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	keyCode := "keyCode_example" // string | 
	accesskey := *openapiclient.NewAccessKey(*openapiclient.NewAccessKeyId(), *openapiclient.NewKeyInfo()) // AccessKey | access key edit form data
	request := TODO // interface{} |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessKeysAPI.EditAccesskey(context.Background(), cUUID, pUUID, keyCode).Accesskey(accesskey).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessKeysAPI.EditAccesskey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditAccesskey`: AccessKey
	fmt.Fprintf(os.Stdout, "Response from `AccessKeysAPI.EditAccesskey`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
pUUID	string
keyCode	string

Other Parameters

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

Name	Type	Description	Notes

accesskey | AccessKey | access key edit form data | request | interface{} | |

Return type

AccessKey

Authorization

apiKeyAuth

HTTP request headers

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

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

Index

AccessKey Index(ctx, cUUID, pUUID, keyCode).Execute()

Get an access key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	keyCode := "keyCode_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
pUUID	string
keyCode	string

Other Parameters

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

Name	Type	Description	Notes

Return type

AccessKey

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

List

[]AccessKey List(ctx, cUUID, pUUID).Execute()

List access keys for a specific provider

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AccessKeysAPI.List(context.Background(), cUUID, pUUID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AccessKeysAPI.List``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `List`: []AccessKey
	fmt.Fprintf(os.Stdout, "Response from `AccessKeysAPI.List`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID	string
pUUID	string

Other Parameters

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

Name	Type	Description	Notes

Return type

[]AccessKey

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListAllForCustomer

[]AccessKey ListAllForCustomer(ctx, cUUID).Execute()

List access keys for all providers of a customer

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/yugabyte/platform-go-client/v1"
)

func main() {
	cUUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

[]AccessKey

Authorization

apiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

FilesExpand file tree

AccessKeysAPI.md

Latest commit

History

AccessKeysAPI.md

File metadata and controls

\AccessKeysAPI

CreateAccesskey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAccesskey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditAccesskey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Index

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

List

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListAllForCustomer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers