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

Class	Method	HTTP request	Description
AccessKeysApi	CreateAccesskey	Post /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys	Create/Upload Access Key for onprem provider region - deprecated
AccessKeysApi	DeleteAccesskey	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Delete an access key
AccessKeysApi	EditAccesskey	Put /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Modify the existing access Key
AccessKeysApi	Index	Get /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}	Get an access key
AccessKeysApi	List	Get /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys	List access keys for a specific provider
AccessKeysApi	ListAllForCustomer	Get /api/v1/customers/{cUUID}/access_keys	List access keys for all providers of a customer
AlertsApi	Acknowledge	Post /api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge	Acknowledge an alert
AlertsApi	AcknowledgeByFilter	Post /api/v1/customers/{cUUID}/alerts/acknowledge	Acknowledge all alerts - deprecated
AlertsApi	AlertNotificationPreview	Post /api/v1/customers/{cUUID}/alert_notification_preview	Prepare alert notification preview
AlertsApi	CountAlerts	Post /api/v1/customers/{cUUID}/alerts/count	Count alerts
AlertsApi	CreateAlertChannel	Post /api/v1/customers/{cUUID}/alert_channels	Create an alert channel
AlertsApi	CreateAlertConfiguration	Post /api/v1/customers/{cUUID}/alert_configurations	Create an alert configuration
AlertsApi	CreateAlertDestination	Post /api/v1/customers/{cUUID}/alert_destinations	Create an alert destination
AlertsApi	DeleteAlertChannel	Delete /api/v1/customers/{cUUID}/alert_channels/{acUUID}	Delete an alert channel
AlertsApi	DeleteAlertChannelTemplates	Delete /api/v1/customers/{cUUID}/alert_channel_templates/{acType}	Delete alert channel templates
AlertsApi	DeleteAlertConfiguration	Delete /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}	Delete an alert configuration
AlertsApi	DeleteAlertDestination	Delete /api/v1/customers/{cUUID}/alert_destinations/{adUUID}	Delete an alert destination
AlertsApi	DeleteAlertTemplateSettings	Delete /api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}	Delete an alert template settings - deprecated
AlertsApi	DeleteAlertTemplateVariables	Delete /api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}	Delete an alert template variables
AlertsApi	EditAlertTemplateSettings	Put /api/v1/customers/{cUUID}/alert_template_settings	Create or update alert template settings list - deprecated
AlertsApi	EditAlertTemplateVariables	Put /api/v1/customers/{cUUID}/alert_template_variables	Create or update alert template variables
AlertsApi	Get	Get /api/v1/customers/{cUUID}/alerts/{alertUUID}	Get details of an alert
AlertsApi	GetAlertChannel	Get /api/v1/customers/{cUUID}/alert_channels/{acUUID}	Get an alert channel
AlertsApi	GetAlertChannelTemplates	Get /api/v1/customers/{cUUID}/alert_channel_templates/{acType}	Get alert channel templates
AlertsApi	GetAlertConfiguration	Get /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}	Get an alert configuration
AlertsApi	GetAlertDestination	Get /api/v1/customers/{cUUID}/alert_destinations/{adUUID}	Get an alert destination
AlertsApi	ListActive	Get /api/v1/customers/{cUUID}/alerts/active	List active alerts - deprecated
AlertsApi	ListAlertChannelTemplates	Get /api/v1/customers/{cUUID}/alert_channel_templates	List all alert channel templates
AlertsApi	ListAlertChannels	Get /api/v1/customers/{cUUID}/alert_channels	List all alert channels
AlertsApi	ListAlertConfigurations	Post /api/v1/customers/{cUUID}/alert_configurations/list	Get filtered list of alert configurations
AlertsApi	ListAlertDestinations	Get /api/v1/customers/{cUUID}/alert_destinations	List alert destinations
AlertsApi	ListAlertTemplateSettings	Get /api/v1/customers/{cUUID}/alert_template_settings	Get alert template settings - deprecated
AlertsApi	ListAlertTemplateVariables	Get /api/v1/customers/{cUUID}/alert_template_variables	List alert template variables
AlertsApi	ListAlertTemplates	Post /api/v1/customers/{cUUID}/alert_templates	Get filtered list of alert configuration templates
AlertsApi	ListOfAlerts	Get /api/v1/customers/{cUUID}/alerts	List all alerts
AlertsApi	PageAlertConfigurations	Post /api/v1/customers/{cUUID}/alert_configurations/page	List all alert configurations (paginated)
AlertsApi	PageAlerts	Post /api/v1/customers/{cUUID}/alerts/page	List alerts (paginated)
AlertsApi	SendTestAlert	Post /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert	Send test alert for alert configuration
AlertsApi	SetAlertChannelTemplates	Post /api/v1/customers/{cUUID}/alert_channel_templates/{acType}	Set alert channel templates
AlertsApi	UpdateAlertChannel	Put /api/v1/customers/{cUUID}/alert_channels/{acUUID}	Update an alert channel
AlertsApi	UpdateAlertConfiguration	Put /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}	Update an alert configuration
AlertsApi	UpdateAlertDestination	Put /api/v1/customers/{cUUID}/alert_destinations/{adUUID}	Update an alert destination
AsynchronousReplicationApi	CreateXClusterConfig	Post /api/v1/customers/{cUUID}/xcluster_configs	Create xcluster config
AsynchronousReplicationApi	DeleteXClusterConfig	Delete /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}	Delete xcluster config
AsynchronousReplicationApi	EditXClusterConfig	Put /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}	Edit xcluster config
AsynchronousReplicationApi	GetXClusterConfig	Get /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}	Get xcluster config
AsynchronousReplicationApi	NeedBootstrapTable	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrap	Whether tables need bootstrap before setting up cross cluster replication
AsynchronousReplicationApi	RestartXClusterConfig	Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}	Restart xcluster config
AsynchronousReplicationApi	SyncXClusterConfig	Post /api/v1/customers/{cUUID}/xcluster_configs/sync	Sync xcluster config - deprecated
AsynchronousReplicationApi	SyncXClusterConfigV2	Post /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/sync	Sync xcluster config (V2)
AuditApi	GetTaskAudit	Get /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_info	Get audit info for a task
AuditApi	GetUserFromTask	Get /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_user	Get the user associated with a task
AuditApi	ListOfAudit	Get /api/v1/customers/{cUUID}/users/{uUUID}/audit_trail	List a user's audit entries
AvailabilityZonesApi	CreateAZ	Post /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones	Create an availability zone - deprecated
AvailabilityZonesApi	CreateZone	Post /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones	Create an availability zone
AvailabilityZonesApi	DeleteAZ	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}	Delete an availability zone
AvailabilityZonesApi	EditAZ	Put /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}	Edit an Availabilty Zone - deprecated
AvailabilityZonesApi	EditZone	Put /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID}	Modify an availability zone
AvailabilityZonesApi	ListOfAZ	Get /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones	List availability zones
BackupsApi	AdvancedRestorePreflight	Post /api/v1/customers/{cUUID}/restore/advanced_restore_preflight	Advanced Restore Preflight checks
BackupsApi	CreateBackupSchedule	Post /api/v1/customers/{cUUID}/create_backup_schedule	Create Backup Schedule - deprecated
BackupsApi	CreateBackupScheduleAsync	Post /api/v1/customers/{cUUID}/create_backup_schedule_async	Create Backup Schedule Async
BackupsApi	CreateMultiTableBackup	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup	Create a multi-table backup - deprecated
BackupsApi	CreateSingleTableBackup	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup	Create a single-table backup - deprecated
BackupsApi	Createbackup	Post /api/v1/customers/{cUUID}/backups	Create a backup V2
BackupsApi	DeleteBackups	Delete /api/v1/customers/{cUUID}/backups	Delete Backups - deprecated
BackupsApi	DeleteBackupsV2	Post /api/v1/customers/{cUUID}/backups/delete	Delete backups V2
BackupsApi	EditBackupV2	Put /api/v1/customers/{cUUID}/backups/{backupUUID}	Edit a backup V2
BackupsApi	FetchBackupsByTaskUUID	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}	List backups associated with a task
BackupsApi	GetBackupV2	Get /api/v1/customers/{cUUID}/backups/{backupUUID}	Get Backup V2
BackupsApi	GetThrottleParams	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params	Get throttle params from YB-Controller
BackupsApi	ListBackupRestoresV2	Post /api/v1/customers/{cUUID}/restore/page	List Backup Restores (paginated)
BackupsApi	ListBackupsV2	Post /api/v1/customers/{cUUID}/backups/page	List Backups (paginated) V2
BackupsApi	ListIncrementalBackups	Get /api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments	List Incremental backups
BackupsApi	ListOfBackups	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/backups	List a customer's backups - deprecated
BackupsApi	ListRestorableKeyspaceTables	Get /api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables	List of all restorable entities in the incremental backup chain
BackupsApi	Restore	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restore	Restore from a backup - deprecated
BackupsApi	RestoreBackupV2	Post /api/v1/customers/{cUUID}/restore	Restore from a backup V2
BackupsApi	RestorePreflight	Post /api/v1/customers/{cUUID}/restore/preflight	Restore preflight checks
BackupsApi	SetThrottleParams	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params	Set throttle params in YB-Controller
BackupsApi	SetUniverseBackupFlag	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state	Set a universe's backup flag
BackupsApi	StopBackup	Post /api/v1/customers/{cUUID}/backups/{backupUUID}/stop	Stop a backup
BackupsApi	UniverseBackup	Post /api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup	Create a Universe Backup
BackupsApi	ValidateKeyspaceTablesToRestore	Post /api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables	Validate keyspace and tables to Restore against Backup
CertificateInfoApi	DeleteCertificate	Delete /api/v1/customers/{cUUID}/certificates/{rUUID}	Delete a certificate
CertificateInfoApi	EditCertificate	Post /api/v1/customers/{cUUID}/certificates/{rUUID}/edit	Edit TLS certificate config details
CertificateInfoApi	GetClientCert	Post /api/v1/customers/{cUUID}/certificates/{rUUID}	Add a client certificate
CertificateInfoApi	GetListOfCertificate	Get /api/v1/customers/{cUUID}/certificates	List a customer's certificates
CertificateInfoApi	GetRootCert	Get /api/v1/customers/{cUUID}/certificates/{rUUID}/download	Get a customer's root certificate
CertificateInfoApi	Upload	Post /api/v1/customers/{cUUID}/certificates	Restore a certificate from backup
CloudProvidersApi	AccessKeyRotation	Post /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation	Rotate access key for a provider
CloudProvidersApi	CreateProviders	Post /api/v1/customers/{cUUID}/providers	Create a provider
CloudProvidersApi	Delete	Delete /api/v1/customers/{cUUID}/providers/{pUUID}	Delete a cloud provider
CloudProvidersApi	EditAccessKeyRotationSchedule	Put /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule/{sUUID}	Edit a access key rotation schedule
CloudProvidersApi	EditProvider	Put /api/v1/customers/{cUUID}/providers/{pUUID}/edit	Update a provider
CloudProvidersApi	GetListOfProviders	Get /api/v1/customers/{cUUID}/providers	List cloud providers
CloudProvidersApi	GetProvider	Get /api/v1/customers/{cUUID}/providers/{pUUID}	Get a cloud provider
CloudProvidersApi	GetRegionMetadata	Get /api/v1/customers/{cUUID}/providers/region_metadata/{code}	Retrieves the region metadata for the cloud providers
CloudProvidersApi	ListSchedules	Get /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule	List all schedules for a provider's access key rotation
CloudProvidersApi	RefreshPricing	Put /api/v1/customers/{cUUID}/providers/{pUUID}/refresh_pricing	Refresh provider pricing info
CloudProvidersApi	ScheduledAccessKeyRotation	Post /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule	Rotate access key for a provider - Scheduled
CustomCACertificatesApi	AddCA	Post /api/v1/customers/{cUUID}/customCAStore	Add a named custom CA certificate
CustomCACertificatesApi	DeleteCustomCACertificate	Delete /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}	Delete a named custom CA certificate
CustomCACertificatesApi	GetAllCustomCaCertificates	Get /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}	Download a custom CA certificates of a customer
CustomCACertificatesApi	ListAllCustomCaCertificates	Get /api/v1/customers/{cUUID}/customCAStoreCertificates	List all custom CA certificates of a customer
CustomCACertificatesApi	UpdateCA	Post /api/v1/customers/{cUUID}/customCAStore/{certUUID}	Update a named custom CA certificate
CustomerConfigurationApi	CreateCustomerConfig	Post /api/v1/customers/{cUUID}/configs	Create a customer configuration
CustomerConfigurationApi	DeleteCustomerConfig	Delete /api/v1/customers/{cUUID}/configs/{configUUID}	Delete a customer configuration
CustomerConfigurationApi	DeleteCustomerConfigV2	Delete /api/v1/customers/{cUUID}/configs/{configUUID}/delete	Delete a customer configuration V2
CustomerConfigurationApi	EditCustomerConfig	Put /api/v1/customers/{cUUID}/configs/{configUUID}	Update a customer configuration
CustomerConfigurationApi	EditCustomerConfig_0	Put /api/v1/customers/{cUUID}/configs/{configUUID}/edit	Update a customer configuration V2
CustomerConfigurationApi	GetListOfCustomerConfig	Get /api/v1/customers/{cUUID}/configs	List all customer configurations
CustomerConfigurationApi	ListBuckets	Post /api/v1/customers/{cUUID}/cloud/{cloud}/buckets	List buckets with provided credentials
CustomerManagementApi	CustomerDetail	Get /api/v1/customers/{cUUID}	Get a customer's details
CustomerManagementApi	DeleteCustomer	Delete /api/v1/customers/{cUUID}	Delete a customer
CustomerManagementApi	GetHostInfo	Get /api/v1/customers/{cUUID}/host_info	Get a customer's host info
CustomerManagementApi	ListOfCustomers	Get /api/v1/customers	List customers
CustomerManagementApi	UpdateCustomer	Put /api/v1/customers/{cUUID}	Update a customer
CustomerTasksApi	AbortTask	Post /api/v1/customers/{cUUID}/tasks/{tUUID}/abort	Abort a task
CustomerTasksApi	FailedSubtasks	Get /api/v1/customers/{cUUID}/tasks/{tUUID}/failed	Fetch failed subtasks - deprecated
CustomerTasksApi	ListFailedSubtasks	Get /api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks	Get a list of task's failed subtasks
CustomerTasksApi	RetryTask	Post /api/v1/customers/{cUUID}/tasks/{tUUID}/retry	Retry a Universe or Provider task
CustomerTasksApi	TaskStatus	Get /api/v1/customers/{cUUID}/tasks/{tUUID}	Get a task's status
CustomerTasksApi	TasksList	Get /api/v1/customers/{cUUID}/tasks_list	List task
DisasterRecoveryApi	CreateDrConfig	Post /api/v1/customers/{cUUID}/dr_configs	Create disaster recovery config
DisasterRecoveryApi	DeleteXClusterConfig	Delete /api/v1/customers/{cUUID}/dr_configs/{drUUID}	Delete xcluster config
DisasterRecoveryApi	EditDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit	Edit disaster recovery config
DisasterRecoveryApi	FailoverDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover	Failover a disaster recovery config
DisasterRecoveryApi	GetDrConfig	Get /api/v1/customers/{cUUID}/dr_configs/{drUUID}	Get disaster recovery config
DisasterRecoveryApi	GetDrConfigSafetime	Get /api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime	Get disaster recovery config safetime
DisasterRecoveryApi	PauseDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause	Pause DR config
DisasterRecoveryApi	PauseDrUniverses	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes	Pause DR config and universes associated with DR
DisasterRecoveryApi	ReplaceReplicaDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica	Replace Replica in a disaster recovery config
DisasterRecoveryApi	RestartDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart	Restart disaster recovery config
DisasterRecoveryApi	ResumeDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume	Resume DR config
DisasterRecoveryApi	ResumeDrUniverses	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes	Resume DR config and universes associated with DR
DisasterRecoveryApi	SetDatabasesDrConfig	Put /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs	Set databases in disaster recovery config
DisasterRecoveryApi	SetTablesDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables	Set tables in disaster recovery config
DisasterRecoveryApi	SwitchoverDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover	Switchover a disaster recovery config
DisasterRecoveryApi	SyncDrConfig	Post /api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync	Sync disaster recovery config
EncryptionAtRestApi	CreateKMSConfig	Post /api/v1/customers/{cUUID}/kms_configs/{kmsProvider}	Create a KMS configuration
EncryptionAtRestApi	DeleteKMSConfig	Delete /api/v1/customers/{cUUID}/kms_configs/{configUUID}	Delete a KMS configuration
EncryptionAtRestApi	EditKMSConfig	Post /api/v1/customers/{cUUID}/kms_configs/{configUUID}/edit	Edit a KMS configuration
EncryptionAtRestApi	GetKMSConfig	Get /api/v1/customers/{cUUID}/kms_configs/{configUUID}	Get details of a KMS configuration
EncryptionAtRestApi	ListKMSConfigs	Get /api/v1/customers/{cUUID}/kms_configs	List KMS configurations
EncryptionAtRestApi	RefreshKMSConfig	Put /api/v1/customers/{cUUID}/kms_configs/{configUUID}/refresh	Refresh KMS Config
EncryptionAtRestApi	RemoveKeyRefHistory	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/kms	This API removes a universe's key reference history - deprecated
ExtractMetadataFromRemoteTarballApi	ExtractMetadata	Post /api/v1/customers/{cUUID}/ybdb_release/extract_metadata	helper to extract release metadata from a remote tarball
ExtractMetadataFromRemoteTarballApi	ExtractMetadata_0	Get /api/v1/customers/{cUUID}/ybdb_release/extract_metadata/{rUUID}	get the extract release metadata from a remote tarball
GFlagsValidationAPIsApi	GetGFlagMetadata	Get /api/v1/metadata/version/{version}/gflag	Get gflag metadata
GFlagsValidationAPIsApi	ListGFlags	Get /api/v1/metadata/version/{version}/list_gflags	List all gflags for a release
GFlagsValidationAPIsApi	ValidateGFlags	Post /api/v1/metadata/version/{version}/validate_gflags	Validate gflags
GrafanaDashboardApi	GrafanaDashboard	Get /api/v1/grafana_dashboard	Get Grafana Dashboard
InstanceTypesApi	CreateInstanceType	Post /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types	Create an instance type
InstanceTypesApi	DeleteInstanceType	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}	Delete an instance type
InstanceTypesApi	GetAZUTypes	Get /api/v1/metadata/azu_types	List supported Azure disk types
InstanceTypesApi	GetEBSTypes	Get /api/v1/metadata/ebs_types	List supported EBS volume types
InstanceTypesApi	GetGCPTypes	Get /api/v1/metadata/gcp_types	List supported GCP disk types
InstanceTypesApi	InstanceTypeDetail	Get /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}	Get details of an instance type
InstanceTypesApi	ListOfInstanceType	Get /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types	List a provider's instance types
KubernetesOverridesControllerApi	ValidateKubernetesOverrides	Post /api/v1/customers/{cUUID}/validate_kubernetes_overrides	Validate kubernetes overrides.
LDAPOIDCRoleManagementApi	DeleteOidcGroupMapping	Delete /api/v1/customers/{cUUID}/oidc_mappings/{groupName}	Delete a OIDC group mapping
LDAPOIDCRoleManagementApi	ListLdapDnToYbaRoles	Get /api/v1/customers/{cUUID}/ldap_mappings	List LDAP Mappings
LDAPOIDCRoleManagementApi	ListOidcGroupToYbaRoles	Get /api/v1/customers/{cUUID}/oidc_mappings	List OIDC Group Mappings
LDAPOIDCRoleManagementApi	MapOidcGroupToYbaRoles	Put /api/v1/customers/{cUUID}/oidc_mappings	Set OIDC Mappings
LDAPOIDCRoleManagementApi	SetLdapDnToYbaRoles	Put /api/v1/customers/{cUUID}/ldap_mappings	Set LDAP Mappings
LDAPRoleManagementApi	SyncLdapUniverse	Post /api/v1/customers/{cUUID}/universes/{univUUID}/ldap_roles_sync	Perform an LDAP users sync on the universe
LicenseManagementApi	DeleteLicense	Delete /api/v1/customers/{cUUID}/licenses/{lUUID}	Delete a license
LicenseManagementApi	UploadLicense	Post /api/v1/customers/{cUUID}/licenses	Uploads the license
LoggingConfigApi	SetAuditLoggingSettings	Post /api/v1/audit_logging_config	Set Audit Logging Level
LoggingConfigApi	SetLoggingSettings	Post /api/v1/logging_config	Set Logging Level
MaintenanceWindowsApi	Create	Post /api/v1/customers/{cUUID}/maintenance_windows	Create maintenance window
MaintenanceWindowsApi	Delete	Delete /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}	Delete maintenance window
MaintenanceWindowsApi	Get	Get /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}	Get details of a maintenance window
MaintenanceWindowsApi	ListOfMaintenanceWindows	Post /api/v1/customers/{cUUID}/maintenance_windows/list	List maintenance windows
MaintenanceWindowsApi	Page	Post /api/v1/customers/{cUUID}/maintenance_windows/page	List maintenance windows (paginated)
MaintenanceWindowsApi	Update	Put /api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}	Update maintenance window
MetricsApi	MetricsDetail	Get /api/v1/prometheus_metrics	Get Prometheus metrics
NewReleaseManagementApi	CreateNewRelease	Post /api/v1/customers/{cUUID}/ybdb_release	Create a release
NewReleaseManagementApi	DeleteNewRelease	Delete /api/v1/customers/{cUUID}/ybdb_release/{rUUID}	delete a release
NewReleaseManagementApi	GetNewRelease	Get /api/v1/customers/{cUUID}/ybdb_release/{rUUID}	Get a release
NewReleaseManagementApi	ListNewReleases	Get /api/v1/customers/{cUUID}/ybdb_release	List releases
NewReleaseManagementApi	UpdateNewRelease	Put /api/v1/customers/{cUUID}/ybdb_release/{rUUID}	Update a release
NodeAgentsApi	DownloadNodeAgentInstaller	Get /api/v1/node_agents/download	Download Node Agent Installer or Package
NodeAgentsApi	GetNodeAgent	Get /api/v1/customers/{cUUID}/node_agents/{nUUID}	Get Node Agent
NodeAgentsApi	ListNodeAgents	Get /api/v1/customers/{cUUID}/node_agents	List Node Agents
NodeAgentsApi	PageListNodeAgents	Post /api/v1/customers/{cUUID}/node_agents/page	List Node Agents (paginated)
NodeAgentsApi	ReinstallNodeAgent	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/node_agents	Reinstall Node Agent
NodeInstancesApi	CreateNodeInstance	Post /api/v1/customers/{cUUID}/zones/{azUUID}/nodes	Create a node instance
NodeInstancesApi	DeleteInstance	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}	Delete a node instance
NodeInstancesApi	DetachedNodeAction	Post /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}	Detached node action
NodeInstancesApi	GetNodeDetails	Get /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/details	Get node details
NodeInstancesApi	GetNodeInstance	Get /api/v1/customers/{cUUID}/nodes/{nodeUUID}/list	Get a node instance
NodeInstancesApi	ListByProvider	Get /api/v1/customers/{cUUID}/providers/{pUUID}/nodes/list	List all of a provider's node instances
NodeInstancesApi	ListByZone	Get /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/list	List all of a zone's node instances
NodeInstancesApi	NodeAction	Put /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}	Update a node
NodeInstancesApi	UpdateState	Put /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/state	Update node instance state
NodeInstancesApi	ValidateNodeInstance	Post /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validate	Validate a node instance
PITRManagementApi	CreatePitrConfig	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/pitr_config	Create pitr config for a keyspace in a universe
PITRManagementApi	DeletePitrConfig	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID}	Delete pitr config on a universe
PITRManagementApi	ListOfPitrConfigs	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config	List the PITR configs of a universe
PITRManagementApi	PerformPitr	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr	Perform PITR on a universe
PerformanceAdvisorApi	Delete	Delete /api/v1/customers/{cUUID}/performance_recommendations	Delete performance recommendations
PerformanceAdvisorApi	Get	Get /api/v1/customers/{cUUID}/performance_recommendations/{rUUID}	Get performance recommendation details
PerformanceAdvisorApi	GetLatestRun	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/last_run	Get last performance advisor run details
PerformanceAdvisorApi	GetSettings	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings	Get universe performance advisor settings
PerformanceAdvisorApi	Page	Post /api/v1/customers/{cUUID}/performance_recommendations/page	List performance recommendations (paginated)
PerformanceAdvisorApi	PageAuditInfo	Post /api/v1/customers/{cUUID}/performance_recommendation_state_change/page	List performance recommendations state change audit events (paginated)
PerformanceAdvisorApi	RunPerfAdvisor	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/start_manually	Start performance advisor run for universe
PerformanceAdvisorApi	UpdateSettings	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings	Update universe performance advisor settings
PreviewApi	CreateImageBundle	Post /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle	Create a image bundle
PreviewApi	Delete	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}	Delete a image bundle
PreviewApi	EditImageBundle	Put /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}	Update a image bundle
PreviewApi	GetImageBundle	Get /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle/{iBUUID}	Get a image bundle
PreviewApi	GetListOfImageBundles	Get /api/v1/customers/{cUUID}/providers/{pUUID}/image_bundle	List image bundles
RBACManagementApi	CreateRole	Post /api/v1/customers/{cUUID}/rbac/role	Create a custom role
RBACManagementApi	DeleteRole	Delete /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Delete a custom role
RBACManagementApi	EditRole	Put /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Edit a custom role
RBACManagementApi	GetRole	Get /api/v1/customers/{cUUID}/rbac/role/{rUUID}	Get a role's information
RBACManagementApi	GetRoleBindings	Get /api/v1/customers/{cUUID}/rbac/role_binding	Get all the role bindings available
RBACManagementApi	ListPermissions	Get /api/v1/customers/{cUUID}/rbac/permissions	List all the permissions available
RBACManagementApi	ListRoles	Get /api/v1/customers/{cUUID}/rbac/role	List all the roles available
RBACManagementApi	SetRoleBinding	Post /api/v1/customers/{cUUID}/rbac/role_binding/{userUUID}	Set the role bindings of a user
RegionManagementApi	CreateProviderRegion	Post /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions	Create a new region
RegionManagementApi	CreateRegion	Post /api/v1/customers/{cUUID}/providers/{pUUID}/regions	Create Region - deprecated
RegionManagementApi	DeleteRegion	Delete /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}	Delete a region
RegionManagementApi	EditProviderRegion	Put /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}	Modify a region
RegionManagementApi	EditRegion	Put /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}	Edit regions - deprecated
RegionManagementApi	GetRegion	Get /api/v1/customers/{cUUID}/providers/{pUUID}/regions	List a provider's regions
RegionManagementApi	ListAllRegions	Get /api/v1/customers/{cUUID}/regions	List regions for all providers
ReleaseManagementApi	CreateRelease	Post /api/v1/customers/{cUUID}/releases	Deprecated: sinceVersion 2024.1. Use ReleasesController.create instead. Create a release
ReleaseManagementApi	DeleteRelease	Delete /api/v1/customers/{cUUID}/releases/{name}	Deprecated: sinceVersion: 2024.1. Use ReleasesController.delete instead. Delete a release
ReleaseManagementApi	GetListOfRegionReleases	Get /api/v1/customers/{cUUID}/providers/{pUUID}/releases	List releases by provider - deprecated
ReleaseManagementApi	GetListOfReleases	Get /api/v1/customers/{cUUID}/releases	Deprecated: sinceVersion: 2024.1. Use ReleasesController.list instead. List all releases
ReleaseManagementApi	Refresh	Put /api/v1/customers/{cUUID}/releases	Refresh a release
ReleaseManagementApi	UpdateRelease	Put /api/v1/customers/{cUUID}/releases/{name}	Deprecated: sinceVersion: 2024.1. Use ReleasesController.update instead. Update a release
RuntimeConfigurationApi	DeleteKey	Delete /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}	Delete a configuration key
RuntimeConfigurationApi	GetConfig	Get /api/v1/customers/{cUUID}/runtime_config/{scope}	List configuration entries for a scope
RuntimeConfigurationApi	GetConfigurationKey	Get /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}	Get a configuration key
RuntimeConfigurationApi	ListKeyInfo	Get /api/v1/runtime_config/mutable_key_info	List mutable keys
RuntimeConfigurationApi	ListKeys	Get /api/v1/runtime_config/mutable_keys	List mutable keys
RuntimeConfigurationApi	ListScopes	Get /api/v1/customers/{cUUID}/runtime_config/scopes	List configuration scopes
RuntimeConfigurationApi	SetKey	Put /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}	Update a configuration key
ScheduleManagementApi	DeleteBackupScheduleAsync	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_async	Delete a backup schedule async
ScheduleManagementApi	DeleteSchedule	Delete /api/v1/customers/{cUUID}/schedules/{sUUID}	Delete a schedule - deprecated
ScheduleManagementApi	DeleteScheduleV2	Delete /api/v1/customers/{cUUID}/schedules/{sUUID}/delete	Delete a schedule V2 - deprecated
ScheduleManagementApi	EditBackupScheduleAsync	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_async	Edit a backup schedule async
ScheduleManagementApi	EditBackupScheduleV2	Put /api/v1/customers/{cUUID}/schedules/{sUUID}	Edit a backup schedule V2 - deprecated
ScheduleManagementApi	GetSchedule	Get /api/v1/customers/{cUUID}/schedules/{sUUID}	Get Schedule
ScheduleManagementApi	ListSchedules	Get /api/v1/customers/{cUUID}/schedules	List schedules - deprecated
ScheduleManagementApi	ListSchedulesV2	Post /api/v1/customers/{cUUID}/schedules/page	List schedules V2
ScheduleManagementApi	ToggleBackupSchedule	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resume	Toggle a backup schedule
SessionManagementApi	ApiLogin	Post /api/v1/api_login	Authenticate user using email and password
SessionManagementApi	ApiToken	Put /api/v1/customers/{cUUID}/api_token	Regenerate and fetch API token
SessionManagementApi	AppVersion	Get /api/v1/app_version	appVersion
SessionManagementApi	CustomerCount	Get /api/v1/customer_count	customerCount
SessionManagementApi	GetAdminNotifications	Get /api/v1/customers/{cUUID}/admin_notifications	Current list of notifications for admin
SessionManagementApi	GetFilteredLogs	Get /api/v1/logs	getFilteredLogs
SessionManagementApi	GetLogs	Get /api/v1/logs/{maxLines}	getLogs
SessionManagementApi	GetSessionInfo	Get /api/v1/session_info	Get current user and customer uuid. This will not generate or return the API token, use /api_token API for that.
SessionManagementApi	RegisterCustomer	Post /api/v1/register	Register a customer
SupportBundleManagementApi	CreateSupportBundle	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle	Create support bundle for specific universe
SupportBundleManagementApi	DeleteSupportBundle	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}	Delete a support bundle
SupportBundleManagementApi	DownloadSupportBundle	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}/download	Download support bundle
SupportBundleManagementApi	GetSupportBundle	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle/{sbUUID}	Get a support bundle from a universe
SupportBundleManagementApi	ListSupportBundle	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/support_bundle	List all support bundles from a universe
SupportBundleManagementApi	ListSupportBundleComponents	Get /api/v1/customers/{cUUID}/support_bundle/components	List all components available in support bundle
UniverseActionsApi	ImportUniverse	Post /api/v1/customers/{cUUID}/universes/import	Import a universe - deprecated
UniverseCDCManagementApi	ListReplicationSlot	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_replication_slots	List CDC Replication slot for a cluster
UniverseClusterMutationsApi	CreateAllClusters	Post /api/v1/customers/{cUUID}/universes/clusters	Create Universe Clusters
UniverseClusterMutationsApi	CreateReadOnlyCluster	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only	Create ReadOnly Cluster
UniverseClusterMutationsApi	DeleteReadonlyCluster	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only/{clustUUID}	Delete Readonly Cluster
UniverseClusterMutationsApi	UpdatePrimaryCluster	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/primary	Update Primary Cluster
UniverseClusterMutationsApi	UpdateReadOnlyCluster	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only	Update Readonly Cluster
UniverseDatabaseManagementApi	ConfigureYCQL	Post /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ycql	Configure YCQL
UniverseDatabaseManagementApi	ConfigureYSQL	Post /api/v1/customers/{cUUID}/universes/{univUUID}/configure/ysql	Configure YSQL
UniverseInformationApi	DownloadNodeLogs	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/{nodeName}/download_logs	Download a node's logs - deprecated
UniverseInformationApi	GetLiveQueries	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/live_queries	Get live queries for a universe
UniverseInformationApi	GetMasterLeaderIP	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/leader	Get IP address of a universe's master leader
UniverseInformationApi	GetSlowQueries	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries	Get slow queries for a universe
UniverseInformationApi	GetUniverseCost	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/cost	Get a cost estimate for a universe - deprecated
UniverseInformationApi	GetUniverseResources	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/universe_resources	Get a resource usage estimate for a universe
UniverseInformationApi	HealthCheckUniverse	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/health_check	Return results for the last health check
UniverseInformationApi	ResetSlowQueries	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries	Reset slow queries for a universe
UniverseInformationApi	UniverseStatus	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/status	Get a universe's status
UniverseManagementApi	ConfigureUniverseAlerts	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/config_alerts	Configure alerts for a universe
UniverseManagementApi	DeleteUniverse	Delete /api/v1/customers/{cUUID}/universes/{uniUUID}	Delete a universe
UniverseManagementApi	GetUniverse	Get /api/v1/customers/{cUUID}/universes/{uniUUID}	Get a universe
UniverseManagementApi	ListUniverses	Get /api/v1/customers/{cUUID}/universes	List universes
UniverseManagementApi	PauseUniverse	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/pause	Pause a universe
UniverseManagementApi	ResumeUniverse	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/resume	Resume a paused universe
UniverseManagementApi	SetUniverseBackupFlag	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state	Set a universe's backup flag
UniverseManagementApi	SetUniverseHelm3Compatible	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible	Flag a universe as Helm 3-compatible - deprecated
UniverseManagementApi	SetUniverseKey	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/set_key	Set a universe's key
UniverseManagementApi	UpdateLoadBalancerConfig	Put /api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config	Update load balancer config
UniverseNodeMetadataMetamasterApi	GetMasterAddresses	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/masters	List a master node's addresses
UniverseNodeMetadataMetamasterApi	GetRedisServerAddresses	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/redisservers	List a REDIS server's addresses
UniverseNodeMetadataMetamasterApi	GetUniverseMasterNodes	Get /metamaster/universe/{universeUUID}	List a universe's master nodes
UniverseNodeMetadataMetamasterApi	GetYQLServerAddresses	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/yqlservers	List a YQL server's addresses
UniverseNodeMetadataMetamasterApi	GetYSQLServerAddresses	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/ysqlservers	List a YSQL server's addresses
UniversePerformanceSuggestionsApi	GetQueryDistributionSuggestions	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/query_distribution_suggestions	Get query distribution improvement suggestion for a universe
UniversePerformanceSuggestionsApi	GetRangeHash	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/range_hash	Return list of hash indexes
UniversePerformanceSuggestionsApi	GetUnusedIndexes	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/unused_indexes	Return list of each unused index across the universe
UniverseUpgradesManagementApi	FinalizeUpgrade	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize	Finalize Upgrade
UniverseUpgradesManagementApi	PreFinalizeSoftwareUpgradeInfo	Get /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize/info	Finalize Software Upgrade info
UniverseUpgradesManagementApi	RebootUniverse	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/reboot	Reboot universe
UniverseUpgradesManagementApi	ResizeNode	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/resize_node	Resize Node
UniverseUpgradesManagementApi	RestartUniverse	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/restart	Restart Universe
UniverseUpgradesManagementApi	RollbackUpgrade	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rollback	Rollback Upgrade
UniverseUpgradesManagementApi	SoftwareUpgradePreCheck	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck	Software Upgrade universe pre-check
UniverseUpgradesManagementApi	UpdateProxyConfig	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/proxy_config	Update Proxy Config
UniverseUpgradesManagementApi	UpgradeCerts	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/certs	Upgrade Certs
UniverseUpgradesManagementApi	UpgradeDBVersion	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/db_version	Upgrade DB version
UniverseUpgradesManagementApi	UpgradeGFlags	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/gflags	Upgrade GFlags
UniverseUpgradesManagementApi	UpgradeKubernetesOverrides	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/kubernetes_overrides	Upgrade KubernetesOverrides
UniverseUpgradesManagementApi	UpgradeSoftware	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software	Upgrade Software
UniverseUpgradesManagementApi	UpgradeSystemd	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/systemd	Upgrade Systemd
UniverseUpgradesManagementApi	UpgradeThirdpartySoftware	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/thirdparty_software	Upgrade third-party software
UniverseUpgradesManagementApi	UpgradeTls	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/tls	Upgrade TLS
UniverseUpgradesManagementApi	UpgradeVMImage	Post /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/vm	Upgrade VM Image
UploadReleasePackagesApi	GetUploadRelease	Get /api/v1/customers/{cUUID}/ybdb_release/upload/{rUUID}	get an uploaded release metadata
UploadReleasePackagesApi	UploadRelease	Post /api/v1/customers/{cUUID}/ybdb_release/upload	upload a release tgz
UserManagementApi	ChangePassword	Put /api/v1/customers/{cUUID}/users/{uUUID}/change_password	Change password - deprecated
UserManagementApi	CreateUser	Post /api/v1/customers/{cUUID}/users	Create a user
UserManagementApi	DeleteUser	Delete /api/v1/customers/{cUUID}/users/{uUUID}	Delete a user
UserManagementApi	GetUserDetails	Get /api/v1/customers/{cUUID}/users/{uUUID}	Get a user's details
UserManagementApi	ListUsers	Get /api/v1/customers/{cUUID}/users	List all users
UserManagementApi	ResetUserPassword	Put /api/v1/customers/{cUUID}/reset_password	Reset the user's password
UserManagementApi	RetrieveOIDCAuthToken	Get /api/v1/customers/{cUUID}/users/{uUUID}/oidc_auth_token	Retrieve OIDC auth token
UserManagementApi	UpdateUserProfile	Put /api/v1/customers/{cUUID}/users/{uUUID}/update_profile	Update a user's profile
UserManagementApi	UpdateUserRole	Put /api/v1/customers/{cUUID}/users/{uUUID}	Change a user's role

