openapi: 3.0.0 info: title: Yugabyte Cloud description: YugabyteDB as a Service termsOfService: https://www.yugabyte.com/yugabyte-cloud-terms-of-service version: v1 contact: name: Yugabyte Cloud Support url: https://support.yugabyte.com/ email: support@yugabyte.com license: name: Properietary (TBD) url: https://www.yugabyte.com/yugabyte-cloud-terms-of-service servers: - url: '{protocol}://{host_port}/api' variables: protocol: enum: - http - https default: http host_port: default: localhost:1323 description: Endpoint of the API server tags: - name: account description: Account APIs - name: alerts description: Customer facing alerting related APIs - name: audit-event description: Public APIs for customer facing audit events - name: auth description: Authentication related APIs - name: backup description: Backup related APIs - name: billing description: Billing related APIs - name: billing-invoice description: Billing invoices APIs - name: cluster description: APIs for cluster CRUD - name: cluster-info description: APIs for getting information about an existing cluster - name: cluster-network description: APIs for cluster networking CRUD - name: cluster-resources description: APIs for cluster creation related parameters - name: health-check description: Health Check endpoint APIs - name: internal-account description: Private APIs to retrieve information about accounts - name: internal-auth description: Private APIs for authentication - name: internal-backup description: Private APIs to interact with backups - name: internal-billing description: Private APIs for Billing - name: internal-cluster description: Private APIs to interact with clusters - name: internal-cluster-info description: Private APIs for getting information about an existing cluster - name: internal-cluster-network description: Private APIs to interact with cluster allow list associations - name: internal-custom-image-set description: Private APIs to interact with custom image sets - name: internal-email description: Private APIs for email - name: internal-fault-injection description: Private APIs for fault injection - name: internal-logger description: Private APIs for Logger - name: internal-maintenance description: Private APIs for Maintenance - name: internal-metadata description: Private API for information about the Yugabyte Cloud application - name: internal-metering description: Private APIs for metering - name: internal-network description: Private APIs to interact with the VPCs and subnets - name: internal-platform description: Private APIs to interact with the YB platforms - name: internal-runtime-config description: Private APIs for runtime configuration - name: internal-scheduled-upgrade description: Private APIs to manage scheduled upgrades - name: internal-software-release description: Private APIs to interact with software releases - name: internal-tags description: Private APIs to manage internal tags - name: internal-task description: Private APIs to interact with tasks and scheduled tasks - name: internal-task-event description: Private APIs to interact with task events - name: internal-user description: Private APIs to manage users - name: internal-xcluster-replication description: Private APIs for xCluster replication - name: maintenance description: Public APIs to manage maintenance windows and events - name: network description: APIs for network related APIs - name: network-resources description: APIs for network related parameters - name: project description: Project APIs - name: read-replica description: Read Replica related APIs - name: scheduled-upgrade description: Public APIs to manage scheduled upgrades - name: software-release description: APIs to retrieve software release related info - name: task description: Task related APIs - name: ui description: Public APIs to be consumed by ui - name: user description: User related APIs paths: /public/accounts: get: description: Get account by name tags: - account summary: Get account by name operationId: getAccountByName parameters: - name: name in: query description: Filter accounts by name required: true style: form explode: false schema: type: string minLength: 1 responses: '200': $ref: '#/components/responses/AccountResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Create an account tags: - account summary: Create an account operationId: createAccount requestBody: $ref: '#/components/requestBodies/AccountSpec' responses: '200': $ref: '#/components/responses/AccountResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}: get: description: Get an account tags: - account summary: Get account info operationId: getAccount parameters: - name: accountId in: path description: ID of account to return required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AccountResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: Modify account tags: - account summary: Modify account parameters: - name: accountId in: path description: ID of account to return required: true style: simple explode: false schema: type: string format: uuid operationId: modifyAccount requestBody: $ref: '#/components/requestBodies/AccountSpec' responses: '200': $ref: '#/components/responses/AccountResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete an account tags: - account summary: Delete account operationId: deleteAccount parameters: - name: accountId in: path description: ID of account to return required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Account successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/users: get: operationId: listUsers parameters: - name: accountId in: path description: ID of account associated to the user required: true style: simple explode: false schema: type: string format: uuid - name: email in: query description: Filter users by email required: false style: form explode: false schema: type: string - name: first_name in: query description: Filter users by first_name required: false style: form explode: false schema: type: string - name: last_name in: query description: Filter users by last_name required: false style: form explode: false schema: type: string - name: state in: query description: Filter users by state required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: email - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string description: List users tags: - account summary: List users responses: '200': $ref: '#/components/responses/UserListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Invite user to signup for the account tags: - account summary: Add or Invite user to account operationId: inviteAccountUser parameters: - name: accountId in: path description: ID of account to invite user to required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/InviteUserRequest' responses: '200': $ref: '#/components/responses/InviteUserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/users/batch: post: description: Batch invite users to signup for the account tags: - account summary: Batch add or invite user to account operationId: batchInviteAccountUser parameters: - name: accountId in: path description: ID of account to invite users to required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/BatchInviteUserRequest' responses: '200': $ref: '#/components/responses/BatchInviteUserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/users/{userId}: get: description: Get a user tags: - account summary: Get user info operationId: getAccountUser parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: Email of the user to get the account info required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/UserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Remove user from account tags: - account summary: Remove user from account operationId: removeAccountUser parameters: - name: accountId in: path description: ID of account of the project required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of the user to get the account info required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: User successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/users/{userId}/roles: put: description: Modify user role tags: - account summary: Modify user role operationId: modifyUserRole parameters: - name: accountId in: path description: ID of associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of associated user required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/ModifyUserRoleRequest' responses: '200': description: Successfully modified user role '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/allowed_login_types: get: description: Get allowed login types for account tags: - account summary: Get allowed login types for account operationId: getAllowedLoginTypes parameters: - name: accountId in: path description: ID of associated account required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AllowedLoginTypesResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: Modify allowed login types for account tags: - account summary: Modify allowed login types for account operationId: modifyAllowedLoginTypes parameters: - name: accountId in: path description: ID of associated account required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/ModifyAllowedLoginTypesRequest' responses: '200': description: Successfully modified allowed login types '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/alert_rules: get: description: API to fetch the alert rules for an account tags: - alerts summary: API to fetch the alert rules for an account operationId: listAlertRules parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AlertRulesListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/alert_rules/{alertRuleId}/test_email: post: description: API to send test email alerts to users of an account tags: - alerts summary: API to send test email alerts to users of an account operationId: sendTestEmailAlert parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: alertRuleId in: path description: ID of the alert for changes required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AlertTestEmailRequest' responses: '200': description: Test email successfully sent '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/alert_rules/{alertRuleId}: put: description: API to modify alert rule for an account tags: - alerts summary: API to modify alert rule for an account operationId: updateAlertRule parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: alertRuleId in: path description: ID of the alert for changes required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AlertRuleSpec' responses: '200': $ref: '#/components/responses/AlertRuleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/alerts/notifications: get: description: API to fetch the alert notifications for an account tags: - alerts summary: API to fetch the alert notifications for an account operationId: listAlertNotifications parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: level in: query description: Severity level required: false style: simple explode: false schema: type: string - name: fetchNewAlerts in: query description: Fetch new alerts required: false style: simple explode: false schema: type: boolean - name: source in: query description: Listing by source i.e CLUSTER or BILLING required: false style: form explode: false schema: type: string - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/AlertNotificationsListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/audit/events: get: description: Get list of audit events for a given account tags: - audit-event summary: Get list of audit events for a given account operationId: listAuditEvents parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: search in: query required: false style: form explode: false schema: type: string - name: event_type in: query required: false style: form explode: false schema: type: string - name: resource_type in: query required: false style: form explode: false schema: type: string - name: start_timestamp in: query description: Query start timestamp in UTC required: false style: form explode: false schema: type: string example: '2021-08-06T08:37:27.707Z' - name: end_timestamp in: query description: Query end timestamp in UTC required: false style: form explode: false schema: type: string example: '2021-08-06T08:37:27.707Z' - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string format: uuid - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: desc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on responses: '200': $ref: '#/components/responses/ListAuditEventResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/audit/events/{auditEventId}: get: description: Get detailed information about a specific audit log event tags: - audit-event summary: Get detailed information about a specific audit log event operationId: getAuditEventById parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: auditEventId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AuditEventResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/audit/categories: get: description: Get audit event categories tags: - audit-event summary: Get audit event categories operationId: getAuditEventCategories parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AuditEventCategoriesResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/quotas: parameters: - name: accountId in: path required: true description: Account to get quotas for style: simple explode: false schema: type: string format: uuid get: description: Get account quotas tags: - account summary: Get account quotas operationId: getAccountQuotas responses: '200': $ref: '#/components/responses/AccountQuotaResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/auth/login: post: description: Login a user tags: - auth summary: Login a user operationId: login requestBody: $ref: '#/components/requestBodies/LoginRequest' responses: '200': $ref: '#/components/responses/LoginResponse' '302': description: Redirect URL headers: Location: schema: description: Redirect URL Location type: string format: uri '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/auth/logout: post: description: Logout a user tags: - auth summary: Logout a user operationId: logout parameters: - name: logout_all_sessions in: query description: Logout of all sessions required: false style: form explode: false schema: type: boolean default: false responses: '200': description: User successfully logged out '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/auth/roles: get: operationId: listRoles description: List of system defined RBAC roles tags: - auth summary: List system defined RBAC roles responses: '200': $ref: '#/components/responses/RoleListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/auth/tokens: get: description: List auth tokens tags: - auth summary: List auth tokens operationId: listAuthTokens parameters: - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: expiry_time - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/AuthTokenListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Create a new auth token tags: - auth summary: Create a new auth token operationId: createAuthToken requestBody: $ref: '#/components/requestBodies/AuthTokenSpec' responses: '200': $ref: '#/components/responses/CreateAuthTokenResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/auth/tokens/{tokenId}: delete: description: Delete auth token tags: - auth summary: Delete auth token operationId: deleteAuthToken parameters: - name: tokenId in: path description: ID of auth token to be deleted required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Auth Token successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get auth token tags: - auth summary: Get auth token operationId: getAuthToken parameters: - name: tokenId in: path description: ID of auth token to be deleted required: true explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AuthTokenResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid delete: summary: Submit task to delete all backups of a cluster description: Delete all the backups of a cluster operationId: deleteClusterBackups tags: - backup responses: '200': description: Successfully submitted delete cluster backups request '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/backups: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid get: summary: List backups description: List backups operationId: listBackups tags: - backup parameters: - name: cluster_id in: query description: ID of the queried cluster required: false style: form explode: false schema: type: string format: uuid - name: action_type in: query description: Filter clusters by action type required: false style: form explode: false schema: type: string - name: state in: query description: Filter clusters by state required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: desc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/BackupListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: summary: Create backups description: Create backups operationId: createBackup tags: - backup requestBody: $ref: '#/components/requestBodies/BackupSpec' responses: '200': $ref: '#/components/responses/BackupResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/backups/{backupId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: backupId in: path description: ID of the backup required: true style: simple explode: false schema: type: string format: uuid get: summary: Get a backup description: Get a backup operationId: getBackup tags: - backup responses: '200': $ref: '#/components/responses/BackupResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: summary: Delete a backup description: Delete a backup operationId: deleteBackup tags: - backup responses: '200': description: Successfully submitted delete backup request '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/backups/{backupId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: backupId in: path description: ID of the backup required: true style: simple explode: false schema: type: string format: uuid get: summary: Get backup info along with the location description: Get a backup operationId: getBackupInfo tags: - internal-backup responses: '200': $ref: '#/components/responses/MigrationBackupResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/restore: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid get: description: List restore operations summary: List restore operations operationId: listRestores tags: - backup parameters: - name: backup_id in: query description: Filter restore operations by backup id required: false style: form explode: false schema: type: string format: uuid - name: cluster_id in: query description: Filter restore operations by cluster id required: false style: form explode: false schema: type: string format: uuid - name: state in: query description: Filter restore operations by its state required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: desc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/RestoreListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Restore a backup to a Cluster summary: Restore a backup to a Cluster operationId: restoreBackup tags: - backup requestBody: $ref: '#/components/requestBodies/RestoreSpec' responses: '200': $ref: '#/components/responses/RestoreResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/backup_schedules: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid post: summary: Schedule a backup description: Schedule a backup operationId: scheduleBackup tags: - backup requestBody: $ref: '#/components/requestBodies/BackupScheduleSpec' responses: '200': $ref: '#/components/responses/ScheduleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: List Schedules summary: List schedules operationId: listSchedules tags: - backup parameters: - name: task_type in: query description: Filter schedule operations by task type required: false style: form explode: false schema: type: string - name: entity_type in: query description: Filter schedule operations by its entity type required: false style: form explode: false schema: type: string - name: entity_id in: query description: Filter schedule operations by entity id required: false style: form explode: false schema: type: string format: uuid - name: state in: query description: Filter schedule operations by its state required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: task_type - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ScheduleListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/backup_schedules/{scheduleId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: scheduleId in: path description: ID of the associated schedule required: true style: simple explode: false schema: type: string format: uuid put: summary: Edit the backup schedule description: Edit the backup schedule operationId: editBackupSchedule tags: - backup requestBody: $ref: '#/components/requestBodies/BackupScheduleSpec' responses: '200': $ref: '#/components/responses/ScheduleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: summary: Delete a schedule description: Delete a schedule operationId: deleteSchedule tags: - backup responses: '200': description: Successfully deleted schedule '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: summary: Get a schedule description: Get a schedule operationId: getSchedule tags: - backup responses: '200': $ref: '#/components/responses/ScheduleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/estimate: post: description: This API to calculate the estimated cost of the cluster tags: - billing summary: This API to calculate the estimated cost of the cluster parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: estimateClusterCost requestBody: $ref: '#/components/requestBodies/EstimateClusterCostRequest' responses: '200': $ref: '#/components/responses/EstimateClusterCostResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/default_payment_method: get: description: Get default payment method tags: - billing summary: Get default payment method parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: getDefaultPaymentMethod responses: '200': $ref: '#/components/responses/GetDefaultPaymentMethodResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/billing_profile: post: description: This API adds billing profile tags: - billing summary: This API adds billing profile parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: createBillingProfile requestBody: $ref: '#/components/requestBodies/BillingProfileSpec' responses: '200': $ref: '#/components/responses/BillingProfileResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: This API gets billing profile tags: - billing summary: This API gets billing profile parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: getBillingProfile responses: '200': $ref: '#/components/responses/BillingProfileResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: This API updates billing profile tags: - billing summary: This API updates billing profile parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: modifyBillingProfile requestBody: $ref: '#/components/requestBodies/BillingProfileSpec' responses: '200': $ref: '#/components/responses/BillingProfileResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/payment_methods/attach: post: description: Attaches payment method to the stripe customer tags: - billing summary: Attaches payment method to the stripe customer operationId: attachPaymentMethod parameters: - name: accountId in: path required: true explode: false style: simple schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/PaymentMethodSpec' responses: '200': $ref: '#/components/responses/PaymentMethodResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/payment_methods/{paymentMethodId}: delete: description: This API deletes payment method tags: - billing summary: This API deletes payment method parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: paymentMethodId in: path required: true style: simple explode: false schema: type: string operationId: deletePaymentMethod responses: '200': $ref: '#/components/responses/PaymentMethodResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/payment_methods/{paymentMethodId}/default_payment_method: post: description: This API sets default payment method tags: - billing summary: This API sets default payment method parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: paymentMethodId in: path required: true style: simple explode: false schema: type: string operationId: setDefaultPaymentMethod responses: '200': $ref: '#/components/responses/PaymentMethodResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/rate_info: get: description: Get rate info of an account tags: - billing summary: Get rate info of an account parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: Project to which cluster belongs required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: Get rate info for specified cluster required: true style: simple explode: false schema: type: string format: uuid operationId: getRateInfo responses: '200': $ref: '#/components/responses/RateInfoResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/payment_methods: get: description: Lists billing payment methods tags: - billing summary: Lists billing payment methods parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: listPaymentMethods responses: '200': $ref: '#/components/responses/PaymentMethodListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/set_up_intent/create: post: description: Create set up intent object tags: - billing summary: Create set up intent object parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid operationId: createSetupIntent responses: '200': $ref: '#/components/responses/SetupIntentResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/credits: get: description: Get list of credits for an account tags: - billing summary: Get list of credits for an account parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string operationId: listCredits responses: '200': $ref: '#/components/responses/CreditListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing/accounts/{accountId}/invoices: get: description: Get list of invoices for an account tags: - billing-invoice summary: Get list of invoices for an account parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string operationId: listInvoices responses: '200': $ref: '#/components/responses/InvoiceListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing-invoice/accounts/{accountId}/summary: get: description: Billing invoice summary tags: - billing-invoice summary: Billing invoice summary operationId: getBillingInvoiceSummary parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/BillingInvoiceSummaryResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing-invoice/accounts/{accountId}/invoices/{invoiceId}/summary: get: description: Billing invoice summary by invoice id tags: - billing-invoice summary: Billing invoice summary by invoice id operationId: getBillingInvoiceSummaryByInvoiceId parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: invoiceId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/BillingInvoiceSummaryResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing-invoice/accounts/{accountId}/invoices/{invoiceId}/usage_summary: get: description: Get account's summary usage tags: - billing-invoice summary: Get account's summary usage operationId: getUsageSummary parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: invoiceId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/UsageSummaryResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/billing-invoice/accounts/{accountId}/invoices/{invoiceId}/usage_summary_statistics: get: description: Get account's summary usage statistics tags: - billing-invoice summary: Get account's summary usage statistics operationId: getUsageSummaryStatistics parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: invoiceId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/UsageSummaryStatisticsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters: get: description: List clusters tags: - cluster summary: List clusters operationId: listClusters parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: name in: query description: Filter clusters by name required: false style: form explode: false schema: type: string - name: cloud in: query description: Filter projects by cloud required: false style: form explode: false schema: type: string - name: region in: query description: Filter clusters by region required: false style: form explode: false schema: type: string - name: state in: query description: Filter clusters by state required: false style: form explode: false schema: type: string - name: tier in: query description: Filter clusters by tier required: false style: form explode: false schema: type: string enum: - FREE - PAID - name: vpc_id in: query description: Filter clusters by VPC ID required: false style: form explode: false schema: type: string format: uuid - name: scheduled_upgrade_execution_id in: query description: Filter clusters by scheduled upgrade execution ID required: false style: form explode: false schema: type: string format: uuid - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: name - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ClusterListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Create a new Yugabyte Cluster tags: - cluster summary: Create a cluster operationId: createCluster parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/CreateClusterRequest' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' parameters: - schema: type: string name: accountId in: path required: true - schema: type: string name: projectId in: path required: true /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid get: summary: Get a cluster description: Get a Yugabyte Cluster operationId: getCluster tags: - cluster responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: summary: Submit task to delete a cluster description: Submit task to delete a Yugabyte Cluster tags: - cluster responses: '200': description: Successfully submitted delete cluster request '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' operationId: deleteCluster put: summary: Submit task to edit a cluster description: Submit task to edit a Yugabyte Cluster operationId: editCluster tags: - cluster requestBody: $ref: '#/components/requestBodies/ClusterSpec' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/pause: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: summary: Submit task to pause a cluster description: Submit task to pause a Yugabyte Cluster operationId: pauseCluster tags: - cluster responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/resume: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: summary: Submit task to resume a cluster description: Submit task to resume a Yugabyte Cluster operationId: resumeCluster tags: - cluster responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/nodes/op: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: summary: Submit task to operate on a node description: Submit task to operate on a node operationId: nodeOp tags: - cluster requestBody: $ref: '#/components/requestBodies/NodeOpRequest' responses: '200': $ref: '#/components/responses/NodeOpResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/cluster_metrics: get: description: Get bulk cluster metrics tags: - cluster-info summary: Get bulk cluster metrics operationId: getBulkClusterMetrics parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: cluster_ids in: query description: Clusters to get metrics data for required: true style: form explode: false schema: type: array items: type: string format: uuid uniqueItems: true nullable: false minItems: 1 maxItems: 25 responses: '200': $ref: '#/components/responses/ClusterInstantMetricsListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /live_queries: get: summary: Get the live queries in a cluster description: Get the Live Queries in a Yugabyte Cluster operationId: getLiveQueries tags: - cluster-info parameters: - name: api in: query description: type of queries for which to retrieve Live Queries (YSQL or YCQL) required: false style: form explode: false schema: type: string enum: - YSQL - YCQL responses: '200': $ref: '#/components/responses/LiveQueryResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /slow_queries: get: summary: Get the slow queries in a cluster description: Get the Slow Queries in a Yugabyte Cluster operationId: getSlowQueries tags: - cluster-info responses: '200': $ref: '#/components/responses/SlowQueryResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /nodes: get: summary: Get the nodes for a cluster description: Get nodes for a Yugabyte cluster operationId: getClusterNodes tags: - cluster-info responses: '200': $ref: '#/components/responses/ClusterNodeListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /metrics: parameters: - name: metrics in: query description: Which metrics to retrieve results for required: true style: form explode: false schema: type: string - name: node_name in: query description: Node name within the cluster required: false style: form explode: false schema: type: string - name: region in: query description: Region name to filter for the given cluster required: false style: form explode: false schema: type: string - name: start_time in: query description: Start of range of time series data (in epoch seconds) required: false style: form explode: false schema: type: integer format: int64 minimum: 0 - name: end_time in: query description: End of range of time series data (in epoch seconds) required: false style: form explode: false schema: type: integer format: int64 minimum: 0 get: summary: Get a metric for a cluster description: Get metrics for a Yugabyte cluster operationId: getClusterMetric tags: - cluster-info responses: '200': $ref: '#/components/responses/MetricResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/tables: get: description: Get list of tables per YB API (YCQL/YSQL) operationId: getClusterTables summary: Get list of DB tables per YB API (YCQL/YSQL) tags: - cluster-info parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid - name: api in: query description: Which DB API to get tables for (YCQL/YSQL) required: false style: form explode: false schema: type: string enum: - YCQL - YSQL responses: '200': $ref: '#/components/responses/ClusterTableListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/tablespaces: get: description: Get list of tablespaces for YSQL operationId: getClusterTablespaces summary: Get list of DB tables for YSQL tags: - cluster-info parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/ClusterTablespacesListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/network/allow_lists: put: description: Modify set of allow lists associated to a cluster operationId: editClusterNetworkAllowLists summary: Modify set of allow lists associated to a cluster tags: - cluster-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/NetworkAllowListIdList' responses: '200': $ref: '#/components/responses/NetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get list of allow lists associated to a cluster operationId: listClusterNetworkAllowLists summary: Get list of allow list entities associated to a cluster tags: - cluster-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/NetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/certificate: get: operationId: getCACert description: Get the CA certificate to use for connection to the cluster summary: Get certificate for connection to the cluster tags: - cluster-resources responses: '200': $ref: '#/components/responses/CertificateResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/regions/{cloud}: get: operationId: getRegions description: Get list of available regions to deploy a cluster in summary: Retrieve list of regions available to deploy cluster by cloud tags: - cluster-resources parameters: - name: cloud in: path description: The choice of deployment cloud required: true style: simple explode: false schema: type: string responses: '200': $ref: '#/components/responses/RegionListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/{accountId}/instance_types/{cloud}: get: operationId: getInstanceTypes description: >- Get the list of supported instance types for a given region/zone and provider summary: >- Get the list of supported instance types for a given region/zone and provider tags: - cluster-resources parameters: - name: accountId in: path description: account id required: true style: simple explode: false schema: type: string format: uuid - name: cloud in: path description: cloud provider code (AWS/GCP) required: true style: simple explode: false schema: type: string enum: - AWS - GCP - name: tier in: query description: tier to retrieve specs for required: false style: form explode: false schema: type: string default: PAID enum: - FREE - PAID - name: region in: query description: region to retrieve specs for required: false style: form explode: false schema: type: string - name: show_disabled in: query description: >- show all instance types, each with an is_enabled boolean variable set required: false style: form explode: false schema: type: boolean default: false responses: '200': $ref: '#/components/responses/InstanceTypeSpecMapResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/clusters/tier_spec: get: operationId: getClusterTierSpecs description: >- Get the cost, number of cores, disk size, transactions, connections, and memory specs associated with paid and free tier clusters. summary: Get base prices and specs of free and paid tier clusters tags: - cluster-resources responses: '200': $ref: '#/components/responses/ClusterTierSpecsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ping: get: description: Check if application is alive summary: A simple ping healthcheck endpoint tags: - health-check responses: '200': $ref: '#/components/responses/HealthCheckResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' operationId: getPing /private/account: get: description: List accounts tags: - internal-account summary: List accounts operationId: listAccounts parameters: - name: name in: query description: Filter accounts by name required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: name - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string - name: track_id in: query description: ID of track required: false style: form explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/AccountListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/auth/admin_token: get: description: Create an admin JWT for bearer authentication summary: Create an admin JWT for bearer authentication tags: - internal-auth parameters: - name: userId in: query description: ID of user to mimic required: false style: form explode: false schema: type: string format: uuid - name: impersonatingUserEmail in: query description: Email of the user impersonating the above user required: false style: form explode: false schema: type: string operationId: getAdminApiToken responses: '200': $ref: '#/components/responses/AdminApiTokenResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/auth/admin_token/list: get: description: List admin JWTs. tags: - internal-auth summary: List admin JWTs operationId: listAdminApiTokens parameters: - name: user_id in: query description: ID of the user who is being mimicked required: false style: form explode: false schema: type: string format: uuid - name: impersonating_user_email in: query description: email of the admin user who has issued the token required: false style: form explode: false schema: type: string - name: issuing_authority in: query description: service account email used to issue the token required: false style: form explode: false schema: type: string - name: only_generic_jwts in: query description: boolean field to list only generic admin jwts required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: expiry_time - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/AdminTokenListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/auth/admin_token/{adminTokenId}: delete: description: Delete admin token tags: - internal-auth summary: Delete admin token operationId: deleteAdminApiToken parameters: - name: adminTokenId in: path description: ID of admin token to be deleted required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Admin Token successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/restore_migration: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid post: description: Restore a backup to a Cluster summary: Restore a backup from the specified bucket to a Cluster operationId: restoreMigrationBackup tags: - internal-backup requestBody: $ref: '#/components/requestBodies/MigrationRestoreSpec' responses: '200': $ref: '#/components/responses/MigrationRestoreResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/rate_card: post: description: Creates rate card for the account tags: - internal-billing summary: Creates rate card for the account operationId: createRateCard parameters: - name: accountId in: path required: true explode: false style: simple schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/RateCardSpec' responses: '200': $ref: '#/components/responses/RateCardResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/global_rate_card: put: description: Updates global rate card tags: - internal-billing summary: Updates global rate card operationId: updateGlobalRateCard requestBody: $ref: '#/components/requestBodies/GlobalRateCardSpec' responses: '200': $ref: '#/components/responses/GlobalRateCardResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/credits: post: description: Add credits to the given account, 1 credit = 1 usd tags: - internal-billing summary: API to add credits to the given account operationId: addCreditToBillingAccount parameters: - name: accountId in: path required: true explode: false style: simple schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/CreditSpec' responses: '200': $ref: '#/components/responses/CreditResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/credits/{creditId}: put: description: Update credits for the given account tags: - internal-billing summary: API to update credits for the given account operationId: updateCreditsForAccount parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: creditId in: path required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UpdateCreditsSpec' responses: '200': $ref: '#/components/responses/UpdateCreditsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/payment_method: put: description: Update payment method for a billing account to OTHER/EMPLOYEE tags: - internal-billing summary: API to update billing method to OTHER/EMPLOYEE operationId: updatePaymentMethod parameters: - name: accountId in: path required: true explode: false style: simple schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UpdatePaymentMethodSpec' responses: '200': $ref: '#/components/responses/UpdatePaymentMethodResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/invoice/aggregate: post: description: Run daily billing aggregation tags: - internal-billing summary: Run daily billing aggregation operationId: aggregate parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/AggregateSpec' responses: '200': $ref: '#/components/responses/AggregateResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/invoice/generate: post: description: Generate an invoice for the account tags: - internal-billing summary: Generate an invoice for the account operationId: generateInvoice parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/InvoiceResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/invoice/set_automatic_invoice_generation: post: description: Enable or disable automatic invoice generation tags: - internal-billing summary: Enable or disable automatic invoice generation operationId: setAutomaticInvoiceGeneration requestBody: $ref: '#/components/requestBodies/SetAutomaticInvoiceGenerationSpec' responses: '200': $ref: '#/components/responses/SetAutomaticInvoiceGenerationResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/billing/accounts/{accountId}/invoices/{invoiceId}: delete: description: Delete billing invoice tags: - internal-billing summary: Delete billing invoice operationId: deleteInvoice parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: invoiceId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Billing invoice successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: Update billing invoice tags: - internal-billing summary: Update billing invoice operationId: updateBillingInvoice parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: invoiceId in: path required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UpdateBillingInvoiceSpec' responses: '200': $ref: '#/components/responses/UpdateBillingInvoiceResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/clusters/scrape_targets: put: description: Rebuild metrics scrape targets summary: Rebuild prometheus configmap for scrape targets operationId: rebuildScrapeTargets tags: - internal-cluster requestBody: $ref: '#/components/requestBodies/RebuildMetricsTargetsRequest' responses: '200': description: Rebuild has started '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters: parameters: - schema: type: string name: accountId in: path required: true - schema: type: string name: projectId in: path required: true post: description: Create a new Private Yugabyte Cluster tags: - internal-cluster summary: Create a Private cluster operationId: createPrivateCluster parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/CreatePrivateClusterRequest' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid get: summary: Get a cluster description: Get a Yugabyte Cluster along with internal cluster info operationId: getClusterInternalDetails tags: - internal-cluster responses: '200': $ref: '#/components/responses/InternalClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: summary: Submit task to edit a private cluster description: Submit task to edit a private Yugabyte Cluster operationId: editPrivateCluster tags: - internal-cluster requestBody: $ref: '#/components/requestBodies/PrivateClusterSpec' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/upgrade/db: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: summary: Submit task to upgrade DB version of a cluster description: Submit task to upgrade DB version of a cluster operationId: dbUpgrade tags: - internal-cluster requestBody: $ref: '#/components/requestBodies/DbUpgradeRequest' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/upgrade/vm: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: summary: Submit task to upgrade VM image of a cluster description: Submit task to upgrade VM image of a cluster operationId: vmUpgrade tags: - internal-cluster requestBody: $ref: '#/components/requestBodies/VmUpgradeRequest' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/db_releases: parameters: - name: versionPrefixes in: query description: Version prefixes to filter the releases required: true style: form explode: false schema: type: array items: type: string get: description: Get all the available DB releases for upgrade summary: Get all the available DB releases for upgrade operationId: getDbReleases tags: - internal-cluster responses: '200': $ref: '#/components/responses/DbReleasesListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/gflags: parameters: - name: accountId in: path description: Account ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: projectId in: path description: Project ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: clusterId in: path description: Cluster ID required: true style: form explode: false schema: type: string format: uuid get: operationId: listGFlags description: List all GFlags on a cluster summary: List all GFlags on a cluster tags: - internal-cluster responses: '200': $ref: '#/components/responses/GFlagsDataResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: summary: Submit task to upgrade gflags of a cluster description: Submit task to upgrade gflags of Yugabyte cluster operationId: gflagsUpgrade tags: - internal-cluster requestBody: $ref: '#/components/requestBodies/GflagsUpgradeRequest' responses: '200': $ref: '#/components/responses/ClusterResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/lock: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: description: Acquire lock on the cluster summary: Acquire lock on the cluster operationId: lockClusterForSupport tags: - internal-cluster responses: '200': description: Acquired lock successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/platform: get: operationId: getPlatformForCluster description: Get data of platform which manages the given cluster summary: Get data of platform which manages the given cluster tags: - internal-cluster parameters: - name: accountId in: path description: Account ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: projectId in: path description: Project ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: clusterId in: path description: Cluster ID required: true style: form explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/PlatformResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/unlock: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid post: description: Release lock on the cluster summary: Release lock on the cluster operationId: unlockClusterForSupport tags: - internal-cluster responses: '200': description: Lock released successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/nodes: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid - name: region in: query description: Filter nodes by region required: false style: form explode: false schema: type: string get: summary: Get internal nodes for a cluster description: Get internal nodes for a cluster operationId: getInternalClusterNodes tags: - internal-cluster-info responses: '200': $ref: '#/components/responses/InternalClusterNodesResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/network/allow_lists: put: description: Modify set of allow lists associated to a cluster operationId: editExternalOrInternalClusterNetworkAllowLists summary: Modify set of allow lists associated to a cluster tags: - internal-cluster-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/NetworkAllowListIdList' responses: '200': $ref: '#/components/responses/InternalNetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get list of allow lists associated to a cluster operationId: listAllClusterNetworkAllowLists summary: Get list of allow list entities associated to a cluster tags: - internal-cluster-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/InternalNetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/custom_image_sets: get: description: API to list all custom image sets tags: - internal-custom-image-set summary: API to list custom image sets operationId: listCustomImageSets parameters: - name: cloud_type in: query description: Filter custom image sets by cloud type required: false style: form explode: false schema: type: string - name: db_version in: query description: Filter custom image sets by DB version required: false style: form explode: false schema: type: string - name: base_image_name in: query description: Filter custom image sets by base image name required: false style: form explode: false schema: type: string - name: build_reference in: query description: Filter custom image sets by build reference required: false style: form explode: false schema: type: string - name: architecture in: query description: Filter custom image sets by architecture required: false style: form explode: false schema: type: string - name: is_default in: query description: Filter custom image sets by default value required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 1000 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/CustomImageSetListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: API to create custom image sets in bulk tags: - internal-custom-image-set summary: API to create custom image sets in bulk operationId: createCustomImageSetsInBulk requestBody: $ref: '#/components/requestBodies/CreateBulkCustomImageSetSpec' responses: '200': $ref: '#/components/responses/CreateBulkCustomImageSetResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/custom_image_sets/{customImageSetId}: get: description: Get information about specific custom image set tags: - internal-custom-image-set summary: API to get details about custom image set operationId: getCustomImageSetDetails parameters: - name: customImageSetId in: path description: ID of custom image set to fetch details for required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/CustomImageSetResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Add a custom image to the specific custom image set tags: - internal-custom-image-set summary: API to add a custom image to the specified custom image set operationId: addCustomImageToSet parameters: - name: customImageSetId in: path description: ID of custom image set to which custom image needs to be added required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/CustomImageRequest' responses: '200': description: Custom image successfully added to the specified set '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete custom image set tags: - internal-custom-image-set summary: Delete custom image set operationId: deleteCustomImageSet parameters: - name: customImageSetId in: path description: ID of custom image set to delete required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Custom image set successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/custom_image_sets/{customImageSetId}/default: post: description: Mark a custom image set as default tags: - internal-custom-image-set summary: Mark a custom image set as default operationId: markCustomImageSetAsDefault parameters: - name: customImageSetId in: path description: ID of custom image set to mark as default required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Custom image set marked as default successfully. '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/email: post: description: Send email with given template tags: - internal-email summary: Send email with given template operationId: sendEmail requestBody: $ref: '#/components/requestBodies/SendEmailSpec' responses: '200': description: Successfully sent email '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/fault_injection: get: description: Get fault injections tags: - internal-fault-injection summary: Get fault injections operationId: getFaultNames responses: '200': $ref: '#/components/responses/FaultInjectionResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/fault_injection/{fault_name}: get: description: Get armed fault injections tags: - internal-fault-injection summary: Get list of entity refs for the specified fault operationId: getEntityRefs parameters: - name: fault_name in: path description: Fault name required: true style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/FaultInjectionListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/fault_injection/arm: post: description: Arm fault injection tags: - internal-fault-injection summary: Arm fault injection operationId: armFaultInjectionForEntity requestBody: $ref: '#/components/requestBodies/FaultInjectionRequest' responses: '200': description: Fault Successfully armed '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/fault_injection/disarm: delete: description: Disarm fault injection tags: - internal-fault-injection summary: Disarm fault injection operationId: disarmFaultInjectionForEntity requestBody: $ref: '#/components/requestBodies/FaultInjectionRequest' responses: '200': description: Fault Successfully diarmed '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/logger: get: description: Get Logging Level summary: Get Logging Level operationId: getLoggingLevel tags: - internal-logger parameters: - name: logger_type in: query description: Type of logger for which to fetch logging level required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/LoggingLevelResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: Set Logging Level summary: Set Logging Level operationId: setLoggingLevel tags: - internal-logger parameters: - name: logging_level in: query description: Level to which to set the Logger required: true style: form explode: false schema: type: string enum: - 'OFF' - ERROR - WARN - INFO - DEBUG - TRACE - ALL - name: logger_type in: query description: Type of Logger for which logging level needs to be set required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/LoggingLevelResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/schedule/gflags: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid post: description: API to set use_custom_gflags flag for a cluster's maintenance schedule tags: - internal-maintenance summary: API to set use_custom_gflags flag for a cluster's maintenance schedule operationId: updateGflagMaintenance requestBody: $ref: '#/components/requestBodies/UpdateGflagMaintenanceRequest' responses: '200': $ref: '#/components/responses/UpdateGflagMaintenanceResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/version: get: summary: Get application version description: Get application version tags: - internal-metadata operationId: getVersion responses: '200': $ref: '#/components/responses/VersionInfo' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/metering/accounts/{accountId}: get: description: Get metering data tags: - internal-metering summary: Get metering data operationId: getMeteringData parameters: - name: accountId in: path required: true style: simple explode: false schema: type: string format: uuid - name: start_timestamp in: query description: Query start timestamp required: true style: form explode: false schema: type: string example: '2021-08-06T08:37:27.707Z' - name: end_timestamp in: query description: Query end timestamp required: true style: form explode: false schema: type: string example: '2021-08-07T08:37:27.707Z' - name: cluster_ids in: query description: Get metering data for cluster with ids required: false style: form explode: false schema: type: array items: type: string format: uuid responses: '200': $ref: '#/components/responses/MeteringResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/network/allow_lists: post: description: Create a private allow list operationId: createInternalNetworkAllowList summary: Create a private allow list entity tags: - internal-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/NetworkAllowListSpec' responses: '200': $ref: '#/components/responses/InternalNetworkAllowListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get list of internal + external allow lists operationId: listAllNetworkAllowLists summary: Get list of allow list entities tags: - internal-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/InternalNetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/network/allow_lists/{allowListId}: get: description: Retrieve an allow list operationId: getExternalOrInternalNetworkAllowList summary: Retrieve an allow list entity tags: - internal-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: allowListId in: path description: ID of the allow list entity required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/InternalNetworkAllowListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete an allow list operationId: deleteExternalOrInternalNetworkAllowList summary: Delete an allow list entity tags: - internal-network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: allowListId in: path description: ID of the allow list entity required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Allow list successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/network: get: description: List all networks tags: - internal-network summary: List all cluster networks operationId: listNetworks parameters: - name: cloud_provider_project in: query description: Filter platforms by cloud provider project/account required: false style: form explode: false schema: type: string - name: cloud in: query description: Filter platforms by cloud required: false style: form explode: false schema: type: string - name: region in: query description: Filter platforms by region required: false style: form explode: false schema: type: string - name: under_maintenance in: query description: Filter active VPCs required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: cloud_provider_project - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/NetworkListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Add new cluster network tags: - internal-network summary: Add new cluster network operationId: addNetwork requestBody: $ref: '#/components/requestBodies/AddNetworkRequest' responses: '200': $ref: '#/components/responses/NetworkResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/network/vpcs: post: description: Add customer VPC metadata tags: - internal-network summary: Create customer-facing VPC metadata for cluster isolation operationId: createSingleTenantVpcMetadata parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/InternalSingleTenantVpcRequest' responses: '200': $ref: '#/components/responses/SingleTenantVpcResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/network/vpcs/{vpcId}/peer: post: description: Peer two yugabyte VPC tags: - internal-network summary: Peer two yugabyte VPC operationId: createInternalVpcPeering parameters: - name: accountId in: path description: accountId of user required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: projectId of user required: true style: simple explode: false schema: type: string format: uuid - name: vpcId in: path description: ID of first yugabyte VPC to peer required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/InternalVpcPeeringRequest' responses: '200': $ref: '#/components/responses/InternalVPCPeeringResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/network/vpcs/{peeringId}: delete: description: Delete internal VPC peering between two yugabyte VPC tags: - internal-network summary: Delete internal VPC peering between two yugabyte VPC operationId: deleteInternalVpcPeering parameters: - name: accountId in: path description: accountId of user required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: projectId of user required: true style: simple explode: false schema: type: string format: uuid - name: peeringId in: path description: ID of VPC peering required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Internal Yugabyte VPCs sucessfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/network/maintenance: parameters: - name: vpcIds in: query description: IDs of VPCs required: true style: form explode: false schema: type: array items: type: string format: uuid minItems: 1 maxItems: 25 uniqueItems: true - name: maintenance_status in: query description: Mark VPCs for maintenance required: true style: form explode: false schema: type: boolean post: description: Mark VPCs as under maintenance tags: - internal-network summary: Mark VPCs for Maintenance operationId: markVpcsForMaintenance responses: '200': description: Okay '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/platform: get: description: List platforms tags: - internal-platform summary: List platforms operationId: listPlatforms parameters: - name: hostname in: query description: Filter platforms by name required: false style: form explode: false schema: type: string - name: cloud in: query description: Filter platforms by cloud required: false style: form explode: false schema: type: string - name: region in: query description: Filter platforms by region required: false style: form explode: false schema: type: string - name: under_maintenance in: query description: Filter active platforms required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: cloud_type - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/PlatformListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Add new platform tags: - internal-platform summary: Add new platform operationId: addPlatform requestBody: $ref: '#/components/requestBodies/AddPlatformRequest' responses: '200': $ref: '#/components/responses/PlatformResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/platform/{platformId}: parameters: - name: platformId in: path description: ID of platform to return required: true style: simple explode: false schema: type: string format: uuid get: description: Get platform by ID tags: - internal-platform summary: Get platform by ID operationId: getPlatform responses: '200': $ref: '#/components/responses/PlatformResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/platform/{platformId}/project: parameters: - name: platformId in: path description: ID of platform to return required: true style: simple explode: false schema: type: string format: uuid post: description: Assign project to platform tags: - internal-platform summary: Add project to platform operationId: addProjectToPlatform requestBody: $ref: '#/components/requestBodies/AddProjectToPlatformRequest' responses: '200': description: Success '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/platform/maintenance: parameters: - name: platformIds in: query description: IDs of platforms to return required: true style: form explode: false schema: type: array items: type: string format: uuid minItems: 1 uniqueItems: true - name: maintenance_status in: query description: Mark platforms for maintenance required: true style: form explode: false schema: type: boolean post: description: Mark platforms as under maintenance tags: - internal-platform summary: Mark Platforms for Maintenance operationId: markPlatformsForMaintenance responses: '200': description: Success '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/platform/providers/refresh-pricing: put: description: Refresh pricing in specified existing customer providers tags: - internal-platform summary: Refresh pricing in specified existing customer providers operationId: refreshProviderPricing requestBody: $ref: '#/components/requestBodies/RefreshProviderPricingSpec' responses: '200': description: Success '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/runtime_config: parameters: - name: scopeId in: query description: ID of the scope for whose runtime config the operations are to be done required: false style: form explode: false schema: type: string format: uuid - name: scopeType in: query description: Scope type of the scopeId required: true style: form explode: false schema: type: string enum: - GLOBAL - ACCOUNT put: description: Update or delete configuration keys for given scope. tags: - internal-runtime-config summary: Update configuration keys for given scope. operationId: updateRuntimeConfig requestBody: $ref: '#/components/requestBodies/RuntimeConfigUpdateRequest' responses: '200': $ref: '#/components/responses/RuntimeConfigUpdateResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get runtime configuration operationId: getRuntimeConfig summary: Get runtime configuration tags: - internal-runtime-config responses: '200': $ref: '#/components/responses/RuntimeConfigResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_upgrade/tracks/{trackId}: post: operationId: scheduleBulkUpgrade description: Schedule a Bulk Upgrade summary: Schedule an upgrade based on cluster tier and optionally cloud/region tags: - internal-scheduled-upgrade parameters: - name: trackId in: path description: ID of the track to schedule an upgrade for required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UpgradeRequestSpec' responses: '200': $ref: '#/components/responses/ScheduledUpgradeTaskResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_upgrade/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}: post: operationId: scheduleClusterUpgrade description: Schedule Cluster Upgrade summary: Schedule an Upgrade for the specified Cluster tags: - internal-scheduled-upgrade parameters: - name: accountId in: path description: Account ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: projectId in: path description: Project ID of the cluster required: true style: form explode: false schema: type: string format: uuid - name: clusterId in: path description: Cluster ID required: true style: form explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/ClusterBasedUpgradeRequestSpec' responses: '200': $ref: '#/components/responses/ScheduledClusterUpgradeTaskResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_upgrade: get: operationId: listScheduledUpgrades description: List Scheduled Upgrades summary: List currently scheduled upgrade tasks tags: - internal-scheduled-upgrade parameters: - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ScheduledUpgradeTaskListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_upgrade/{taskId}/clusters/{clusterId}: delete: operationId: removeClusterFromExecution description: Remove Cluster From Execution summary: Remove a cluster from a scheduled upgrade execution tags: - internal-scheduled-upgrade parameters: - name: taskId in: path description: upgrade task ID required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: cluster ID required: true style: simple explode: false schema: type: string format: uuid responses: '204': description: removed successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_upgrade/{taskId}: delete: operationId: cancelScheduledUpgrade description: Cancel Scheduled Upgrade summary: Cancel a scheduled upgrade task tags: - internal-scheduled-upgrade parameters: - name: taskId in: path description: upgrade task ID required: true style: simple explode: false schema: type: string format: uuid responses: '204': description: cancelled successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/software/tracks: post: description: Create a DB software release track operationId: createTrack summary: Create a DB software release track tags: - internal-software-release requestBody: $ref: '#/components/requestBodies/SoftwareReleaseTrackSpec' responses: '200': $ref: '#/components/responses/SoftwareReleaseTrackResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: List all DB software release tracks operationId: listTracks summary: List all DB software release tracks tags: - internal-software-release parameters: - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/SoftwareReleaseTrackListPagedResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/software/tracks/{trackId}: delete: description: Delete a DB software release track operationId: deleteTrack summary: Delete a DB software release track tags: - internal-software-release parameters: - name: trackId in: path description: ID of the associated DB SW track required: true style: simple explode: false schema: type: string format: uuid responses: '204': description: deleted successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/software/tracks/{trackId}/releases: post: description: Create a software release operationId: createRelease summary: Create a software release tags: - internal-software-release parameters: - name: trackId in: path description: ID of the associated DB SW track required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/SoftwareReleaseSpec' responses: '200': $ref: '#/components/responses/SoftwareReleaseResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: List of all software releases for a track operationId: listReleasesOnTrack summary: List all DB software releases by track tags: - internal-software-release parameters: - name: trackId in: path description: ID of the associated DB SW track required: true style: simple explode: false schema: type: string format: uuid - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/SoftwareReleaseListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/software/tracks/{trackId}/releases/{releaseId}: parameters: - name: trackId in: path description: ID of the associated DB SW track required: true style: simple explode: false schema: type: string format: uuid - name: releaseId in: path description: ID of the associated DB SW version required: true style: simple explode: false schema: type: string format: uuid put: description: Update a software release operationId: updateRelease summary: Update a software release tags: - internal-software-release requestBody: $ref: '#/components/requestBodies/SoftwareReleaseSpec' responses: '200': $ref: '#/components/responses/SoftwareReleaseResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete a software release operationId: deleteRelease summary: Delete a software release tags: - internal-software-release responses: '204': description: deleted successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/software/tracks: parameters: - name: accountId in: path description: ID of Account required: true style: simple explode: false schema: type: string format: uuid post: description: Batch Add release tracks to account operationId: batchAddTracks summary: Add release tracks to account tags: - internal-software-release requestBody: $ref: '#/components/requestBodies/BatchAddSoftwareTrackRequest' responses: '200': description: Successfully added software release track to account '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/software/tracks/{trackId}: parameters: - name: accountId in: path description: ID of Account required: true style: simple explode: false schema: type: string format: uuid - name: trackId in: path description: ID of Track required: true style: simple explode: false schema: type: string format: uuid delete: description: Remove release track from account operationId: removeTrack summary: Remove release track from account tags: - internal-software-release responses: '200': description: deleted successfully '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/internal_tags/allowed_values: get: description: API to fetch allowed values for internal tags tags: - internal-tags summary: API to fetch allowed values for internal tags operationId: getAllowedValuesForInternalTags responses: '200': $ref: '#/components/responses/GetAllowedValuesForInternalTagsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/users/{userId}/internal_tags: get: description: API to get user internal tags for a given user tags: - internal-tags summary: API to get user internal tags for a given user operationId: getUserInternalTags parameters: - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/GetUserInternalTagsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: API to set/update internal tags for a given user tags: - internal-tags summary: API to set/update internal tags for a given user operationId: updateUserInternalTags parameters: - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UpdateUserInternalTagsRequest' responses: '200': description: Successfully updated user internal tags '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/internal_tags/default: get: description: API to fetch all the default internal tags tags: - internal-tags summary: API to fetch all the default internal tags operationId: listAllDefaultInternalTags parameters: - name: email_prefix in: query description: Filter default internal tags by email prefix required: false style: form explode: false schema: type: string - name: yb_dept in: query description: Filter default internal tags by yb dept tag required: false style: form explode: false schema: type: string - name: yb_task in: query description: Filter default internal tags by yb task tag required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: email_prefix - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 1000 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/DefaultInternalTagsListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: API to batch set/update default internal tags tags: - internal-tags summary: API to batch set/update default internal tags operationId: updateDefaultInternalTags requestBody: $ref: '#/components/requestBodies/UpdateDefaultInternalTagsRequest' responses: '200': $ref: '#/components/responses/UpdateDefaultInternalTagsResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/scheduled_tasks/{task}: post: description: Trigger a scheduled task to run tags: - internal-task summary: Run scheduled task operationId: runScheduledTask parameters: - name: task in: path required: true style: simple explode: false schema: type: string - name: task_instance in: query required: false description: ID of task instance to run style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/RunScheduledTaskResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/tasks: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid get: summary: List tasks description: List tasks (including internal tasks) operationId: listTasksAll tags: - internal-task parameters: - name: projectId in: query description: ID of the associated project required: false style: form explode: false schema: type: string format: uuid - name: entity_id in: query description: ID of the queried entity required: false style: form explode: false schema: type: string format: uuid - name: entity_type in: query description: Type of entity to look for required: false style: form explode: false schema: type: string enum: - BACKUP - CLUSTER - CLUSTER_ALLOW_LIST - PROJECT - name: task_type in: query description: Type of task to look for required: false style: form explode: false schema: type: string enum: - CREATE_CLUSTER - EDIT_CLUSTER - DELETE_CLUSTER - EDIT_ALLOW_LIST - CREATE_BACKUP - RESTORE_BACKUP - DELETE_PROJECT - UPGRADE_CLUSTER - PAUSE_CLUSTER - RESUME_CLUSTER - name: locking in: query description: Get locking tasks required: false style: form explode: false schema: type: boolean - name: internal_task in: query description: Get internal tasks required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: desc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/TaskListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/taskEvents/{eventId}: post: description: Post a task-related event callback tags: - internal-task-event summary: Post a task-related event callback operationId: eventCallback parameters: - name: eventId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '204': description: successful callback '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/users: get: operationId: listAllUsers parameters: - name: account_id in: query description: Filter users by account id required: false style: form explode: false schema: type: string format: uuid - name: email in: query description: Filter users by email required: false style: form explode: false schema: type: string - name: first_name in: query description: Filter users by first_name required: false style: form explode: false schema: type: string - name: last_name in: query description: Filter users by last_name required: false style: form explode: false schema: type: string - name: state in: query description: Filter users by state required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: email - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string - name: email_prefix in: query description: Search prefix for user emails required: false style: form explode: false schema: type: string description: List users tags: - internal-user summary: List all users responses: '200': $ref: '#/components/responses/UserListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/users/activate: post: description: Activate signup user tags: - internal-user summary: Activate signup user by skipping token validation operationId: activateSignupUserWithoutToken parameters: - name: email in: query description: user email for activation required: true style: form explode: false schema: type: string responses: '200': description: User sucessfully activated '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/users/activate_invited: post: description: Activate invited user tags: - internal-user summary: Activate invited user by skipping token validation operationId: activateInvitedUserWithoutToken requestBody: $ref: '#/components/requestBodies/InviteUserRequest' responses: '200': description: User sucessfully activated '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/users/{userId}/cleanup: delete: description: Cleanup User tags: - internal-user summary: >- Delete user and remove the accounts/projects of which they are the sole admin operationId: cleanupUser parameters: - name: userId in: path required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: User successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/accounts/{accountId}/projects/{projectId}/xcluster_replication: post: description: API to create replication tags: - internal-xcluster-replication summary: API to create replication operationId: createXclusterReplication parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/XClusterConfigSpec' responses: '200': $ref: '#/components/responses/XClusterConfigResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/events/{executionId}/delay: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid - name: executionId in: path description: ID of the associated execution required: true style: simple explode: false schema: type: string format: uuid post: description: API to delay maintenance events for a cluster tags: - maintenance summary: API to delay maintenance events for a cluster operationId: delayMaintenanceEvent responses: '200': $ref: '#/components/responses/ScheduledUpgradeResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/events/{executionId}/trigger: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid - name: executionId in: path description: ID of the associated execution required: true style: simple explode: false schema: type: string format: uuid post: description: API to trigger maintenance events for a cluster tags: - maintenance summary: API to trigger maintenance events for a cluster operationId: triggerMaintenanceEvent responses: '200': description: Successfully triggered scheduled upgrade '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/events: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid get: description: API to list all scheduled maintenance events for a cluster tags: - maintenance summary: API to list all scheduled maintenance events for a cluster operationId: listScheduledMaintenanceEventsForCluster parameters: - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ScheduledMaintenanceEventListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/schedule: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid get: description: API to get maintenance schedules tags: - maintenance summary: API to get maintenance schedules operationId: getMaintenanceSchedule responses: '200': $ref: '#/components/responses/MaintenanceScheduleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: API to update maintenance schedules tags: - maintenance summary: API to update maintenance schedules operationId: updateMaintenanceSchedule requestBody: $ref: '#/components/requestBodies/MaintenanceScheduleSpec' responses: '200': $ref: '#/components/responses/MaintenanceScheduleResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance/{executionId}/next_available_window: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the associated cluster required: true style: simple explode: false schema: type: string format: uuid - name: executionId in: path description: ID of the associated execution required: true style: simple explode: false schema: type: string format: uuid get: description: API to next maintenance window for a cluster tags: - maintenance summary: API to get next maintenance window for a cluster operationId: getNextMaintenanceWindowInfo responses: '200': $ref: '#/components/responses/MaintenanceWindowResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/allow_lists: post: description: Create an allow list operationId: createNetworkAllowList summary: Create an allow list entity tags: - network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/NetworkAllowListSpec' responses: '200': $ref: '#/components/responses/NetworkAllowListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: Get list of allow lists operationId: listNetworkAllowLists summary: Get list of allow list entities tags: - network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/NetworkAllowListListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/allow_lists/{allowListId}: get: description: Retrieve an allow list operationId: getNetworkAllowList summary: Retrieve an allow list entity tags: - network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: allowListId in: path description: ID of the allow list entity required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/NetworkAllowListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete an allow list operationId: deleteNetworkAllowList summary: Delete an allow list entity tags: - network parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: allowListId in: path description: ID of the allow list entity required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Allow list successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/vpcs/{vpcId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: vpcId in: path description: ID of the VPC required: true style: simple explode: false schema: type: string format: uuid get: description: Get customer VPC tags: - network summary: Get customer-facing VPC by ID operationId: getSingleTenantVpc responses: '200': $ref: '#/components/responses/SingleTenantVpcResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete customer VPC tags: - network summary: Delete customer-facing VPC by ID operationId: deleteVpc responses: '200': description: Successfully submitted delete vpc request '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/vpc-peerings: post: description: Create a peering tags: - network summary: Create a peering between customer VPC and Yugabyte VPC operationId: createVpcPeering parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/VpcPeeringRequest' responses: '200': $ref: '#/components/responses/VpcPeeringResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: List peerings tags: - network summary: List peerings between customer VPCs and Yugabyte VPCs operationId: listVpcPeerings parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: vpc_id in: query description: Filter results by VPC ID required: false style: form explode: false schema: type: string format: uuid - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: name - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/VpcPeeringListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/vpc-peerings/{peeringId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: peeringId in: path description: ID of the peering required: true style: simple explode: false schema: type: string format: uuid get: description: Get a VPC Peering tags: - network summary: Get a VPC Peering operationId: getVpcPeering responses: '200': $ref: '#/components/responses/VpcPeeringResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete VPC Peering tags: - network summary: Delete VPC Peering operationId: deleteVpcPeering responses: '200': description: Successfully submitted delete peering request '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/network/vpcs: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid post: description: Create a dedicated VPC tags: - network summary: Create a dedicated VPC for your DB clusters operationId: createVpc requestBody: $ref: '#/components/requestBodies/SingleTenantVpcRequest' responses: '200': $ref: '#/components/responses/SingleTenantVpcResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' get: description: List customer VPCs tags: - network summary: Get customer-facing VPCs to choose for cluster isolation operationId: listSingleTenantVpcs parameters: - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: name - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string - name: name in: query description: Filter results by name required: false style: form explode: false schema: type: string - name: cloud in: query description: Filter results by cloud required: false style: form explode: false schema: type: string enum: - AWS - GCP - name: region in: query description: Filter results by region required: false style: form explode: false schema: type: string - name: ids in: query description: Filter VPCs by Id style: form explode: false schema: type: array uniqueItems: true items: type: string format: uuid responses: '200': $ref: '#/components/responses/SingleTenantVpcListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /private/network/{vpcId}: get: description: Get network info by ID tags: - internal-network summary: Get network info by ID operationId: getVpc parameters: - name: vpcId in: path description: ID of platform to return required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/NetworkResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/networks/{cloud}/restricted: get: operationId: getRestrictedCidrs description: Get list of unavailable CIDRs summary: Get list of unavailable CIDRs tags: - network-resources parameters: - name: cloud in: path description: The choice of deployment cloud required: true style: simple explode: false schema: type: string responses: '200': $ref: '#/components/responses/CidrListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects: get: description: List projects tags: - project summary: List projects operationId: listProjects parameters: - name: accountId in: path description: ID of the account required: true style: simple explode: false schema: type: string format: uuid - name: name in: query description: Filter projects by name required: false style: form explode: false schema: type: string - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: asc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: name - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ProjectListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Create a project tags: - project summary: Create a project operationId: createProject parameters: - name: accountId in: path description: ID of account to add the project to required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/CreateProjectRequest' responses: '200': $ref: '#/components/responses/ProjectResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' parameters: - schema: type: string name: accountId in: path required: true /public/accounts/{accountId}/projects/{projectId}: get: description: Get a project tags: - project summary: Get project info operationId: getProject parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of project to get required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/ProjectResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' parameters: - schema: type: string name: accountId in: path required: true - schema: type: string name: projectId in: path required: true delete: description: Delete a project tags: - project summary: Delete project operationId: deleteProject parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of project to get required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Project successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/read_replicas: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid get: description: List Read Replicas tags: - read-replica summary: List Read Replicas operationId: listReadReplicas parameters: - name: region in: query description: region for which to fetch read replica required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/ReadReplicaListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' post: description: Create Read Replica tags: - read-replica summary: Create Read Replica operationId: createReadReplica requestBody: $ref: '#/components/requestBodies/ReadReplicaSpec' responses: '200': $ref: '#/components/responses/ReadReplicaResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/read_replica/{readReplicaId}: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: projectId in: path description: ID of the associated project required: true style: simple explode: false schema: type: string format: uuid - name: clusterId in: path description: ID of the cluster required: true style: simple explode: false schema: type: string format: uuid - name: readReplicaId in: path description: ID of the read replica required: true style: simple explode: false schema: type: string format: uuid get: description: Get Read Replica tags: - read-replica summary: Get Read Replicas operationId: getReadReplica responses: '200': $ref: '#/components/responses/ReadReplicaResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/software/tracks: parameters: - name: accountId in: path description: Account ID style: simple required: true explode: false schema: type: string format: uuid get: description: List all release tracks linked to account operationId: listTracksForAccount summary: List all release tracks linked to account tags: - software-release responses: '200': $ref: '#/components/responses/SoftwareReleaseTrackListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/software/tracks/{trackId}: parameters: - name: accountId in: path description: Account ID style: simple required: true explode: false schema: type: string format: uuid - name: trackId in: path description: Track ID style: simple required: true explode: false schema: type: string format: uuid get: description: Get release track by ID operationId: getTrackById summary: Get release track by ID tags: - software-release responses: '200': $ref: '#/components/responses/SoftwareReleaseTrackResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/software/tracks/{trackId}/releases: get: description: List DB software releases by track operationId: listReleases summary: List DB software releases by track tags: - software-release parameters: - name: accountId in: path description: ID of Account required: true style: simple explode: false schema: type: string format: uuid - name: trackId in: path description: ID of the associated DB SW track required: true style: simple explode: false schema: type: string format: uuid - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/SoftwareReleaseListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/software/tracks/{trackId}/releases/{releaseId}: get: description: Get Software Release by ID operationId: getRelease summary: Get Software Release by Id tags: - software-release parameters: - name: accountId in: path description: ID of Account required: true style: simple explode: false schema: type: string format: uuid - name: trackId in: path description: ID of Track required: true style: simple explode: false schema: type: string format: uuid - name: releaseId in: path description: ID of release required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/SoftwareReleaseResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/accounts/{accountId}/tasks: parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid get: summary: List tasks description: List tasks operationId: listTasks tags: - task parameters: - name: projectId in: query description: ID of the associated project required: false style: form explode: false schema: type: string format: uuid - name: entity_id in: query description: ID of the queried entity required: false style: form explode: false schema: type: string format: uuid - name: entity_type in: query description: Type of entity to look for required: false style: form explode: false schema: type: string enum: - BACKUP - CLUSTER - CLUSTER_ALLOW_LIST - PROJECT - name: task_type in: query description: Type of task to look for required: false style: form explode: false schema: type: string enum: - CREATE_CLUSTER - EDIT_CLUSTER - DELETE_CLUSTER - EDIT_ALLOW_LIST - CREATE_BACKUP - RESTORE_BACKUP - DELETE_PROJECT - UPGRADE_CLUSTER - PAUSE_CLUSTER - RESUME_CLUSTER - name: locking in: query description: Get locking tasks required: false style: form explode: false schema: type: boolean - name: order in: query description: Order of results required: false style: form explode: false schema: type: string default: desc - name: order_by in: query description: Sort results by attribute required: false style: form explode: false schema: type: string default: created_on - name: limit in: query description: Limit number of results returned per page required: false style: form explode: false schema: type: integer default: 25 minimum: 1 maximum: 100 - name: continuation_token in: query description: Boundary before next page required: false style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/TaskListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/app_config: get: description: Get application configuration for a given set of paths operationId: getAppConfig summary: Get application configuration tags: - ui parameters: - name: scopeType in: query description: Get app config for scope with type required: true style: form explode: false schema: type: string enum: - GLOBAL - ACCOUNT - name: scopeId in: query description: Get app config for scope with id required: false style: form explode: false schema: type: string format: uuid - name: paths in: query description: Get app config for paths required: true style: form explode: false schema: type: array items: type: string responses: '200': $ref: '#/components/responses/AppConfigResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/accounts/{accountId}/users/{userId}/tutorials: get: description: Get tutorials for a user operationId: getUserTutorials summary: Get tutorials for a user tags: - ui parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid responses: '200': $ref: '#/components/responses/UserTutorialListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/accounts/{accountId}/users/{userId}/tutorials/{tutorialId}: put: description: Update tutorial for a user operationId: updateUserTutorial summary: Update tutorial for a user tags: - ui parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid - name: tutorialId in: path description: Id of the associated tutorial required: true style: simple explode: false schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/UserTutorialRequestSpec' responses: '200': $ref: '#/components/responses/UserTutorialResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/accounts/{accountId}/users/{userId}/tutorials/{tutorialId}/state/{stateId}/{is_completed}: put: description: Update tutorial state status for a user operationId: updateUserTutorialState summary: Update tutorial state status for a user tags: - ui parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid - name: tutorialId in: path description: Id of the associated tutorial required: true style: simple explode: false schema: type: string format: uuid - name: stateId in: path description: Id of the associated tutorial state required: true style: simple explode: false schema: type: string format: uuid - name: is_completed in: path description: Completion status to set the tutorial state to required: true style: simple explode: false schema: type: boolean nullable: false responses: '200': $ref: '#/components/responses/UserTutorialResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/accounts/{accountId}/users/{userId}/tutorials/{tutorialId}/enabled: put: description: Update whether tutorial is enabled for a user operationId: updateUserTutorialEnabled summary: Update whether tutorial is enabled for a user tags: - ui parameters: - name: accountId in: path description: ID of the associated account required: true style: simple explode: false schema: type: string format: uuid - name: userId in: path description: ID of the associated user required: true style: simple explode: false schema: type: string format: uuid - name: tutorialId in: path description: Id of the associated tutorial required: true style: simple explode: false schema: type: string format: uuid responses: '200': description: Successfully updated user tutorial '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/callback/sso_signup: get: description: Callback for SSO signup tags: - ui summary: Callback for SSO signup operationId: ssoSignupCallback parameters: - name: sso_type in: query description: SSO type associated with the callback style: form explode: false schema: type: string enum: - GOOGLE - GITHUB - LINKEDIN required: true - name: code in: query description: Authorization code returned by SSO provider style: form explode: false schema: type: string - name: country_code in: query description: Two letter country code as defined in ISO 3166 style: form explode: false schema: type: string minLength: 2 maxLength: 2 pattern: ^[A-Z][A-Z]$ - name: marketing_consent in: query description: Marketing consent of the user style: form explode: false schema: type: boolean default: false responses: '200': $ref: '#/components/responses/LoginResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/sso_redirect_url: get: description: Retrieve redirect URL for Single Sign On using external authentication. tags: - ui summary: Retrieve redirect URL for Single Sign On using external authentication. operationId: getSsoRedirectUrl parameters: - name: sso_type in: query description: The social provider used for SSO. required: true style: form explode: false schema: type: string enum: - GOOGLE - GITHUB - LINKEDIN - name: sso_event_type in: query description: The event initiating the SSO. required: true style: form explode: false schema: type: string enum: - SIGNUP - LOGIN - INVITE responses: '200': $ref: '#/components/responses/SSORedirectURLResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/callback/sso_login: get: description: Callback for SSO login tags: - ui summary: Callback for SSO login operationId: ssoLoginCallback parameters: - name: sso_type in: query description: SSO type associated with the callback style: form explode: false schema: type: string enum: - GOOGLE - GITHUB - LINKEDIN required: true - name: code in: query description: Authorization code returned by SSO provider style: form explode: false schema: type: string responses: '200': $ref: '#/components/responses/LoginResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/ui/callback/sso_invite: get: description: Callback for SSO invite tags: - ui summary: Callback for SSO invite operationId: ssoInviteCallback parameters: - name: sso_type in: query description: SSO type associated with the callback style: form explode: false schema: type: string enum: - GOOGLE - GITHUB - LINKEDIN required: true - name: code in: query description: Authorization code returned by SSO provider style: form explode: false schema: type: string - name: country_code in: query description: Two letter country code as defined in ISO 3166 style: form explode: false schema: type: string minLength: 2 maxLength: 2 pattern: ^[A-Z][A-Z]$ - name: marketing_consent in: query description: Marketing consent of the user style: form explode: false schema: type: boolean default: false responses: '200': $ref: '#/components/responses/LoginResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/users: post: description: Create a user tags: - user summary: Create a user operationId: createUser requestBody: $ref: '#/components/requestBodies/CreateUserRequest' responses: '200': $ref: '#/components/responses/UserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/users/self: get: description: Get info for current user tags: - user summary: Get user info operationId: getUser responses: '200': $ref: '#/components/responses/UserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' put: description: Modify user info tags: - user summary: Modify user info operationId: modifyUser requestBody: $ref: '#/components/requestBodies/UserSpec' responses: '200': $ref: '#/components/responses/UserResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' delete: description: Delete current user tags: - user summary: Delete user operationId: deleteUser responses: '200': description: User successfully deleted '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/users/self/password: put: description: Change user password tags: - user summary: Change user password operationId: changePassword requestBody: $ref: '#/components/requestBodies/ChangePasswordRequest' responses: '200': description: Successfully updated password '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' /public/users/self/accounts: get: description: Get a list of accounts associated with the current user tags: - user summary: Get account information for the user operationId: listUserAccounts responses: '200': $ref: '#/components/responses/UserAccountListResponse' '400': $ref: '#/components/responses/ApiError' '500': $ref: '#/components/responses/ApiError' components: schemas: AccountSpec: title: Account Specification description: Account Specification type: object required: - name properties: name: type: string description: The account name minLength: 1 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ RoleData: title: Role Data description: RBAC Role Data type: object required: - id - name - description properties: id: type: string format: uuid description: The UUID of the RBAC role name: type: string description: Name of the RBAC role description: type: string description: Description of the RBAC role EntityMetadata: title: Entity Metadata description: Common metadata for entities type: object properties: created_on: description: Timestamp when the entity was created (UTC) type: string nullable: true updated_on: description: Timestamp when the entity was last updated (UTC) type: string nullable: true AccountInfo: title: Account Info description: Account Info type: object required: - id - owner_id - roles properties: id: type: string format: uuid description: The UUID of the account owner_id: type: string format: uuid description: UUID of the owner user of the account roles: type: array uniqueItems: true items: $ref: '#/components/schemas/RoleData' metadata: $ref: '#/components/schemas/EntityMetadata' AccountData: title: Account Data description: Account Data type: object properties: spec: $ref: '#/components/schemas/AccountSpec' info: $ref: '#/components/schemas/AccountInfo' ApiError: title: API Error type: object properties: error: type: object properties: detail: description: Error message type: string status: description: Error code type: integer UserSpec: title: User Specification description: User specification type: object required: - email properties: email: description: The email of the user type: string format: email minLength: 5 maxLength: 100 first_name: type: string description: The first name associated with the user minLength: 1 maxLength: 50 nullable: true last_name: type: string description: The last name associated with the user minLength: 1 maxLength: 50 nullable: true company_name: type: string description: Company name associated with the user minLength: 1 maxLength: 255 nullable: true country_code: type: string description: Two letter country code as defined in ISO 3166 minLength: 2 maxLength: 2 pattern: ^[A-Z][A-Z]$ nullable: true marketing_consent: type: boolean description: Marketing consent of the user default: false nullable: true UserStateEnum: title: User State Enum description: Which state the user is in type: string default: ACTIVE enum: - ACTIVE - PROVISIONED - INACTIVE UserAccountRoleData: title: User Account Role Data type: object properties: account_id: type: string format: uuid role_ids: type: array description: Role Ids items: type: string format: uuid required: - account_id - role_ids LoginTypeEnum: title: Login Type description: Login type associated with a user type: string enum: - LOCAL - GOOGLE - GITHUB - LINKEDIN UserInfo: title: User Information description: User Information type: object required: - id - state properties: id: description: The UUID of the user type: string format: uuid state: $ref: '#/components/schemas/UserStateEnum' role_list: type: array description: List of roles associated with the user nullable: true items: $ref: '#/components/schemas/UserAccountRoleData' metadata: $ref: '#/components/schemas/EntityMetadata' login_types: type: array description: List of login types associated with the user items: $ref: '#/components/schemas/LoginTypeEnum' UserData: title: User Data description: User Data type: object properties: spec: $ref: '#/components/schemas/UserSpec' info: $ref: '#/components/schemas/UserInfo' PagingLinks: title: Paging Links description: Links to navigate API pages type: object properties: self: type: string nullable: true next: type: string nullable: true PagingMetadata: title: Paging Metadata description: API pagination metadata type: object properties: continuation_token: type: string minLength: 36 nullable: true links: $ref: '#/components/schemas/PagingLinks' InviteUserSpec: title: Invite User Spec required: - email type: object properties: email: type: string description: The email associated with the user format: email minLength: 5 maxLength: 100 first_name: type: string description: The first name associated with the user minLength: 1 maxLength: 50 nullable: true last_name: type: string description: The last name associated with the user minLength: 1 maxLength: 50 nullable: true company_name: type: string description: The company associated with the user minLength: 1 maxLength: 255 nullable: true role_id: description: The role id of the user type: string format: uuid nullable: true password: type: string format: password description: Password to associate with newly invited user minLength: 8 maxLength: 72 nullable: true country_code: type: string description: Two letter country code as defined in ISO 3166 minLength: 2 maxLength: 2 pattern: ^[A-Z][A-Z]$ nullable: true marketing_consent: type: boolean description: Marketing consent of the user default: false nullable: true InviteUserData: title: Invite User Data description: Invite User Data type: object properties: spec: $ref: '#/components/schemas/InviteUserSpec' info: $ref: '#/components/schemas/UserInfo' BatchInviteUserSpec: type: object title: Batch invite User Spec properties: userList: type: array items: $ref: '#/components/schemas/InviteUserSpec' BatchInviteUserData: title: Batch Invite User Data description: Batch invite User Data type: object properties: userList: type: array items: type: object properties: InviteUserData: $ref: '#/components/schemas/InviteUserData' is_successful: description: user invitiation status type: boolean error_message: type: string nullable: true ModifyUserRoleRequest: title: Modify User Role Request Payload description: Modify user role request payload type: object required: - role_id properties: role_id: description: New role to associate with the user type: string format: uuid nullable: false LoginTypeInfo: title: Login type information description: Login type information type: object required: - login_type - is_enabled properties: login_type: $ref: '#/components/schemas/LoginTypeEnum' is_enabled: type: boolean AllowedLoginTypesSpec: title: Modify Allowed Login Types Payload description: Modify Allowed Login Types payload type: object required: - allowed_login_types properties: allowed_login_types: type: array uniqueItems: true items: $ref: '#/components/schemas/LoginTypeInfo' nullable: false ModifyAllowedLoginTypesRequest: title: Modify Allowed Login Types Payload description: Modify Allowed Login Types payload type: object required: - allowed_login_types_spec properties: allowed_login_types_spec: $ref: '#/components/schemas/AllowedLoginTypesSpec' AlertRuleSpec: title: Alert rule data description: Alert rule data type: object properties: is_enabled: type: boolean required: - is_enabled AlertRuleSourceEnum: title: Alert rule source enum description: Alert rule source enum type: string enum: - CLUSTER - BILLING AlertRuleSeverityEnum: title: Alert rule severity enum description: Alert rule severity enum type: string enum: - WARNING - SEVERE AlertRuleInfo: title: Alert rule info description: Alert rule info type: object properties: id: type: string format: uuid name: type: string nullable: false source: $ref: '#/components/schemas/AlertRuleSourceEnum' severity: $ref: '#/components/schemas/AlertRuleSeverityEnum' is_editable: type: boolean default: true description: type: string nullable: false required: - rule_name - source - severity - id - description AlertRuleData: title: Alert rule data description: Alert rule data type: object properties: spec: $ref: '#/components/schemas/AlertRuleSpec' info: $ref: '#/components/schemas/AlertRuleInfo' required: - spec - config AlertTestEmailRequest: title: Alert test email request description: Alert test email request type: object properties: email_list: type: array uniqueItems: true items: type: string format: email required: - alertRuleId AlertNotificationInfo: title: Alert notification info description: Alert notification info type: object properties: id: type: string format: uuid description: Unique id of the record name: type: string description: Alert notification name description: type: string description: Alert notification description source_id: type: string description: >- Alert notification source id i.e cluster id or account id (In case of billing) source_name: type: string description: Name of the cluster if source type is CLUSTER nullable: true severity: $ref: '#/components/schemas/AlertRuleSeverityEnum' description: Alert rule severity enum trigger_time: type: string description: Alert notification trigered time required: - name - description - source_id - severity - trigger_time AlertNotificationData: title: Alert rule data description: Alert rule data type: object properties: info: $ref: '#/components/schemas/AlertNotificationInfo' required: - info AuditEventData: title: Audit Event data description: Audit event data type: object properties: entity_name: type: string audit_event_id: type: string format: uuid account_id: type: string format: uuid account_name: type: string nullable: true project_id: type: string format: uuid nullable: true project_name: type: string nullable: true cluster_id: type: string format: uuid nullable: true cluster_name: type: string nullable: true user_id: type: string format: uuid nullable: true user_email: type: string nullable: true impersonating_user_email: type: string nullable: true task_id: type: string format: uuid nullable: true message: type: string nullable: false is_successful: type: boolean resource_type: type: string event_type: type: string created_on: type: string required: - account_id - audit_event_id - message - is_successful - resource_type - event_type - created_on - entity_name AuditEventDetailedData: title: Audit Event detailed data description: Audit Event detailed data type: object additionalProperties: true ResourceTypeEnum: title: Resource Type Enum description: The type of resource type: string enum: - CLUSTER - ALLOW_LIST - BACKUP - BACKUP_SCHEDULE - ACCOUNT - USER - PROJECT - BILLING - PAYMENT - TRACK - MAINTENANCE_EVENT - VPC - VPC_PEERING - MAINTENANCE_WINDOW - MAINTENANCE_EXCLUSION EventTypeEnum: title: Event Type Enum description: The type of an event type: string enum: - CREATE - EDIT - PAUSE - RESUME - DELETE - ADD - REMOVE - RESTORE - ACTIVATE - CANCEL - SCHEDULE - TRIGGER - DELAY - UPGRADE AuditEventCategory: title: Audit Event Category description: Audit Event Category type: object properties: resource_type: $ref: '#/components/schemas/ResourceTypeEnum' event_types: type: array items: $ref: '#/components/schemas/EventTypeEnum' required: - resource_type - event_types AccountQuota: type: object properties: free_tier: type: object properties: max_num_clusters: description: >- Maximum number of free tier clusters allowed to exist simultaneously type: integer minimum: 0 maximum: 25 num_clusters_remaining: description: Number of additional free tier clusters allowed to be created type: integer minimum: 0 maximum: 25 required: - max_num_clusters - num_clusters_remaining paid_tier: type: object properties: max_num_nodes_per_cluster: description: Maximum number of nodes allowed for a cluster type: integer minimum: 0 maximum: 24 max_num_vcpus_per_cluster: description: Maximum number of vcpus allowed for a cluster type: integer minimum: 0 maximum: 96 required: - max_num_nodes_per_cluster - max_num_vcpus_per_cluster required: - free_tier - paid_tier LoginRequest: title: Login User Request Payload type: object properties: email: type: string description: The email associated with the user format: email password: type: string description: The password associated with the user format: password AuthTokenSpec: title: Auth Token specification description: Token Specification type: object required: - expiry_time properties: expiry_time: type: string description: Timestamp when the token will expire (UTC) AuthTokenInfo: title: Auth Token Info description: Auth Token Info type: object required: - id - issuer properties: id: type: string format: uuid description: The UUID of the token issuer: type: string description: Email of the user who issued the jwt metadata: $ref: '#/components/schemas/EntityMetadata' AuthTokenData: title: Auth Token Data description: Auth Token Data type: object properties: spec: $ref: '#/components/schemas/AuthTokenSpec' info: $ref: '#/components/schemas/AuthTokenInfo' BackupSpec: title: Backup Specification description: Backup spec type: object properties: cluster_id: description: The UUID of the cluster type: string format: uuid retention_period_in_days: description: Time to retain the backup type: integer description: description: Description for the backup type: string maxLength: 1024 required: - cluster_id BackupStateEnum: title: Backup State Enum description: State of the backup type: string enum: - SUCCEEDED - FAILED - IN_PROGRESS BackupActionTypeEnum: title: Backup Action Type Enum description: Type of the backup action type: string enum: - MANUAL - SCHEDULED YbApiEnum: title: Yb Api Enum description: Type of DB API (YSQL/YCQL) type: string enum: - YSQL - YCQL BackupKeyspaceInfo: title: Backup Keyspace Info description: Backup keyspace info type: object properties: table_type: $ref: '#/components/schemas/YbApiEnum' keyspaces: type: array description: List of keyspaces items: type: string BackupInfo: title: Backup Info description: Backup data type: object properties: id: description: The UUID of the backup type: string format: uuid cluster_name: description: The name of the cluster type: string state: $ref: '#/components/schemas/BackupStateEnum' action_type: $ref: '#/components/schemas/BackupActionTypeEnum' keyspace_info: type: array items: $ref: '#/components/schemas/BackupKeyspaceInfo' size_in_bytes: type: integer format: int64 nullable: true deleted_on: description: Timestamp when the backup was deleted type: string nullable: true completed_on: description: Timestamp when the backup creation completed type: string nullable: true metadata: $ref: '#/components/schemas/EntityMetadata' BackupData: title: Backup Data description: Backup data type: object properties: spec: $ref: '#/components/schemas/BackupSpec' info: $ref: '#/components/schemas/BackupInfo' MigrationBackupSpec: title: Backup Specification description: Backup spec type: object properties: cluster_id: description: The UUID of the cluster type: string format: uuid retention_period_in_days: description: Time to retain the backup type: integer description: description: Description for the backup type: string maxLength: 1024 required: - cluster_id CloudEnum: title: Cloud Enum description: Which cloud the cluster is deployed in type: string default: GCP enum: - AWS - GCP MigrationBackupKeyspaceInfo: title: Migration Backup Keyspace Info description: Migration backup keyspace info type: object properties: table_type: description: Type of the table type: string pattern: (YSQL|YCQL) keyspace: description: Name of the keyspace type: string location: description: Location of the keyspace type: string MigrationBackupInfo: title: Backup Migration Restore Specification description: Backup migration spec type: object properties: id: description: The UUID of the backup type: string format: uuid cluster_name: description: The name of the cluster type: string project_id: description: The UUID of the project type: string format: uuid platform_id: description: The UUID of the platform type: string format: uuid region: description: Region of the bucket type: string bucket_name: description: The name of the bucket type: string credentials: description: Credentials of the backup type: string state: $ref: '#/components/schemas/BackupStateEnum' cloud_type: $ref: '#/components/schemas/CloudEnum' keyspaces_info: type: array description: List of keyspaces and their location items: $ref: '#/components/schemas/MigrationBackupKeyspaceInfo' MigrationBackupData: title: Migration Backup Data description: Migration backup data type: object properties: spec: $ref: '#/components/schemas/MigrationBackupSpec' info: $ref: '#/components/schemas/MigrationBackupInfo' RestoreSpec: title: Backup Restore Specification description: Backup spec type: object properties: backup_id: description: The UUID of the backup type: string format: uuid cluster_id: description: The UUID of the cluster type: string format: uuid RestoreStateEnum: title: Backup State Enum description: State of the backup type: string enum: - SUCCEEDED - FAILED - IN_PROGRESS RestoreInfo: title: Restore Info description: Restore Info type: object properties: id: description: The UUID of the restore type: string format: uuid project_id: description: The UUID of the project type: string format: uuid source_cluster_name: description: The name of the cluster from which backup was taken type: string target_cluster_name: description: The name of the cluster to which backup is being restored type: string description: description: Description of the restore operation type: string maxLength: 1024 keyspace_info: type: array items: $ref: '#/components/schemas/BackupKeyspaceInfo' state: $ref: '#/components/schemas/RestoreStateEnum' metadata: $ref: '#/components/schemas/EntityMetadata' size_in_bytes: type: integer format: int64 nullable: true RestoreData: title: Restore Backup Data description: Restore Backup data type: object properties: spec: $ref: '#/components/schemas/RestoreSpec' info: $ref: '#/components/schemas/RestoreInfo' ScheduleStateEnum: title: Schedule State Enum description: State of the schedule type: string enum: - ACTIVE - PAUSED ScheduleSpec: title: Schedule Spec description: Schedule spec type: object properties: time_interval_in_days: description: Time interval between two scheduled tasks in days type: integer cron_expression: description: Cron expression of the schedule type: string nullable: true state: $ref: '#/components/schemas/ScheduleStateEnum' required: - state TaskTypeEnum: title: Task Type Enum description: The type of task type: string enum: - CREATE_CLUSTER - EDIT_CLUSTER - DELETE_CLUSTER - EDIT_ALLOW_LIST - CREATE_BACKUP - RESTORE_BACKUP - MIGRATE_CLUSTER - DELETE_PROJECT - UPGRADE_CLUSTER - PAUSE_CLUSTER - RESUME_CLUSTER - SETUP_XCLUSTER_REPLICATION EntityTypeEnum: title: Entity Type Enum description: The Entity type type: string enum: - BACKUP - CLUSTER - CLUSTER_ALLOW_LIST - PROJECT ScheduleTypeEnum: title: Schedule Tyoe Enum description: Type of the schedule type: string enum: - SYSTEM_DEFAULT - USER_DEFINED ScheduleInfo: title: Schedule Info description: Schedule info type: object properties: id: description: Id of the schedule type: string format: uuid task_type: $ref: '#/components/schemas/TaskTypeEnum' task_params: description: Task params for the schedule type type: object entity_type: $ref: '#/components/schemas/EntityTypeEnum' entity_id: description: Entity id for the schedule type: string format: uuid schedule_type: $ref: '#/components/schemas/ScheduleTypeEnum' last_schedule_time: description: Timestamp when the last schedule instance ran in UTC type: string nullable: true next_schedule_time: description: Timestamp when the next schedule instance will run in UTC type: string nullable: true required: - id - task_type - task_params - entity_type - entity_id ScheduleData: title: Schedule Data description: Schedule data type: object properties: spec: $ref: '#/components/schemas/ScheduleSpec' info: $ref: '#/components/schemas/ScheduleInfo' required: - spec - info BackupScheduleSpec: title: Backup Schedule Spec description: Backup schedule spec type: object properties: backup_spec: $ref: '#/components/schemas/BackupSpec' schedule_spec: $ref: '#/components/schemas/ScheduleSpec' required: - backup_spec - schedule_spec NodeConfigSpec: title: Node config spec description: Node config spec type: object properties: num_vcpus: type: integer disk_storage_gb: type: integer required: - num_vcpus - disk_storage_gb EstimateClusterCostSpec: title: Estimate Cluster Cost Spec description: Estimate Cluster Cost Spec type: object properties: cloud_provider: $ref: '#/components/schemas/CloudEnum' region: type: string minLength: 1 default: us-west2 num_nodes: type: integer is_production_cluster: type: boolean node_config: $ref: '#/components/schemas/NodeConfigSpec' required: - cloud_provider - region - is_production_cluster - node_config - num_nodes EstimateClusterCostInfo: title: Estimate cluster cost data description: Estimate cluster cost data type: object properties: estimated_cost_usd: type: number format: double default: 0 additional_cost_usd: type: number format: double default: 0 required: - estimated_cost_usd - additional_cost_usd EstimateClusterCostData: title: Estimate cluster cost data description: Estimate cluster cost data type: object properties: spec: $ref: '#/components/schemas/EstimateClusterCostSpec' info: $ref: '#/components/schemas/EstimateClusterCostInfo' GetDefaultPaymentMethodSpec: title: Get default payment method spec description: Get default payment method spec type: object properties: payment_method: type: string nullable: true AddressSpec: title: Address spec description: Address spec type: object properties: country: type: string example: India minLength: 4 maxLength: 64 state: type: string example: Maharastra minLength: 2 maxLength: 64 address_line1: type: string example: Lane no 1312,CH Road minLength: 4 maxLength: 128 address_line2: type: string example: 13/12,PCMC,Pune maxLength: 128 city: type: string example: Pune minLength: 1 maxLength: 128 postal_code: type: string example: '411062' minLength: 1 maxLength: 16 required: - country - address_line1 - city - postal_code SubscriptionCapacity: title: Subscription capacity type: object properties: prod_vcpus: type: integer example: 0 non_prod_vcpus: type: integer example: 0 required: - prod_vcpus - non_prod_vcpus BillingTypeSpec: title: Billing type spec type: object nullable: true properties: type: type: integer default: 0 start_date: type: string format: date end_date: type: string format: date subscribed_capacity_summary: $ref: '#/components/schemas/SubscriptionCapacity' threshold: type: integer minimum: 0 example: 0 required: - type PaymentMethodEnum: title: Payment method enum description: Payment method enum (CARD/OTHER/EMPLOYEE) type: string enum: - CREDIT_CARD - OTHER - EMPLOYEE BillingProfileSpec: title: Billing profile spec description: Billing profile spec type: object properties: contact_name: type: string minLength: 1 maxLength: 50 example: Bob contact_email_address: type: string format: email example: bob@example.com contact_phone: type: string maxLength: 15 example: +91 1234567890 nullable: true company_name: type: string example: Yugabyte maxLength: 128 nullable: true invoice_address: $ref: '#/components/schemas/AddressSpec' billing_address: $ref: '#/components/schemas/AddressSpec' duns_number: type: string minLength: 9 maxLength: 9 tax_registration_number: type: string minLength: 5 maxLength: 20 example: 18AABCU9603R1ZM billing_type: $ref: '#/components/schemas/BillingTypeSpec' payment_method_id: type: string nullable: true payment_method_type: $ref: '#/components/schemas/PaymentMethodEnum' required: - contact_name - contact_email_address - invoice_address - billing_address - payment_method_type PaymentMethodSpec: title: Payment method spec description: Payment method spec properties: payment_method_id: type: string is_default: type: boolean payment_method_type: $ref: '#/components/schemas/PaymentMethodEnum' required: - payment_method_id - is_default - payment_method_type ActiveClusterRate: title: Active cluster rate info description: Active cluster rate info type: object properties: rate_per_hour: type: number format: double description: Cluster rate per hour when cluster is in active state required: - rate_per_hour PausedClusterRate: title: Paused cluster rate info description: Paused cluster rate info type: object properties: rate_per_hour: type: number format: double description: Cluster rate per hour when cluster is in paused state required: - rate_per_hour RateInfo: title: Rate info description: Rate info type: object properties: active_cluster: $ref: '#/components/schemas/ActiveClusterRate' description: Active cluster rate info paused_cluster: $ref: '#/components/schemas/PausedClusterRate' description: Paused cluster rate info required: - active_cluster - paused_cluster PaymentMethodResponseSpec: title: Payment method response spec description: Payment method response spec type: object properties: payment_method_id: type: string brand: type: string last_4_digits: type: string name: type: string exp_year: type: string exp_month: type: string is_default: type: boolean default: false required: - payment_method_id - brand - last_4_digits - name - exp_month - exp_year - is_default PaymentMethodListResponseSpec: title: Payment method list response spec description: Payment method list response spec type: object properties: card_list: type: array items: $ref: '#/components/schemas/PaymentMethodResponseSpec' SetupIntentInfo: title: Setup intent info default: Setup intent info properties: token: type: string required: - token CreditSpec: title: Add credits spec description: Add credits spec type: object properties: total_credits: type: integer minimum: 1 valid_from: type: string valid_until: type: string credited_by: type: string format: email reason: type: string required: - total_credits - valid_from - valid_until - credited_by - reason CreditInfo: title: Credit Information description: Credit Information type: object properties: credit_id: type: string format: uuid credits_redeemed: type: integer metadata: $ref: '#/components/schemas/EntityMetadata' required: - credit_id - credits_redeemed - metadata CreditData: title: Credit identifier with credit spec description: Credit identifier with credit spec type: object properties: spec: $ref: '#/components/schemas/CreditSpec' info: $ref: '#/components/schemas/CreditInfo' InvoiceData: title: Invoice data description: Invoice data type: object properties: invoice_id: type: string format: uuid total_amount: type: number format: double pdf_link: type: string invoiced_on: type: string start_date: type: string end_date: type: string payment_status: type: string invoice_number: type: string invoice_status: type: string required: - invoice_id - total_amount - start_date - end_date InvoicePaymentEnum: title: Invoice payment enum description: Invoice payment enum type: string enum: - PROCESSING - PAID - NA - UNPAID - REFUNDED - FAILED PAYMENT BillingInvoiceSummaryData: title: Billing invoice summary data description: Billing invoice summary data type: object properties: status: type: string description: Invoice status invoice_id: type: string format: uuid description: Invoice unique id invoice_serial_no: type: string nullable: true description: Invoice serial number invoice_pdf_link: type: string nullable: true description: Invoice PDF downloadble link total_amount: type: number format: double nullable: true description: Total invoice amount billing_option: type: string description: Billing option i.e PayG or Subscription billing_period: type: string description: Billing cycle period previous_invoice_amount: type: number format: double nullable: true description: Previous invoiced amount last_billed_on: type: string nullable: true description: Previous invoice generated date payment_status: $ref: '#/components/schemas/InvoicePaymentEnum' payment_date: type: string nullable: true payment_method_detail: type: string nullable: true payment_method_brand: type: string nullable: true this_time_last_month_amount: type: number format: double nullable: true amount_percentage_change_from_last_month: type: number format: double nullable: true required: - status - invoice_id - total_amount - billing_option - billing_period UsageSummaryDetail: title: usage summary description: usage summary type: object properties: name: type: string description: type: string unit: type: string quantity: type: number format: double unit_price: type: number format: double amount: type: number format: double required: - name - quantity - unit_price - amount ClusterUsageSummaryData: title: Cluster usage summary data description: Cluster usage summary data type: object properties: cluster_id: type: string format: uuid cluster_name: type: string is_apac_region: type: boolean instances: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' data_storage: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' paused_data_storage: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' cloud_backup_storage: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' paused_backup_storage: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' data_transfer: type: array items: $ref: '#/components/schemas/UsageSummaryDetail' total_amount: type: number format: double required: - cluster_id - is_apac_region - cluster_name - instances - data_storage - cloud_backup_storage - data_transfer UsageSummaryData: title: Usage summary data description: Usage summary data type: object properties: cluster_list: type: array items: $ref: '#/components/schemas/ClusterUsageSummaryData' required: - cluster_list UsageSummaryStatisticsData: title: Usage summary statistics data description: Usage summary statistics data type: object properties: name: type: string percentage: type: number format: float minimum: 0 maximum: 100 amount: type: number format: double required: - name - percentage - amount UsageSummaryClusterData: title: Usage summary data by cluster description: Usage summary data by cluster type: object properties: cluster_list: type: array items: $ref: '#/components/schemas/UsageSummaryStatisticsData' UsageSummaryInfrastructureData: title: Usage summary data by infrastructure description: Usage summary data by infrastructure type: object properties: infrastructure_list: type: array items: $ref: '#/components/schemas/UsageSummaryStatisticsData' CloudInfo: title: Cloud Info description: Cloud deployment information type: object properties: code: $ref: '#/components/schemas/CloudEnum' region: type: string minLength: 1 default: us-west2 required: - code - region ClusterTier: title: Cluster Tier description: Which tier the cluster is in type: string default: PAID enum: - FREE - PAID ClusterType: title: Cluster Type description: The kind of cluster deployment type: string enum: - SYNCHRONOUS - GEO_PARTITIONED ClusterFaultTolerance: title: Cluster Fault Tolerance description: The level of fault tolerance for the cluster type: string enum: - NONE - NODE - ZONE - REGION default: ZONE ClusterNodeInfo: title: Cluster Node Info description: Node level information type: object properties: num_cores: description: The number of cores for each node type: integer minimum: 1 maximum: 96 default: 4 memory_mb: description: The amount of RAM (MB) for each node type: integer minimum: 2048 default: 16384 disk_size_gb: description: The size of disk (GB) of each node type: integer minimum: 10 maximum: 4096 default: 256 required: - num_cores - memory_mb - disk_size_gb ClusterInfo: title: Cluster Info description: Cluster level information type: object properties: cluster_tier: $ref: '#/components/schemas/ClusterTier' cluster_type: $ref: '#/components/schemas/ClusterType' nullable: true num_nodes: description: How many nodes are in the cluster type: integer minimum: 1 maximum: 24 default: 3 fault_tolerance: $ref: '#/components/schemas/ClusterFaultTolerance' node_info: $ref: '#/components/schemas/ClusterNodeInfo' is_production: description: Describes if the cluster is a production cluster type: boolean default: false version: description: cluster data version type: integer nullable: true required: - num_nodes - fault_tolerance - node_info - cluster_tier - is_production Networking: title: Networking description: Cluster networking type: object properties: single_tenant_vpc_id: type: string format: uuid nullable: true SoftwareInfo: title: Software Info description: Cluster software info type: object properties: track_id: type: string format: uuid nullable: true PlacementInfo: type: object properties: cloud_info: $ref: '#/components/schemas/CloudInfo' num_nodes: description: How many nodes are in the region type: integer minimum: 1 maximum: 24 default: 3 vpc_id: type: string format: uuid nullable: true num_replicas: description: Number of data copies (read replica only) type: integer minimum: 1 maximum: 24 nullable: true multi_zone: description: Whether to spread the nodes in this region across zones type: boolean default: true nullable: true required: - cloud_info - num_nodes ClusterRegionInfo: title: Cluster Region Info description: Cluster region info list type: object properties: placement_info: $ref: '#/components/schemas/PlacementInfo' is_default: type: boolean default: false is_affinitized: description: If the leaders should be pinned to this region type: boolean default: true nullable: true required: - placement_info ClusterSpec: title: Cluster Specification description: Cluster spec type: object properties: name: description: The name of the cluster type: string minLength: 3 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ cloud_info: $ref: '#/components/schemas/CloudInfo' cluster_info: $ref: '#/components/schemas/ClusterInfo' network_info: $ref: '#/components/schemas/Networking' software_info: $ref: '#/components/schemas/SoftwareInfo' cluster_region_info: type: array uniqueItems: true items: $ref: '#/components/schemas/ClusterRegionInfo' nullable: true required: - name - cloud_info - cluster_info - network_info - software_info ClusterDataInfo: type: object properties: id: description: The UUID of the cluster type: string format: uuid state: description: The current state of the cluster type: string endpoint: description: Endpoint to connect to the cluster type: string format: hostname nullable: true endpoints: description: Endpoints to connect to the cluster by region type: object additionalProperties: type: string nullable: true nullable: true example: us-west1: id.cloud_provider.cloud.yugabyte.com project_id: description: ID of the associated project type: string format: uuid software_version: description: The current version of YugabyteDB installed on the cluster type: string metadata: $ref: '#/components/schemas/EntityMetadata' required: - id - state - project_id - metadata ClusterData: title: Cluster Data description: Cluster data type: object required: - spec - info properties: spec: $ref: '#/components/schemas/ClusterSpec' info: $ref: '#/components/schemas/ClusterDataInfo' DBCredentials: description: username/password tuple title: Credentials Object type: object properties: username: type: string description: username minLength: 5 password: type: string description: password format: password minLength: 8 required: - username - password CreateClusterRequest: title: Create cluster request description: Create cluster request type: object required: - cluster_spec - db_credentials properties: cluster_spec: $ref: '#/components/schemas/ClusterSpec' db_credentials: description: DB admin user credentials for YSQL/YCQL type: object properties: ycql: $ref: '#/components/schemas/DBCredentials' ysql: $ref: '#/components/schemas/DBCredentials' NodeOpEnum: title: Node operation Enum description: Action to be performed on the node type: string enum: - STOP - START NodeOpRequest: title: Node operation request description: Node Operation Request type: object required: - node_name - action properties: node_name: description: Name of the node to be operated on type: string action: $ref: '#/components/schemas/NodeOpEnum' NodeData: type: object description: Node data properties: name: type: string nullable: false is_node_up: type: boolean is_master: type: boolean is_tserver: type: boolean metrics: type: object properties: memory_used_bytes: type: integer format: int64 default: 0 total_sst_file_size_bytes: type: integer format: int64 default: 0 nullable: true uncompressed_sst_file_size_bytes: type: integer format: int64 default: 0 nullable: true read_ops_per_sec: type: number format: double default: 0 write_ops_per_sec: type: number format: double default: 0 required: - memory_used_bytes - total_sst_file_size_bytes - uncompressed_sst_file_size_bytes - read_ops_per_sec - write_ops_per_sec cloud_info: type: object properties: region: type: string zone: type: string required: - region - zone required: - name - is_node_up - is_master - is_tserver - cloud_info - metrics ClusterInstantMetricsData: title: Cluster Instant Metrics Data description: Cluster instance metrics data type: object nullable: true properties: read_ops_per_second: type: number format: double write_ops_per_second: type: number format: double ClusterInstantMetrics: title: Cluster Instant Metrics description: Cluster instant metrics type: object properties: cluster_id: type: string format: uuid metrics: $ref: '#/components/schemas/ClusterInstantMetricsData' required: - cluster_id - metrics LiveQueryResponseYSQLQueryItem: title: Live Query Response YSQL Query Item description: Schema for Live Query Response YSQL Query Item type: object properties: id: type: string format: uuid node_name: type: string db_name: type: string session_status: type: string query: type: string elapsed_millis: type: integer format: int64 query_start_time: type: string app_name: type: string client_host: type: string client_port: type: string LiveQueryResponseYSQLData: title: Live Query Response YSQL Data description: Schema for Live Query Response YSQL Data type: object properties: error_count: description: Count of Errors type: integer queries: type: array items: $ref: '#/components/schemas/LiveQueryResponseYSQLQueryItem' LiveQueryResponseYCQLQueryItem: title: Live Query Response YCQL Query Item description: Schema for Live Query Response YCQL Query Item type: object properties: id: type: string format: uuid node_name: type: string keyspace: type: string query: type: string type: type: string elapsed_millis: type: integer format: int64 client_host: type: string client_port: type: string LiveQueryResponseYCQLData: title: Live Query Response YCQL Data description: Schema for Live Query Response YCQL Data type: object properties: error_count: description: Count of Errors type: integer queries: type: array items: $ref: '#/components/schemas/LiveQueryResponseYCQLQueryItem' LiveQueryResponseData: title: Live Query Response Data description: Live Query Response Data type: object properties: ysql: $ref: '#/components/schemas/LiveQueryResponseYSQLData' ycql: $ref: '#/components/schemas/LiveQueryResponseYCQLData' LiveQueryResponseSchema: title: Live Query Response Schema description: Live Query Response Schema type: object properties: data: $ref: '#/components/schemas/LiveQueryResponseData' SlowQueryResponseYSQLQueryItem: title: Slow Query Response YSQL Query Item description: Schema for Slow Query Response YSQL Query Item type: object properties: queryid: type: integer format: int64 query: type: string rolname: type: string datname: type: string calls: type: integer local_blks_hit: type: integer local_blks_written: type: integer max_time: type: number mean_time: type: number min_time: type: number rows: type: integer stddev_time: type: number total_time: type: number SlowQueryResponseYSQLData: title: Slow Query Response YSQL Data description: Schema for Slow Query Response YSQL Data type: object properties: error_count: description: Count of Errors type: integer queries: type: array items: $ref: '#/components/schemas/SlowQueryResponseYSQLQueryItem' SlowQueryResponseData: title: Slow Query Response Data description: Slow Query Response Data type: object properties: ysql: $ref: '#/components/schemas/SlowQueryResponseYSQLData' SlowQueryResponseSchema: title: Slow Query Response Schema description: Slow Query Response Schema type: object properties: data: $ref: '#/components/schemas/SlowQueryResponseData' MetricData: title: Metric Data description: Metric data type: object properties: name: description: The name of the metric type: string values: description: Array of (timestamp, value) tuples type: array items: type: array items: type: number format: double minItems: 2 maxItems: 2 required: - name - values ClusterTable: title: Cluster Table Object description: Model representing a DB table type: object properties: name: type: string minLength: 1 nullable: false keyspace: type: string minLength: 1 nullable: false type: $ref: '#/components/schemas/YbApiEnum' size_bytes: type: integer format: int64 minimum: 0 required: - name - keyspace - type - size_bytes ClusterTableData: title: Cluster Table Data description: List of cluster tables type: array uniqueItems: true nullable: false items: $ref: '#/components/schemas/ClusterTable' TablePlacementInfo: title: A placement object for table space description: Model representing a table placement type: object properties: cloud: $ref: '#/components/schemas/CloudEnum' region: type: string zone: type: string min_num_replicas: type: integer minimum: 1 required: - cloud - region - zone - min_num_replicas ClusterTablespace: title: Cluster Tablespace Object description: Model representing a tablespace type: object properties: name: type: string minLength: 1 nullable: false num_replicas: type: integer format: int32 minimum: 1 placement_info_list: type: array items: $ref: '#/components/schemas/TablePlacementInfo' required: - name - num_replicas - placement_info_list CidrBlock: title: CIDR Block description: A CIDR block type: string pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}($|/((?:[0-9]|[12][0-9]|3[012])))$ NetworkAllowListSpec: title: NetworkAllowListSpec description: Allow list for client connections to database type: object properties: name: type: string description: Name of the allow list group minLength: 1 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ description: type: string description: A short description of the allow list group allow_list: description: The list of CIDRs type: array minItems: 1 uniqueItems: true items: $ref: '#/components/schemas/CidrBlock' required: - name - description - allow_list NetworkAllowListInfo: title: NetworkAllowListInfo description: Allow list info type: object properties: id: type: string format: uuid project_id: type: string format: uuid cluster_ids: type: array items: type: string format: uuid required: - id - project_id - cluster_ids NetworkAllowListData: title: Allow List Data description: Allow list data type: object properties: spec: $ref: '#/components/schemas/NetworkAllowListSpec' info: $ref: '#/components/schemas/NetworkAllowListInfo' required: - spec - info NetworkAllowListIdList: title: Allow List Id List description: List of allow list IDs type: array uniqueItems: true items: type: string format: uuid CertificateContent: title: CertificateContent description: Content of the root certificate type: string RegionListResponseDataItem: title: Region List Response Data Item description: An object containing code and name of a region type: object properties: code: type: string description: Region code name: type: string description: Region name country_code: type: string description: Country code required: - code - name - country_code RegionListResponseData: title: Region List Response description: A list of regions that a cluster can be deployed in type: array items: $ref: '#/components/schemas/RegionListResponseDataItem' InstanceTypeSpecResponseItem: title: Instance Type Spec description: A HW spec for a specific VM instance type type: object properties: memory_mb: type: integer description: Maxmium available RAM in MB num_cores: type: integer description: Maximum number of cores supported included_disk_size_gb: type: integer description: Maximum disk size in GB included for free num_azs: type: integer description: >- Number of AZs supported by the instance type for the given region (if applicable) nullable: true is_enabled: type: boolean default: true description: Whether the instance type is enabled required: - memory_mb - num_cores - included_disk_size_gb InstanceTypeSpecList: title: Per-region Instance Type Spec List description: A list of instance type HW specs for a given region/zone type: array uniqueItems: true items: $ref: '#/components/schemas/InstanceTypeSpecResponseItem' InstanceTypeSpecMapResponseData: title: Instance Type Spec Map description: A map of region codes to available HW specs type: object additionalProperties: $ref: '#/components/schemas/InstanceTypeSpecList' ClusterLimits: title: Specifications for cluster limits description: Specifications for cluster limits type: object properties: num_cores: type: integer minimum: 1 memory_mb: type: integer minimum: 2048 disk_size_gb: type: integer minimum: 10 required: - num_cores - memory_mb - disk_size_gb FreeTierSpecsData: title: Free tier specifications description: Free tier specifications type: object properties: cluster_limits: $ref: '#/components/schemas/ClusterLimits' apis: type: array items: $ref: '#/components/schemas/YbApiEnum' minItems: 1 uniqueItems: true required: - cluster_limits - apis PaidTierSpecsData: title: Paid tier specifications description: Paid tier specifications type: object properties: per_core_cost_cents_per_hr: type: integer minimum: 0 apis: type: array items: $ref: '#/components/schemas/YbApiEnum' minItems: 1 uniqueItems: true required: - per_core_cost_cents_per_hr - apis ClusterTierSpecsResponseData: title: Cluster specifications data description: Cluster specifications data type: object properties: free_tier: $ref: '#/components/schemas/FreeTierSpecsData' paid_tier: $ref: '#/components/schemas/PaidTierSpecsData' required: - free_tier - paid_tier BuildInfo: title: Build Info type: object properties: revision: type: string description: The hash of the cloud code that is running branch: type: string description: The branch that the cloud code belongs to required: - revision - branch RuntimeInfo: title: Runtime Info type: object properties: start_timestamp: type: string description: The time that the apiserver process was last started (UTC) example: '2021-08-06T08:37:27.707Z' alive: type: boolean description: Whether or not the server is running required: - start_timestamp - alive HealthCheckInfo: title: Health Check Info type: object properties: build_info: $ref: '#/components/schemas/BuildInfo' runtime_info: $ref: '#/components/schemas/RuntimeInfo' required: - build_info - runtime_info AdminTokenInfo: title: Admin Token Info description: Admin Token Info type: object required: - id - expiry_time - issuing_authority properties: id: type: string format: uuid description: The UUID of the token impersonated_user_id: type: string format: uuid description: UUID of the user that the admin is impersonating nullable: true expiry_time: type: string description: Timestamp when the token will expire (UTC) impersonating_user_email: type: string description: The email of the admin user who issued the token nullable: true issuing_authority: type: string description: The service account email used to issue the jwt nullable: true metadata: $ref: '#/components/schemas/EntityMetadata' KmsSpec: title: KMS spec for EAR enabled clusters description: Spec to create the KMS Config type: object properties: name: description: Name of the KMS config type: string access_key: description: AWS access key type: string secret_key: description: AWS secret key type: string cmk_id: description: CMK id of AWS KMS type: string region: description: AWS region type: string kms_endpoint: description: KMS endpoint type: string required: - name MigrationRestoreSpec: title: Backup Migration Restore Specification description: Backup migration spec type: object properties: cloud_type: $ref: '#/components/schemas/CloudEnum' credentials: description: Credentials of the backup bucket type: string bucket_name: description: Name of the backup bucket type: string region: description: Region of the bucket type: string num_parallel_ops: description: Number of parallel operations type: integer minimum: 1 maximum: 100 default: 8 keyspaces_info: type: array description: List of keyspaces and their location items: $ref: '#/components/schemas/MigrationBackupKeyspaceInfo' cluster_id: description: The UUID of the cluster type: string format: uuid kms_spec: $ref: '#/components/schemas/KmsSpec' MigrationRestoreInfo: title: Migration Restore Info description: Migration Restore Info type: object properties: id: description: The UUID of the restore type: string format: uuid cluster_name: description: The name of the cluster to which backup is being restored type: string description: description: Description of the restore operation type: string maxLength: 1024 state: $ref: '#/components/schemas/RestoreStateEnum' metadata: $ref: '#/components/schemas/EntityMetadata' MigrationRestoreData: title: Restore Backup Data description: Restore Backup data type: object properties: spec: $ref: '#/components/schemas/MigrationRestoreSpec' info: $ref: '#/components/schemas/MigrationRestoreInfo' RateCardSpec: title: Rate card spec description: Rate card spec properties: prod_vcpu_discount_percentage: type: number format: float minimum: 0 maximum: 100 non_prod_vcpu_discount_percentage: type: number format: float minimum: 0 maximum: 100 valid_from: type: string example: '2021-08-31' valid_until: type: string example: '2022-08-31' required: - prod_vcpu_discount_percentage - non_prod_vcpu_discount_percentage GlobalRateCardMap: title: Global rate card map for type PROD or NON_PROD description: Global rate card map for type PROD or NON_PROD properties: base_product_rate: description: Base product rate type: number minimum: 0 overage_rate: description: The overage rate type: object properties: disk_storage: description: Disk storage type: number minimum: 0 backup_storage: description: Backup storage type: number minimum: 0 required: - disk_storage - backup_storage burstable_vcpu_rate: description: Burstable vCPU rate type: number minimum: 0 paused_cluster_disk_storage_rate: description: Paused cluster disk storage rate type: number minimum: 0 rate_for: description: Describes whether the rate is for prod or non-prod type: string enum: - PROD - NON_PROD required: - base_product_rate - overage_rate - rate_for GlobalRateCardSpec: title: Global rate card spec description: Global rate card spec properties: type: type: integer rate: type: array items: $ref: '#/components/schemas/GlobalRateCardMap' required: - type - rate UpdateCreditsSpec: title: Update credits for an account description: Update credits for an account type: object properties: total_credits: type: integer minimum: 1 required: - total_credits UpdatePaymentMethodSpec: title: Update payment method of a billing account description: Update payment method of a billing account type: object properties: payment_method_type: $ref: '#/components/schemas/PaymentMethodEnum' required: - payment_method_type AggregateSpec: title: Aggregate spec description: Aggregate spec type: object properties: start_date: type: string end_date: type: string required: - start_date - end_date InvoiceInfo: title: Invoice spec description: Invoice spec type: object properties: invoice_number: type: string required: - invoice_number SetAutomaticInvoiceGenerationSpec: title: Set automatic invoice generation spec description: Set automatic invoice generation spec type: object properties: automatic_invoice_generation: type: boolean required: - automatic_invoice_generation InvoiceStatusEnum: title: Invoice status enum description: Invoice status enum type: string enum: - DRAFT - RUNNING - INVOICED - PENDING - DISPUTE - FORGIVEN UpdateBillingInvoiceSpec: title: Update invoice status of a billing account description: Update invoice status of a billing account type: object properties: invoice_status: $ref: '#/components/schemas/InvoiceStatusEnum' payment_status: $ref: '#/components/schemas/InvoicePaymentEnum' required: - invoice_status - payment_status RebuildMetricsTargetsRequest: title: Rebuild meterics targets options description: Payload to configure rebuild targets job type: object properties: clean: type: boolean default: false required: - clean PrivateClusterInfo: title: Private Cluster Info description: Private cluster level information type: object properties: cluster_tier: $ref: '#/components/schemas/ClusterTier' cluster_type: $ref: '#/components/schemas/ClusterType' nullable: true fault_tolerance: $ref: '#/components/schemas/ClusterFaultTolerance' node_info: $ref: '#/components/schemas/ClusterNodeInfo' is_production: description: Describes if the cluster is a production cluster type: boolean default: false version: description: cluster data version type: integer required: - fault_tolerance - node_info - cluster_tier - is_production PrivateClusterSpec: title: Private Cluster Specification description: Private Cluster spec type: object properties: name: description: The name of the cluster type: string minLength: 3 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ cluster_info: $ref: '#/components/schemas/PrivateClusterInfo' cluster_region_info: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/ClusterRegionInfo' software_info: $ref: '#/components/schemas/SoftwareInfo' required: - name - cluster_info - cluster_region_info - software_info CreatePrivateClusterRequest: title: Create private cluster request description: Create private cluster request type: object required: - cluster_spec - db_credentials properties: cluster_spec: $ref: '#/components/schemas/PrivateClusterSpec' db_credentials: description: DB admin user credentials for YSQL/YCQL type: object properties: ycql: $ref: '#/components/schemas/DBCredentials' ysql: $ref: '#/components/schemas/DBCredentials' InternalClusterData: title: Cluster Data with internal cluster details description: Cluster data with internal cluster details type: object required: - spec - info properties: spec: $ref: '#/components/schemas/ClusterSpec' info: $ref: '#/components/schemas/ClusterDataInfo' internal_info: type: object properties: custom_images: type: array uniqueItems: true items: type: string required: - custom_images DbUpgradeRequest: title: Request to upgrade DB version of a cluster description: Request to upgrade DB version of a cluster type: object properties: release_id: type: string format: uuid downgrade_override: type: boolean default: false required: - release_id VMImageMap: title: VM Image region map data description: VM Image region map data type: object additionalProperties: type: string minProperties: 1 VmUpgradeRequest: title: Request to upgrade VM image of a cluster description: Request to upgrade VM image of a cluster type: object properties: vm_image: $ref: '#/components/schemas/VMImageMap' force_upgrade: type: boolean default: false required: - vm_image GFlagsMap: title: GFlags map data description: GFlags map data type: object additionalProperties: type: string minProperties: 1 GFlagsData: title: Gflags Data description: Gflags Data type: object properties: master_gflags: $ref: '#/components/schemas/GFlagsMap' tserver_gflags: $ref: '#/components/schemas/GFlagsMap' minProperties: 1 required: - master_gflags - tserver_gflags GflagsUpgradeRequest: title: Request to upgrade gflags of a cluster description: Request to upgrade gflags of a cluster type: object properties: master_gflags: $ref: '#/components/schemas/GFlagsMap' tserver_gflags: $ref: '#/components/schemas/GFlagsMap' minProperties: 1 PlatformTypeEnum: title: Platform type description: The type of clusters the platform supports type: string enum: - Paid - Free - Both PlatformData: title: Platform data description: Information about YB Platform properties: hostname: type: string cloud_info: $ref: '#/components/schemas/CloudInfo' cidr: $ref: '#/components/schemas/CidrBlock' platform_type: $ref: '#/components/schemas/PlatformTypeEnum' vpc_id: type: string certificate_authority: type: string kube_cluster_endpoint: type: string kube_cluster_name: type: string PlatformDataResponse: title: Platform data description: Information about YB Platform properties: id: description: The UUID of the platform type: string format: uuid platform_data: $ref: '#/components/schemas/PlatformData' num_clusters: type: integer InternalNodeData: type: object description: Internal node data properties: name: type: string description: Name of the node (as recognized by platform) private_ip: type: string description: Private IP of the node nullable: true region: type: string description: Region the node belongs to required: - name - region InternalNetworkAllowListSpec: title: NetworkAllowListSpec description: Allow list for client connections to database type: object properties: name: type: string description: Name of the allow list group minLength: 1 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ description: type: string description: A short description of the allow list group is_internal: type: boolean description: Whether this allow list entry will be visible to users or not default: false allow_list: description: The list of CIDRs type: array minItems: 1 uniqueItems: true items: $ref: '#/components/schemas/CidrBlock' required: - name - description - is_internal - allow_list InternalNetworkAllowListData: title: Allow List Data description: Allow list data type: object properties: spec: $ref: '#/components/schemas/InternalNetworkAllowListSpec' info: $ref: '#/components/schemas/NetworkAllowListInfo' ArchitectureEnum: title: Architecture Enum description: Architecture type type: string default: X86 enum: - X86 - ARM CustomImageSetListItem: title: Custom Image Set List Item description: Custom Image Set List Item type: object properties: id: type: string format: uuid cloud_type: $ref: '#/components/schemas/CloudEnum' db_version: description: Version of the DB present in the images of this custom image set type: string base_image_name: description: >- Base image name on which the images of this custom image set are based on type: string build_reference: description: Build reference that generated images of this custom image set type: string architecture: $ref: '#/components/schemas/ArchitectureEnum' is_default: description: >- Denotes whether the images of this set are to be used for combination or not type: boolean metadata: $ref: '#/components/schemas/EntityMetadata' required: - id - cloud_type - db_version - base_image_name - build_reference - architecture - is_default CustomImageSpec: title: Custom Image Specification description: Custom Image specification type: object required: - image_name - region properties: image_name: description: Name of the custom image in the cloud type: string region: description: Cloud region where the custom image is deployed type: string CreateBulkCustomImageSetSpec: title: Create Custom Image Set Spec description: Create custom image set spec type: object required: - cloud_type - db_version - base_image_name - build_reference - architecture - is_default - custom_images properties: cloud_type: $ref: '#/components/schemas/CloudEnum' db_version: description: Version of the DB present in the images of this custom image set type: string base_image_name: description: >- Base image name on which the images of this custom image set are based on type: string build_reference: description: Build reference that generated images of this custom image set type: string architecture: $ref: '#/components/schemas/ArchitectureEnum' is_default: description: >- Denotes whether the images of this set are to be used for combination or not type: boolean custom_images: description: List of Custom images in the set type: array items: $ref: '#/components/schemas/CustomImageSpec' CreateBulkCustomImageSetSpecList: title: Create Bulk Custom Image Set Spec List description: List of custom image sets for bulk creation type: object properties: custom_image_set_list: type: array uniqueItems: true items: $ref: '#/components/schemas/CreateBulkCustomImageSetSpec' CustomImageSetSpec: title: Custom Image Set spec description: Custom Image Set spec type: object required: - cloud_type - db_version - base_image_name - build_reference - architecture - is_default properties: cloud_type: $ref: '#/components/schemas/CloudEnum' db_version: description: Version of the DB present in the images of this custom image set type: string base_image_name: description: >- Base image name on which the images of this custom image set are based on type: string build_reference: description: Build reference that generated images of this custom image set type: string architecture: $ref: '#/components/schemas/ArchitectureEnum' is_default: description: >- Denotes whether the images of this set are to be used for combination or not type: boolean CreateBulkCustomImageSetResponseInfo: title: Custom Image Set Response Information description: Custom Image Set Response Information type: object properties: id: description: The UUID of the custom image set type: string format: uuid success: description: >- Whether the creation of all custom images in the set is successful or not type: boolean error: description: Error message in case of failure type: string nullable: true metadata: $ref: '#/components/schemas/EntityMetadata' required: - success CreateBulkCustomImageSetStatus: title: Custom Image Bulk Response Status description: Custom Image bulk response Status type: object properties: spec: $ref: '#/components/schemas/CustomImageSetSpec' info: $ref: '#/components/schemas/CreateBulkCustomImageSetResponseInfo' CustomImageSetInfo: title: Custom Image Set Information description: Custom Image Set Information type: object properties: id: description: The UUID of the custom image set type: string format: uuid metadata: $ref: '#/components/schemas/EntityMetadata' required: - id CustomImageInfo: title: Custom Image Information description: Custom Image Information type: object properties: id: description: The UUID of the custom image type: string format: uuid metadata: $ref: '#/components/schemas/EntityMetadata' required: - id CustomImageData: title: Custom Image data description: Custom Image data type: object properties: spec: $ref: '#/components/schemas/CustomImageSpec' info: $ref: '#/components/schemas/CustomImageInfo' CustomImageSetData: title: Custom Image Set data description: Custom Image Set data type: object properties: spec: $ref: '#/components/schemas/CustomImageSetSpec' info: $ref: '#/components/schemas/CustomImageSetInfo' custom_images: description: List of Custom Images type: array items: $ref: '#/components/schemas/CustomImageData' EmailTemplateEnum: title: Email Template Enum description: Which type of email to send type: string example: USER_ONBOARDING nullable: false enum: - USER_ONBOARDING - SALES_USER_SIGNUP - ABANDONED_CLUSTER_PAUSED - ABANDONED_CLUSTER_WARNING - ABANDONED_CLUSTER_DELETED - ALERT_CLUSTER_DISK_SPACE_LOW - ALERT_CLUSTER - ALERT_BILLING - ALERT_CLUSTER_TEST - CLUSTER_CREATED - PAUSED_CLUSTER_NOTIFICATION - UPGRADE_SCHEDULED_FREE - UPGRADE_SCHEDULED_RF1 - UPGRADE_SCHEDULED - MAINTENANCE_EVENT - MAINTENANCE_EVENT_COMPLETION_SUCCESS - MAINTENANCE_EVENT_COMPLETION_FAILURE - CUSTOM - SINGLE_CREDIT_THRESHOLD_ALERT - TOTAL_CREDIT_THRESHOLD_ALERT SendEmailSpec: title: Send email spec description: Send email spec type: object properties: email_template: $ref: '#/components/schemas/EmailTemplateEnum' user_email: description: Send email corresponding to user type: string format: email example: user@example.com nullable: true from_address: description: Source email address type: string format: email example: user@example.com nullable: true to_address: description: Destination email address type: string format: email example: user@example.com nullable: true reply_to_addresses: description: Reply to Address(es) type: array uniqueItems: true nullable: true items: type: string format: email example: user@example.com cc_addresses: description: CC Address(es) type: array uniqueItems: true nullable: true items: type: string format: email example: user@example.com mappings: description: Email template mapping values type: object additionalProperties: type: string nullable: true required: - email_template FaultInjection: title: Fault Injection description: Contains the entity ref and user id type: object properties: entity_ref: type: string user_id: type: string format: uuid nullable: true required: - fault_name - entity_ref FaultInjectionSpec: title: Fault Injection Spec description: Contains the fault name and entity ref type: object properties: fault_name: type: string entity_ref: type: string user_id: type: string format: uuid nullable: true required: - fault_name - entity_ref LoggingLevelData: title: Logging Level of API Server description: Logging Level of API Server type: object properties: logging_level: description: Logging Level type: string LoggingLevelResponseSchema: description: Type of Logging Level type: object properties: data: $ref: '#/components/schemas/LoggingLevelData' UpdateGflagMaintenanceSpec: title: Update Gflag Maintenance Spec description: Update Gflag Maintenance Spec type: object properties: use_custom_gflags: type: boolean required: - use_custom_gflags VersionInfo: title: Version Info description: '' type: object properties: data: type: object properties: version: type: string minLength: 1 commit_hash: type: string minLength: 1 required: - version - commit_hash ClusterMeteringEvent: title: Cluster Metering Event description: Cluster metering event type: object properties: start_timestamp: type: string period_in_mins: type: number format: double is_active: type: boolean cluster_data: $ref: '#/components/schemas/ClusterData' required: - start_timestamp - period_in_mins - cluster_data BackupMeteringEvent: title: Backup Metering Event description: Backup metering event type: object properties: start_timestamp: type: string period_in_mins: type: number format: double total_backup_size_in_bytes: type: integer format: int64 required: - start_timestamp - period_in_mins - total_backup_size_in_bytes ZoneType: title: Zone Type description: Zone type type: object properties: same_zone: type: number format: double cross_zone: type: number format: double required: - same_zone - cross_zone RegionType: title: Region Type description: Region type type: object properties: same_region: $ref: '#/components/schemas/ZoneType' cross_region: type: number format: double internet: type: number format: double required: - same_region - cross_region - internet NetworkData: title: Network Data description: Network data type: object properties: ingress: $ref: '#/components/schemas/RegionType' egress: $ref: '#/components/schemas/RegionType' required: - ingress - egress EntityMeteringData: title: Entity Metering Data description: Entity metering data type: object properties: cluster_id: type: string format: uuid cluster_events: type: array items: $ref: '#/components/schemas/ClusterMeteringEvent' backup_events: type: array items: $ref: '#/components/schemas/BackupMeteringEvent' network_data: $ref: '#/components/schemas/NetworkData' required: - cluster_id - cluster_events - backup_events - network_data MeteringData: title: Metering Data description: Metering data type: object properties: query_start_timestamp: type: string query_end_timestamp: type: string cluster_record_list: type: array items: $ref: '#/components/schemas/EntityMeteringData' required: - query_start_timestamp - query_end_timestamp - cluster_record_list VpcData: title: VPC Data description: Information about the VPC properties: vpc_id: description: The reference ID of the VPC in the provider cloud type: string cloud_project: description: The account in AWS/project in GCP that this VPC belongs to. type: string cloud_info: $ref: '#/components/schemas/CloudInfo' cidr: $ref: '#/components/schemas/CidrBlock' vpc_type: type: string enum: - Private - Shared VpcDataResponse: title: VPC Data Response description: Information about the VPC properties: id: description: The ID of the VPC type: string format: uuid vpc_data: $ref: '#/components/schemas/VpcData' num_clusters: type: integer SubnetData: title: Subnet Data description: Information about the Subnet properties: subnet_id: description: The subnet reference ID in the provider cloud type: string subnet_mapping: description: The region/zone of the subnet type: string is_primary: description: If the subnet is used for the primary NIC type: boolean SubnetDataResponse: title: Subnet Data Response description: Information about the subnet properties: id: description: The ID of the subnet type: string format: uuid subnet_data: $ref: '#/components/schemas/SubnetData' NetworkDataResponse: title: Network Data description: Information about cluster network properties: vpc: $ref: '#/components/schemas/VpcDataResponse' subnets: type: array items: $ref: '#/components/schemas/SubnetDataResponse' AddNetworkRequest: title: Add Network Request Payload description: Payload to define a network type: object properties: vpc_data: $ref: '#/components/schemas/VpcData' subnets: type: array items: $ref: '#/components/schemas/SubnetData' platform_id: description: The platform with which this VPC is peered type: string format: uuid required: - vpc_data - subnet_data VpcRegionSpec: title: Vpc Region Spec type: object properties: region: type: string cidr: $ref: '#/components/schemas/CidrBlock' required: - region - cidr SingleTenantVpcSpec: title: Single Tenant Vpc Specification type: object properties: name: description: The name of the vpc type: string minLength: 3 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ cloud: $ref: '#/components/schemas/CloudEnum' parent_cidr: $ref: '#/components/schemas/CidrBlock' nullable: true region_specs: type: array uniqueItems: true items: $ref: '#/components/schemas/VpcRegionSpec' required: - name - cloud - region_specs InternalSingleTenantVpcRequest: title: Single Tenant Vpc Request type: object properties: spec: $ref: '#/components/schemas/SingleTenantVpcSpec' vpc_id: type: string format: uuid nullable: false parent_id: type: string format: uuid nullable: true VPCStateEnum: title: VPC State Enum description: The current state of a VPC type: string enum: - CREATING - FAILED - ACTIVE - DELETING SingleTenantVpcDataResponse: title: Single Tenant Vpc Data properties: spec: $ref: '#/components/schemas/SingleTenantVpcSpec' info: type: object properties: id: type: string format: uuid nullable: false cloud_provider_project: type: string cluster_ids: type: array uniqueItems: true nullable: false items: type: string format: uuid nullable: false peering_ids: type: array uniqueItems: true nullable: false items: type: string format: uuid nullable: false state: $ref: '#/components/schemas/VPCStateEnum' external_vpc_id: type: string nullable: true minLength: 1 required: - id - cluster_ids - peering_ids - state required: - spec - info InternalVpcPeeringSpec: title: Peer two yugabyte VPC description: Peer two yugabyte VPC type: object properties: vpcIdToPeer: type: string format: uuid required: - vpcIdToPeer AddPlatformRequest: title: Add Platform Request Payload description: Payload to define a platform type: object properties: platform_data: $ref: '#/components/schemas/PlatformData' credentials: type: string minLength: 1 admin_api_key: type: string format: uuid required: - platform_data - credentials AddProjectToPlatformRequest: title: Add Project To Platform Request Payload description: Payload to define project and cloud type: object properties: project_id: type: string format: uuid cloud: $ref: '#/components/schemas/CloudEnum' required: - project_id - cloud RefreshProviderPricingSpec: title: Refresh provider pricing description: Refresh provider pricing for clusters matching these filters type: object properties: cloud: $ref: '#/components/schemas/CloudEnum' region: type: string tier: $ref: '#/components/schemas/ClusterTier' cluster_ids: type: array items: type: string format: uuid uniqueItems: true RuntimeConfigSpec: title: Runtime Config Spec description: Runtime Config value specification for a path type: object properties: config_key: type: string minLength: 1 config_value: type: string override_entities: type: boolean required: - config_key RuntimeConfigUpdateRequest: title: Runtime Config Update Request description: Config key-value pairs for runtime config update type: object properties: configs: type: array items: $ref: '#/components/schemas/RuntimeConfigSpec' RuntimeConfigUpdateData: title: Runtime Config Update Data description: Runtime Config data after update type: object properties: config_key: type: string minLength: 1 config_value: type: string nullable: true success: type: boolean error: type: string description: Success/Failure message nullable: true required: - config_key - success UpgradeRequestFilters: title: Upgrade Request Filters description: Filters to limit scheduled upgrade scope type: object properties: cloud_type: $ref: '#/components/schemas/CloudEnum' nullable: true region: type: string minLength: 7 nullable: true cluster_tier: $ref: '#/components/schemas/ClusterTier' nullable: true UpgradeRequestSpec: title: Upgrade Request Spec description: Additional spec for scheduled upgrades type: object properties: release_id: description: Release ID to upgrade to (will default to latest if omitted) type: string format: uuid filters: $ref: '#/components/schemas/UpgradeRequestFilters' required: - filters UpgradeRequestInfo: title: Upgrade Request Info description: Upgrade Request Info type: object properties: id: description: Task instance ID type: string format: uuid task_type: description: Task type type: string scheduled_at: description: Creation time type: string version: description: Upgrade version type: string required: - id - task_type - scheduled_at - version ScheduledUpgradeTaskData: title: Scheduled Upgrade Task Data description: Scheduled upgrade task data type: object required: - spec - info properties: spec: $ref: '#/components/schemas/UpgradeRequestSpec' info: $ref: '#/components/schemas/UpgradeRequestInfo' ClusterBasedUpgradeRequestSpec: title: Cluster Based Upgrade Request Spec description: Upgrade Spec for Cluster Based Upgrade type: object properties: release_id: description: Release ID to upgrade to (will default to latest if omitted) type: string format: uuid ScheduledClusterUpgradeTaskData: title: Scheduled Cluster Upgrade Task Data description: Scheduled Cluster upgrade task data type: object required: - spec - info properties: spec: $ref: '#/components/schemas/ClusterBasedUpgradeRequestSpec' info: $ref: '#/components/schemas/UpgradeRequestInfo' SoftwareReleaseTrackSpec: title: DB software Release Track description: DB software release track type: object properties: name: type: string description: track name minLength: 3 required: - name SoftwareReleaseTrackInfo: title: Software Release Track Info description: Software release track Info type: object required: - id properties: id: type: string format: uuid description: The UUID of the release track default_release_id: type: string format: uuid nullable: true SoftwareReleaseTrackData: title: Software Release Track Data description: Software release track data type: object properties: spec: $ref: '#/components/schemas/SoftwareReleaseTrackSpec' info: $ref: '#/components/schemas/SoftwareReleaseTrackInfo' SoftwareReleaseSpec: title: DB Software Release description: DB software release type: object properties: version: type: string minLength: 10 release_date: type: string example: '1997-02-11' is_default: type: boolean default: false required: - version - release_date - is_default SoftwareReleaseInfo: title: Software Release Track Info description: Software release track Info type: object required: - id - track_id properties: id: type: string format: uuid description: The UUID of the release track_id: type: string format: uuid description: The UUID of the release track SoftwareReleaseData: title: Software Release Data description: Software release data type: object properties: spec: $ref: '#/components/schemas/SoftwareReleaseSpec' info: $ref: '#/components/schemas/SoftwareReleaseInfo' required: - spec - info BatchAddAccountSoftwareTrackRequest: title: Batch Account Specific Software Release Track Data description: Batch Account Specific Software Release Track Data type: object properties: track_list: type: array uniqueItems: true items: type: string format: uuid InternalTagsSpec: title: Internal Tags Spec description: Internal tags spec type: object properties: email_prefix: type: string description: Email prefix of the user yb_dept: type: string description: Value of yb_dept tag nullable: true yb_task: type: string description: Value of yb_task tag nullable: true yb_owner: type: string description: Value of yb_owner tag nullable: true yb_customer: type: string description: Value of yb_customer tag nullable: true override_default: type: boolean default: false description: If true, then the default tags will be overridden UpdateDefaultInternalTagsRequest: title: Default Internal Tags Update Request description: Default internal tags update request type: object properties: data: type: array items: $ref: '#/components/schemas/InternalTagsSpec' DefaultInternalTagsUpdateData: title: Default Internal Tags Update Data description: Default internal tags update data type: object properties: email_prefix: type: string description: Email prefix of the user yb_dept: type: string description: Value of yb_dept tag yb_task: type: string description: Value of yb_task tag success: type: boolean description: Whether the update was successful or not error: type: string description: Error message when update fails required: - email_prefix - success TaskInfo: title: Task Info description: Task data type: object properties: id: description: The UUID of the task type: string format: uuid entity_id: description: The ID of the entity being operated on type: string format: uuid locking: description: If the task locks the entity type: boolean entity_type: $ref: '#/components/schemas/EntityTypeEnum' task_type: $ref: '#/components/schemas/TaskTypeEnum' completed_on: description: Time of task completion type: string nullable: true state: description: State of the task type: string metadata: $ref: '#/components/schemas/EntityMetadata' TaskData: title: Task Data description: Task data type: object properties: info: $ref: '#/components/schemas/TaskInfo' XClusterConfigSpec: title: XCluster Config Specification description: XCluster Config Specification type: object required: - name - source_cluster_id - target_cluster_id - table_ids properties: name: type: string maxLength: 256 nullable: false description: The name of the config to be created source_cluster_id: type: string format: uuid nullable: false description: The UUID of the source cluster target_cluster_id: type: string format: uuid nullable: false description: UUID of the target cluster table_ids: type: array uniqueItems: true items: type: string description: Names of Tables to be replicated XClusterConfigStateEnum: title: XCluster Config State Enum description: XCluster Config State Enum type: string enum: - CREATING - UPDATING - ACTIVE - FAILED - DELETING - PAUSED XClusterConfigInfo: title: XCluster Config Information description: XCluster Config Information type: object required: - id - state - metadata properties: id: description: The UUID of the XCluster Config type: string format: uuid state: $ref: '#/components/schemas/XClusterConfigStateEnum' metadata: $ref: '#/components/schemas/EntityMetadata' XClusterConfigData: title: XCluster Config Data description: XCluster Config Data type: object properties: spec: $ref: '#/components/schemas/XClusterConfigSpec' info: $ref: '#/components/schemas/XClusterConfigInfo' MaintenanceWindowEventTypeEnum: title: Maintenance Window Event Type Enum description: Maintenance Window Event Type Enum type: string enum: - DB_UPGRADE DBUpgradeEventInfo: title: DB Upgrade Event Info description: DB Upgrade Event Info type: object required: - release_id - track_id - version - estimated_time_mins properties: release_id: description: Release ID type: string format: uuid track_id: description: Track ID type: string format: uuid version: description: Upgrade Version type: string estimated_time_mins: description: Estimated time of completion in minutes type: integer MaintenanceWindowEventStateEnum: title: Maintenance Window State Enum description: Maintenance Window State Enum type: string enum: - SCHEDULED - ACTIVE MaintenanceWindowInfo: title: Maintenance Window Info description: Maintenance Window Info type: object required: - start_timestamp - end_timestamp properties: start_timestamp: description: Start time of upgrade in UTC type: string example: '2021-08-06T08:37:27.707Z' end_timestamp: description: End time of upgrade in UTC type: string example: '2021-08-06T08:57:00.707Z' ScheduledMaintenanceEventData: title: Scheduled Maintenance Event Data description: Scheduled Maintenance Event Data type: object required: - scheduled_execution_id - maintenance_window - event_type - event_info - state - can_delay - can_trigger properties: scheduled_execution_id: description: Scheduled Execution ID type: string format: uuid can_delay: type: boolean description: indicates if this event can be delayed can_trigger: type: boolean description: indicates if this event can be triggered immediately event_type: $ref: '#/components/schemas/MaintenanceWindowEventTypeEnum' event_info: $ref: '#/components/schemas/DBUpgradeEventInfo' state: $ref: '#/components/schemas/MaintenanceWindowEventStateEnum' maintenance_window: $ref: '#/components/schemas/MaintenanceWindowInfo' MaintenanceScheduleInfo: title: Maintenance Schedule Info description: Maintenance Schedule Info type: object properties: is_locked: type: boolean required: - is_locked DayEnum: title: Day Enum description: Day Enum type: string enum: - SUN - MON - TUE - WED - THU - FRI - SAT MaintenanceWindowSpec: title: Maintenance Window Spec description: Maintenance Window Spec type: object properties: day: $ref: '#/components/schemas/DayEnum' hour: type: integer description: Start time for Maintenance Windows minimum: 0 maximum: 23 required: - day - hour MaintenanceWindowExclusionInfo: title: Maintenance Window Exclusion Info description: Maintenance Window Exclusion Info type: object properties: id: type: string format: uuid description: ID of Maintenance Window Exclusion nullable: true metadata: $ref: '#/components/schemas/EntityMetadata' nullable: true MaintenanceWindowExclusionSpec: title: Maintenance Window Exclusion Spec description: Maintenance Window Exclusion Spec type: object properties: start_timestamp: type: string description: start date-time for Maintenance Window Exclusion example: '2000-01-23T04:56:07.000+00:00' end_timestamp: type: string description: end date-time for Maintenance Window Exclusion example: '2000-01-23T04:56:07.000+00:00' required: - start_timestamp - end_timestamp MaintenanceWindowExclusionData: title: Maintenance Window Exclusion Data description: Maintenance Window Exclusion Data type: object properties: info: $ref: '#/components/schemas/MaintenanceWindowExclusionInfo' spec: $ref: '#/components/schemas/MaintenanceWindowExclusionSpec' required: - info - spec MaintenanceScheduleSpec: title: Maintenance Schedule Spec description: Maintenance Schedule Spec type: object properties: windows: $ref: '#/components/schemas/MaintenanceWindowSpec' exclusions: type: array uniqueItems: true items: $ref: '#/components/schemas/MaintenanceWindowExclusionData' required: - windows - exclusions MaintenanceScheduleData: title: Maintenance Schedule Data description: Maintenance Schedule Data type: object properties: info: $ref: '#/components/schemas/MaintenanceScheduleInfo' spec: $ref: '#/components/schemas/MaintenanceScheduleSpec' required: - info - spec VpcCloudInfo: title: VPC Cloud Info description: Cloud deployment information for a VPC type: object properties: code: $ref: '#/components/schemas/CloudEnum' region: type: string minLength: 1 required: - code CustomerVpcSpec: title: Customer Vpc Specification type: object properties: external_vpc_id: type: string nullable: false cloud_provider_project: type: string nullable: false cidr: $ref: '#/components/schemas/CidrBlock' nullable: true cloud_info: $ref: '#/components/schemas/VpcCloudInfo' required: - external_vpc_id - cloud_provider_project - cloud_info VpcPeeringSpec: title: Vpc Peering Specification type: object properties: internal_yugabyte_vpc_id: type: string format: uuid nullable: false name: description: The name of the peering type: string minLength: 3 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ customer_vpc: $ref: '#/components/schemas/CustomerVpcSpec' required: - yugabyte_vpc_internal_id - name - customer_vpc PeeringStateEnum: title: Peering State Enum description: The current state of a VPC peering connection type: string enum: - CREATING - FAILED - ACTIVE - PENDING - EXPIRED - DELETING - DELETED VpcPeeringData: title: Single Tenant Vpc Data type: object properties: spec: $ref: '#/components/schemas/VpcPeeringSpec' info: type: object properties: id: type: string format: uuid nullable: false state: $ref: '#/components/schemas/PeeringStateEnum' yugabyte_vpc_name: type: string nullable: false required: - id - state - single_tenant_vpc_name required: - spec - info SingleTenantVpcRequest: title: Single Tenant Vpc Request type: object properties: spec: $ref: '#/components/schemas/SingleTenantVpcSpec' required: - spec CidrListResponseData: title: Cidr List Response description: A list of cidrs type: array uniqueItems: true items: $ref: '#/components/schemas/CidrBlock' ProjectData: title: Project Data description: Project data type: object required: - id - name properties: id: description: The UUID of the project type: string format: uuid name: description: The name of the project type: string minLength: 1 maxLength: 255 metadata: $ref: '#/components/schemas/EntityMetadata' CreateProjectRequest: title: Create Project Request Payload required: - name type: object properties: name: type: string minLength: 1 maxLength: 63 pattern: ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$ ReadReplicaSpec: title: Read Replica Specification description: Read Replica Spec type: object properties: node_info: $ref: '#/components/schemas/ClusterNodeInfo' placement_info: $ref: '#/components/schemas/PlacementInfo' primary_cluster_id: type: string format: uuid required: - node_info - cluster_region_info - primary_cluster_id ReadReplicaData: title: Cluster Data description: Cluster data type: object required: - spec - info properties: spec: $ref: '#/components/schemas/ReadReplicaSpec' info: $ref: '#/components/schemas/ClusterDataInfo' AppConfigResponseDataItem: title: App Config Response Data Item description: An object containing config path and value type: object properties: path: type: string description: Configuration path value: type: string description: Value corresponding to the path required: - path - value AppConfigResponseData: title: App Config Response Data description: A list of configuration paths and corresponding values type: array uniqueItems: true items: $ref: '#/components/schemas/AppConfigResponseDataItem' UserTutorialSpecEntity: title: User Tutorial Spec Entity description: User Tutorial Spec Entity type: object properties: entity_id: type: string format: uuid entity_type: type: string required: - entity_id - entity_type UserTutorialState: title: User Tutorial State description: User Tutorial State type: object properties: id: type: string format: uuid name: type: string is_completed: type: boolean required: - id - name - is_completed UserTutorialSpec: title: User Tutorial Spec description: User Tutorial Spec type: object properties: is_enabled: type: boolean entities: type: array uniqueItems: true items: $ref: '#/components/schemas/UserTutorialSpecEntity' states: type: array items: $ref: '#/components/schemas/UserTutorialState' required: - is_enabled - entities - states UserTutorialInfo: title: User Tutorial Info description: User Tutorial Info type: object properties: user_id: type: string format: uuid tutorial_id: type: string format: uuid tutorial_name: type: string required: - user_id - tutorial_id - tutorial_name UserTutorialData: title: User Tutorial Data description: User Tutorial Data type: object properties: spec: $ref: '#/components/schemas/UserTutorialSpec' info: $ref: '#/components/schemas/UserTutorialInfo' required: - spec - info SSOType: title: SSO Type description: SSO Type type: string enum: - GOOGLE - GITHUB - LINKEDIN example: GOOGLE SSOEventType: title: SSO Event Type description: SSO Event Type type: string enum: - SIGNUP - LOGIN - INVITE example: SIGNUP CreateUserRequest: title: Create user request description: Create user request type: object required: - user_spec - password properties: user_spec: $ref: '#/components/schemas/UserSpec' password: type: string format: password description: Password associated with the user minLength: 8 maxLength: 72 hcaptcha_token: type: string description: Token from hCaptcha service ChangePasswordRequest: title: Change password request payload description: Change password request payload type: object required: - newPassword properties: current_password: type: string format: password description: Current password associated with the user minLength: 8 maxLength: 72 new_password: type: string format: password description: New password to associate with the user minLength: 8 maxLength: 72 UserAccountListInfo: title: User Account List Payload type: object properties: owned_accounts: type: array description: List of admin accounts associated with the user nullable: true items: $ref: '#/components/schemas/AccountData' admin_accounts: type: array description: List of admin accounts associated with the user nullable: true items: $ref: '#/components/schemas/AccountData' linked_accounts: type: array description: List of all accounts associated with the user nullable: true items: $ref: '#/components/schemas/AccountData' accounts: type: array description: List of all accounts associated with the user nullable: true items: $ref: '#/components/schemas/AccountData' requestBodies: AccountSpec: description: Account to be added to the cloud content: application/json: schema: $ref: '#/components/schemas/AccountSpec' required: true InviteUserRequest: description: User to be invited content: application/json: schema: $ref: '#/components/schemas/InviteUserSpec' required: true BatchInviteUserRequest: description: List of user to be invited content: application/json: schema: $ref: '#/components/schemas/BatchInviteUserSpec' required: true ModifyUserRoleRequest: description: Request to modify user role content: application/json: schema: $ref: '#/components/schemas/ModifyUserRoleRequest' required: true ModifyAllowedLoginTypesRequest: description: Request to modify allowed login types content: application/json: schema: $ref: '#/components/schemas/ModifyAllowedLoginTypesRequest' required: true AlertTestEmailRequest: description: Alert rule specification content: application/json: schema: $ref: '#/components/schemas/AlertTestEmailRequest' AlertRuleSpec: description: Alert rule specification content: application/json: schema: $ref: '#/components/schemas/AlertRuleSpec' LoginRequest: description: Request for logging in a user content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true AuthTokenSpec: description: Auth token spec content: application/json: schema: $ref: '#/components/schemas/AuthTokenSpec' BackupSpec: description: Backup to be created content: application/json: schema: $ref: '#/components/schemas/BackupSpec' RestoreSpec: description: Backup to be created content: application/json: schema: $ref: '#/components/schemas/RestoreSpec' BackupScheduleSpec: description: Schedule to be created content: application/json: schema: $ref: '#/components/schemas/BackupScheduleSpec' EstimateClusterCostRequest: description: Create estimate cluster cost request content: application/json: schema: $ref: '#/components/schemas/EstimateClusterCostSpec' BillingProfileSpec: description: Billing profile spec content: application/json: schema: $ref: '#/components/schemas/BillingProfileSpec' PaymentMethodSpec: description: Payment method spec content: application/json: schema: $ref: '#/components/schemas/PaymentMethodSpec' CreateClusterRequest: description: DB Cluster to be created content: application/json: schema: $ref: '#/components/schemas/CreateClusterRequest' ClusterSpec: description: DB Cluster to be updated content: application/json: schema: $ref: '#/components/schemas/ClusterSpec' NodeOpRequest: description: Request Body for Node Operation content: application/json: schema: $ref: '#/components/schemas/NodeOpRequest' NetworkAllowListIdList: description: Allow list specification content: application/json: schema: $ref: '#/components/schemas/NetworkAllowListIdList' MigrationRestoreSpec: description: Restore for a migration content: application/json: schema: $ref: '#/components/schemas/MigrationRestoreSpec' RateCardSpec: description: Rate card spec content: application/json: schema: $ref: '#/components/schemas/RateCardSpec' GlobalRateCardSpec: description: Global rate card spec content: application/json: schema: $ref: '#/components/schemas/GlobalRateCardSpec' CreditSpec: description: Credits spec content: application/json: schema: $ref: '#/components/schemas/CreditSpec' UpdateCreditsSpec: description: Update credits spec content: application/json: schema: $ref: '#/components/schemas/UpdateCreditsSpec' UpdatePaymentMethodSpec: description: Update payment method spec content: application/json: schema: $ref: '#/components/schemas/UpdatePaymentMethodSpec' AggregateSpec: description: Aggregate spec content: application/json: schema: $ref: '#/components/schemas/AggregateSpec' SetAutomaticInvoiceGenerationSpec: description: Set automatic invoice generation spec content: application/json: schema: $ref: '#/components/schemas/SetAutomaticInvoiceGenerationSpec' UpdateBillingInvoiceSpec: description: Update billing invoice spec content: application/json: schema: $ref: '#/components/schemas/UpdateBillingInvoiceSpec' RebuildMetricsTargetsRequest: description: Rebuild metrics targets request content: application/json: schema: $ref: '#/components/schemas/RebuildMetricsTargetsRequest' CreatePrivateClusterRequest: description: Private DB Cluster to be created content: application/json: schema: $ref: '#/components/schemas/CreatePrivateClusterRequest' PrivateClusterSpec: description: Private DB Cluster to be updated content: application/json: schema: $ref: '#/components/schemas/PrivateClusterSpec' DbUpgradeRequest: description: Request to upgrade DB version of a cluster content: application/json: schema: $ref: '#/components/schemas/DbUpgradeRequest' VmUpgradeRequest: description: Request to upgrade VM image of a cluster content: application/json: schema: $ref: '#/components/schemas/VmUpgradeRequest' GflagsUpgradeRequest: description: Request to upgrade gflags of a cluster content: application/json: schema: $ref: '#/components/schemas/GflagsUpgradeRequest' CreateBulkCustomImageSetSpec: description: Spec for creating custom image sets content: application/json: schema: $ref: '#/components/schemas/CreateBulkCustomImageSetSpecList' CustomImageRequest: description: Spec for creating custom image content: application/json: schema: $ref: '#/components/schemas/CustomImageSpec' SendEmailSpec: description: Send email specification content: application/json: schema: $ref: '#/components/schemas/SendEmailSpec' FaultInjectionRequest: description: Request Body Spec for Fault Injection content: application/json: schema: $ref: '#/components/schemas/FaultInjectionSpec' UpdateGflagMaintenanceRequest: description: Spec for Update Gflag Maintenance Request content: application/json: schema: $ref: '#/components/schemas/UpdateGflagMaintenanceSpec' NetworkAllowListSpec: description: Allow list specification content: application/json: schema: $ref: '#/components/schemas/NetworkAllowListSpec' AddNetworkRequest: description: Cluster network to be added content: application/json: schema: $ref: '#/components/schemas/AddNetworkRequest' InternalSingleTenantVpcRequest: description: Single tenant vpc specification content: application/json: schema: $ref: '#/components/schemas/InternalSingleTenantVpcRequest' InternalVpcPeeringRequest: description: Peer two yugabyte VPC content: application/json: schema: $ref: '#/components/schemas/InternalVpcPeeringSpec' AddPlatformRequest: description: YB Platform to be added content: application/json: schema: $ref: '#/components/schemas/AddPlatformRequest' AddProjectToPlatformRequest: description: Project to be added to the platform content: application/json: schema: $ref: '#/components/schemas/AddProjectToPlatformRequest' RefreshProviderPricingSpec: description: Refresh provider pricing in clusters matching these filters content: application/json: schema: $ref: '#/components/schemas/RefreshProviderPricingSpec' RuntimeConfigUpdateRequest: description: Request for updating runtime config for particular scope and path content: application/json: schema: $ref: '#/components/schemas/RuntimeConfigUpdateRequest' UpgradeRequestSpec: description: Scheduled cluster upgrade filters content: application/json: schema: $ref: '#/components/schemas/UpgradeRequestSpec' ClusterBasedUpgradeRequestSpec: description: Request Body Spec for Cluster Based Upgrades content: application/json: schema: $ref: '#/components/schemas/ClusterBasedUpgradeRequestSpec' SoftwareReleaseTrackSpec: description: DB software release track specification content: application/json: schema: $ref: '#/components/schemas/SoftwareReleaseTrackSpec' SoftwareReleaseSpec: description: DB software release specification content: application/json: schema: $ref: '#/components/schemas/SoftwareReleaseSpec' BatchAddSoftwareTrackRequest: description: Batch Add Software Track Request content: application/json: schema: $ref: '#/components/schemas/BatchAddAccountSoftwareTrackRequest' UpdateUserInternalTagsRequest: description: Request to update user internal tags content: application/json: schema: $ref: '#/components/schemas/InternalTagsSpec' UpdateDefaultInternalTagsRequest: description: Request to update default internal tags content: application/json: schema: $ref: '#/components/schemas/UpdateDefaultInternalTagsRequest' XClusterConfigSpec: description: Spec for XCluster Config content: application/json: schema: $ref: '#/components/schemas/XClusterConfigSpec' MaintenanceScheduleSpec: description: Request Body for Maintenance Schedule Spec content: application/json: schema: $ref: '#/components/schemas/MaintenanceScheduleSpec' VpcPeeringRequest: description: Vpc peering request content: application/json: schema: $ref: '#/components/schemas/VpcPeeringSpec' SingleTenantVpcRequest: description: Single tenant vpc specification content: application/json: schema: $ref: '#/components/schemas/SingleTenantVpcRequest' CreateProjectRequest: description: Project to be added to the cloud content: application/json: schema: $ref: '#/components/schemas/CreateProjectRequest' required: true ReadReplicaSpec: description: Read Replica to be created content: application/json: schema: $ref: '#/components/schemas/ReadReplicaSpec' UserTutorialRequestSpec: description: Request body for managing a user tutorial content: application/json: schema: $ref: '#/components/schemas/UserTutorialSpec' CreateUserRequest: description: Request for creating a user content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' required: true UserSpec: description: User specification content: application/json: schema: $ref: '#/components/schemas/UserSpec' ChangePasswordRequest: description: Request for changing user password content: application/json: schema: $ref: '#/components/schemas/ChangePasswordRequest' responses: AccountResponse: description: Account response content: application/json: schema: title: Account Response type: object properties: data: $ref: '#/components/schemas/AccountData' ApiError: description: API Error content: application/json: schema: $ref: '#/components/schemas/ApiError' UserListResponse: description: List of users content: application/json: schema: title: User List Response type: object properties: data: type: array items: $ref: '#/components/schemas/UserData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata InviteUserResponse: description: Invite User response content: application/json: schema: title: Invite User Response type: object properties: data: $ref: '#/components/schemas/InviteUserData' BatchInviteUserResponse: description: Batch invite User response content: application/json: schema: title: Batch invite User Response type: object properties: data: $ref: '#/components/schemas/BatchInviteUserData' UserResponse: description: User response content: application/json: schema: title: User Response type: object properties: data: $ref: '#/components/schemas/UserData' AllowedLoginTypesResponse: description: Allowed login types for account content: application/json: schema: title: Allowed login types response type: object properties: spec: $ref: '#/components/schemas/AllowedLoginTypesSpec' AlertRulesListResponse: description: Alert rules list response content: application/json: schema: title: Alert rules list response type: object properties: data: type: array items: $ref: '#/components/schemas/AlertRuleData' AlertRuleResponse: description: Alert rule response content: application/json: schema: title: Alert rule response type: object properties: data: $ref: '#/components/schemas/AlertRuleData' AlertNotificationsListResponse: description: Alert notifications list response content: application/json: schema: title: Alert notifications list response type: object properties: data: type: array items: $ref: '#/components/schemas/AlertNotificationData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata ListAuditEventResponse: description: List Audit Event Response content: application/json: schema: title: List Audit Event Response type: object properties: data: type: array items: $ref: '#/components/schemas/AuditEventData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata AuditEventResponse: description: Audit event response content: application/json: schema: title: Audit event response type: object properties: audit_event_data: $ref: '#/components/schemas/AuditEventData' audit_event_detailed_data: $ref: '#/components/schemas/AuditEventDetailedData' AuditEventCategoriesResponse: description: Audit Event Categories Response content: application/json: schema: title: Audit Event Categories Response type: object properties: categories: type: array items: $ref: '#/components/schemas/AuditEventCategory' AccountQuotaResponse: description: Account Quotas content: application/json: schema: title: Account Quota Response type: object properties: data: $ref: '#/components/schemas/AccountQuota' LoginResponse: description: Successful login response content: application/json: schema: title: Login Response type: object properties: data: type: object properties: authToken: type: string description: The auth token issued to the user minLength: 1 userId: type: string description: The id associated with the user format: uuid nullable: true RoleListResponse: description: List of RBAC roles content: application/json: schema: title: Role List Response type: object required: - data properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/RoleData' AuthTokenListResponse: description: List of non expired auth tokens content: application/json: schema: title: Auth Token List Response type: object properties: data: type: array items: $ref: '#/components/schemas/AuthTokenData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata CreateAuthTokenResponse: description: Create Auth Token response content: application/json: schema: title: Create Auth Token Response type: object properties: data: $ref: '#/components/schemas/AuthTokenData' jwt: type: string description: The jwt issued to the user minLength: 1 AuthTokenResponse: description: Auth Token response content: application/json: schema: title: Auth Token Response type: object properties: data: $ref: '#/components/schemas/AuthTokenData' BackupListResponse: description: List of backups content: application/json: schema: title: Backup List Response type: object properties: data: type: array items: $ref: '#/components/schemas/BackupData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata BackupResponse: description: Backup response content: application/json: schema: title: Backup Response type: object properties: data: $ref: '#/components/schemas/BackupData' MigrationBackupResponse: description: Migration backup response content: application/json: schema: title: Migration Backup Response type: object properties: data: $ref: '#/components/schemas/MigrationBackupData' RestoreListResponse: description: List of restores content: application/json: schema: title: Restore List Response type: object properties: data: type: array items: $ref: '#/components/schemas/RestoreData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata RestoreResponse: description: Restore response content: application/json: schema: title: Restore Response type: object properties: data: $ref: '#/components/schemas/RestoreData' ScheduleListResponse: description: List of schedules content: application/json: schema: title: Schedule List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduleData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata ScheduleResponse: description: Schedule response content: application/json: schema: title: Schedule Response type: object properties: data: $ref: '#/components/schemas/ScheduleData' EstimateClusterCostResponse: description: Estimate Cluster Cost Response content: application/json: schema: title: Estimate Cluster Cost Response type: object properties: data: $ref: '#/components/schemas/EstimateClusterCostData' GetDefaultPaymentMethodResponse: description: Get default payment method response content: application/json: schema: title: Get default payment method response type: object properties: data: $ref: '#/components/schemas/GetDefaultPaymentMethodSpec' BillingProfileResponse: description: Billing profile response content: application/json: schema: title: Billing profile response type: object properties: data: $ref: '#/components/schemas/BillingProfileSpec' PaymentMethodResponse: description: Payment method response content: application/json: schema: title: Payment method response type: object properties: data: $ref: '#/components/schemas/PaymentMethodSpec' RateInfoResponse: description: Rate info response content: application/json: schema: title: Rate info response type: object properties: data: $ref: '#/components/schemas/RateInfo' PaymentMethodListResponse: description: Payment method list response content: application/json: schema: title: Payment method list response type: object properties: data: $ref: '#/components/schemas/PaymentMethodListResponseSpec' SetupIntentResponse: description: Setup intent response content: application/json: schema: title: Setup intent response type: object properties: info: $ref: '#/components/schemas/SetupIntentInfo' CreditListResponse: description: List of Credit info content: application/json: schema: title: Credit List Response type: object properties: data: type: array items: $ref: '#/components/schemas/CreditData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata InvoiceListResponse: description: Invoice List Response content: application/json: schema: title: Invoice List Response type: object properties: data: type: array items: $ref: '#/components/schemas/InvoiceData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata BillingInvoiceSummaryResponse: description: Billing invoice summary response content: application/json: schema: title: Billing invoice summary response type: object properties: data: $ref: '#/components/schemas/BillingInvoiceSummaryData' UsageSummaryResponse: description: Usage summary response content: application/json: schema: title: Usage summary response type: object properties: data: $ref: '#/components/schemas/UsageSummaryData' UsageSummaryStatisticsResponse: description: Usage summary Statistics response content: application/json: schema: title: Usage summary Statistics response type: object properties: cluster_data: $ref: '#/components/schemas/UsageSummaryClusterData' infrastructure_data: $ref: '#/components/schemas/UsageSummaryInfrastructureData' ClusterListResponse: description: List of clusters content: application/json: schema: title: Cluster List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ClusterData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata ClusterResponse: description: Cluster response content: application/json: schema: title: Cluster Response type: object properties: data: $ref: '#/components/schemas/ClusterData' NodeOpResponse: description: Node operation response content: application/json: schema: title: Node operation Response type: object properties: data: $ref: '#/components/schemas/NodeData' required: - data ClusterInstantMetricsListResponse: description: List of cluster instant metrics content: application/json: schema: title: Cluster instant metrics list response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/ClusterInstantMetrics' LiveQueryResponse: description: Live Queries of a Cluster content: application/json: schema: $ref: '#/components/schemas/LiveQueryResponseSchema' SlowQueryResponse: description: Slow Queries of a Cluster content: application/json: schema: $ref: '#/components/schemas/SlowQueryResponseSchema' ClusterNodeListResponse: description: Cluster nodes response content: application/json: schema: title: Cluster Nodes Response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/NodeData' required: - data MetricResponse: description: Metric response content: application/json: schema: title: Metric Response type: object properties: data: type: array items: $ref: '#/components/schemas/MetricData' start_timestamp: description: Start of range of results type: integer format: int64 end_timestamp: description: End of range of results type: integer format: int64 required: - data - start_timestamp - end_timestamp ClusterTableListResponse: description: List of cluster tables content: application/json: schema: title: Cluster table list response type: object properties: data: $ref: '#/components/schemas/ClusterTableData' required: - data ClusterTablespacesListResponse: description: List of cluster tablespaces content: application/json: schema: title: Cluster tablespaces list response type: object properties: data: type: array items: $ref: '#/components/schemas/ClusterTablespace' required: - data NetworkAllowListListResponse: description: List of allow lists content: application/json: schema: title: Network allow list list response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/NetworkAllowListData' required: - data CertificateResponse: description: The CA certificate for connecting to the cluster content: application/json: schema: title: Certificate Response type: object properties: data: $ref: '#/components/schemas/CertificateContent' RegionListResponse: description: Region List response content: application/json: schema: title: Region List Response type: object properties: data: $ref: '#/components/schemas/RegionListResponseData' InstanceTypeSpecMapResponse: description: Instance Type Spec Map response content: application/json: schema: title: Instance Type Spec Map Response type: object properties: data: $ref: '#/components/schemas/InstanceTypeSpecMapResponseData' ClusterTierSpecsResponse: description: Cluster Tier Specs response content: application/json: schema: title: Cluster Tier Specs Response type: object properties: data: $ref: '#/components/schemas/ClusterTierSpecsResponseData' required: - data HealthCheckResponse: description: Successful health check response content: application/json: schema: title: Health Check Response type: object properties: data: $ref: '#/components/schemas/HealthCheckInfo' AccountListResponse: description: List of Accounts content: application/json: schema: title: Account List Response type: object properties: data: type: array items: $ref: '#/components/schemas/AccountData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata AdminApiTokenResponse: description: Admin Jwt for bearer authentication content: application/json: schema: title: Admin Api Token Response type: object properties: data: type: object properties: adminJwt: type: string description: The auth Jwt issued to the admin minLength: 1 info: $ref: '#/components/schemas/AdminTokenInfo' AdminTokenListResponse: description: List of non expired admin tokens content: application/json: schema: title: Admin Token List Response type: object properties: data: type: array items: $ref: '#/components/schemas/AdminTokenInfo' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata MigrationRestoreResponse: description: Migration restore response content: application/json: schema: title: Migration Restore Response type: object properties: data: $ref: '#/components/schemas/MigrationRestoreData' RateCardResponse: description: Rate card response content: application/json: schema: title: Rate card response type: object properties: data: $ref: '#/components/schemas/RateCardSpec' GlobalRateCardResponse: description: Global rate card response content: application/json: schema: title: Global rate card response type: object properties: data: $ref: '#/components/schemas/GlobalRateCardSpec' CreditResponse: description: Credit response content: application/json: schema: title: Credit response type: object properties: credit_data: $ref: '#/components/schemas/CreditData' UpdateCreditsResponse: description: Update credits response content: application/json: schema: title: Update credits response type: object properties: credit_data: $ref: '#/components/schemas/UpdateCreditsSpec' UpdatePaymentMethodResponse: description: Update payment method response content: application/json: schema: title: Update payment method response type: object properties: payment_data: $ref: '#/components/schemas/UpdatePaymentMethodSpec' AggregateResponse: description: Aggregate response content: application/json: schema: title: Aggregate response type: object properties: spec: $ref: '#/components/schemas/AggregateSpec' InvoiceResponse: description: Invoice response content: application/json: schema: title: Invoice response type: object properties: info: $ref: '#/components/schemas/InvoiceInfo' SetAutomaticInvoiceGenerationResponse: description: Set automatic invoice generation response content: application/json: schema: title: Set automatic invoice generation response type: object properties: info: $ref: '#/components/schemas/SetAutomaticInvoiceGenerationSpec' UpdateBillingInvoiceResponse: description: Update billing invoice response content: application/json: schema: title: Update billing invoice response type: object properties: invoice_data: $ref: '#/components/schemas/UpdateBillingInvoiceSpec' InternalClusterResponse: description: Cluster response with internal cluster details content: application/json: schema: title: Internal cluster response type: object properties: data: $ref: '#/components/schemas/InternalClusterData' DbReleasesListResponse: description: List of DB releases content: application/json: schema: title: DB releases list response type: object properties: releases: type: array items: type: string GFlagsDataResponse: description: GFlags Data Response content: application/json: schema: title: GFlags Data Response type: object properties: data: $ref: '#/components/schemas/GFlagsData' required: - data PlatformResponse: description: Platform response content: application/json: schema: title: Platform Response type: object properties: data: $ref: '#/components/schemas/PlatformDataResponse' InternalClusterNodesResponse: description: Internal cluster nodes response content: application/json: schema: title: Internal Cluster Nodes Response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/InternalNodeData' required: - data InternalNetworkAllowListListResponse: description: List of allow lists content: application/json: schema: title: Internal network allow list list response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/InternalNetworkAllowListData' required: - data CustomImageSetListResponse: description: Custom Image Set List Response content: application/json: schema: title: Custom Image Set List Response type: object properties: data: type: array items: $ref: '#/components/schemas/CustomImageSetListItem' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata CreateBulkCustomImageSetResponse: description: Custom Image Set Bulk Create Response content: application/json: schema: title: Create Bulk Custom Image Set Response type: object properties: data: type: array items: $ref: '#/components/schemas/CreateBulkCustomImageSetStatus' required: - data CustomImageSetResponse: description: Custom Image Set Response content: application/json: schema: title: Custom Image Set Response type: object properties: data: $ref: '#/components/schemas/CustomImageSetData' FaultInjectionResponse: description: Fault Injection content: application/json: schema: title: Fault Injection Response type: object properties: data: type: array items: type: string FaultInjectionListResponse: description: Fault Injection content: application/json: schema: title: Fault Injection List Response type: object properties: data: type: array items: $ref: '#/components/schemas/FaultInjection' LoggingLevelResponse: description: Logging Level Response for API Server content: application/json: schema: $ref: '#/components/schemas/LoggingLevelResponseSchema' UpdateGflagMaintenanceResponse: description: Update Gflag Maintenance Response content: application/json: schema: $ref: '#/components/schemas/UpdateGflagMaintenanceSpec' VersionInfo: description: Version Information content: application/json: schema: $ref: '#/components/schemas/VersionInfo' MeteringResponse: description: Metering Response content: application/json: schema: title: Metering Response type: object properties: data: $ref: '#/components/schemas/MeteringData' InternalNetworkAllowListResponse: description: Internal network allow list response content: application/json: schema: title: Internal network allow List Response type: object properties: data: $ref: '#/components/schemas/InternalNetworkAllowListData' required: - data NetworkListResponse: description: List of networks content: application/json: schema: title: Network List Response type: object properties: data: type: array items: $ref: '#/components/schemas/NetworkDataResponse' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata NetworkResponse: description: Network response content: application/json: schema: title: Network Response type: object properties: data: $ref: '#/components/schemas/NetworkDataResponse' SingleTenantVpcResponse: description: Single tenant vpc response content: application/json: schema: title: Single Tenant Vpc Response type: object properties: data: $ref: '#/components/schemas/SingleTenantVpcDataResponse' InternalVPCPeeringResponse: description: Internal Vpc peering response content: application/json: schema: title: Internal VPC peering Response type: object properties: peeringId: type: string format: uuid description: peering Id between two yugabyte VPCs PlatformListResponse: description: List of platforms content: application/json: schema: title: Platform List Response type: object properties: data: type: array items: $ref: '#/components/schemas/PlatformDataResponse' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata RuntimeConfigResponse: description: Runtime config response content: application/json: schema: title: Runtime Config Response type: object properties: data: type: string required: - data RuntimeConfigUpdateResponse: description: Updated config data for scope content: application/json: schema: title: Runtime Config Update Response type: object properties: configs: type: array items: $ref: '#/components/schemas/RuntimeConfigUpdateData' ScheduledUpgradeTaskResponse: description: Scheduled Upgrade Task Response content: application/json: schema: title: Scheduled Upgrade Task Response type: object properties: data: $ref: '#/components/schemas/ScheduledUpgradeTaskData' ScheduledClusterUpgradeTaskResponse: description: Scheduled Cluster Upgrade Task Response content: application/json: schema: title: Scheduled Cluster Upgrade Task Response type: object properties: data: $ref: '#/components/schemas/ScheduledClusterUpgradeTaskData' ScheduledUpgradeTaskListResponse: description: List of Scheduled Upgrade Tasks content: application/json: schema: title: Scheduled Upgrade Task List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduledUpgradeTaskData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata SoftwareReleaseTrackListPagedResponse: description: List of software release tracks content: application/json: schema: title: Software release track list paged response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/SoftwareReleaseTrackData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata SoftwareReleaseTrackResponse: description: Software Release Track Response content: application/json: schema: title: Software release track response type: object properties: data: $ref: '#/components/schemas/SoftwareReleaseTrackData' SoftwareReleaseListResponse: description: List of software releases for a track content: application/json: schema: title: Software release list response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/SoftwareReleaseData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata SoftwareReleaseResponse: description: Software Release Response content: application/json: schema: title: Software release response type: object properties: data: $ref: '#/components/schemas/SoftwareReleaseData' required: - data GetAllowedValuesForInternalTagsResponse: description: Get allowed values for internal tags response content: application/json: schema: title: Get allowed values for internal tags response type: object properties: data: type: object additionalProperties: type: array items: type: string nullable: true GetUserInternalTagsResponse: description: Get user internal tags response content: application/json: schema: title: Get user internal tags response type: object properties: data: $ref: '#/components/schemas/InternalTagsSpec' DefaultInternalTagsListResponse: description: Default internal tags list response content: application/json: schema: title: Default internal tags list response type: object properties: data: type: array items: $ref: '#/components/schemas/InternalTagsSpec' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata UpdateDefaultInternalTagsResponse: description: Update Default Internal Tags Response content: application/json: schema: title: Update default internal tags response type: object properties: data: type: array items: $ref: '#/components/schemas/DefaultInternalTagsUpdateData' required: - data RunScheduledTaskResponse: description: Run scheduled task response content: application/json: schema: title: Run scheduled task response type: object properties: message: type: string required: - message TaskListResponse: description: List of tasks content: application/json: schema: title: Task List Response type: object properties: data: type: array items: $ref: '#/components/schemas/TaskData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata XClusterConfigResponse: description: XCluster Config Response content: application/json: schema: title: XCluster Config Response type: object properties: data: $ref: '#/components/schemas/XClusterConfigData' ScheduledUpgradeResponse: description: Scheduled Upgrade Response content: application/json: schema: title: Scheduled Upgrade Response type: object properties: data: $ref: '#/components/schemas/ScheduledMaintenanceEventData' required: - data ScheduledMaintenanceEventListResponse: description: Scheduled Maintenance Event List Response content: application/json: schema: title: Scheduled Maintenance Event List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ScheduledMaintenanceEventData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata MaintenanceScheduleResponse: description: Maintenance Schedule Response content: application/json: schema: title: Maintenance Schedule Response type: object properties: data: $ref: '#/components/schemas/MaintenanceScheduleData' MaintenanceWindowResponse: description: Maintenance Window Response content: application/json: schema: title: Maintenance Window Response type: object properties: data: $ref: '#/components/schemas/MaintenanceWindowInfo' required: - data NetworkAllowListResponse: description: Network allow list response content: application/json: schema: title: Network allow List Response type: object properties: data: $ref: '#/components/schemas/NetworkAllowListData' required: - data VpcPeeringListResponse: description: Vpc Peering List Response content: application/json: schema: title: Vpc Peering List Response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/VpcPeeringData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata VpcPeeringResponse: description: Vpc Peering Response content: application/json: schema: title: Vpc Peering Response type: object properties: data: $ref: '#/components/schemas/VpcPeeringData' SingleTenantVpcListResponse: description: List of single tenant vpc response content: application/json: schema: title: Single Tenant Vpc List Response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/SingleTenantVpcDataResponse' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata CidrListResponse: description: Cidr List Response content: application/json: schema: title: Cidr List Response type: object properties: data: $ref: '#/components/schemas/CidrListResponseData' ProjectListResponse: description: List of projects content: application/json: schema: title: Project List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ProjectData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata ProjectResponse: description: Project response content: application/json: schema: title: Project Response type: object properties: data: $ref: '#/components/schemas/ProjectData' ReadReplicaListResponse: description: List of read replicas content: application/json: schema: title: Read Replica List Response type: object properties: data: type: array items: $ref: '#/components/schemas/ReadReplicaData' _metadata: $ref: '#/components/schemas/PagingMetadata' required: - data - _metadata ReadReplicaResponse: description: Read Replica response content: application/json: schema: title: Read Replica Response type: object properties: data: $ref: '#/components/schemas/ReadReplicaData' SoftwareReleaseTrackListResponse: description: List of software release tracks content: application/json: schema: title: Software release track list response type: object properties: data: type: array uniqueItems: true items: $ref: '#/components/schemas/SoftwareReleaseTrackData' required: - data AppConfigResponse: description: Application config response content: application/json: schema: title: App Config Response type: object properties: data: $ref: '#/components/schemas/AppConfigResponseData' required: - data UserTutorialListResponse: description: User Tutorials Response content: application/json: schema: title: User Tutorials Response type: object properties: tutorials: type: array items: $ref: '#/components/schemas/UserTutorialData' required: - tutorials UserTutorialResponse: description: User Tutorial Response content: application/json: schema: $ref: '#/components/schemas/UserTutorialData' SSORedirectURLResponse: description: SSO Redirect URL Response content: application/json: schema: title: SSO Redirect URL Response type: object properties: sso_type: $ref: '#/components/schemas/SSOType' sso_event_type: $ref: '#/components/schemas/SSOEventType' sso_redirect_url: type: string minLength: 1 UserAccountListResponse: description: User Account List response content: application/json: schema: title: User Account List Response type: object properties: data: $ref: '#/components/schemas/UserAccountListInfo' securitySchemes: BearerAuthToken: type: http scheme: bearer bearerFormat: JWT security: - BearerAuthToken: []