openapi: 3.0.1 info: contact: name: https://docs.yugabyte.com description: Providers and Infrastructure subset of the YugabyteDB Anywhere v1 REST API, split from the canonical platform-go-client OpenAPI bundle. license: name: Polyform Free Trial License 1.0.0 url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt termsOfService: TODO(chirag) title: YugabyteDB Anywhere v1 — Providers and Infrastructure version: v1 x-source: https://github.com/yugabyte/platform-go-client/blob/master/api/openapi.yaml x-split-from: yugabytedb-anywhere-v1-openapi.yaml externalDocs: description: About YugabyteDB Anywhere url: https://docs.yugabyte.com/latest/yugabyte-platform/ servers: - url: / tags: - name: Access Keys - name: Availability Zones - name: Certificate Info - name: Cloud providers - name: Custom CA Certificates - name: Encryption at rest - name: Instance types - name: Node Agents - name: Node instances - name: Region management paths: /api/v1/customers/{cUUID}/access_keys: get: operationId: listAllForCustomer parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AccessKey' type: array examples: ListAllForCustomer200Example: summary: Default listAllForCustomer 200 response x-microcks-default: true value: - 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Access Keys for All Providers of a Customer tags: - Access Keys x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates: get: operationId: getListOfCertificate parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CertificateInfoExt' type: array examples: GetListOfCertificate200Example: summary: Default getListOfCertificate 200 response x-microcks-default: true value: - customServerCertInfo: serverCert: serverCert serverKey: serverKey certType: SelfSigned customHCPKICertInfo: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken certificate: /opt/yugaware/certs/.../ca.root.cert label: yb-admin-example uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryDateIso: 2022-12-12 13:07:18+00:00 expiryDate: 2000-01-23 04:56:07+00:00 privateKey: /opt/yugaware/.../example.key.pem customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeDetails: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDateIso: 2022-12-12 13:07:18+00:00 universeDetailSubsets: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 checksum: checksum inUse: true customCertPathParams: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath startDate: 2000-01-23 04:56:07+00:00 description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: GetListOfCertificate500Example: summary: Default getListOfCertificate 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there was a server or database issue when listing the regions security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List a Customer's Certificates tags: - Certificate Info x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: upload parameters: - in: path name: cUUID 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/CertificateParams' examples: UploadRequestExample: summary: Default upload request x-microcks-default: true value: certStart: 6 customCertInfo: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath customServerCertData: serverCertContent: serverCertContent serverKeyContent: serverKeyContent certType: SelfSigned certContent: certContent certExpiry: 0 keyContent: keyContent label: label hcVaultCertParams: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken description: certificate params of the backup to be restored required: true responses: '200': content: application/json: schema: format: uuid type: string examples: Upload200Example: summary: Default upload 200 response x-microcks-default: true value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restore a Certificate from Backup tags: - Certificate Info x-codegen-request-body-name: certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/create_self_signed_cert: post: description: YbaApi Internal. operationId: createSelfSignedCert parameters: - in: path name: cUUID 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: type: string examples: CreateSelfSignedCertRequestExample: summary: Default createSelfSignedCert request x-microcks-default: true value: string description: certificate label required: true responses: '200': content: application/json: schema: format: uuid type: string examples: CreateSelfSignedCert200Example: summary: Default createSelfSignedCert 200 response x-microcks-default: true value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Self Signed Certificate tags: - Certificate Info x-codegen-request-body-name: label x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/{name}: get: description: YbaApi Internal. operationId: getCertificate parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: name required: true schema: type: string example: example-name responses: '200': content: application/json: schema: format: uuid type: string examples: GetCertificate200Example: summary: Default getCertificate 200 response x-microcks-default: true value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Certificate's UUID tags: - Certificate Info x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/{rUUID}: delete: operationId: deleteCertificate parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID 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: DeleteCertificate200Example: summary: Default deleteCertificate 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Certificate tags: - Certificate Info x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: getClientCert parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID 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/ClientCertParams' examples: GetClientCertRequestExample: summary: Default getClientCert request x-microcks-default: true value: certStart: 6 certExpiry: 0 username: username description: post certificate info required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CertificateDetails' examples: GetClientCert200Example: summary: Default getClientCert 200 response x-microcks-default: true value: yugabytedb.key: yugabytedb.key yugabytedb.crt: yugabytedb.crt description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Add a Client Certificate tags: - Certificate Info x-codegen-request-body-name: certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/{rUUID}/download: get: operationId: getRootCert parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID 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: type: object examples: GetRootCert200Example: summary: Default getRootCert 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Customer's Root Certificate tags: - Certificate Info x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/{rUUID}/edit: post: operationId: editCertificate parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID 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/CertificateParams' examples: EditCertificateRequestExample: summary: Default editCertificate request x-microcks-default: true value: certStart: 6 customCertInfo: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath customServerCertData: serverCertContent: serverCertContent serverKeyContent: serverKeyContent certType: SelfSigned certContent: certContent certExpiry: 0 keyContent: keyContent label: label hcVaultCertParams: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken description: certificate params to edit required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: EditCertificate200Example: summary: Default editCertificate 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit TLS Certificate Config Details tags: - Certificate Info x-codegen-request-body-name: certificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/certificates/{rUUID}/update_empty_cert: post: description: YbaApi Internal. operationId: updateEmptyCustomCert parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID 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/CertificateInfoExt' examples: UpdateEmptyCustomCert200Example: summary: Default updateEmptyCustomCert 200 response x-microcks-default: true value: customServerCertInfo: serverCert: serverCert serverKey: serverKey certType: SelfSigned customHCPKICertInfo: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken certificate: /opt/yugaware/certs/.../ca.root.cert label: yb-admin-example uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryDateIso: 2022-12-12 13:07:18+00:00 expiryDate: 2000-01-23 04:56:07+00:00 privateKey: /opt/yugaware/.../example.key.pem customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeDetails: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDateIso: 2022-12-12 13:07:18+00:00 universeDetailSubsets: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 checksum: checksum inUse: true customCertPathParams: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath startDate: 2000-01-23 04:56:07+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update an Empty Certificate tags: - Certificate Info x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/customCAStore: post: description: 'WARNING: This is a preview API that could change.' operationId: addCA parameters: - in: path name: cUUID 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/CustomCACertParams' examples: AddCARequestExample: summary: Default addCA request x-microcks-default: true value: contents: contents name: name description: CA certificate contents in 'X509' format required: true responses: '200': content: application/json: schema: format: uuid type: string examples: AddCA200Example: summary: Default addCA 200 response x-microcks-default: true value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Add a Named Custom CA Certificate tags: - Custom CA Certificates x-codegen-request-body-name: X509CACertificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/customCAStore/{certUUID}: post: description: 'WARNING: This is a preview API that could change.' operationId: updateCA parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: certUUID 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/CustomCACertParams' examples: UpdateCARequestExample: summary: Default updateCA request x-microcks-default: true value: contents: contents name: name description: CA certificate contents in 'X509' format required: true responses: '200': content: application/json: schema: format: uuid type: string examples: UpdateCA200Example: summary: Default updateCA 200 response x-microcks-default: true value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update a Named Custom CA Certificate tags: - Custom CA Certificates x-codegen-request-body-name: X509CACertificate x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/customCAStoreCertificates: get: description: 'WARNING: This is a preview API that could change.' operationId: listAllCustomCaCertificates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CustomCaCertificateInfo' type: array examples: ListAllCustomCaCertificates200Example: summary: Default listAllCustomCaCertificates 200 response x-microcks-default: true value: - expiryDate: 2024-07-12 13:07:18+00:00 contents: /opt/yugaware/certs/trust-store//ca.root.cert customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true createdTime: 2023-11-10 15:09:18+00:00 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDate: 2023-10-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Custom CA Certificates of a Customer tags: - Custom CA Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: Delete custom CA certificate parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: certUUID 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: Delete custom CA certificate200Example: summary: Default Delete custom CA certificate 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Named Custom CA Certificate tags: - Custom CA Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getAllCustomCaCertificates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: certUUID 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/CustomCaCertificateInfo' examples: GetAllCustomCaCertificates200Example: summary: Default getAllCustomCaCertificates 200 response x-microcks-default: true value: expiryDate: 2024-07-12 13:07:18+00:00 contents: /opt/yugaware/certs/trust-store//ca.root.cert customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true createdTime: 2023-11-10 15:09:18+00:00 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDate: 2023-10-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Download a Custom CA Certificates of a Customer tags: - Custom CA Certificates x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/kms_configs: get: operationId: listKMSConfigs parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: properties: {} type: object type: array examples: ListKMSConfigs200Example: summary: Default listKMSConfigs 200 response x-microcks-default: true value: - {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List KMS Configurations tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/kms_configs/{configUUID}: delete: operationId: deleteKMSConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID 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: DeleteKMSConfig200Example: summary: Default deleteKMSConfig 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 KMS Configuration tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: getKMSConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: additionalProperties: properties: {} type: object type: object examples: GetKMSConfig200Example: summary: Default getKMSConfig 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Details of a KMS Configuration tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/kms_configs/{configUUID}/edit: post: operationId: editKMSConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID 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: type: object examples: EditKMSConfigRequestExample: summary: Default editKMSConfig request x-microcks-default: true value: {} description: KMS config to be edited required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: EditKMSConfig200Example: summary: Default editKMSConfig 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 Edit a KMS Configuration tags: - Encryption at rest x-codegen-request-body-name: KMS config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/kms_configs/{configUUID}/refresh: put: description: 'WARNING: This is a preview API that could change.' operationId: refreshKMSConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID 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: RefreshKMSConfig200Example: summary: Default refreshKMSConfig 200 response x-microcks-default: true value: success: true message: message description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: RefreshKMSConfig500Example: summary: Default refreshKMSConfig 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there is an error refreshing the KMS config. security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Refresh KMS Config tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/kms_configs/{kmsProvider}: post: operationId: createKMSConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: kmsProvider required: true schema: type: string example: example-kmsProvider - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: type: object examples: CreateKMSConfigRequestExample: summary: Default createKMSConfig request x-microcks-default: true value: {} description: KMS config to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateKMSConfig200Example: summary: Default createKMSConfig 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 KMS Configuration tags: - Encryption at rest x-codegen-request-body-name: KMS config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/node_agents: get: operationId: ListNodeAgents parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: nodeIp schema: type: string example: node-1 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/NodeAgentResp' type: array examples: ListNodeAgents200Example: summary: Default ListNodeAgents 200 response x-microcks-default: true value: - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Node Agents tags: - Node Agents x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/node_agents/page: post: operationId: PageListNodeAgents parameters: - in: path name: cUUID 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/NodeAgentPagedApiQuery' examples: PageListNodeAgentsRequestExample: summary: Default PageListNodeAgents request x-microcks-default: true value: filter: universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cloudType: unknown zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeIps: - nodeIps - nodeIps offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeAgentPagedApiResponse' examples: PageListNodeAgents200Example: summary: Default PageListNodeAgents 200 response x-microcks-default: true value: entities: - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 hasPrev: true hasNext: true totalCount: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Node Agents (paginated) tags: - Node Agents x-codegen-request-body-name: PageNodeAgentRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/node_agents/{nUUID}: get: operationId: GetNodeAgent parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: nUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeAgentResp' examples: GetNodeAgent200Example: summary: Default GetNodeAgent 200 response x-microcks-default: true value: lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Node Agent tags: - Node Agents x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/nodes: get: operationId: List parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: nodeIp schema: default: 'null' type: string example: 'null' responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeInstance' examples: List200Example: summary: Default List 200 response x-microcks-default: true value: manuallyDecommissioned: true nodeName: universe_node1 instanceName: Mumbai instance instanceTypeCode: c5large inUse: true zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east state: DECOMMISSIONED nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Node Instances of a Customer tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/nodes/{nodeUUID}/list: get: operationId: getNodeInstance parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: nodeUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeInstance' examples: GetNodeInstance200Example: summary: Default getNodeInstance 200 response x-microcks-default: true value: manuallyDecommissioned: true nodeName: universe_node1 instanceName: Mumbai instance instanceTypeCode: c5large inUse: true zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east state: DECOMMISSIONED nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Node Instance tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /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}/access_keys: get: operationId: list 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/AccessKey' type: array examples: List200Example: summary: Default list 200 response x-microcks-default: true value: - 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Access Keys for a Specific Provider tags: - Access Keys x-microcks-operation: delay: 0 dispatcher: FALLBACK post: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use /api/v1/customers/{cUUID}/provider/{pUUID}/edit instead for adding the key operationId: createAccesskey 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKeyFormData' examples: CreateAccesskeyRequestExample: summary: Default createAccesskey request x-microcks-default: true value: expirationThresholdDays: 0 keyCode: keyCode keyContent: keyContent keyType: PUBLIC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessKey' examples: CreateAccesskey200Example: summary: Default createAccesskey 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create/Upload Access Key for Onprem Provider Region - Deprecated tags: - Access Keys x-codegen-request-body-name: AccessKeyFormData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/access_keys/{keyCode}: delete: operationId: delete_accesskey 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: keyCode required: true schema: type: string example: OK - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: Delete_accesskey200Example: summary: Default delete_accesskey 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Access Key tags: - Access Keys x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: index 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: keyCode required: true schema: type: string example: OK responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessKey' examples: Index200Example: summary: Default index 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get an Access Key tags: - Access Keys x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: editAccesskey 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: keyCode required: true schema: type: string example: OK - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessKey' examples: EditAccesskeyRequestExample: summary: Default editAccesskey request x-microcks-default: true value: 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' description: access key edit form data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessKey' examples: EditAccesskey200Example: summary: Default editAccesskey 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Modify the Existing Access Key tags: - Access Keys x-codegen-request-body-name: accesskey 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}/instance_types: get: operationId: listOfInstanceType 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 - explode: true in: query name: zone schema: items: type: string type: array style: form example: - us-east-1a - in: query name: arch schema: default: 'null' type: string example: 'null' responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/InstanceTypeResp' type: array examples: ListOfInstanceType200Example: summary: Default listOfInstanceType 200 response x-microcks-default: true value: - numCores: 1.4658129805029452 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerCode: providerCode memSizeGB: 6.027456183070403 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: ListOfInstanceType500Example: summary: Default listOfInstanceType 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there was a server or database issue when listing the instance types security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List a Provider's Instance Types tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createInstanceType 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceType' examples: CreateInstanceTypeRequestExample: summary: Default createInstanceType request x-microcks-default: true value: numCores: 6.027456183070403 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 memSizeGB: 0.8008281904610115 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true description: Instance type data of the instance to be stored required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InstanceTypeResp' examples: CreateInstanceType200Example: summary: Default createInstanceType 200 response x-microcks-default: true value: numCores: 1.4658129805029452 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerCode: providerCode memSizeGB: 6.027456183070403 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Instance Type tags: - Instance types x-codegen-request-body-name: Instance type x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}: delete: operationId: deleteInstanceType 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: code required: true schema: type: string example: OK - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteInstanceType200Example: summary: Default deleteInstanceType 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Instance Type tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: instanceTypeDetail 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: code required: true schema: type: string example: OK responses: '200': content: application/json: schema: $ref: '#/components/schemas/InstanceTypeResp' examples: InstanceTypeDetail200Example: summary: Default instanceTypeDetail 200 response x-microcks-default: true value: numCores: 1.4658129805029452 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerCode: providerCode memSizeGB: 6.027456183070403 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Details of an Instance Type tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}: delete: operationId: deleteInstance 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: instanceIP required: true schema: type: string example: example-instanceIP - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteInstance200Example: summary: Default deleteInstance 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Node Instance tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: detachedNodeAction 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: instanceIP required: true schema: type: string example: example-instanceIP - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/NodeActionFormData' examples: DetachedNodeActionRequestExample: summary: Default detachedNodeAction request x-microcks-default: true value: nodeAction: ADD runOnlyPrechecks: true force: true description: Node action data to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DetachedNodeAction200Example: summary: Default detachedNodeAction 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 Detached Node Action tags: - Node instances x-codegen-request-body-name: Node action x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/state: put: description: 'WARNING: This is a preview API that could change.' operationId: updateState 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: instanceIP required: true schema: type: string example: example-instanceIP - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/NodeInstanceStateFormData' examples: UpdateStateRequestExample: summary: Default updateState request x-microcks-default: true value: state: DECOMMISSIONED description: Resultant node instance state to transition to required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: UpdateState200Example: summary: Default updateState 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 Node Instance State tags: - Node instances x-codegen-request-body-name: NodeInstanceStateFormData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/nodes/list: get: operationId: listByProvider 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/NodeInstance' type: array examples: ListByProvider200Example: summary: Default listByProvider 200 response x-microcks-default: true value: - manuallyDecommissioned: true nodeName: universe_node1 instanceName: Mumbai instance instanceTypeCode: c5large inUse: true zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east state: DECOMMISSIONED nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All of a Provider's Node Instances tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions: post: description: 'WARNING: This is a preview API that could change.' operationId: createProviderRegion 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/Region' examples: CreateProviderRegionRequestExample: summary: Default createProviderRegion request x-microcks-default: true value: 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 description: Specification of Region to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' examples: CreateProviderRegion200Example: summary: Default createProviderRegion 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a New Region tags: - Region management x-codegen-request-body-name: region x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}: put: description: 'WARNING: This is a preview API that could change.' operationId: editProviderRegion 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: rUUID 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/Region' examples: EditProviderRegionRequestExample: summary: Default editProviderRegion request x-microcks-default: true value: 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 description: Specification of Region to be edited required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' examples: EditProviderRegion200Example: summary: Default editProviderRegion 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Modify a Region tags: - Region management x-codegen-request-body-name: region x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones: post: description: 'WARNING: This is a preview API that could change.' operationId: createZone 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: rUUID 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/AvailabilityZone' examples: CreateZoneRequestExample: summary: Default createZone request x-microcks-default: true value: 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 description: Availability Zone to create required: true responses: '200': content: application/json: schema: additionalProperties: $ref: '#/components/schemas/AvailabilityZone' type: object examples: CreateZone200Example: summary: Default createZone 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Availability Zone tags: - Availability Zones x-codegen-request-body-name: azData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID}: put: description: 'WARNING: This is a preview API that could change.' operationId: editZone 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: rUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID 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/AvailabilityZone' examples: EditZoneRequestExample: summary: Default editZone request x-microcks-default: true value: 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 description: Availability zone to edit required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' examples: EditZone200Example: summary: Default editZone 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Modify an Availability Zone tags: - Availability Zones x-codegen-request-body-name: azData 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 /api/v1/customers/{cUUID}/providers/{pUUID}/regions: get: operationId: getRegion 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/Region' type: array examples: GetRegion200Example: summary: Default getRegion 200 response x-microcks-default: true value: - 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 description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: GetRegion500Example: summary: Default getRegion 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there was a server or database issue when listing the regions security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List a Provider's Regions tags: - Region management x-microcks-operation: delay: 0 dispatcher: FALLBACK post: deprecated: true description: Deprecated since YBA version 2.18.2.0.

Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions instead operationId: createRegion 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/RegionFormData' examples: CreateRegionRequestExample: summary: Default createRegion request x-microcks-default: true value: securityGroupId: securityGroupId hostVpcId: hostVpcId code: code destVpcId: destVpcId ybImage: ybImage latitude: 0.8008281904610115 name: name vnetName: vnetName hostVpcRegion: hostVpcRegion longitude: 6.027456183070403 description: region form data for new region to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' examples: CreateRegion200Example: summary: Default createRegion 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Region - Deprecated tags: - Region management x-codegen-request-body-name: region x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}: delete: operationId: deleteRegion 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: rUUID 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: type: object examples: DeleteRegion200Example: summary: Default deleteRegion 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Region tags: - Region management x-microcks-operation: delay: 0 dispatcher: FALLBACK put: deprecated: true description: Deprecated since YBA version 2.18.2.0.

Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions instead operationId: editRegion 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: rUUID 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/RegionFormData' examples: EditRegionRequestExample: summary: Default editRegion request x-microcks-default: true value: securityGroupId: securityGroupId hostVpcId: hostVpcId code: code destVpcId: destVpcId ybImage: ybImage latitude: 0.8008281904610115 name: name vnetName: vnetName hostVpcRegion: hostVpcRegion longitude: 6.027456183070403 description: region edit form data required: true responses: '200': content: application/json: schema: type: object examples: EditRegion200Example: summary: Default editRegion 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit Regions - Deprecated tags: - Region management x-codegen-request-body-name: region x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones: get: operationId: listOfAZ 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: rUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AvailabilityZone' type: array examples: ListOfAZ200Example: summary: Default listOfAZ 200 response x-microcks-default: true value: - 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Availability Zones tags: - Availability Zones x-microcks-operation: delay: 0 dispatcher: FALLBACK post: deprecated: true description: Deprecated since YBA version 2.18.2.0.

Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions/:rUUID/region_zones instead operationId: createAZ 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: rUUID 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/AvailabilityZoneFormData' examples: CreateAZRequestExample: summary: Default createAZ request x-microcks-default: true value: availabilityZones: - subnet: subnet code: code name: name secondarySubnet: secondarySubnet - subnet: subnet code: code name: name secondarySubnet: secondarySubnet description: Availability zone form data required: true responses: '200': content: application/json: schema: additionalProperties: $ref: '#/components/schemas/AvailabilityZone' type: object examples: CreateAZ200Example: summary: Default createAZ 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Availability Zone - Deprecated tags: - Availability Zones x-codegen-request-body-name: azFormData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}: delete: operationId: deleteAZ 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: rUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID 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: DeleteAZ200Example: summary: Default deleteAZ 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Availability Zone tags: - Availability Zones x-microcks-operation: delay: 0 dispatcher: FALLBACK put: deprecated: true description: Deprecated since YBA version 2.18.2.0.

Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions/:rUUID/region_zones/:zUUID instead operationId: editAZ 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: rUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID 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/AvailabilityZoneFormData' examples: EditAZRequestExample: summary: Default editAZ request x-microcks-default: true value: availabilityZones: - subnet: subnet code: code name: name secondarySubnet: secondarySubnet - subnet: subnet code: code name: name secondarySubnet: secondarySubnet description: Availability zone edit form data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AvailabilityZone' examples: EditAZ200Example: summary: Default editAZ 200 response x-microcks-default: true value: 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit an Availabilty Zone - Deprecated tags: - Availability Zones x-codegen-request-body-name: azFormData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/regions: get: operationId: listAllRegions parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Region' type: array examples: ListAllRegions200Example: summary: Default listAllRegions 200 response x-microcks-default: true value: - 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 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Regions for All Providers tags: - Region management x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/kms: delete: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Do not use. operationId: removeKeyRefHistory parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID 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: RemoveKeyRefHistory200Example: summary: Default removeKeyRefHistory 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere This API Removes a Universe's Key Reference History - Deprecated tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: YbaApi Internal. operationId: getKeyRefHistory parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: properties: {} type: object type: array examples: GetKeyRefHistory200Example: summary: Default getKeyRefHistory 200 response x-microcks-default: true value: - {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Universe's Key Reference History tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: YbaApi Internal. operationId: retrieveKey parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID 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: additionalProperties: properties: {} type: object type: object examples: RetrieveKey200Example: summary: Default retrieveKey 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Retrive a Universe's KMS Key tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/kms/key_ref: get: description: YbaApi Internal. operationId: getCurrentKeyRef parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: additionalProperties: properties: {} type: object type: object examples: GetCurrentKeyRef200Example: summary: Default getCurrentKeyRef 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get a Universe's Key Reference tags: - Encryption at rest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/node_agents: post: operationId: ReinstallNodeAgent parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID 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/ReinstallNodeAgentForm' examples: ReinstallNodeAgentRequestExample: summary: Default ReinstallNodeAgent request x-microcks-default: true value: nodeNames: - nodeNames - nodeNames required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeAgent' examples: ReinstallNodeAgent200Example: summary: Default ReinstallNodeAgent 200 response x-microcks-default: true value: lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message ip: ip uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version home: home customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor updatedAt: 2022-12-21 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Reinstall Node Agent tags: - Node Agents x-codegen-request-body-name: ReinstallNodeAgentForm x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}: put: operationId: nodeAction parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: universeUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: nodeName required: true schema: type: string example: example-nodeName - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/NodeActionFormData' examples: NodeActionRequestExample: summary: Default nodeAction request x-microcks-default: true value: nodeAction: ADD runOnlyPrechecks: true force: true description: Details of the node action to be performed required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: NodeAction200Example: summary: Default nodeAction 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 Perform the Specified Action on the Universe Node tags: - Node instances x-codegen-request-body-name: Node action x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/details: get: operationId: getNodeDetails parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: universeUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: nodeName required: true schema: type: string example: example-nodeName responses: '200': content: application/json: schema: $ref: '#/components/schemas/NodeDetailsResp' examples: GetNodeDetails200Example: summary: Default getNodeDetails 200 response x-microcks-default: true value: nodeName: nodeName nodeExporterPort: 6 allowedActions: - ADD - ADD placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 6 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 3 masterState: ToStart tserverRpcPort: 7 ysqlServerHttpPort: 7 yqlServerRpcPort: 8 otelCollectorMetricsPort: 6 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 7 cronsActive: true state: Provisioned nodeIdx: 5 masterRpcPort: 6 redisServerRpcPort: 3 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 kubernetesOverrides: kubernetesOverrides tserverHttpPort: 0 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 1 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 0 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 2 ysqlServerRpcPort: 3 autoSyncMasterAddrs: true yqlServerHttpPort: 4 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Node Details tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/zones/{azUUID}/nodes: post: operationId: createNodeInstance parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID 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/NodeInstanceFormData' examples: CreateNodeInstanceRequestExample: summary: Default createNodeInstance request x-microcks-default: true value: nodes: - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east description: Node instance data to be created required: true responses: '200': content: application/json: schema: additionalProperties: $ref: '#/components/schemas/NodeInstance' type: object examples: CreateNodeInstance200Example: summary: Default createNodeInstance 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Node Instance tags: - Node instances x-codegen-request-body-name: Node instance x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/list: get: operationId: listByZone parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/NodeInstance' type: array examples: ListByZone200Example: summary: Default listByZone 200 response x-microcks-default: true value: - manuallyDecommissioned: true nodeName: universe_node1 instanceName: Mumbai instance instanceTypeCode: c5large inUse: true zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east state: DECOMMISSIONED nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All of a Zone's Node Instances tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validate: post: operationId: validateNodeInstance parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: azUUID 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: additionalProperties: $ref: '#/components/schemas/ValidationResult' type: object examples: ValidateNodeInstance200Example: summary: Default validateNodeInstance 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Validate a Node Instance tags: - Node instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/metadata/azu_types: get: operationId: getAZUTypes responses: '200': content: application/json: schema: items: enum: - IO1 - IO2 - GP2 - GP3 - Scratch - Persistent - Hyperdisk_Balanced - Hyperdisk_Extreme - StandardSSD_LRS - Premium_LRS - PremiumV2_LRS - UltraSSD_LRS - Local type: string type: array examples: GetAZUTypes200Example: summary: Default getAZUTypes 200 response x-microcks-default: true value: - IO1 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Supported Azure Disk Types tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/metadata/ebs_types: get: operationId: getEBSTypes responses: '200': content: application/json: schema: items: enum: - IO1 - IO2 - GP2 - GP3 - Scratch - Persistent - Hyperdisk_Balanced - Hyperdisk_Extreme - StandardSSD_LRS - Premium_LRS - PremiumV2_LRS - UltraSSD_LRS - Local type: string type: array examples: GetEBSTypes200Example: summary: Default getEBSTypes 200 response x-microcks-default: true value: - IO1 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Supported EBS Volume Types tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/metadata/gcp_types: get: operationId: getGCPTypes responses: '200': content: application/json: schema: items: enum: - IO1 - IO2 - GP2 - GP3 - Scratch - Persistent - Hyperdisk_Balanced - Hyperdisk_Extreme - StandardSSD_LRS - Premium_LRS - PremiumV2_LRS - UltraSSD_LRS - Local type: string type: array examples: GetGCPTypes200Example: summary: Default getGCPTypes 200 response x-microcks-default: true value: - IO1 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Supported GCP Disk Types tags: - Instance types x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/node_agents/download: get: operationId: DownloadNodeAgentInstaller parameters: - in: query name: downloadType schema: default: INSTALLER type: string example: INSTALLER - in: query name: os schema: type: string example: example-os - in: query name: arch schema: type: string example: example-arch responses: '200': content: application/gzip: schema: type: string examples: DownloadNodeAgentInstaller200Example: summary: Default DownloadNodeAgentInstaller 200 response x-microcks-default: true value: string application/x-sh: schema: type: string examples: DownloadNodeAgentInstaller200Example: summary: Default DownloadNodeAgentInstaller 200 response x-microcks-default: true value: string description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Download Node Agent Installer or Package tags: - Node Agents x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: apiKeyAuth: description: API token passed as header in: header name: X-AUTH-YW-API-TOKEN type: apiKey schemas: 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 HashicorpVaultConfigParams: example: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken properties: engine: type: string example: example-engine mountPath: type: string example: /var/lib/yugabyte/example role: type: string example: example-role ttl: format: int64 type: integer example: 1000 ttlExpiry: format: int64 type: integer example: 1000 vaultAddr: type: string example: example-vaultAddr vaultAuthNamespace: type: string example: example-vaultAuthNamespace vaultRoleID: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vaultSecretID: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vaultToken: type: string example: REDACTED required: - engine - mountPath - role - vaultAddr 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 AccessKeyFormData: example: expirationThresholdDays: 0 keyCode: keyCode keyContent: keyContent keyType: PUBLIC properties: expirationThresholdDays: format: int32 type: integer example: 100 keyCode: type: string example: OK keyContent: type: string example: example-key keyType: enum: - PUBLIC - PRIVATE type: string example: PUBLIC required: - keyCode - keyContent - keyType type: object ClientCertParams: example: certStart: 6 certExpiry: 0 username: username properties: certExpiry: format: int64 type: integer example: 1000 certStart: format: int64 type: integer example: 1000 username: type: string example: example-username required: - certExpiry - certStart - username type: object NodeAgentResp: description: Node agent details example: lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 properties: archType: description: Node agent host machine arch enum: - ARM64 - AMD64 readOnly: true type: string example: ARM64 config: $ref: '#/components/schemas/Config' customerUuid: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 home: description: Node agent installation directory readOnly: true type: string example: example-home ip: description: Node agent server IP readOnly: true type: string example: 10.0.0.1 lastError: $ref: '#/components/schemas/YBAError' name: description: Node agent name readOnly: true type: string example: example-name osType: description: Node agent host OS enum: - DARWIN - LINUX readOnly: true type: string example: DARWIN port: description: Node agent server port format: int32 readOnly: true type: integer example: 5433 providerName: readOnly: true type: string example: example-providerName providerUuid: format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 reachable: readOnly: true type: boolean example: true state: description: Node agent state enum: - REGISTERING - REGISTERED - UPGRADE - UPGRADED - READY readOnly: true type: string example: REGISTERING universeName: readOnly: true type: string example: example-universeName universeUuid: format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedAt: description: Updated time example: 2022-12-21 13:07:18+00:00 format: date-time readOnly: true type: string uuid: description: Node agent UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: description: Node agent installed version readOnly: true type: string example: 2.20.0.0 versionMatched: readOnly: true type: boolean example: true type: object NodeAgentPagedApiResponse: example: entities: - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: 2022-12-21 13:07:18+00:00 hasPrev: true hasNext: true totalCount: 0 properties: entities: items: $ref: '#/components/schemas/NodeAgentResp' type: array example: - lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message versionMatched: true ip: ip providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version reachable: true home: home universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor providerName: providerName universeName: universeName updatedAt: '2022-12-21T13:07:18+00:00' hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object AvailabilityZoneData: description: Details of an availability zone, used by the API and UI to validate data against input constraints example: subnet: subnet code: code name: name secondarySubnet: secondarySubnet properties: code: description: AZ code type: string example: OK name: description: AZ name type: string example: example-name secondarySubnet: description: AZ secondary subnet type: string example: example-secondarySubnet subnet: description: AZ subnet type: string example: example-subnet required: - code - name type: object VolumeDetails: example: volumeSizeGB: 0 volumeType: EBS mountPath: mountPath properties: mountPath: type: string example: /var/lib/yugabyte/example volumeSizeGB: format: int32 type: integer example: 10 volumeType: enum: - EBS - SSD - HDD - NVME type: string example: EBS required: - mountPath - volumeSizeGB - volumeType 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 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 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 NodeActionFormData: example: nodeAction: ADD runOnlyPrechecks: true force: true properties: force: description: Should ignore master unavailability and proceed with the node action type: boolean example: true nodeAction: description: Action to perform on the node. enum: - ADD - REMOVE - START - STOP - DELETE - QUERY - RELEASE - REBOOT - START_MASTER - PRECHECK_DETACHED - HARD_REBOOT - REPROVISION - REPLACE - DECOMMISSION type: string example: ADD runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean example: true required: - nodeAction 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 ValidationResult: description: Validation result of a node config properties: description: type: string example: Example description required: type: boolean example: true type: enum: - NTP_SERVICE_STATUS - PROMETHEUS_SPACE - MOUNT_POINTS_WRITABLE - USER - USER_GROUP - HOME_DIR_SPACE - HOME_DIR_EXISTS - HOME_DIR_MATCHES - RAM_SIZE - INTERNET_CONNECTION - CPU_CORES - PROMETHEUS_NO_NODE_EXPORTER - TMP_DIR_SPACE - PAM_LIMITS_WRITABLE - PYTHON_VERSION - MOUNT_POINTS_VOLUME - CHRONYD_RUNNING - LOCALE_PRESENT - SSH_PORT - SUDO_ACCESS - OPENSSL - POLICYCOREUTILS - RSYNC - XXHASH - LIBATOMIC1 - LIBNCURSES6 - LIBATOMIC - AZCOPY - CHRONYC - GSUTIL - S3CMD - NODE_EXPORTER_RUNNING - NODE_EXPORTER_PORT - SWAPPINESS - ULIMIT_CORE - ULIMIT_OPEN_FILES - ULIMIT_USER_PROCESSES - SSH_ACCESS - NODE_AGENT_ACCESS - MASTER_HTTP_PORT - MASTER_RPC_PORT - TSERVER_HTTP_PORT - TSERVER_RPC_PORT - YB_CONTROLLER_HTTP_PORT - YB_CONTROLLER_RPC_PORT - REDIS_SERVER_HTTP_PORT - REDIS_SERVER_RPC_PORT - YB_HOME_DIR_CLEAN - DATA_DIR_CLEAN - YCQL_SERVER_HTTP_PORT - YCQL_SERVER_RPC_PORT - YSQL_SERVER_HTTP_PORT - YSQL_SERVER_RPC_PORT - VM_MAX_MAP_COUNT - NTP_SKEW type: string example: NTP_SERVICE_STATUS valid: type: boolean example: true value: type: string example: example-value required: - description - required - type - valid - value type: object CustomServerCertData: example: serverCertContent: serverCertContent serverKeyContent: serverKeyContent properties: serverCertContent: type: string example: example-serverCertContent serverKeyContent: type: string example: example-key required: - serverCertContent - serverKeyContent type: object InstanceTypeDetails: example: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath properties: arch: description: Architecture for the instance. enum: - x86_64 - aarch64 type: string example: x86_64 tenancy: description: Tenancy for the instance. enum: - Shared - Dedicated - Host type: string example: Shared volumeDetailsList: description: Volume Details for the instance. items: $ref: '#/components/schemas/VolumeDetails' type: array example: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath type: object 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 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 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 CertificateParams: description: Certificate Params is used to validate constraints for the custom certificate Data example: certStart: 6 customCertInfo: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath customServerCertData: serverCertContent: serverCertContent serverKeyContent: serverKeyContent certType: SelfSigned certContent: certContent certExpiry: 0 keyContent: keyContent label: label hcVaultCertParams: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken properties: certContent: type: string example: example-certContent certExpiry: format: int64 type: integer example: 1000 certStart: format: int64 type: integer example: 1000 certType: enum: - SelfSigned - CustomCertHostPath - CustomServerCert - HashicorpVault - K8SCertManager type: string example: SelfSigned customCertInfo: $ref: '#/components/schemas/CustomCertInfo' customServerCertData: $ref: '#/components/schemas/CustomServerCertData' hcVaultCertParams: $ref: '#/components/schemas/HashicorpVaultConfigParams' keyContent: type: string example: example-key label: type: string example: example-label required: - certContent - certExpiry - certStart - certType - label type: object CertificateInfoExt: description: SSL certificate used by the universe example: customServerCertInfo: serverCert: serverCert serverKey: serverKey certType: SelfSigned customHCPKICertInfo: vaultAddr: vaultAddr vaultRoleID: vaultRoleID mountPath: mountPath role: role engine: engine ttlExpiry: 6 vaultAuthNamespace: vaultAuthNamespace vaultSecretID: vaultSecretID ttl: 0 vaultToken: vaultToken certificate: /opt/yugaware/certs/.../ca.root.cert label: yb-admin-example uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryDateIso: 2022-12-12 13:07:18+00:00 expiryDate: 2000-01-23 04:56:07+00:00 privateKey: /opt/yugaware/.../example.key.pem customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeDetails: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDateIso: 2022-12-12 13:07:18+00:00 universeDetailSubsets: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 checksum: checksum inUse: true customCertPathParams: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath startDate: 2000-01-23 04:56:07+00:00 properties: certType: description: Type of the certificate enum: - SelfSigned - CustomCertHostPath - CustomServerCert - HashicorpVault - K8SCertManager example: SelfSigned type: string certificate: description: Certificate path example: /opt/yugaware/certs/.../ca.root.cert type: string checksum: description: The certificate file's checksum readOnly: true type: string example: example-checksum customCertPathParams: $ref: '#/components/schemas/CustomCertInfo' customHCPKICertInfo: $ref: '#/components/schemas/HashicorpVaultConfigParams' customServerCertInfo: $ref: '#/components/schemas/CustomServerCertInfo' customerUUID: description: Customer UUID of the backup which it belongs to format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryDate: description: The certificate's expiry date. Deprecated since YBA version 2.17.2.0. Use expirtyDateIso instead format: date-time type: string example: '2026-05-03T12:00:00Z' expiryDateIso: description: The certificate's expiry date example: 2022-12-12 13:07:18+00:00 format: date-time type: string inUse: description: Indicates whether the certificate is in use. This value is `true` if the universe contains a reference to the certificate. readOnly: true type: boolean example: true label: description: Certificate label example: yb-admin-example type: string privateKey: description: Private key path example: /opt/yugaware/.../example.key.pem type: string startDate: description: The certificate's creation date. Deprecated since YBA version 2.17.2.0. Use stateDateIso instead format: date-time type: string example: '2026-05-03T12:00:00Z' startDateIso: description: The certificate's creation date example: 2022-12-12 13:07:18+00:00 format: date-time type: string universeDetailSubsets: items: $ref: '#/components/schemas/UniverseDetailSubset' type: array example: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeDetails: description: Associated universe details for the certificate items: $ref: '#/components/schemas/UniverseDetailSubset' readOnly: true type: array example: - universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: description: Certificate UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customCertPathParams - customHCPKICertInfo - customServerCertInfo - universeDetailSubsets type: object InstanceTypeKey: example: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: instanceTypeCode: type: string example: OK providerUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - instanceTypeCode - providerUuid 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 InstanceType: description: Information about an instance example: numCores: 6.027456183070403 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 memSizeGB: 0.8008281904610115 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true properties: active: description: True if the instance is active readOnly: true type: boolean example: true idKey: $ref: '#/components/schemas/InstanceTypeKey' instanceTypeCode: description: Instance type code readOnly: true type: string example: OK instanceTypeDetails: $ref: '#/components/schemas/InstanceTypeDetails' memSizeGB: description: The instance's memory size, in gigabytes format: double type: number example: 1.5 numCores: description: The instance's number of CPU cores format: double type: number example: 1.5 required: - idKey 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 YBPError: description: Generic error response from the YugabyteDB Anywhere API example: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: error: description: User-visible unstructured error message example: There was a problem creating the universe type: string errorJson: description: User visible structured error message as json object example: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: {} type: object httpMethod: description: Method for HTTP call that resulted in this error example: POST type: string requestJson: description: User request JSON object example: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: {} type: object requestUri: description: URI for HTTP request that resulted in this error example: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create type: string success: description: Always set to false to indicate failure example: false type: boolean 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 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 CustomCertInfo: example: nodeCertPath: nodeCertPath nodeKeyPath: nodeKeyPath clientKeyPath: clientKeyPath clientCertPath: clientCertPath rootCertPath: rootCertPath properties: clientCertPath: type: string example: /var/lib/yugabyte/example clientKeyPath: type: string example: /var/lib/yugabyte/example nodeCertPath: type: string example: /var/lib/yugabyte/example nodeKeyPath: type: string example: /var/lib/yugabyte/example rootCertPath: type: string example: /var/lib/yugabyte/example required: - clientCertPath - clientKeyPath - nodeCertPath - nodeKeyPath - rootCertPath type: object CustomCACertParams: example: contents: contents name: name properties: contents: type: string example: example-contents name: type: string example: example-name required: - contents - name 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 CloudSpecificInfo: description: Node information reported by the cloud provider example: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type properties: assignPublicIP: description: True if the node has a public IP address assigned type: boolean example: true az: description: The node's availability zone type: string example: example-az cloud: description: The node's cloud provider type: string example: example-cloud instance_type: description: The node's instance type type: string example: DEFAULT kubernetesNamespace: description: Kubernetes namespace type: string example: example-kubernetesNamespace kubernetesPodName: description: Pod name in Kubernetes type: string example: example-kubernetesPodName lun_indexes: description: Mounted disks LUN indexes items: format: int32 type: integer type: array example: - 100 mount_roots: description: Mount roots type: string example: example-mount_roots private_dns: description: The node's private DNS type: string example: example-private_dns private_ip: description: The node's private IP address type: string example: 10.0.0.1 public_dns: description: The node's public DNS name type: string example: example-public_dns public_ip: description: The node's public IP address type: string example: 10.0.0.1 region: description: The node's region type: string example: us-east-1 root_volume: description: Root volume ID or name type: string example: example-root_volume secondary_private_ip: description: Secondary Private IP type: string example: 10.0.0.1 secondary_subnet_id: description: Secondary Subnet IP type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 subnet_id: description: ID of the subnet on which this node is deployed type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useTimeSync: description: True if `use time sync` is enabled type: boolean example: true type: object AvailabilityZoneFormData: example: availabilityZones: - subnet: subnet code: code name: name secondarySubnet: secondarySubnet - subnet: subnet code: code name: name secondarySubnet: secondarySubnet properties: availabilityZones: description: List of availability zones items: $ref: '#/components/schemas/AvailabilityZoneData' type: array example: - subnet: subnet code: code name: name secondarySubnet: secondarySubnet required: - availabilityZones 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 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 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 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 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 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 NodeAgentPagedApiQuery: example: filter: universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cloudType: unknown zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeIps: - nodeIps - nodeIps offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/NodeAgentApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - uuid - ip - name - state - updatedAt - version type: string example: uuid required: - direction - filter - limit - needTotalCount - offset - sortBy type: object UniverseDetailSubset: description: A small subset of universe information example: universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: creationDate: format: int64 type: integer example: 1000 name: type: string example: example-name universePaused: type: boolean example: true updateInProgress: type: boolean example: true updateSucceeded: type: boolean example: true uuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - creationDate - name - universePaused - updateInProgress - updateSucceeded - uuid 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 NodeInstanceData: description: Details of a node instance. Used by the API to validate data against input constraints. example: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east properties: instanceName: description: Node instance name example: Mumbai instance type: string instanceType: description: Node instance type example: c5large type: string ip: description: IP address example: 1.1.1.1 type: string nodeName: description: Node name in a universe example: universe_node1 readOnly: true type: string region: description: Region example: south-east type: string sshUser: description: SSH user example: centos type: string zone: description: Zone example: south-east type: string required: - instanceName - instanceType - ip - region - zone 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 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 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 NodeInstance: description: A single node instance, attached to a provider and availability zone example: manuallyDecommissioned: true nodeName: universe_node1 instanceName: Mumbai instance instanceTypeCode: c5large inUse: true zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east state: DECOMMISSIONED nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}' properties: details: $ref: '#/components/schemas/NodeInstanceData' detailsJson: description: Node details (as a JSON object) example: '{"ip":"1.1.1.1","sshUser":"centos"}' readOnly: true type: string inUse: description: True if the node is in use Deprecated since YBA version 2024.1.0.0. Use NodeInstance.state instead type: boolean example: true instanceName: description: The node instance's name example: Mumbai instance type: string instanceTypeCode: description: The node's type code example: c5large type: string manuallyDecommissioned: description: Manually set to decommissioned state by user readOnly: true type: boolean example: true nodeName: description: The node's name in a universe example: universe_node1 readOnly: true type: string nodeUuid: description: The node's UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: description: State of on-prem node enum: - DECOMMISSIONED - USED - FREE readOnly: true type: string example: DECOMMISSIONED zoneUuid: description: The availability zone's UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - details 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 NodeAgent: description: Node agent details example: lastError: code: UNKNOWN_ERROR originMessage: originMessage message: message ip: ip uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: version home: home customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 port: 0 name: name osType: DARWIN archType: ARM64 state: REGISTERING config: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor updatedAt: 2022-12-21 13:07:18+00:00 properties: archType: description: Node agent host machine arch enum: - ARM64 - AMD64 readOnly: true type: string example: ARM64 config: $ref: '#/components/schemas/Config' customerUuid: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 home: description: Node agent installation directory readOnly: true type: string example: example-home ip: description: Node agent server IP readOnly: true type: string example: 10.0.0.1 lastError: $ref: '#/components/schemas/YBAError' name: description: Node agent name readOnly: true type: string example: example-name osType: description: Node agent host OS enum: - DARWIN - LINUX readOnly: true type: string example: DARWIN port: description: Node agent server port format: int32 readOnly: true type: integer example: 5433 state: description: Node agent state enum: - REGISTERING - REGISTERED - UPGRADE - UPGRADED - READY readOnly: true type: string example: REGISTERING updatedAt: description: Updated time example: 2022-12-21 13:07:18+00:00 format: date-time readOnly: true type: string uuid: description: Node agent UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: description: Node agent installed version readOnly: true type: string example: 2.20.0.0 type: object NodeDetailsResp: example: nodeName: nodeName nodeExporterPort: 6 allowedActions: - ADD - ADD placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 6 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 3 masterState: ToStart tserverRpcPort: 7 ysqlServerHttpPort: 7 yqlServerRpcPort: 8 otelCollectorMetricsPort: 6 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 7 cronsActive: true state: Provisioned nodeIdx: 5 masterRpcPort: 6 redisServerRpcPort: 3 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 kubernetesOverrides: kubernetesOverrides tserverHttpPort: 0 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 1 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 0 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 2 ysqlServerRpcPort: 3 autoSyncMasterAddrs: true yqlServerHttpPort: 4 properties: allowedActions: items: enum: - ADD - REMOVE - START - STOP - DELETE - QUERY - RELEASE - REBOOT - START_MASTER - PRECHECK_DETACHED - HARD_REBOOT - REPROVISION - REPLACE - DECOMMISSION type: string readOnly: true type: array uniqueItems: true example: - ADD autoSyncMasterAddrs: description: 'WARNING: This is a preview API that could change. Used by auto master failover' readOnly: true type: boolean example: true azUuid: description: The availability zone's UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cloudInfo: $ref: '#/components/schemas/CloudSpecificInfo' cronsActive: description: True if cron jobs were properly configured for this node type: boolean example: true dedicatedTo: description: Used for configurations where each node can have only one process enum: - MASTER - TSERVER - CONTROLLER - YQLSERVER - YSQLSERVER - REDISSERVER - EITHER type: string example: MASTER disksAreMountedByUUID: description: Disks are mounted by uuid type: boolean example: true internalYsqlServerRpcPort: description: Internal YSQL RPC port format: int32 type: integer example: 5433 isMaster: description: True if this node is a master type: boolean example: true isRedisServer: description: True if this node is a REDIS server type: boolean example: true isTserver: description: True if this node is a Tablet server type: boolean example: true isYqlServer: description: True if this node is a YCQL server type: boolean example: true isYsqlServer: description: True if this node is a YSQL server type: boolean example: true kubernetesOverrides: type: string example: example-kubernetesOverrides lastVolumeUpdateTime: description: Store last volume update time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string machineImage: description: Machine image name type: string example: example-machineImage masterHttpPort: description: Master HTTP port format: int32 type: integer example: 5433 masterRpcPort: description: Master RPC port format: int32 type: integer example: 5433 masterState: description: Master state enum: - None - ToStart - Configured - ToStop example: ToStart type: string nodeExporterPort: description: Node exporter port format: int32 type: integer example: 5433 nodeIdx: description: Node ID format: int32 type: integer example: 100 nodeName: description: Node name type: string example: example-nodeName nodeUuid: description: Node UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 otelCollectorMetricsPort: description: Otel collector metrics port format: int32 type: integer example: 5433 placementUuid: description: UUID of the cluster to which this node belongs format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 redisServerHttpPort: description: REDIS HTTP port format: int32 type: integer example: 5433 redisServerRpcPort: description: REDIS RPC port format: int32 type: integer example: 5433 sshPortOverride: description: SSH port override for the AMI format: int32 type: integer example: 5433 sshUserOverride: description: SSH user override for the AMI type: string example: example-sshUserOverride state: description: Node state enum: - ToBeAdded - InstanceCreated - ServerSetup - ToJoinCluster - Reprovisioning - Provisioned - SoftwareInstalled - UpgradeMasterSoftware - UpgradeSoftware - RollbackUpgrade - FinalizeUpgrade - UpdateGFlags - Live - Stopping - Starting - Stopped - Unreachable - MetricsUnavailable - ToBeRemoved - Removing - Removed - Adding - BeingDecommissioned - Decommissioned - UpdateCert - ToggleTls - ConfigureDBApis - Resizing - SystemdUpgrade - Terminating - Terminated - Rebooting - HardRebooting - VMImageUpgrade - InstanceStopping - InstanceStopped example: Provisioned type: string tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer example: 5433 tserverRpcPort: description: Tablet server RPC port format: int32 type: integer example: 5433 ybControllerHttpPort: description: Yb controller HTTP port format: int32 type: integer example: 5433 ybControllerRpcPort: description: Yb controller RPC port format: int32 type: integer example: 5433 ybPrebuiltAmi: description: True if this a custom YB AMI type: boolean example: true yqlServerHttpPort: description: YCQL HTTP port format: int32 type: integer example: 5433 yqlServerRpcPort: description: YCQL RPC port format: int32 type: integer example: 5433 ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer example: 5433 ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer example: 5433 required: - kubernetesOverrides type: object NodeAgentApiFilter: example: universeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cloudType: unknown zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeIps: - nodeIps - nodeIps properties: cloudType: enum: - unknown - aws - gcp - azu - docker - onprem - kubernetes - local - other type: string example: unknown nodeIps: items: type: string type: array uniqueItems: true example: - node-1 providerUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 zoneUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - cloudType - nodeIps - providerUuid - regionUuid - universeUuid - zoneUuid type: object CustomServerCertInfo: example: serverCert: serverCert serverKey: serverKey properties: serverCert: type: string example: example-serverCert serverKey: type: string example: example-key required: - serverCert - serverKey type: object CertificateDetails: example: yugabytedb.key: yugabytedb.key yugabytedb.crt: yugabytedb.crt properties: yugabytedb.crt: type: string example: example-yugabytedb.crt yugabytedb.key: type: string example: example-key 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 RegionFormData: example: securityGroupId: securityGroupId hostVpcId: hostVpcId code: code destVpcId: destVpcId ybImage: ybImage latitude: 0.8008281904610115 name: name vnetName: vnetName hostVpcRegion: hostVpcRegion longitude: 6.027456183070403 properties: code: type: string example: OK destVpcId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 hostVpcId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 hostVpcRegion: type: string example: yugabyte.example.com latitude: format: double type: number example: 1.5 longitude: format: double type: number example: 1.5 name: type: string example: example-name securityGroupId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 vnetName: type: string example: example-vnetName ybImage: type: string example: example-ybImage required: - code - destVpcId - hostVpcId - hostVpcRegion - latitude - longitude - name - securityGroupId - vnetName - ybImage 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 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 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 InstanceTypeResp: description: Details of a cloud instance type example: numCores: 1.4658129805029452 idKey: instanceTypeCode: instanceTypeCode providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 providerCode: providerCode memSizeGB: 6.027456183070403 instanceTypeCode: instanceTypeCode instanceTypeDetails: tenancy: Shared arch: x86_64 volumeDetailsList: - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath - volumeSizeGB: 0 volumeType: EBS mountPath: mountPath active: true providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: active: description: True if the instance is active readOnly: true type: boolean example: true idKey: $ref: '#/components/schemas/InstanceTypeKey' instanceTypeCode: description: Instance type code readOnly: true type: string example: OK instanceTypeDetails: $ref: '#/components/schemas/InstanceTypeDetails' memSizeGB: description: The instance's memory size, in gigabytes format: double type: number example: 1.5 numCores: description: The instance's number of CPU cores format: double type: number example: 1.5 providerCode: description: Cloud provider code readOnly: true type: string example: OK providerUuid: description: Provider UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - idKey type: object NodeInstanceFormData: example: nodes: - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east properties: nodes: description: Node instances items: $ref: '#/components/schemas/NodeInstanceData' maxItems: 2147483647 minItems: 1 type: array example: - nodeName: universe_node1 instanceName: Mumbai instance zone: south-east instanceType: c5large ip: 1.1.1.1 sshUser: centos region: south-east required: - nodes type: object ReinstallNodeAgentForm: example: nodeNames: - nodeNames - nodeNames properties: nodeNames: description: Node names items: type: string type: array uniqueItems: true example: - example-nodeNames 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 Config: example: certPath: certPath serverCert: serverCert offloadable: true serverKey: serverKey compressor: compressor properties: certPath: type: string example: /var/lib/yugabyte/example compressor: type: string example: example-compressor offloadable: type: boolean example: true serverCert: type: string example: example-serverCert serverKey: type: string example: example-key required: - certPath - compressor - offloadable - serverCert - serverKey type: object CustomCaCertificateInfo: description: Custom CA certificate example: expiryDate: 2024-07-12 13:07:18+00:00 contents: /opt/yugaware/certs/trust-store//ca.root.cert customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true createdTime: 2023-11-10 15:09:18+00:00 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startDate: 2023-10-12 13:07:18+00:00 properties: active: type: boolean example: true contents: description: Path to CA Certificate example: /opt/yugaware/certs/trust-store//ca.root.cert type: string createdTime: description: Date when certificate was added. example: 2023-11-10 15:09:18+00:00 format: date-time type: string customerId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryDate: description: End date of certificate validity. example: 2024-07-12 13:07:18+00:00 format: date-time type: string id: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: type: string example: example-name startDate: description: Start date of certificate validity. example: 2023-10-12 13:07:18+00:00 format: date-time type: string required: - active - customerId - id - name 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 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 YBAError: example: code: UNKNOWN_ERROR originMessage: originMessage message: message properties: code: description: Error code enum: - UNKNOWN_ERROR - INTERNAL_ERROR - PLATFORM_SHUTDOWN - PLATFORM_RESTARTED - INSTALLATION_ERROR - SERVICE_START_ERROR - CONNECTION_ERROR - TIMED_OUT readOnly: true type: string example: UNKNOWN_ERROR message: description: Error message readOnly: true type: string example: Example message originMessage: description: Origin error message readOnly: true type: string example: Example originMessage type: object NodeInstanceStateFormData: example: state: DECOMMISSIONED properties: state: description: Target state of the node instance enum: - DECOMMISSIONED - USED - FREE type: string example: DECOMMISSIONED type: object