Documentation For Models

• AWSCloudInfo
• AWSCloudWatchConfig
• AWSCloudWatchConfigAllOf
• AWSRegionCloudInfo
• AZCloudInfo
• AZOverrides
• AccessKey
• AccessKeyFormData
• AccessKeyId
• AdminNotification
• Alert
• AlertApiFilter
• AlertChannel
• AlertChannelEmailParams
• AlertChannelEmailParamsAllOf
• AlertChannelFormData
• AlertChannelPagerDutyParams
• AlertChannelPagerDutyParamsAllOf
• AlertChannelParams
• AlertChannelSlackParams
• AlertChannelSlackParamsAllOf
• AlertChannelTemplates
• AlertChannelTemplatesExtWithDefaultValues
• AlertChannelWebHookParams
• AlertChannelWebHookParamsAllOf
• AlertConfiguration
• AlertConfigurationApiFilter
• AlertConfigurationPagedApiQuery
• AlertConfigurationPagedResponse
• AlertConfigurationTarget
• AlertConfigurationTemplate
• AlertConfigurationThreshold
• AlertDefinition
• AlertDefinitionLabel
• AlertDefinitionLabelKey
• AlertDestination
• AlertDestinationFormData
• AlertLabel
• AlertLabelKey
• AlertPagedApiQuery
• AlertPagedResponse
• AlertTemplateApiFilter
• AlertTemplateSettings
• AlertTemplateSettingsFormData
• AlertTemplateVariable
• AlertTemplateVariablesFormData
• AlertTemplateVariablesList
• AlertingData
• AllowedUniverseTasksResp
• Artifact
• Audit
• AuditLogConfig
• AuditLogConfigParams
• AuditLoggingConfig
• AvailabilityZone
• AvailabilityZoneData
• AvailabilityZoneDetails
• AvailabilityZoneFormData
• AzureCloudInfo
• AzureRegionCloudInfo
• Backup
• BackupApiFilter
• BackupPagedApiQuery
• BackupPagedApiResponse
• BackupPointInTimeRestoreWindow
• BackupRequestParams
• BackupResp
• BackupScheduleEditParams
• BackupScheduleToggleParams
• BackupStorageInfo
• BackupTableParams
• BasicAuthInformation
• BasicAuthInformationAllOf
• BootstrapBackupParams
• BootstrapParams
• BulkImportParams
• BundleDetails
• BundleInfo
• CertificateDetails
• CertificateInfo
• CertificateInfoExt
• CertificateParams
• CertsRotateParams
• ClientCertParams
• CloudInfo
• CloudSpecificInfo
• Cluster
• ColumnDetails
• CommonBackupInfo
• CommunicationPorts
• ConfDataType
• ConfDataTypeObject
• ConfKeyInfo
• Config
• ConfigEntry
• ConfigureYCQLFormData
• ConfigureYSQLFormData
• CreatePitrConfigParams
• CreateRelease
• CreateTablespaceParams
• CurrentAdminNotificationMessages
• CustomCACertParams
• CustomCaCertificateInfo
• CustomCertInfo
• CustomServerCertData
• CustomServerCertInfo
• Customer
• CustomerAlertData
• CustomerConfig
• CustomerConfigUI
• CustomerCountResp
• CustomerDetailsData
• CustomerLicense
• CustomerLoginFormData
• CustomerRegisterFormData
• CustomerTaskData
• DataDogConfig
• DataDogConfigAllOf
• DatabaseSecurityFormData
• DatabaseUserFormData
• DeleteBackupInfo
• DeleteBackupParams
• Details
• DeviceInfo
• DrConfigCreateForm
• DrConfigEditForm
• DrConfigFailoverForm
• DrConfigGetResp
• DrConfigReplaceReplicaForm
• DrConfigRestartForm
• DrConfigSafetimeResp
• DrConfigSetDatabasesForm
• DrConfigSetTablesForm
• DrConfigSwitchoverForm
• EditAccessKeyRotationScheduleParams
• EditBackupParams
• EditBackupScheduleParams
• EncryptionAtRestConfig
• ExtraDependencies
• ExtractMetadata
• FailedSubtasks
• FinalizeUpgradeInfoResponse
• FinalizeUpgradeParams
• GCPCloudInfo
• GCPCloudMonitoringConfig
• GCPCloudMonitoringConfigAllOf
• GCPRegionCloudInfo
• GCSLocation
• GFlagDetails
• GFlagValidationDetails
• GFlagsUpgradeParams
• GFlagsValidationFormData
• GFlagsValidationRequest
• GFlagsValidationResponse
• GroupMappingInfo
• HTTPAuthInformation
• HashedTimestampColumnFinderResponse
• HashicorpVaultConfigParams
• HttpLocation
• ImageBundle
• ImageBundleDetails
• ImageBundleUpgradeInfo
• ImpactedXClusterConnectedUniverse
• ImportUniverseFormData
• InstanceType
• InstanceTypeDetails
• InstanceTypeKey
• InstanceTypeResp
• K8SNodeResourceSpec
• KeyInfo
• KeyspaceTable
• KeyspaceTables
• KeyspaceTablesList
• KubernetesInfo
• KubernetesOverrideError
• KubernetesOverridesResponse
• KubernetesOverridesUpgradeParams
• KubernetesRegionInfo
• LdapDnToYbaRoleData
• LdapDnYbaRoleDataPair
• LdapUnivSyncFormData
• LocalCloudInfo
• LogData
• MaintenanceWindow
• MaintenanceWindowApiFilter
• MaintenanceWindowPagedApiQuery
• MaintenanceWindowPagedResponse
• MasterInfo
• MasterNode
• MastersList
• Metadata
• Metric
• MetricLabel
• MetricQueryParams
• MetricValue
• MultiTableBackupRequestParams
• NamespaceInfoResp
• NamespaceSafetime
• NoAuth
• NodeActionFormData
• NodeAgent
• NodeAgentApiFilter
• NodeAgentPagedApiQuery
• NodeAgentPagedApiResponse
• NodeAgentResp
• NodeConfig
• NodeData
• NodeDetails
• NodeDetailsResp
• NodeInstance
• NodeInstanceData
• NodeInstanceFormData
• NodeInstanceStateFormData
• NodeQueryDistributionDetails
• OidcGroupToYbaRolesData
• OidcGroupToYbaRolesPair
• OnPremCloudInfo
• Package
• PackagePaths
• PackagesRequestParams
• ParametersForAdvancedRestorePreflightChecks
• ParametersForRestorePreflightChecks
• ParametersForValidatingRestorableKeyspaceAndTablesInBackup
• PerBackupLocationKeyspaceTables
• PerLocationBackupInfo
• PerProcessDetails
• PerProcessFlags
• PerfAdvisorManualRunStatus
• PerfAdvisorSettingsFormData
• PerfAdvisorSettingsWithDefaults
• PerformanceRecommendation
• PerformanceRecommendationFilter
• PerformanceRecommendationPagedQuery
• PerformanceRecommendationPagedResponse
• Permission
• PermissionDetails
• PermissionInfo
• PitrConfig
• PitrParams
• PlacementAZ
• PlacementBlock
• PlacementCloud
• PlacementInfo
• PlacementRegion
• PlatformLoggingConfig
• PresetThrottleValues
• PrevYBSoftwareConfig
• Principal
• Provider
• ProviderDetails
• ProxyConfig
• ProxyConfigUpdateParams
• QueryDistributionSuggestionResponse
• Region
• RegionCloudInfo
• RegionDetails
• RegionFormData
• RegionLocations
• RegionMetadata
• RegionMetadataInfo
• ReinstallNodeAgentForm
• ReleaseFormData
• ReleaseMetadata
• ReplicaPlacement
• ResizeNodeParams
• ResourceDefinition
• ResourceGroup
• ResponseExtractMetadata
• ResponseRelease
• RestartBootstrapParams
• RestartTaskParams
• RestoreApiFilter
• RestoreBackupParams
• RestoreKeyspace
• RestorePagedApiQuery
• RestorePagedApiResponse
• RestorePreflightResponse
• RestoreResp
• RestoreSnapshotScheduleParams
• Role
• RoleAttribute
• RoleBinding
• RoleBindingFormData
• RoleFormData
• RoleResourceDefinition
• RollMaxBatchSize
• RollbackUpgradeParams
• RunQueryFormData
• RuntimeConfigData
• S3Location
• Schedule
• ScheduleApiFilter
• SchedulePagedApiQuery
• SchedulePagedResponse
• ScopedConfig
• SessionInfo
• SmtpData
• SoftwareUpgradeInfoRequest
• SoftwareUpgradeInfoResponse
• SoftwareUpgradeParams
• SpecificGFlags
• SplunkConfig
• SplunkConfigAllOf
• StateChangeAuditInfo
• StateChangeAuditInfoFilter
• StateChangeAuditInfoPagedQuery
• StateChangeAuditInfoPagedResponse
• SubtaskData
• SupportBundle
• SupportBundleFormData
• SuppressHealthCheckNotificationsConfig
• SystemdUpgradeParams
• TableDefinitionTaskParams
• TableDetails
• TableInfoResp
• TableSpaceInfo
• Tablespace
• TablespaceResponse
• TelemetryProvider
• TelemetryProviderConfig
• ThirdpartySoftwareUpgradeParams
• ThrottleParamValue
• TlsToggleParams
• TokenAuthInformation
• TokenAuthInformationAllOf
• TriggerHealthCheckResult
• TroubleshootingPlatform
• TroubleshootingPlatformDetailsModel
• Universe
• UniverseBackupRequestFormData
• UniverseConfigureTaskParams
• UniverseDefinitionTaskParams
• UniverseDefinitionTaskParamsResp
• UniverseDetailSubset
• UniverseLogsExporterConfig
• UniversePerformanceAdvisorStatus
• UniverseResourceDetails
• UniverseResp
• UnusedIndexFinderResponse
• UpdateLoadBalancerConfig
• UpdateRelease
• UpgradeTaskParams
• UserIntent
• UserIntentOverrides
• UserOIDCAuthToken
• UserPasswordChangeFormData
• UserProfileData
• UserRegistrationData
• UserWithFeatures
• Users
• VMImageUpgradeParams
• ValidationResult
• VolumeDetails
• XClusterConfig
• XClusterConfigCreateFormData
• XClusterConfigEditFormData
• XClusterConfigGetResp
• XClusterConfigNeedBootstrapFormData
• XClusterConfigRestartFormData
• XClusterInfo
• XClusterNamespaceConfig
• XClusterTableConfig
• YBAError
• YBPCreateSuccess
• YBPError
• YBPSuccess
• YBPTask
• YCQLAuditConfig
• YSQLAuditConfig
• YbcThrottleParameters
• YbcThrottleParametersResponse

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