openapi: 3.2.0 info: title: Yugabytedb Schedule management API version: v1 contact: name: https://docs.yugabyte.com license: name: Polyform Free Trial License 1.0.0 url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt termsOfService: TODO(chirag) description: 'Operations tagged Schedule management across 2 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json. Each path carries the servers of the definition it was published in.' servers: - url: / tags: - name: Schedule management paths: /api/v1/customers/{cUUID}/schedules: servers: - url: / get: deprecated: true description: 'Deprecated since YBA version 2.20.0.0. Use ''List schedules V2'' instead.' operationId: listSchedules parameters: - in: path name: cUUID required: true schema: format: uuid type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Schedule' type: array description: successful operation security: - apiKeyAuth: [] summary: List schedules - deprecated tags: - Schedule management /api/v1/customers/{cUUID}/schedules/page: servers: - url: / post: operationId: listSchedulesV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: query name: request schema: {} requestBody: content: application/json: schema: $ref: '#/components/schemas/SchedulePagedApiQuery' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SchedulePagedApiResponse' description: successful operation security: - apiKeyAuth: [] summary: List schedules V2 tags: - Schedule management x-codegen-request-body-name: PageScheduleRequest /api/v1/customers/{cUUID}/schedules/{sUUID}: servers: - url: / delete: deprecated: true description: 'Deprecated since YBA version 2.20.0.0. Use ''Delete a schedule V2'' instead.' operationId: deleteSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' description: successful operation security: - apiKeyAuth: [] summary: Delete a schedule - deprecated tags: - Schedule management get: operationId: getSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' description: successful operation security: - apiKeyAuth: [] summary: Get Schedule tags: - Schedule management put: deprecated: true description: 'Deprecated since YBA version 2024.2.0.0. Use ''Edit a backup schedule async'' instead.' operationId: editBackupScheduleV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} requestBody: content: application/json: schema: $ref: '#/components/schemas/EditBackupScheduleParams' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' description: successful operation security: - apiKeyAuth: [] summary: Edit a backup schedule V2 - deprecated tags: - Schedule management x-codegen-request-body-name: body /api/v1/customers/{cUUID}/schedules/{sUUID}/delete: servers: - url: / delete: deprecated: true description: 'Deprecated since YBA version 2024.2.0.0. Use ''Delete a backup schedule async'' instead.' operationId: deleteScheduleV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' description: successful operation security: - apiKeyAuth: [] summary: Delete a schedule V2 - deprecated tags: - Schedule management /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_async: servers: - url: / delete: description: 'WARNING: This is a preview API that could change. Delete a backup schedule async.' operationId: deleteBackupScheduleAsync parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: uniUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' description: successful operation security: - apiKeyAuth: [] summary: Delete a backup schedule async tags: - Schedule management /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_async: servers: - url: / put: description: 'WARNING: This is a preview API that could change. Edit a backup schedule async.' operationId: editBackupScheduleAsync parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: uniUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupScheduleEditParams' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' description: successful operation security: - apiKeyAuth: [] summary: Edit a backup schedule async tags: - Schedule management x-codegen-request-body-name: body /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resume: servers: - url: / put: description: 'WARNING: This is a preview API that could change. Toggle a backup schedule. Only allowed to toggle backup schedule state between Active and Stopped.' operationId: toggleBackupSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string - in: path name: uniUUID required: true schema: format: uuid type: string - in: path name: sUUID required: true schema: format: uuid type: string - in: query name: request schema: {} requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupScheduleToggleParams' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' description: successful operation security: - apiKeyAuth: [] summary: Toggle a backup schedule tags: - Schedule management x-codegen-request-body-name: body components: schemas: BackupScheduleEditParams: example: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 schedulingFrequency: 6 incrementalBackupFrequency: 0 properties: cronExpression: description: Cron expression for scheduling type: string frequencyTimeUnit: description: Time Unit for frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string incrementalBackupFrequency: description: Frequency of incremental backup schedule format: int64 type: integer incrementalBackupFrequencyTimeUnit: description: TimeUnit for incremental Backup Schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string schedulingFrequency: description: Frequency of the schedule format: int64 type: integer timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer type: object SchedulePagedApiResponse: example: entities: - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting hasPrev: true hasNext: true totalCount: 2 properties: entities: items: $ref: '#/components/schemas/ScheduleResp' type: array hasNext: type: boolean hasPrev: type: boolean totalCount: format: int32 type: integer required: - entities - hasNext - hasPrev - totalCount type: object YBPTask: example: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: resourceUUID: description: UUID of the resource being modified by the task format: uuid readOnly: true type: string taskUUID: description: Task UUID format: uuid readOnly: true type: string type: object SchedulePagedApiQuery: example: filter: taskTypes: - CloudBootstrap - CloudBootstrap universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: - Deleting - Deleting offset: 6 needTotalCount: true limit: 0 sortBy: taskType direction: ASC properties: direction: enum: - ASC - DESC type: string filter: $ref: '#/components/schemas/ScheduleApiFilter' limit: format: int32 type: integer needTotalCount: type: boolean offset: format: int32 type: integer sortBy: enum: - taskType - scheduleUUID - scheduleName type: string required: - direction - filter - limit - needTotalCount - offset - sortBy type: object KeyspaceTablesList: example: backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation properties: allTables: type: boolean backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow' backupSizeInBytes: format: int64 type: integer defaultLocation: type: string keyspace: type: string perRegionLocations: items: $ref: '#/components/schemas/RegionLocations' type: array tableUUIDList: items: format: uuid type: string type: array tablesList: items: type: string type: array required: - allTables - backupPointInTimeRestoreWindow - backupSizeInBytes - defaultLocation - keyspace - perRegionLocations - tableUUIDList - tablesList type: object BackupInfo: example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE properties: backupType: enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string expiryTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string fullBackup: type: boolean keyspaceList: items: $ref: '#/components/schemas/KeyspaceTablesList' type: array parallelism: format: int64 type: integer pointInTimeRestoreEnabled: type: boolean storageConfigUUID: format: uuid type: string timeBeforeDelete: format: int64 type: integer universeUUID: format: uuid type: string useRoles: type: boolean useTablespaces: type: boolean required: - backupType - expiryTimeUnit - fullBackup - keyspaceList - parallelism - pointInTimeRestoreEnabled - storageConfigUUID - timeBeforeDelete - universeUUID - useRoles - useTablespaces type: object Schedule: description: Backup schedule example: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting properties: backlogStatus: description: Backlog status of schedule arose due to conflicts readOnly: true type: boolean cronExpression: description: Cron expression for the schedule type: string failureCount: description: Number of failed backup attempts format: int32 readOnly: true type: integer frequency: description: Frequency of the schedule, in milli seconds format: int64 type: integer frequencyTimeUnit: description: Time unit of frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string incrementBacklogStatus: description: Backlog status of schedule of incremental backups arose due to conflicts readOnly: true type: boolean kubernetesOperatorControlled: type: boolean nextIncrementScheduleTaskTime: description: Time on which schedule is expected to run for incremental backups example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string nextScheduleTaskTime: description: Time on which schedule is expected to run example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string ownerUUID: description: Owner UUID for the schedule format: uuid readOnly: true type: string runningState: description: Running state of the schedule type: boolean scheduleName: description: Name of the schedule readOnly: true type: string scheduleUUID: description: Schedule UUID format: uuid readOnly: true type: string status: description: Status of the task. Possible values are _Active_, _Paused_, or _Stopped_. enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing readOnly: true type: string taskType: description: Type of task to be scheduled. enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string useLocalTimezone: description: Whether to use local timezone with cron expression for the schedule type: boolean userEmail: description: User who created the schedule policy readOnly: true type: string required: - kubernetesOperatorControlled type: object YBPSuccess: example: success: true message: message properties: message: description: API response message. readOnly: true type: string success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean type: object ScheduleApiFilter: example: taskTypes: - CloudBootstrap - CloudBootstrap universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: - Deleting - Deleting properties: status: items: enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string type: array uniqueItems: true taskTypes: items: enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string type: array uniqueItems: true universeUUIDList: items: format: uuid type: string type: array uniqueItems: true required: - status - taskTypes - universeUUIDList type: object RegionLocations: example: LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION properties: HOST_BASE: type: string LOCATION: type: string REGION: type: string required: - HOST_BASE - LOCATION - REGION type: object BackupScheduleToggleParams: example: runImmediateBackupOnResume: true status: Deleting properties: runImmediateBackupOnResume: description: Run a full or incremental backup if required when resuming a stopped schedule. When false (default), the full backup will instead run at its normally scheduled time. type: boolean status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string required: - status type: object BackupPointInTimeRestoreWindow: example: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 properties: timestampRetentionWindowEndMillis: format: int64 type: integer timestampRetentionWindowStartMillis: format: int64 type: integer required: - timestampRetentionWindowEndMillis - timestampRetentionWindowStartMillis type: object EditBackupScheduleParams: description: Info to edit the schedule params for backups example: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 incrementalBackupFrequency: 6 runImmediateBackupOnResume: true frequency: 0 status: Deleting properties: cronExpression: description: Cron expression for scheduling type: string frequency: description: Frequency of the schedule format: int64 type: integer frequencyTimeUnit: description: Time Unit for frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string incrementalBackupFrequency: description: Frequency of incremental backup schedule format: int64 type: integer incrementalBackupFrequencyTimeUnit: description: TimeUnit for incremental Backup Schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string runImmediateBackupOnResume: description: Run a full or incremental backup if the schedule is expired when resuming a stopped schedule type: boolean status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer type: object ScheduleResp: example: scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting properties: backlogStatus: type: boolean backupInfo: $ref: '#/components/schemas/BackupInfo' cronExpression: type: string customerUUID: format: uuid type: string failureCount: format: int32 type: integer frequency: format: int64 type: integer frequencyTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string incrementBacklogStatus: type: boolean incrementalBackupFrequency: format: int64 type: integer incrementalBackupFrequencyTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string nextExpectedTask: description: Next expected task time example: 2022-12-12 13:07:18+00:00 format: date-time type: string prevCompletedTask: description: Previous completed task time example: 2022-12-12 13:07:18+00:00 format: date-time type: string runningState: type: boolean scheduleName: type: string scheduleUUID: format: uuid type: string status: enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string tableByTableBackup: type: boolean taskType: enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string useLocalTimezone: type: boolean required: - backlogStatus - backupInfo - cronExpression - customerUUID - failureCount - frequency - frequencyTimeUnit - incrementBacklogStatus - incrementalBackupFrequency - incrementalBackupFrequencyTimeUnit - runningState - scheduleName - scheduleUUID - status - tableByTableBackup - taskType - useLocalTimezone type: object securitySchemes: apiKeyAuth: description: API token passed as header in: header name: X-AUTH-YW-API-TOKEN type: apiKey externalDocs: description: About YugabyteDB Anywhere url: https://docs.yugabyte.com/latest/yugabyte-platform/ x-refined-from: - openapi_2.yaml - platform.swagger.json