Categorygithub.com/yugabyte/platform-go-client
repositorypackage
0.0.0-20240927075814-3f9ed9d72e75
Repository: https://github.com/yugabyte/platform-go-client.git
Documentation: pkg.go.dev

# README

Go API client for ywclient

ALPHA - NOT FOR EXTERNAL USE

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 2.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./ywclient"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AccessKeysApiCreateAccesskeyPost /api/v1/customers/{cUUID}/providers/{pUUID}/access_keysCreate/Upload Access Key for onprem provider region - deprecated
AccessKeysApiDeleteAccesskeyDelete /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}Delete an access key
AccessKeysApiEditAccesskeyPut /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}Modify the existing access Key
AccessKeysApiIndexGet /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}Get an access key
AccessKeysApiListGet /api/v1/customers/{cUUID}/providers/{pUUID}/access_keysList access keys for a specific provider
AccessKeysApiListAllForCustomerGet /api/v1/customers/{cUUID}/access_keysList access keys for all providers of a customer
AlertsApiAcknowledgePost /api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledgeAcknowledge an alert
AlertsApiAcknowledgeByFilterPost /api/v1/customers/{cUUID}/alerts/acknowledgeAcknowledge all alerts - deprecated
AlertsApiAlertNotificationPreviewPost /api/v1/customers/{cUUID}/alert_notification_previewPrepare alert notification preview
AlertsApiCountAlertsPost /api/v1/customers/{cUUID}/alerts/countCount alerts
AlertsApiCreateAlertChannelPost /api/v1/customers/{cUUID}/alert_channelsCreate an alert channel
AlertsApiCreateAlertConfigurationPost /api/v1/customers/{cUUID}/alert_configurationsCreate an alert configuration
AlertsApiCreateAlertDestinationPost /api/v1/customers/{cUUID}/alert_destinationsCreate an alert destination
AlertsApiDeleteAlertChannelDelete /api/v1/customers/{cUUID}/alert_channels/{acUUID}Delete an alert channel
AlertsApiDeleteAlertChannelTemplatesDelete /api/v1/customers/{cUUID}/alert_channel_templates/{acType}Delete alert channel templates
AlertsApiDeleteAlertConfigurationDelete /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}Delete an alert configuration
AlertsApiDeleteAlertDestinationDelete /api/v1/customers/{cUUID}/alert_destinations/{adUUID}Delete an alert destination
AlertsApiDeleteAlertTemplateSettingsDelete /api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}Delete an alert template settings - deprecated
AlertsApiDeleteAlertTemplateVariablesDelete /api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}Delete an alert template variables
AlertsApiEditAlertTemplateSettingsPut /api/v1/customers/{cUUID}/alert_template_settingsCreate or update alert template settings list - deprecated
AlertsApiEditAlertTemplateVariablesPut /api/v1/customers/{cUUID}/alert_template_variablesCreate or update alert template variables
AlertsApiGetGet /api/v1/customers/{cUUID}/alerts/{alertUUID}Get details of an alert
AlertsApiGetAlertChannelGet /api/v1/customers/{cUUID}/alert_channels/{acUUID}Get an alert channel
AlertsApiGetAlertChannelTemplatesGet /api/v1/customers/{cUUID}/alert_channel_templates/{acType}Get alert channel templates
AlertsApiGetAlertConfigurationGet /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}Get an alert configuration
AlertsApiGetAlertDestinationGet /api/v1/customers/{cUUID}/alert_destinations/{adUUID}Get an alert destination
AlertsApiListActiveGet /api/v1/customers/{cUUID}/alerts/activeList active alerts - deprecated
AlertsApiListAlertChannelTemplatesGet /api/v1/customers/{cUUID}/alert_channel_templatesList all alert channel templates
AlertsApiListAlertChannelsGet /api/v1/customers/{cUUID}/alert_channelsList all alert channels
AlertsApiListAlertConfigurationsPost /api/v1/customers/{cUUID}/alert_configurations/listGet filtered list of alert configurations
AlertsApiListAlertDestinationsGet /api/v1/customers/{cUUID}/alert_destinationsList alert destinations
AlertsApiListAlertTemplateSettingsGet /api/v1/customers/{cUUID}/alert_template_settingsGet alert template settings - deprecated
AlertsApiListAlertTemplateVariablesGet /api/v1/customers/{cUUID}/alert_template_variablesList alert template variables
AlertsApiListAlertTemplatesPost /api/v1/customers/{cUUID}/alert_templatesGet filtered list of alert configuration templates
AlertsApiListOfAlertsGet /api/v1/customers/{cUUID}/alertsList all alerts
AlertsApiPageAlertConfigurationsPost /api/v1/customers/{cUUID}/alert_configurations/pageList all alert configurations (paginated)
AlertsApiPageAlertsPost /api/v1/customers/{cUUID}/alerts/pageList alerts (paginated)
AlertsApiSendTestAlertPost /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alertSend test alert for alert configuration
AlertsApiSetAlertChannelTemplatesPost /api/v1/customers/{cUUID}/alert_channel_templates/{acType}Set alert channel templates
AlertsApiUpdateAlertChannelPut /api/v1/customers/{cUUID}/alert_channels/{acUUID}Update an alert channel
AlertsApiUpdateAlertConfigurationPut /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}Update an alert configuration
AlertsApiUpdateAlertDestinationPut /api/v1/customers/{cUUID}/alert_destinations/{adUUID}Update an alert destination
AsynchronousReplicationApiCreateXClusterConfigPost /api/v1/customers/{cUUID}/xcluster_configsCreate xcluster config
AsynchronousReplicationApiDeleteXClusterConfigDelete /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}Delete xcluster config
AsynchronousReplicationApiEditXClusterConfigPut /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}Edit xcluster config
AsynchronousReplicationApiGetXClusterConfigGet /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}Get xcluster config
AsynchronousReplicationApiNeedBootstrapTablePost /api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrapWhether tables need bootstrap before setting up cross cluster replication
AsynchronousReplicationApiRestartXClusterConfigPost /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}Restart xcluster config
AsynchronousReplicationApiSyncXClusterConfigPost /api/v1/customers/{cUUID}/xcluster_configs/syncSync xcluster config - deprecated
AsynchronousReplicationApiSyncXClusterConfigV2Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/syncSync xcluster config (V2)
AuditApiGetTaskAuditGet /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_infoGet audit info for a task
AuditApiGetUserFromTaskGet /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_userGet the user associated with a task
AuditApiListOfAuditGet /api/v1/customers/{cUUID}/users/{uUUID}/audit_trailList a user's audit entries
AvailabilityZonesApiCreateAZPost /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zonesCreate an availability zone - deprecated
AvailabilityZonesApiCreateZonePost /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zonesCreate an availability zone
AvailabilityZonesApiDeleteAZDelete /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}Delete an availability zone
AvailabilityZonesApiEditAZPut /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}Edit an Availabilty Zone - deprecated
AvailabilityZonesApiEditZonePut /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID}Modify an availability zone
AvailabilityZonesApiListOfAZGet /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zonesList availability zones
BackupsApiAdvancedRestorePreflightPost /api/v1/customers/{cUUID}/restore/advanced_restore_preflightAdvanced Restore Preflight checks
BackupsApiCreateBackupSchedulePost /api/v1/customers/{cUUID}/create_backup_scheduleCreate Backup Schedule - deprecated
BackupsApiCreateBackupScheduleAsyncPost /api/v1/customers/{cUUID}/create_backup_schedule_asyncCreate Backup Schedule Async
BackupsApiCreateMultiTableBackupPut /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backupCreate a multi-table backup - deprecated
BackupsApiCreateSingleTableBackupPut /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backupCreate a single-table backup - deprecated
BackupsApiCreatebackupPost /api/v1/customers/{cUUID}/backupsCreate a backup V2
BackupsApiDeleteBackupsDelete /api/v1/customers/{cUUID}/backupsDelete Backups - deprecated
BackupsApiDeleteBackupsV2Post /api/v1/customers/{cUUID}/backups/deleteDelete backups V2
BackupsApiEditBackupV2Put /api/v1/customers/{cUUID}/backups/{backupUUID}Edit a backup V2
BackupsApiFetchBackupsByTaskUUIDGet /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}List backups associated with a task
BackupsApiGetBackupV2Get /api/v1/customers/{cUUID}/backups/{backupUUID}Get Backup V2
BackupsApiGetThrottleParamsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_paramsGet throttle params from YB-Controller
BackupsApiListBackupRestoresV2Post /api/v1/customers/{cUUID}/restore/pageList Backup Restores (paginated)
BackupsApiListBackupsV2Post /api/v1/customers/{cUUID}/backups/pageList Backups (paginated) V2
BackupsApiListIncrementalBackupsGet /api/v1/customers/{cUUID}/backups/{backupUUID}/list_incrementsList Incremental backups
BackupsApiListOfBackupsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/backupsList a customer's backups - deprecated
BackupsApiListRestorableKeyspaceTablesGet /api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tablesList of all restorable entities in the incremental backup chain
BackupsApiRestorePost /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restoreRestore from a backup - deprecated
BackupsApiRestoreBackupV2Post /api/v1/customers/{cUUID}/restoreRestore from a backup V2
BackupsApiRestorePreflightPost /api/v1/customers/{cUUID}/restore/preflightRestore preflight checks
BackupsApiSetThrottleParamsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_paramsSet throttle params in YB-Controller
BackupsApiSetUniverseBackupFlagPut /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_stateSet a universe's backup flag
BackupsApiStopBackupPost /api/v1/customers/{cUUID}/backups/{backupUUID}/stopStop a backup
BackupsApiUniverseBackupPost /api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backupCreate a Universe Backup
BackupsApiValidateKeyspaceTablesToRestorePost /api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tablesValidate keyspace and tables to Restore against Backup
CertificateInfoApiDeleteCertificateDelete /api/v1/customers/{cUUID}/certificates/{rUUID}Delete a certificate
CertificateInfoApiEditCertificatePost /api/v1/customers/{cUUID}/certificates/{rUUID}/editEdit TLS certificate config details
CertificateInfoApiGetListOfCertificateGet /api/v1/customers/{cUUID}/certificatesList a customer's certificates
CertificateInfoApiGetRootCertGet /api/v1/customers/{cUUID}/certificates/{rUUID}/downloadGet a customer's root certificate
CertificateInfoApiUploadPost /api/v1/customers/{cUUID}/certificatesRestore a certificate from backup
CloudProvidersApiAccessKeyRotationPost /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotationRotate access key for a provider
CloudProvidersApiCreateProvidersPost /api/v1/customers/{cUUID}/providersCreate a provider
CloudProvidersApiDeleteDelete /api/v1/customers/{cUUID}/providers/{pUUID}Delete a cloud provider
CloudProvidersApiEditAccessKeyRotationSchedulePut /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule/{sUUID}Edit a access key rotation schedule
CloudProvidersApiEditProviderPut /api/v1/customers/{cUUID}/providers/{pUUID}/editUpdate a provider
CloudProvidersApiGetListOfProvidersGet /api/v1/customers/{cUUID}/providersList cloud providers
CloudProvidersApiGetProviderGet /api/v1/customers/{cUUID}/providers/{pUUID}Get a cloud provider
CloudProvidersApiGetRegionMetadataGet /api/v1/customers/{cUUID}/providers/region_metadata/{code}Retrieves the region metadata for the cloud providers
CloudProvidersApiListSchedulesGet /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/scheduleList all schedules for a provider's access key rotation
CloudProvidersApiRefreshPricingPut /api/v1/customers/{cUUID}/providers/{pUUID}/refresh_pricingRefresh provider pricing info
CloudProvidersApiScheduledAccessKeyRotationPost /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/scheduleRotate access key for a provider - Scheduled
CustomCACertificatesApiAddCAPost /api/v1/customers/{cUUID}/customCAStoreAdd a named custom CA certificate
CustomCACertificatesApiDeleteCustomCACertificateDelete /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}Delete a named custom CA certificate
CustomCACertificatesApiGetAllCustomCaCertificatesGet /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}Download a custom CA certificates of a customer
CustomCACertificatesApiListAllCustomCaCertificatesGet /api/v1/customers/{cUUID}/customCAStoreCertificatesList all custom CA certificates of a customer
CustomCACertificatesApiUpdateCAPost /api/v1/customers/{cUUID}/customCAStore/{certUUID}Update a named custom CA certificate
CustomerConfigurationApiCreateCustomerConfigPost /api/v1/customers/{cUUID}/configsCreate a customer configuration
CustomerConfigurationApiDeleteCustomerConfigDelete /api/v1/customers/{cUUID}/configs/{configUUID}Delete a customer configuration
CustomerConfigurationApiDeleteCustomerConfigV2Delete /api/v1/customers/{cUUID}/configs/{configUUID}/deleteDelete a customer configuration V2
CustomerConfigurationApiEditCustomerConfigPut /api/v1/customers/{cUUID}/configs/{configUUID}Update a customer configuration
CustomerConfigurationApiEditCustomerConfig_0Put /api/v1/customers/{cUUID}/configs/{configUUID}/editUpdate a customer configuration V2
CustomerConfigurationApiGetListOfCustomerConfigGet /api/v1/customers/{cUUID}/configsList all customer configurations
CustomerConfigurationApiListBucketsPost /api/v1/customers/{cUUID}/cloud/{cloud}/bucketsList buckets with provided credentials
CustomerManagementApiCustomerDetailGet /api/v1/customers/{cUUID}Get a customer's details
CustomerManagementApiDeleteCustomerDelete /api/v1/customers/{cUUID}Delete a customer
CustomerManagementApiGetHostInfoGet /api/v1/customers/{cUUID}/host_infoGet a customer's host info
CustomerManagementApiListOfCustomersGet /api/v1/customersList customers
CustomerManagementApiUpdateCustomerPut /api/v1/customers/{cUUID}Update a customer
CustomerTasksApiAbortTaskPost /api/v1/customers/{cUUID}/tasks/{tUUID}/abortAbort a task
CustomerTasksApiFailedSubtasksGet /api/v1/customers/{cUUID}/tasks/{tUUID}/failedFetch failed subtasks - deprecated
CustomerTasksApiListFailedSubtasksGet /api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasksGet a list of task's failed subtasks
CustomerTasksApiRetryTaskPost /api/v1/customers/{cUUID}/tasks/{tUUID}/retryRetry a Universe or Provider task
CustomerTasksApiTaskStatusGet /api/v1/customers/{cUUID}/tasks/{tUUID}Get a task's status
CustomerTasksApiTasksListGet /api/v1/customers/{cUUID}/tasks_listList task
DisasterRecoveryApiCreateDrConfigPost /api/v1/customers/{cUUID}/dr_configsCreate disaster recovery config
DisasterRecoveryApiDeleteXClusterConfigDelete /api/v1/customers/{cUUID}/dr_configs/{drUUID}Delete xcluster config
DisasterRecoveryApiEditDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/editEdit disaster recovery config
DisasterRecoveryApiFailoverDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/failoverFailover a disaster recovery config
DisasterRecoveryApiGetDrConfigGet /api/v1/customers/{cUUID}/dr_configs/{drUUID}Get disaster recovery config
DisasterRecoveryApiGetDrConfigSafetimeGet /api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetimeGet disaster recovery config safetime
DisasterRecoveryApiPauseDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pausePause DR config
DisasterRecoveryApiReplaceReplicaDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replicaReplace Replica in a disaster recovery config
DisasterRecoveryApiRestartDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/restartRestart disaster recovery config
DisasterRecoveryApiResumeDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resumeResume DR config
DisasterRecoveryApiSetDatabasesDrConfigPut /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbsSet databases in disaster recovery config
DisasterRecoveryApiSetTablesDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tablesSet tables in disaster recovery config
DisasterRecoveryApiSwitchoverDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchoverSwitchover a disaster recovery config
DisasterRecoveryApiSyncDrConfigPost /api/v1/customers/{cUUID}/dr_configs/{drUUID}/syncSync disaster recovery config
EncryptionAtRestApiCreateKMSConfigPost /api/v1/customers/{cUUID}/kms_configs/{kmsProvider}Create a KMS configuration
EncryptionAtRestApiDeleteKMSConfigDelete /api/v1/customers/{cUUID}/kms_configs/{configUUID}Delete a KMS configuration
EncryptionAtRestApiEditKMSConfigPost /api/v1/customers/{cUUID}/kms_configs/{configUUID}/editEdit a KMS configuration
EncryptionAtRestApiGetKMSConfigGet /api/v1/customers/{cUUID}/kms_configs/{configUUID}Get details of a KMS configuration
EncryptionAtRestApiListKMSConfigsGet /api/v1/customers/{cUUID}/kms_configsList KMS configurations
EncryptionAtRestApiRefreshKMSConfigPut /api/v1/customers/{cUUID}/kms_configs/{configUUID}/refreshRefresh KMS Config
EncryptionAtRestApiRemoveKeyRefHistoryDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/kmsThis API removes a universe's key reference history - deprecated
ExtractMetadataFromRemoteTarballApiExtractMetadataPost /api/v1/customers/{cUUID}/ybdb_release/extract_metadatahelper to extract release metadata from a remote tarball
ExtractMetadataFromRemoteTarballApiExtractMetadata_0Get /api/v1/customers/{cUUID}/ybdb_release/extract_metadata/{rUUID}get the extract release metadata from a remote tarball
GrafanaDashboardApiGrafanaDashboardGet /api/v1/grafana_dashboardGet Grafana Dashboard
InstanceTypesApiCreateInstanceTypePost /api/v1/customers/{cUUID}/providers/{pUUID}/instance_typesCreate an instance type
InstanceTypesApiDeleteInstanceTypeDelete /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}Delete an instance type
InstanceTypesApiGetAZUTypesGet /api/v1/metadata/azu_typesList supported Azure disk types
InstanceTypesApiGetEBSTypesGet /api/v1/metadata/ebs_typesList supported EBS volume types
InstanceTypesApiGetGCPTypesGet /api/v1/metadata/gcp_typesList supported GCP disk types
InstanceTypesApiInstanceTypeDetailGet /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}Get details of an instance type
InstanceTypesApiListOfInstanceTypeGet /api/v1/customers/{cUUID}/providers/{pUUID}/instance_typesList a provider's instance types
KubernetesOverridesControllerApiValidateKubernetesOverridesPost /api/v1/customers/{cUUID}/validate_kubernetes_overridesValidate kubernetes overrides.
LDAPOIDCRoleManagementApiDeleteOidcGroupMappingDelete /api/v1/customers/{cUUID}/oidc_mappings/{groupName}Delete a OIDC group mapping
LDAPOIDCRoleManagementApiListLdapDnToYbaRolesGet /api/v1/customers/{cUUID}/ldap_mappingsList LDAP Mappings
LDAPOIDCRoleManagementApiListOidcGroupToYbaRolesGet /api/v1/customers/{cUUID}/oidc_mappingsList OIDC Group Mappings
LDAPOIDCRoleManagementApiMapOidcGroupToYbaRolesPut /api/v1/customers/{cUUID}/oidc_mappingsSet OIDC Mappings
LDAPOIDCRoleManagementApiSetLdapDnToYbaRolesPut /api/v1/customers/{cUUID}/ldap_mappingsSet LDAP Mappings
LDAPRoleManagementApiSyncLdapUniversePost /api/v1/customers/{cUUID}/universes/{univUUID}/ldap_roles_syncPerform an LDAP users sync on the universe
LicenseManagementApiDeleteLicenseDelete /api/v1/customers/{cUUID}/licenses/{lUUID}Delete a license
LicenseManagementApiUploadLicensePost /api/v1/customers/{cUUID}/licensesUploads the license
LoggingConfigApiSetAuditLoggingSettingsPost /api/v1/audit_logging_configSet Audit Logging Level
LoggingConfigApiSetLoggingSettingsPost /api/v1/logging_configSet Logging Level
MaintenanceWindowsApiCreatePost /api/v1/customers/{cUUID}/maintenance_windowsCreate maintenance window
MaintenanceWindowsApiDeleteDelete /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}Delete maintenance window
MaintenanceWindowsApiGetGet /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}Get details of a maintenance window
MaintenanceWindowsApiListOfMaintenanceWindowsPost /api/v1/customers/{cUUID}/maintenance_windows/listList maintenance windows
MaintenanceWindowsApiPagePost /api/v1/customers/{cUUID}/maintenance_windows/pageList maintenance windows (paginated)
MaintenanceWindowsApiUpdatePut /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}Update maintenance window
MetricsApiMetricsDetailGet /api/v1/prometheus_metricsGet Prometheus metrics
NewReleaseManagementApiCreateNewReleasePost /api/v1/customers/{cUUID}/ybdb_releaseCreate a release
NewReleaseManagementApiDeleteNewReleaseDelete /api/v1/customers/{cUUID}/ybdb_release/{rUUID}delete a release
NewReleaseManagementApiGetNewReleaseGet /api/v1/customers/{cUUID}/ybdb_release/{rUUID}Get a release
NewReleaseManagementApiListNewReleasesGet /api/v1/customers/{cUUID}/ybdb_releaseList releases
NewReleaseManagementApiUpdateNewReleasePut /api/v1/customers/{cUUID}/ybdb_release/{rUUID}Update a release
NodeAgentsApiDownloadNodeAgentInstallerGet /api/v1/node_agents/downloadDownload Node Agent Installer or Package
NodeAgentsApiGetNodeAgentGet /api/v1/customers/{cUUID}/node_agents/{nUUID}Get Node Agent
NodeAgentsApiListNodeAgentsGet /api/v1/customers/{cUUID}/node_agentsList Node Agents
NodeAgentsApiPageListNodeAgentsPost /api/v1/customers/{cUUID}/node_agents/pageList Node Agents (paginated)
NodeAgentsApiReinstallNodeAgentPost /api/v1/customers/{cUUID}/universes/{uniUUID}/node_agentsReinstall Node Agent
NodeInstancesApiCreateNodeInstancePost /api/v1/customers/{cUUID}/zones/{azUUID}/nodesCreate a node instance
NodeInstancesApiDeleteInstanceDelete /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}Delete a node instance
NodeInstancesApiDetachedNodeActionPost /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}Detached node action
NodeInstancesApiGetNodeDetailsGet /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/detailsGet node details
NodeInstancesApiGetNodeInstanceGet /api/v1/customers/{cUUID}/nodes/{nodeUUID}/listGet a node instance
NodeInstancesApiListByProviderGet /api/v1/customers/{cUUID}/providers/{pUUID}/nodes/listList all of a provider's node instances
NodeInstancesApiListByZoneGet /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/listList all of a zone's node instances
NodeInstancesApiNodeActionPut /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}Update a node
NodeInstancesApiUpdateStatePut /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/stateUpdate node instance state
NodeInstancesApiValidateNodeInstancePost /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validateValidate a node instance
PITRManagementApiCreatePitrConfigPost /api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/pitr_configCreate pitr config for a keyspace in a universe
PITRManagementApiDeletePitrConfigDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID}Delete pitr config on a universe
PITRManagementApiListOfPitrConfigsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_configList the PITR configs of a universe
PITRManagementApiPerformPitrPost /api/v1/customers/{cUUID}/universes/{uniUUID}/pitrPerform PITR on a universe
PerformanceAdvisorApiDeleteDelete /api/v1/customers/{cUUID}/performance_recommendationsDelete performance recommendations
PerformanceAdvisorApiGetGet /api/v1/customers/{cUUID}/performance_recommendations/{rUUID}Get performance recommendation details
PerformanceAdvisorApiGetLatestRunGet /api/v1/customers/{cUUID}/universes/{uniUUID}/last_runGet last performance advisor run details
PerformanceAdvisorApiGetSettingsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settingsGet universe performance advisor settings
PerformanceAdvisorApiPagePost /api/v1/customers/{cUUID}/performance_recommendations/pageList performance recommendations (paginated)
PerformanceAdvisorApiPageAuditInfoPost /api/v1/customers/{cUUID}/performance_recommendation_state_change/pageList performance recommendations state change audit events (paginated)
PerformanceAdvisorApiRunPerfAdvisorPost /api/v1/customers/{cUUID}/universes/{uniUUID}/start_manuallyStart performance advisor run for universe
PerformanceAdvisorApiUpdateSettingsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settingsUpdate universe performance advisor settings
PreviewApiCreateImageBundlePost /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundleCreate a image bundle
PreviewApiDeleteDelete /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}Delete a image bundle
PreviewApiEditImageBundlePut /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}Update a image bundle
PreviewApiGetImageBundleGet /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}Get a image bundle
PreviewApiGetListOfImageBundlesGet /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundleList image bundles
RegionManagementApiCreateProviderRegionPost /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regionsCreate a new region
RegionManagementApiCreateRegionPost /api/v1/customers/{cUUID}/providers/{pUUID}/regionsCreate Region - deprecated
RegionManagementApiDeleteRegionDelete /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}Delete a region
RegionManagementApiEditProviderRegionPut /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}Modify a region
RegionManagementApiEditRegionPut /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}Edit regions - deprecated
RegionManagementApiGetRegionGet /api/v1/customers/{cUUID}/providers/{pUUID}/regionsList a provider's regions
RegionManagementApiListAllRegionsGet /api/v1/customers/{cUUID}/regionsList regions for all providers
ReleaseManagementApiCreateReleasePost /api/v1/customers/{cUUID}/releasesDeprecated: sinceVersion 2024.1. Use ReleasesController.create instead. Create a release
ReleaseManagementApiDeleteReleaseDelete /api/v1/customers/{cUUID}/releases/{name}Deprecated: sinceVersion: 2024.1. Use ReleasesController.delete instead. Delete a release
ReleaseManagementApiGetListOfRegionReleasesGet /api/v1/customers/{cUUID}/providers/{pUUID}/releasesList releases by provider - deprecated
ReleaseManagementApiGetListOfReleasesGet /api/v1/customers/{cUUID}/releasesDeprecated: sinceVersion: 2024.1. Use ReleasesController.list instead. List all releases
ReleaseManagementApiRefreshPut /api/v1/customers/{cUUID}/releasesRefresh a release
ReleaseManagementApiUpdateReleasePut /api/v1/customers/{cUUID}/releases/{name}Deprecated: sinceVersion: 2024.1. Use ReleasesController.update instead. Update a release
RuntimeConfigurationApiDeleteKeyDelete /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}Delete a configuration key
RuntimeConfigurationApiGetConfigGet /api/v1/customers/{cUUID}/runtime_config/{scope}List configuration entries for a scope
RuntimeConfigurationApiGetConfigurationKeyGet /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}Get a configuration key
RuntimeConfigurationApiListKeyInfoGet /api/v1/runtime_config/mutable_key_infoList mutable keys
RuntimeConfigurationApiListKeysGet /api/v1/runtime_config/mutable_keysList mutable keys
RuntimeConfigurationApiListScopesGet /api/v1/customers/{cUUID}/runtime_config/scopesList configuration scopes
RuntimeConfigurationApiSetKeyPut /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}Update a configuration key
ScheduleManagementApiDeleteBackupScheduleAsyncDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_asyncDelete a backup schedule async
ScheduleManagementApiDeleteScheduleDelete /api/v1/customers/{cUUID}/schedules/{sUUID}Delete a schedule - deprecated
ScheduleManagementApiDeleteScheduleV2Delete /api/v1/customers/{cUUID}/schedules/{sUUID}/deleteDelete a schedule V2 - deprecated
ScheduleManagementApiEditBackupScheduleAsyncPut /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_asyncEdit a backup schedule async
ScheduleManagementApiEditBackupScheduleV2Put /api/v1/customers/{cUUID}/schedules/{sUUID}Edit a backup schedule V2 - deprecated
ScheduleManagementApiGetScheduleGet /api/v1/customers/{cUUID}/schedules/{sUUID}Get Schedule
ScheduleManagementApiListSchedulesGet /api/v1/customers/{cUUID}/schedulesList schedules - deprecated
ScheduleManagementApiListSchedulesV2Post /api/v1/customers/{cUUID}/schedules/pageList schedules V2
ScheduleManagementApiToggleBackupSchedulePut /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resumeToggle a backup schedule
SessionManagementApiApiLoginPost /api/v1/api_loginAuthenticate user using email and password
SessionManagementApiApiTokenPut /api/v1/customers/{cUUID}/api_tokenRegenerate and fetch API token
SessionManagementApiAppVersionGet /api/v1/app_versionappVersion
SessionManagementApiCustomerCountGet /api/v1/customer_countcustomerCount
SessionManagementApiGetAdminNotificationsGet /api/v1/customers/{cUUID}/admin_notificationsCurrent list of notifications for admin
SessionManagementApiGetFilteredLogsGet /api/v1/logsgetFilteredLogs
SessionManagementApiGetLogsGet /api/v1/logs/{maxLines}getLogs
SessionManagementApiGetSessionInfoGet /api/v1/session_infoGet current user and customer uuid. This will not generate or return the API token, use /api_token API for that.
SessionManagementApiRegisterCustomerPost /api/v1/registerRegister a customer
SupportBundleManagementApiCreateSupportBundlePost /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundleCreate support bundle for specific universe
SupportBundleManagementApiDeleteSupportBundleDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}Delete a support bundle
SupportBundleManagementApiDownloadSupportBundleGet /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}/downloadDownload support bundle
SupportBundleManagementApiGetSupportBundleGet /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}Get a support bundle from a universe
SupportBundleManagementApiListSupportBundleGet /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundleList all support bundles from a universe
SupportBundleManagementApiListSupportBundleComponentsGet /api/v1/customers/{cUUID}/support_bundle/componentsList all components available in support bundle
UniverseActionsApiImportUniversePost /api/v1/customers/{cUUID}/universes/importImport a universe - deprecated
UniverseCDCManagementApiListReplicationSlotGet /api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_replication_slotsList CDC Replication slot for a cluster
UniverseClusterMutationsApiCreateAllClustersPost /api/v1/customers/{cUUID}/universes/clustersCreate Universe Clusters
UniverseClusterMutationsApiCreateReadOnlyClusterPost /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_onlyCreate ReadOnly Cluster
UniverseClusterMutationsApiDeleteReadonlyClusterDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only/{clustUUID}Delete Readonly Cluster
UniverseClusterMutationsApiUpdatePrimaryClusterPut /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/primaryUpdate Primary Cluster
UniverseClusterMutationsApiUpdateReadOnlyClusterPut /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_onlyUpdate Readonly Cluster
UniverseDatabaseManagementApiConfigureYCQLPost /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ycqlConfigure YCQL
UniverseDatabaseManagementApiConfigureYSQLPost /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ysqlConfigure YSQL
UniverseInformationApiDownloadNodeLogsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/{nodeName}/download_logsDownload a node's logs - deprecated
UniverseInformationApiGetLiveQueriesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/live_queriesGet live queries for a universe
UniverseInformationApiGetMasterLeaderIPGet /api/v1/customers/{cUUID}/universes/{uniUUID}/leaderGet IP address of a universe's master leader
UniverseInformationApiGetSlowQueriesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queriesGet slow queries for a universe
UniverseInformationApiGetUniverseCostGet /api/v1/customers/{cUUID}/universes/{uniUUID}/costGet a cost estimate for a universe - deprecated
UniverseInformationApiGetUniverseResourcesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/universe_resourcesGet a resource usage estimate for a universe
UniverseInformationApiHealthCheckUniverseGet /api/v1/customers/{cUUID}/universes/{uniUUID}/health_checkReturn results for the last health check
UniverseInformationApiResetSlowQueriesDelete /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queriesReset slow queries for a universe
UniverseInformationApiUniverseStatusGet /api/v1/customers/{cUUID}/universes/{uniUUID}/statusGet a universe's status
UniverseManagementApiConfigureUniverseAlertsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/config_alertsConfigure alerts for a universe
UniverseManagementApiDeleteUniverseDelete /api/v1/customers/{cUUID}/universes/{uniUUID}Delete a universe
UniverseManagementApiGetUniverseGet /api/v1/customers/{cUUID}/universes/{uniUUID}Get a universe
UniverseManagementApiListUniversesGet /api/v1/customers/{cUUID}/universesList universes
UniverseManagementApiPauseUniversePost /api/v1/customers/{cUUID}/universes/{uniUUID}/pausePause a universe
UniverseManagementApiResumeUniversePost /api/v1/customers/{cUUID}/universes/{uniUUID}/resumeResume a paused universe
UniverseManagementApiSetUniverseBackupFlagPut /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_stateSet a universe's backup flag
UniverseManagementApiSetUniverseHelm3CompatiblePut /api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatibleFlag a universe as Helm 3-compatible - deprecated
UniverseManagementApiSetUniverseKeyPost /api/v1/customers/{cUUID}/universes/{uniUUID}/set_keySet a universe's key
UniverseManagementApiUpdateLoadBalancerConfigPut /api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_configUpdate load balancer config
UniverseNodeMetadataMetamasterApiGetMasterAddressesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/mastersList a master node's addresses
UniverseNodeMetadataMetamasterApiGetRedisServerAddressesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/redisserversList a REDIS server's addresses
UniverseNodeMetadataMetamasterApiGetUniverseMasterNodesGet /metamaster/universe/{universeUUID}List a universe's master nodes
UniverseNodeMetadataMetamasterApiGetYQLServerAddressesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/yqlserversList a YQL server's addresses
UniverseNodeMetadataMetamasterApiGetYSQLServerAddressesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/ysqlserversList a YSQL server's addresses
UniversePerformanceSuggestionsApiGetQueryDistributionSuggestionsGet /api/v1/customers/{cUUID}/universes/{uniUUID}/query_distribution_suggestionsGet query distribution improvement suggestion for a universe
UniversePerformanceSuggestionsApiGetRangeHashGet /api/v1/customers/{cUUID}/universes/{uniUUID}/range_hashReturn list of hash indexes
UniversePerformanceSuggestionsApiGetUnusedIndexesGet /api/v1/customers/{cUUID}/universes/{uniUUID}/unused_indexesReturn list of each unused index across the universe
UniverseUpgradesManagementApiFinalizeUpgradePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalizeFinalize Upgrade
UniverseUpgradesManagementApiPreFinalizeSoftwareUpgradeInfoGet /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize/infoFinalize Software Upgrade info
UniverseUpgradesManagementApiRebootUniversePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rebootReboot universe
UniverseUpgradesManagementApiResizeNodePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/resize_nodeResize Node
UniverseUpgradesManagementApiRestartUniversePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/restartRestart Universe
UniverseUpgradesManagementApiRollbackUpgradePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rollbackRollback Upgrade
UniverseUpgradesManagementApiSoftwareUpgradePreCheckPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheckSoftware Upgrade universe pre-check
UniverseUpgradesManagementApiUpdateProxyConfigPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/proxy_configUpdate Proxy Config
UniverseUpgradesManagementApiUpgradeCertsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/certsUpgrade Certs
UniverseUpgradesManagementApiUpgradeDBVersionPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/db_versionUpgrade DB version
UniverseUpgradesManagementApiUpgradeGFlagsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/gflagsUpgrade GFlags
UniverseUpgradesManagementApiUpgradeKubernetesOverridesPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/kubernetes_overridesUpgrade KubernetesOverrides
UniverseUpgradesManagementApiUpgradeSoftwarePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/softwareUpgrade Software
UniverseUpgradesManagementApiUpgradeSystemdPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/systemdUpgrade Systemd
UniverseUpgradesManagementApiUpgradeThirdpartySoftwarePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/thirdparty_softwareUpgrade third-party software
UniverseUpgradesManagementApiUpgradeTlsPost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/tlsUpgrade TLS
UniverseUpgradesManagementApiUpgradeVMImagePost /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/vmUpgrade VM Image
UploadReleasePackagesApiGetUploadReleaseGet /api/v1/customers/{cUUID}/ybdb_release/upload/{rUUID}get an uploaded release metadata
UploadReleasePackagesApiUploadReleasePost /api/v1/customers/{cUUID}/ybdb_release/uploadupload a release tgz
UserManagementApiChangePasswordPut /api/v1/customers/{cUUID}/users/{uUUID}/change_passwordChange password - deprecated
UserManagementApiCreateUserPost /api/v1/customers/{cUUID}/usersCreate a user
UserManagementApiDeleteUserDelete /api/v1/customers/{cUUID}/users/{uUUID}Delete a user
UserManagementApiGetUserDetailsGet /api/v1/customers/{cUUID}/users/{uUUID}Get a user's details
UserManagementApiListUsersGet /api/v1/customers/{cUUID}/usersList all users
UserManagementApiResetUserPasswordPut /api/v1/customers/{cUUID}/reset_passwordReset the user's password
UserManagementApiRetrieveOIDCAuthTokenGet /api/v1/customers/{cUUID}/users/{uUUID}/oidc_auth_tokenRetrieve OIDC auth token
UserManagementApiUpdateUserProfilePut /api/v1/customers/{cUUID}/users/{uUUID}/update_profileUpdate a user's profile
UserManagementApiUpdateUserRolePut /api/v1/customers/{cUUID}/users/{uUUID}Change a user's role

Documentation For Models

Documentation For Authorization

apiKeyAuth

  • Type: API key
  • API key parameter name: X-AUTH-YW-API-TOKEN
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-AUTH-YW-API-TOKEN and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author