openapi: 3.1.0 info: title: YugabyteDB Aeon REST Access Keys Cloud providers API description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page. version: v1 contact: name: Yugabyte Support url: https://support.yugabyte.com termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/ x-generated-from: documentation x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/ x-last-validated: '2026-05-03' servers: - url: https://cloud.yugabyte.com/api/public/v1 description: YugabyteDB Aeon Production Server security: - bearerAuth: [] tags: - name: Cloud providers paths: /api/v1/customers/{cUUID}/providers: get: operationId: getListOfProviders parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: name schema: default: 'null' type: string example: 'null' - in: query name: providerCode schema: default: 'null' type: string example: 'null' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Provider' type: array examples: GetListOfProviders200Example: summary: Default getListOfProviders 200 response x-microcks-default: true value: - sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Cloud Providers tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createProviders parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: validate schema: default: true type: boolean example: true - in: query name: ignoreValidationErrors schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/Provider' examples: CreateProvidersRequestExample: summary: Default createProviders request x-microcks-default: true value: sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: '2022-12-12T13:07:18+00:00' keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: '2022-12-12T13:07:18+00:00' - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: '2022-12-12T13:07:18+00:00' keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: '2022-12-12T13:07:18+00:00' name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateProviders200Example: summary: Default createProviders 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Provider tags: - Cloud providers x-codegen-request-body-name: CreateProviderRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/region_metadata/{code}: get: operationId: getRegionMetadata parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: code required: true schema: type: string example: OK - in: query name: subType schema: default: 'null' type: string example: 'null' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionMetadata' examples: GetRegionMetadata200Example: summary: Default getRegionMetadata 200 response x-microcks-default: true value: regionMetadata: key: latitude: 0.8008281904610115 name: name availabilityZones: - availabilityZones - availabilityZones longitude: 6.027456183070403 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Retrieves the Region Metadata for the Cloud Providers tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}: delete: operationId: delete parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: Delete200Example: summary: Default delete 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Cloud Provider tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: getProvider parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Provider' examples: GetProvider200Example: summary: Default getProvider 200 response x-microcks-default: true value: sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Cloud Provider tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation: post: description: 'WARNING: This is a preview API that could change.' operationId: accessKeyRotation parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: AccessKeyRotation200Example: summary: Default accessKeyRotation 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Rotate Access Key for a Provider tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule: get: description: 'WARNING: This is a preview API that could change.' operationId: listSchedules parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Schedule' type: array examples: ListSchedules200Example: summary: Default listSchedules 200 response x-microcks-default: true value: - 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Schedules for a Provider's Access Key Rotation tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change.' operationId: scheduledAccessKeyRotation parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: ScheduledAccessKeyRotation200Example: summary: Default scheduledAccessKeyRotation 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Rotate Access Key for a Provider - Scheduled tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule/{sUUID}: put: description: 'WARNING: This is a preview API that could change.' operationId: editAccessKeyRotationSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/EditAccessKeyRotationScheduleParams' examples: EditAccessKeyRotationScheduleRequestExample: summary: Default editAccessKeyRotationSchedule request x-microcks-default: true value: schedulingFrequencyDays: 0 status: Deleting required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: EditAccessKeyRotationSchedule200Example: summary: Default editAccessKeyRotationSchedule 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit a Access Key Rotation Schedule tags: - Cloud providers x-codegen-request-body-name: body x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/edit: put: operationId: editProvider parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: validate schema: default: true type: boolean example: true - in: query name: ignoreValidationErrors schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/Provider' examples: EditProviderRequestExample: summary: Default editProvider request x-microcks-default: true value: sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: '2022-12-12T13:07:18+00:00' keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: '2022-12-12T13:07:18+00:00' - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: '2022-12-12T13:07:18+00:00' keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: '2022-12-12T13:07:18+00:00' name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName description: edit provider form data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: EditProvider200Example: summary: Default editProvider 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update a Provider tags: - Cloud providers x-codegen-request-body-name: EditProviderRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/refresh_pricing: put: description: 'WARNING: This is a preview API that could change.' operationId: refreshPricing parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: RefreshPricing200Example: summary: Default refreshPricing 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Refresh Provider Pricing Info tags: - Cloud providers x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: AvailabilityZone: description: Availability zone (AZ) for a region example: subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id properties: active: description: AZ status. This value is `true` for an active AZ. readOnly: true type: boolean example: true code: description: AZ code example: us-west1-a type: string config: additionalProperties: type: string description: AZ configuration values type: object example: {} details: $ref: '#/components/schemas/AvailabilityZoneDetails' kubeconfigPath: description: Path to Kubernetes configuration file readOnly: true type: string example: /var/lib/yugabyte/example name: description: AZ name example: us-west1-a type: string secondarySubnet: description: AZ secondary subnet example: secondary subnet id type: string subnet: description: AZ subnet example: subnet id type: string uuid: description: AZ UUID. This must be specified for existing AZs on update format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - name type: object ImageBundleDetails: example: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 properties: arch: description: Architecture type for the image bundle enum: - x86_64 - aarch64 type: string example: x86_64 globalYbImage: description: Global YB image for the bundle type: string example: example-globalYbImage regions: additionalProperties: $ref: '#/components/schemas/BundleInfo' description: Regions override for image bundle type: object example: {} sshPort: format: int32 type: integer example: 5433 sshUser: type: string example: example-sshUser useIMDSv2: type: boolean example: true type: object OnPremCloudInfo: example: ybHomeDir: ybHomeDir useClockbound: true properties: useClockbound: description: 'WARNING: This is a preview API that could change.' type: boolean example: true ybHomeDir: type: string example: example-ybHomeDir type: object AWSCloudInfo: example: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion properties: awsAccessKeyID: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 awsAccessKeySecret: type: string example: REDACTED awsHostedZoneId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 awsHostedZoneName: type: string example: yugabyte.example.com hostVpcId: readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 hostVpcRegion: readOnly: true type: string example: yugabyte.example.com useIMDSv2: type: boolean example: true vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string example: EXISTING type: object AZCloudInfo: example: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: kubernetes: $ref: '#/components/schemas/KubernetesRegionInfo' type: object EditAccessKeyRotationScheduleParams: example: schedulingFrequencyDays: 0 status: Deleting properties: schedulingFrequencyDays: description: Frequency of the schedule in days format: int32 type: integer example: 100 status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string example: Deleting 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 example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: description: Task UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object AzureCloudInfo: example: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId properties: azuClientId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 azuClientSecret: type: string example: REDACTED azuHostedZoneId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 azuNetworkRG: type: string example: example-azuNetworkRG azuNetworkSubscriptionId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 azuRG: type: string example: example-azuRG azuSubscriptionId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 azuTenantId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string example: EXISTING type: object AccessKeyId: example: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: keyCode: type: string example: OK providerUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object AWSRegionCloudInfo: example: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 properties: arch: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead enum: - x86_64 - aarch64 type: string example: x86_64 securityGroupId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vnet: type: string example: example-vnet ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string example: example-ybImage type: object RegionDetails: example: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride properties: cloudInfo: $ref: '#/components/schemas/RegionCloudInfo' type: object YBPSuccess: example: success: true message: message properties: message: description: API response message. readOnly: true type: string example: Example message success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean example: true type: object AvailabilityZoneDetails: example: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: cloudInfo: $ref: '#/components/schemas/AZCloudInfo' type: object BundleInfo: example: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 properties: sshPortOverride: description: sshPortOverride for the bundle. Deprecated since YBA version 2.20.3.0. Use imageBundles.details.sshUser instead. format: int32 type: integer example: 5433 sshUserOverride: description: sshUserOverride for the bundle. Deprecated since YBA version 2.20.3.0. Use imageBundles.details.sshUser instead. type: string example: example-sshUserOverride ybImage: type: string example: example-ybImage type: object AccessKey: description: Access key for the cloud provider. This helps to authenticate the user and get access to the provider. example: idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 properties: creationDate: description: Creation date of key example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string expirationDate: description: Expiration date of key example: 2022-12-12 13:07:18+00:00 format: date-time type: string idKey: $ref: '#/components/schemas/AccessKeyId' keyInfo: $ref: '#/components/schemas/KeyInfo' required: - idKey - keyInfo type: object AzureRegionCloudInfo: example: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride properties: azuNetworkRGOverride: type: string example: example-azuNetworkRGOverride azuRGOverride: type: string example: example-azuRGOverride securityGroupId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vnet: type: string example: example-vnet ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string example: example-ybImage type: object RegionMetadataInfo: example: latitude: 0.8008281904610115 name: name availabilityZones: - availabilityZones - availabilityZones longitude: 6.027456183070403 properties: availabilityZones: items: type: string type: array example: - us-east-1a latitude: format: double type: number example: 1.5 longitude: format: double type: number example: 1.5 name: type: string example: example-name required: - availabilityZones - latitude - longitude - name type: object KubernetesInfo: example: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: isKubernetesOperatorControlled: readOnly: true type: boolean example: true kubeConfig: readOnly: true type: string example: example-kubeConfig kubeConfigContent: type: string example: example-kubeConfigContent kubeConfigName: type: string example: example-kubeConfigName kubernetesImagePullSecretName: type: string example: REDACTED kubernetesImageRegistry: type: string example: example-kubernetesImageRegistry kubernetesOperatorControlled: type: boolean example: true kubernetesProvider: type: string example: example-kubernetesProvider kubernetesPullSecret: readOnly: true type: string example: REDACTED kubernetesPullSecretContent: type: string example: REDACTED kubernetesPullSecretName: type: string example: REDACTED kubernetesServiceAccount: description: Deprecated since YBA version 2.17.3.0. kubernetes service account is not needed. type: string example: example-kubernetesServiceAccount kubernetesStorageClass: type: string example: example-kubernetesStorageClass required: - kubernetesOperatorControlled type: object GCPCloudInfo: example: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags properties: destVpcId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 gceApplicationCredentials: type: string example: example-gceApplicationCredentials gceApplicationCredentialsPath: readOnly: true type: string example: /var/lib/yugabyte/example gceProject: type: string example: example-gceProject hostVpcId: readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sharedVPCProject: type: string example: example-sharedVPCProject useHostCredentials: type: boolean example: true useHostVPC: type: boolean example: true vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string example: EXISTING ybFirewallTags: type: string example: example-tag type: object GCPRegionCloudInfo: example: instanceTemplate: instanceTemplate ybImage: ybImage properties: instanceTemplate: description: The instance template to be used for nodes created in this region. type: string example: example-instanceTemplate ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string example: example-ybImage type: object KeyInfo: example: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged properties: airGapInstall: type: boolean example: true deleteRemote: type: boolean example: true installNodeExporter: type: boolean example: true keyPairName: type: string example: example-keyPairName managementState: description: Key Management state enum: - YBAManaged - SelfManaged - Unknown readOnly: true type: string example: YBAManaged nodeExporterPort: format: int32 type: integer example: 5433 nodeExporterUser: type: string example: '5433' ntpServers: items: type: string type: array example: - example-ntpServers passwordlessSudoAccess: type: boolean example: true privateKey: type: string example: example-key provisionInstanceScript: type: string example: example-provisionInstanceScript publicKey: type: string example: example-key setUpChrony: type: boolean example: true showSetUpChrony: type: boolean example: true skipKeyValidateAndUpload: type: boolean example: true skipProvisioning: type: boolean example: true sshPort: format: int32 type: integer example: 5433 sshPrivateKeyContent: type: string example: example-key sshUser: type: string example: example-sshUser vaultFile: type: string example: example-vaultFile vaultPasswordFile: type: string example: REDACTED type: object RegionCloudInfo: example: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride properties: aws: $ref: '#/components/schemas/AWSRegionCloudInfo' azu: $ref: '#/components/schemas/AzureRegionCloudInfo' gcp: $ref: '#/components/schemas/GCPRegionCloudInfo' kubernetes: $ref: '#/components/schemas/KubernetesRegionInfo' type: object ImageBundle: example: metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: active: description: Is the ImageBundle Active type: boolean example: true details: $ref: '#/components/schemas/ImageBundleDetails' metadata: $ref: '#/components/schemas/Metadata' name: description: Image Bundle Name type: string example: example-name useAsDefault: description: Default Image Bundle. A provider can have two defaults, one per architecture type: boolean example: true uuid: description: Image Bundle UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object Region: description: Region within a given provider. Typically, this maps to a single cloud provider region. example: securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 properties: active: readOnly: true type: boolean example: true code: description: Cloud provider region code example: us-west-2 type: string config: additionalProperties: type: string type: object example: {} details: $ref: '#/components/schemas/RegionDetails' latitude: description: The region's latitude example: 37.22 format: double readOnly: true type: number longitude: description: The region's longitude example: -120.01 format: double readOnly: true type: number name: description: Cloud provider region name example: US West (Oregon) readOnly: true type: string securityGroupId: description: Deprecated since YBA version 2.17.2.0. Moved to regionDetails.cloudInfo aws/azure securityGroupId property type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: description: Region UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vnetName: description: Deprecated since YBA version 2.17.2.0. Moved to regionDetails.cloudInfo aws/azure vnet property type: string example: example-vnetName ybImage: description: Deprecated since YBA version 2.17.2.0. Moved to details.cloudInfo aws/gcp/azure ybImage property example: TODO type: string zones: items: $ref: '#/components/schemas/AvailabilityZone' type: array example: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id required: - zones type: object Provider: example: sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName properties: active: description: Provider active status readOnly: true type: boolean example: true airGapInstall: description: Deprecated since YBA version 2.17.2.0. Use details.airGapInstall. Only supported in Create Request type: boolean example: true allAccessKeys: items: $ref: '#/components/schemas/AccessKey' type: array example: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: '2022-12-12T13:07:18+00:00' keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: '2022-12-12T13:07:18+00:00' code: description: Provider cloud code type: string example: OK config: additionalProperties: type: string description: Deprecated since YBA version 2.17.2.0. Use details.metadata instead type: object example: {} customerUUID: description: Customer uuid format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 destVpcId: description: Deprecated since YBA version 2.17.2.0. type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: $ref: '#/components/schemas/ProviderDetails' hostVpcId: description: Deprecated since YBA version 2.17.2.0. type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 hostVpcRegion: description: Deprecated since YBA version 2.17.2.0. type: string example: yugabyte.example.com imageBundles: items: $ref: '#/components/schemas/ImageBundle' type: array example: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyPairName: description: Deprecated since YBA version 2.17.2.0. Use allAccessKeys[0].keyInfo.keyPairName instead type: string example: example-keyPairName name: description: Provider name type: string example: example-name prevUsabilityState: description: Previous usability state enum: - READY - UPDATING - ERROR - DELETING readOnly: true type: string example: READY regions: items: $ref: '#/components/schemas/Region' type: array example: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 sshPort: description: Deprecated since YBA version 2.17.2.0. Use details.SshPort instead. Only supported in create request format: int32 type: integer example: 5433 sshPrivateKeyContent: description: Deprecated since YBA version 2.17.2.0. Use allAccessKeys[0].keyInfo.sshPrivateKeyContent instead type: string example: example-key sshUser: description: Deprecated since YBA version 2.17.2.0. Use details.SshUser instead. Only supported in create request type: string example: example-sshUser updateSource: description: Update source if current state is UPDATING enum: - USER - AUTO readOnly: true type: string example: USER usabilityState: description: Current usability state enum: - READY - UPDATING - ERROR - DELETING readOnly: true type: string example: READY uuid: description: Provider uuid format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: description: Provider version format: int64 readOnly: true type: integer example: 1000 required: - imageBundles - regions type: object ProviderDetails: example: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true properties: airGapInstall: type: boolean example: true cloudInfo: $ref: '#/components/schemas/CloudInfo' enableNodeAgent: readOnly: true type: boolean example: true installNodeExporter: type: boolean example: true nodeExporterPort: format: int32 type: integer example: 5433 nodeExporterUser: type: string example: '5433' ntpServers: items: type: string type: array example: - example-ntpServers passwordlessSudoAccess: type: boolean example: true provisionInstanceScript: type: string example: example-provisionInstanceScript setUpChrony: type: boolean example: true showSetUpChrony: type: boolean example: true skipProvisioning: type: boolean example: true sshPort: format: int32 type: integer example: 5433 sshUser: type: string example: example-sshUser type: object RegionMetadata: example: regionMetadata: key: latitude: 0.8008281904610115 name: name availabilityZones: - availabilityZones - availabilityZones longitude: 6.027456183070403 properties: regionMetadata: additionalProperties: $ref: '#/components/schemas/RegionMetadataInfo' type: object example: {} required: - regionMetadata type: object CloudInfo: example: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir properties: aws: $ref: '#/components/schemas/AWSCloudInfo' azu: $ref: '#/components/schemas/AzureCloudInfo' gcp: $ref: '#/components/schemas/GCPCloudInfo' kubernetes: $ref: '#/components/schemas/KubernetesInfo' local: $ref: '#/components/schemas/LocalCloudInfo' onprem: $ref: '#/components/schemas/OnPremCloudInfo' type: object Metadata: example: type: YBA_ACTIVE version: version properties: type: enum: - YBA_ACTIVE - YBA_DEPRECATED - CUSTOM type: string example: YBA_ACTIVE version: type: string example: 2.20.0.0 required: - type - version type: object KubernetesRegionInfo: example: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: certManagerClusterIssuer: description: Deprecated since YBA version 2024.2.3.0.. Use certManagerIssuerKind and certManagerIssuerName instead type: string example: example-certManagerClusterIssuer certManagerIssuer: description: Deprecated since YBA version 2024.2.3.0.. Use certManagerIssuerKind and certManagerIssuerName instead type: string example: example-certManagerIssuer certManagerIssuerGroup: type: string example: example-certManagerIssuerGroup certManagerIssuerKind: type: string example: DEFAULT certManagerIssuerName: type: string example: example-certManagerIssuerName isKubernetesOperatorControlled: readOnly: true type: boolean example: true kubeConfig: readOnly: true type: string example: example-kubeConfig kubeConfigContent: type: string example: example-kubeConfigContent kubeConfigName: type: string example: example-kubeConfigName kubeDomain: type: string example: example.com kubeNamespace: type: string example: example-kubeNamespace kubePodAddressTemplate: type: string example: example-kubePodAddressTemplate kubernetesImagePullSecretName: type: string example: REDACTED kubernetesImageRegistry: type: string example: example-kubernetesImageRegistry kubernetesOperatorControlled: type: boolean example: true kubernetesProvider: type: string example: example-kubernetesProvider kubernetesPullSecret: readOnly: true type: string example: REDACTED kubernetesPullSecretContent: type: string example: REDACTED kubernetesPullSecretName: type: string example: REDACTED kubernetesServiceAccount: description: Deprecated since YBA version 2.17.3.0. kubernetes service account is not needed. type: string example: example-kubernetesServiceAccount kubernetesStorageClass: type: string example: example-kubernetesStorageClass overrides: type: string example: example-overrides required: - kubernetesOperatorControlled type: object LocalCloudInfo: example: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir properties: dataHomeDir: type: string example: example-dataHomeDir envVars: additionalProperties: type: string type: object example: {} hostedZoneId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcBinDir: type: string example: example-ybcBinDir yugabyteBinDir: type: string example: example-yugabyteBinDir required: - dataHomeDir - envVars - hostedZoneId - ybcBinDir - yugabyteBinDir 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 example: true cronExpression: description: Cron expression for the schedule type: string example: example-cronExpression failureCount: description: Number of failed backup attempts format: int32 readOnly: true type: integer example: 10 frequency: description: Frequency of the schedule, in milli seconds format: int64 type: integer example: 1000 frequencyTimeUnit: description: Time unit of frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS incrementBacklogStatus: description: Backlog status of schedule of incremental backups arose due to conflicts readOnly: true type: boolean example: true kubernetesOperatorControlled: type: boolean example: true 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 example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 runningState: description: Running state of the schedule type: boolean example: true scheduleName: description: Name of the schedule readOnly: true type: string example: example-scheduleName scheduleUUID: description: Schedule UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 example: Deleting 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 example: CloudBootstrap useLocalTimezone: description: Whether to use local timezone with cron expression for the schedule type: boolean example: true userEmail: description: User who created the schedule policy readOnly: true type: string example: admin@example.com required: - kubernetesOperatorControlled type: object AvailabilityZone_2: description: Availability zone (AZ) for a region example: subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id properties: active: description: AZ status. This value is `true` for an active AZ. readOnly: true type: boolean code: description: AZ code example: us-west1-a type: string config: additionalProperties: type: string description: AZ configuration values type: object details: $ref: '#/components/schemas/AvailabilityZoneDetails' kubeconfigPath: description: Path to Kubernetes configuration file readOnly: true type: string name: description: AZ name example: us-west1-a type: string secondarySubnet: description: AZ secondary subnet example: secondary subnet id type: string subnet: description: AZ subnet example: subnet id type: string uuid: description: AZ UUID. This must be specified for existing AZs on update format: uuid type: string required: - name type: object ImageBundleDetails_2: example: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 properties: arch: description: Architecture type for the image bundle enum: - x86_64 - aarch64 type: string globalYbImage: description: Global YB image for the bundle type: string regions: additionalProperties: $ref: '#/components/schemas/BundleInfo_2' description: Regions override for image bundle type: object sshPort: format: int32 type: integer sshUser: type: string useIMDSv2: type: boolean type: object OnPremCloudInfo_2: example: ybHomeDir: ybHomeDir useClockbound: true properties: useClockbound: description: 'WARNING: This is a preview API that could change.' type: boolean ybHomeDir: type: string type: object AWSCloudInfo_2: example: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion properties: awsAccessKeyID: type: string awsAccessKeySecret: type: string awsHostedZoneId: type: string awsHostedZoneName: type: string hostVpcId: readOnly: true type: string hostVpcRegion: readOnly: true type: string useIMDSv2: type: boolean vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string type: object EditAccessKeyRotationScheduleParams_2: example: schedulingFrequencyDays: 0 status: Deleting properties: schedulingFrequencyDays: description: Frequency of the schedule in days format: int32 type: integer status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string type: object YBPTask_2: 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 AzureCloudInfo_2: example: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId properties: azuClientId: type: string azuClientSecret: type: string azuHostedZoneId: type: string azuNetworkRG: type: string azuNetworkSubscriptionId: type: string azuRG: type: string azuSubscriptionId: type: string azuTenantId: type: string vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string type: object AccessKeyId_2: example: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: keyCode: type: string providerUUID: format: uuid type: string type: object AWSRegionCloudInfo_2: example: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 properties: arch: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead enum: - x86_64 - aarch64 type: string securityGroupId: type: string vnet: type: string ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string type: object YBPSuccess_2: 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 BundleInfo_2: example: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 properties: sshPortOverride: description: sshPortOverride for the bundle. Deprecated since YBA version 2.20.3.0. Use imageBundles.details.sshUser instead. format: int32 type: integer sshUserOverride: description: sshUserOverride for the bundle. Deprecated since YBA version 2.20.3.0. Use imageBundles.details.sshUser instead. type: string ybImage: type: string type: object AzureRegionCloudInfo_2: example: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride properties: azuNetworkRGOverride: type: string azuRGOverride: type: string securityGroupId: type: string vnet: type: string ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string type: object RegionMetadataInfo_2: example: latitude: 0.8008281904610115 name: name availabilityZones: - availabilityZones - availabilityZones longitude: 6.027456183070403 properties: availabilityZones: items: type: string type: array latitude: format: double type: number longitude: format: double type: number name: type: string required: - availabilityZones - latitude - longitude - name type: object KubernetesInfo_2: example: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: isKubernetesOperatorControlled: readOnly: true type: boolean kubeConfig: readOnly: true type: string kubeConfigContent: type: string kubeConfigName: type: string kubernetesImagePullSecretName: type: string kubernetesImageRegistry: type: string kubernetesOperatorControlled: type: boolean kubernetesProvider: type: string kubernetesPullSecret: readOnly: true type: string kubernetesPullSecretContent: type: string kubernetesPullSecretName: type: string kubernetesServiceAccount: description: Deprecated since YBA version 2.17.3.0. kubernetes service account is not needed. type: string kubernetesStorageClass: type: string required: - kubernetesOperatorControlled type: object GCPCloudInfo_2: example: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags properties: destVpcId: type: string gceApplicationCredentials: type: string gceApplicationCredentialsPath: readOnly: true type: string gceProject: type: string hostVpcId: readOnly: true type: string sharedVPCProject: type: string useHostCredentials: type: boolean useHostVPC: type: boolean vpcType: description: New/Existing VPC for provider creation enum: - EXISTING - NEW - HOSTVPC readOnly: true type: string ybFirewallTags: type: string type: object GCPRegionCloudInfo_2: example: instanceTemplate: instanceTemplate ybImage: ybImage properties: instanceTemplate: description: The instance template to be used for nodes created in this region. type: string ybImage: description: Deprecated since YBA version 2.20.0. Use provider.imageBundle instead type: string type: object KeyInfo_2: example: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged properties: airGapInstall: type: boolean deleteRemote: type: boolean installNodeExporter: type: boolean keyPairName: type: string managementState: description: Key Management state enum: - YBAManaged - SelfManaged - Unknown readOnly: true type: string nodeExporterPort: format: int32 type: integer nodeExporterUser: type: string ntpServers: items: type: string type: array passwordlessSudoAccess: type: boolean privateKey: type: string provisionInstanceScript: type: string publicKey: type: string setUpChrony: type: boolean showSetUpChrony: type: boolean skipKeyValidateAndUpload: type: boolean skipProvisioning: type: boolean sshPort: format: int32 type: integer sshPrivateKeyContent: type: string sshUser: type: string vaultFile: type: string vaultPasswordFile: type: string type: object ImageBundle_2: example: metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: active: description: Is the ImageBundle Active type: boolean details: $ref: '#/components/schemas/ImageBundleDetails_2' metadata: $ref: '#/components/schemas/Metadata_2' name: description: Image Bundle Name type: string useAsDefault: description: Default Image Bundle. A provider can have two defaults, one per architecture type: boolean uuid: description: Image Bundle UUID format: uuid readOnly: true type: string type: object Region_2: description: Region within a given provider. Typically, this maps to a single cloud provider region. example: securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 properties: active: readOnly: true type: boolean code: description: Cloud provider region code example: us-west-2 type: string config: additionalProperties: type: string type: object details: $ref: '#/components/schemas/RegionDetails' latitude: description: The region's latitude example: 37.22 format: double readOnly: true type: number longitude: description: The region's longitude example: -120.01 format: double readOnly: true type: number name: description: Cloud provider region name example: US West (Oregon) readOnly: true type: string securityGroupId: description: Deprecated since YBA version 2.17.2.0. Moved to regionDetails.cloudInfo aws/azure securityGroupId property type: string uuid: description: Region UUID format: uuid readOnly: true type: string vnetName: description: Deprecated since YBA version 2.17.2.0. Moved to regionDetails.cloudInfo aws/azure vnet property type: string ybImage: description: Deprecated since YBA version 2.17.2.0. Moved to details.cloudInfo aws/gcp/azure ybImage property example: TODO type: string zones: items: $ref: '#/components/schemas/AvailabilityZone_2' type: array required: - zones type: object Provider_2: example: sshPort: 5 hostVpcId: hostVpcId code: code destVpcId: destVpcId regions: - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 - securityGroupId: securityGroupId code: us-west-2 ybImage: TODO latitude: 37.22 name: US West (Oregon) active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: instanceTemplate: instanceTemplate ybImage: ybImage aws: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage arch: x86_64 azu: securityGroupId: securityGroupId vnet: vnet ybImage: ybImage azuNetworkRGOverride: azuNetworkRGOverride azuRGOverride: azuRGOverride vnetName: vnetName zones: - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id - subnet: subnet id code: us-west1-a name: us-west1-a active: true details: cloudInfo: kubernetes: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount kubeconfigPath: kubeconfigPath config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 secondarySubnet: secondary subnet id config: key: config uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 longitude: -120.01 usabilityState: READY active: true prevUsabilityState: READY uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: 2 hostVpcRegion: hostVpcRegion sshPrivateKeyContent: sshPrivateKeyContent customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateSource: USER allAccessKeys: - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 - idKey: keyCode: keyCode providerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 creationDate: 2022-12-12 13:07:18+00:00 keyInfo: sshPort: 6 nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true publicKey: publicKey vaultFile: vaultFile sshPrivateKeyContent: sshPrivateKeyContent privateKey: privateKey setUpChrony: true vaultPasswordFile: vaultPasswordFile ntpServers: - ntpServers - ntpServers skipKeyValidateAndUpload: true sshUser: sshUser deleteRemote: true showSetUpChrony: true airGapInstall: true keyPairName: keyPairName managementState: YBAManaged expirationDate: 2022-12-12 13:07:18+00:00 name: name sshUser: sshUser imageBundles: - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - metadata: type: YBA_ACTIVE version: version useAsDefault: true name: name active: true details: sshPort: 5 regions: key: sshUserOverride: sshUserOverride ybImage: ybImage sshPortOverride: 1 useIMDSv2: true globalYbImage: globalYbImage sshUser: sshUser arch: x86_64 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true config: key: config airGapInstall: true keyPairName: keyPairName properties: active: description: Provider active status readOnly: true type: boolean airGapInstall: description: Deprecated since YBA version 2.17.2.0. Use details.airGapInstall. Only supported in Create Request type: boolean allAccessKeys: items: $ref: '#/components/schemas/AccessKey' type: array code: description: Provider cloud code type: string config: additionalProperties: type: string description: Deprecated since YBA version 2.17.2.0. Use details.metadata instead type: object customerUUID: description: Customer uuid format: uuid readOnly: true type: string destVpcId: description: Deprecated since YBA version 2.17.2.0. type: string details: $ref: '#/components/schemas/ProviderDetails_2' hostVpcId: description: Deprecated since YBA version 2.17.2.0. type: string hostVpcRegion: description: Deprecated since YBA version 2.17.2.0. type: string imageBundles: items: $ref: '#/components/schemas/ImageBundle_2' type: array keyPairName: description: Deprecated since YBA version 2.17.2.0. Use allAccessKeys[0].keyInfo.keyPairName instead type: string name: description: Provider name type: string prevUsabilityState: description: Previous usability state enum: - READY - UPDATING - ERROR - DELETING readOnly: true type: string regions: items: $ref: '#/components/schemas/Region_2' type: array sshPort: description: Deprecated since YBA version 2.17.2.0. Use details.SshPort instead. Only supported in create request format: int32 type: integer sshPrivateKeyContent: description: Deprecated since YBA version 2.17.2.0. Use allAccessKeys[0].keyInfo.sshPrivateKeyContent instead type: string sshUser: description: Deprecated since YBA version 2.17.2.0. Use details.SshUser instead. Only supported in create request type: string updateSource: description: Update source if current state is UPDATING enum: - USER - AUTO readOnly: true type: string usabilityState: description: Current usability state enum: - READY - UPDATING - ERROR - DELETING readOnly: true type: string uuid: description: Provider uuid format: uuid readOnly: true type: string version: description: Provider version format: int64 readOnly: true type: integer required: - imageBundles - regions type: object ProviderDetails_2: example: sshPort: 6 enableNodeAgent: true nodeExporterPort: 0 installNodeExporter: true skipProvisioning: true nodeExporterUser: nodeExporterUser provisionInstanceScript: provisionInstanceScript passwordlessSudoAccess: true setUpChrony: true ntpServers: - ntpServers - ntpServers cloudInfo: kubernetes: kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName kubernetesImageRegistry: kubernetesImageRegistry kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount gcp: useHostVPC: true hostVpcId: hostVpcId destVpcId: destVpcId gceProject: gceProject gceApplicationCredentials: gceApplicationCredentials gceApplicationCredentialsPath: gceApplicationCredentialsPath useHostCredentials: true vpcType: EXISTING sharedVPCProject: sharedVPCProject ybFirewallTags: ybFirewallTags onprem: ybHomeDir: ybHomeDir useClockbound: true aws: awsAccessKeySecret: awsAccessKeySecret hostVpcId: hostVpcId useIMDSv2: true awsAccessKeyID: awsAccessKeyID awsHostedZoneId: awsHostedZoneId vpcType: EXISTING awsHostedZoneName: awsHostedZoneName hostVpcRegion: hostVpcRegion azu: azuRG: azuRG azuClientSecret: azuClientSecret azuNetworkRG: azuNetworkRG azuNetworkSubscriptionId: azuNetworkSubscriptionId azuSubscriptionId: azuSubscriptionId azuTenantId: azuTenantId vpcType: EXISTING azuHostedZoneId: azuHostedZoneId azuClientId: azuClientId local: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir sshUser: sshUser showSetUpChrony: true airGapInstall: true properties: airGapInstall: type: boolean cloudInfo: $ref: '#/components/schemas/CloudInfo' enableNodeAgent: readOnly: true type: boolean installNodeExporter: type: boolean nodeExporterPort: format: int32 type: integer nodeExporterUser: type: string ntpServers: items: type: string type: array passwordlessSudoAccess: type: boolean provisionInstanceScript: type: string setUpChrony: type: boolean showSetUpChrony: type: boolean skipProvisioning: type: boolean sshPort: format: int32 type: integer sshUser: type: string type: object RegionMetadata_2: example: regionMetadata: key: latitude: 0.8008281904610115 name: name availabilityZones: - availabilityZones - availabilityZones longitude: 6.027456183070403 properties: regionMetadata: additionalProperties: $ref: '#/components/schemas/RegionMetadataInfo_2' type: object required: - regionMetadata type: object Metadata_2: example: type: YBA_ACTIVE version: version properties: type: enum: - YBA_ACTIVE - YBA_DEPRECATED - CUSTOM type: string version: type: string required: - type - version type: object KubernetesRegionInfo_2: example: kubeNamespace: kubeNamespace kubernetesImagePullSecretName: kubernetesImagePullSecretName kubernetesPullSecretContent: kubernetesPullSecretContent certManagerIssuer: certManagerIssuer isKubernetesOperatorControlled: true kubernetesOperatorControlled: true kubeConfig: kubeConfig kubeDomain: kubeDomain overrides: overrides certManagerIssuerName: certManagerIssuerName kubernetesPullSecret: kubernetesPullSecret kubeConfigName: kubeConfigName certManagerIssuerKind: certManagerIssuerKind kubePodAddressTemplate: kubePodAddressTemplate kubernetesProvider: kubernetesProvider kubeConfigContent: kubeConfigContent kubernetesPullSecretName: kubernetesPullSecretName certManagerIssuerGroup: certManagerIssuerGroup kubernetesImageRegistry: kubernetesImageRegistry certManagerClusterIssuer: certManagerClusterIssuer kubernetesStorageClass: kubernetesStorageClass kubernetesServiceAccount: kubernetesServiceAccount properties: certManagerClusterIssuer: description: Deprecated since YBA version 2024.2.3.0.. Use certManagerIssuerKind and certManagerIssuerName instead type: string certManagerIssuer: description: Deprecated since YBA version 2024.2.3.0.. Use certManagerIssuerKind and certManagerIssuerName instead type: string certManagerIssuerGroup: type: string certManagerIssuerKind: type: string certManagerIssuerName: type: string isKubernetesOperatorControlled: readOnly: true type: boolean kubeConfig: readOnly: true type: string kubeConfigContent: type: string kubeConfigName: type: string kubeDomain: type: string kubeNamespace: type: string kubePodAddressTemplate: type: string kubernetesImagePullSecretName: type: string kubernetesImageRegistry: type: string kubernetesOperatorControlled: type: boolean kubernetesProvider: type: string kubernetesPullSecret: readOnly: true type: string kubernetesPullSecretContent: type: string kubernetesPullSecretName: type: string kubernetesServiceAccount: description: Deprecated since YBA version 2.17.3.0. kubernetes service account is not needed. type: string kubernetesStorageClass: type: string overrides: type: string required: - kubernetesOperatorControlled type: object LocalCloudInfo_2: example: hostedZoneId: hostedZoneId yugabyteBinDir: yugabyteBinDir dataHomeDir: dataHomeDir envVars: key: envVars ybcBinDir: ybcBinDir properties: dataHomeDir: type: string envVars: additionalProperties: type: string type: object hostedZoneId: type: string ybcBinDir: type: string yugabyteBinDir: type: string required: - dataHomeDir - envVars - hostedZoneId - ybcBinDir - yugabyteBinDir type: object Schedule_2: 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 securitySchemes: bearerAuth: type: http scheme: bearer description: API key obtained from the YugabyteDB Aeon UI under User Profile > API Keys. Pass the key as a Bearer token in the Authorization header. definitions: YBPSuccess: 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 Provider: properties: active: description: Provider active status readOnly: true type: boolean airGapInstall: description: Transient property - only present in mutate API request type: boolean code: description: Provider cloud code type: string config: additionalProperties: type: string type: object customHostCidrs: description: Transient property - only present in mutate API request items: type: string type: array customerUUID: description: Customer uuid format: uuid readOnly: true type: string destVpcId: description: Transient property - only present in mutate API request type: string hostVpcId: description: Transient property - only present in mutate API request type: string hostVpcRegion: description: Transient property - only present in mutate API request type: string hostedZoneId: type: string hostedZoneName: type: string keyPairName: description: Transient property - only present in mutate API request type: string name: description: Provider name type: string ntpServers: description: Transient property - only present in mutate API request items: type: string type: array overrideKeyValidate: description: Transient property - only present in mutate API request type: boolean regions: items: $ref: '#/definitions/Region' type: array setUpChrony: description: Transient property - only present in mutate API request type: boolean showSetUpChrony: description: Transient property - only present in mutate API request type: boolean sshPort: description: Transient property - only present in mutate API request format: int32 type: integer sshPrivateKeyContent: description: Transient property - only present in mutate API request type: string sshUser: description: Transient property - only present in mutate API request type: string uuid: description: Provider uuid format: uuid readOnly: true type: string required: - regions type: object YBPTask: 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 AvailabilityZone: description: Availability zone (AZ) for a region properties: active: description: AZ status. This value is `true` for an active AZ. readOnly: true type: boolean code: description: AZ code example: us-west1-a type: string config: additionalProperties: type: string description: AZ configuration values type: object kubeconfigPath: description: Path to Kubernetes configuration file readOnly: true type: string name: description: AZ name example: us-west1-a type: string secondarySubnet: description: AZ secondary subnet example: secondary subnet id type: string subnet: description: AZ subnet example: subnet id type: string uuid: description: AZ UUID format: uuid readOnly: true type: string required: - name type: object Region: description: Region within a given provider. Typically, this maps to a single cloud provider region. properties: active: readOnly: true type: boolean architecture: enum: - x86_64 - arm64 type: string code: description: Cloud provider region code example: us-west-2 type: string config: additionalProperties: type: string type: object latitude: description: The region's latitude example: 37.22 format: double readOnly: true type: number longitude: description: The region's longitude example: -120.01 format: double readOnly: true type: number name: description: Cloud provider region name example: US West (Oregon) readOnly: true type: string securityGroupId: type: string uuid: description: Region UUID format: uuid readOnly: true type: string vnetName: type: string ybImage: description: The AMI to be used in this region. example: TODO type: string zones: items: $ref: '#/definitions/AvailabilityZone' type: array required: - zones type: object externalDocs: description: YugabyteDB Aeon REST API Documentation url: https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/