openapi: 3.0.1
info:
title: Data Management for VMware Tanzu
description: Public endpoints of Data Management for VMware Tanzu.
version: 1.0.0
#servers:
#- url: https://10.196.63.207
# description: Generated server url
#security:
#- orgHeader: []
tags:
- name: Provider HA Operations
description: Endpoints for triggering actions on Providers
- name: Provider Certificates
description: Endpoints for operations related to certificates on the Provider
- name: Secondary Provider Operations
description: Endpoints for triggering actions on Secondary Providers
- name: Provider Health APIs
description: Endpoints related to Provider appliance health
- name: Provider Log APIs
description: Endpoints related to Provider appliance logs
- name: Appliance
description: Endpoints for operations on the appliance vm
- name: Infrastructure Metrics
description: Endpoints to fetch infrastructure metrics for the particular period of time
- name: Database Metrics
description: Endpoints for fetching Database Metrics for the particular period of time
- name: SMTP Settings
description: Endpoints for operations on SMTP settings
- name: Storage Information
description: Endpoints for operations on storage information
- name: Database Logs
description: Endpoints for operations on database logs
- name: Organization
description: Endpoints for operations on Organization
- name: Provider Application Status
description: Endpoints for operations on provider application status
- name: Tanzu Net Settings
description: Endpoints for operations on tanzu net settings
- name: Provider External Storage
description: Endpoints for operations on provider external storage
- name: Audit
description: Endpoints for operations on audit
- name: Elastic Search Log
description: Endpoints for operations on elastic search log
- name: Log Bundles
description: Endpoints for operations on log bundles
- name: Databases
description: Endpoints for operations on Databases
- name: Alarms
description: Endpoints for operations on alarms
- name: Tasks
description: Endpoints for operations on tasks
- name: RabbitMQ Settings
description: Endpoints for operations on rabbitmq settings
- name: Templates
description: Endpoints for operations on templates
- name: Agent Appliance management
description: Endpoints for operations on Agent appliance management
- name: Backup
description: Endpoints for operations on backup
- name: Events
description: Endpoints for operations on events
- name: Provider Storage Settings
description: Endpoints for operations on provider storage settings
- name: LDAP Server Configuration
description: Endpoints for operations on ldap server configuration
- name: Environment
description: Endpoints for operations on Environment
- name: Users
description: Endpoints for operations on users
- name: Instance Plans
description: Endpoints for operations on Instance Plans
- name: DB Password Management
description: Endpoints for operations on Databases
- name: Trigger Provider Update
description: Endpoints to perform provider node update operations
- name: Available Provider Updates
description: Endpoints to fetch available provider node updates
- name: Provider Update Task History
description: Endpoints to fetch details of provider update history
paths:
'/appliance/provider/{providerId}/password':
put:
tags:
- Appliance
summary: Update provider node root password
description: "Use this endpoint to update provider node's root password
Authorized\
\ Roles : PROVIDER"
operationId: changeApplianceRootPassword
parameters:
- name: providerId
in: path
description: Provider Node instance ID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeAppliancePasswordDto'
required: true
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/rabbitmq: {}
/appliance/provider/sync-trusted-certificates:
post:
tags:
- Provider Certificates
summary: Sync trusted certificates with Primary Node
description: "Use this endpoint to sync trusted certificates from Primary Provider
Authorized\
\ Roles : PROVIDER"
operationId: syncTrustedCerts
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/provider/replace-certificate:
post:
tags:
- Provider Certificates
summary: Replace Server SSL Certificate on all nodes in HA cluster
description: "Use this endpoint to replace the server SSL certificate on all\
\ nodes in HA cluster
Authorized Roles : PROVIDER"
operationId: uploadNewProviderCertificatesToAllNodes
requestBody:
content:
multipart/form-data:
schema:
required:
- certificate
- key
type: object
properties:
key:
type: string
format: binary
certificate:
type: string
format: binary
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/provider/configure-es:
post:
tags:
- Provider Log APIs
summary: Configure Elastic Search for logs collection
description: "Use this endpoint to configure elastic search for log collection
Authorized\
\ Roles : PROVIDER"
operationId: configureLogstashInAllNodes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EsConfigurationDto'
required: true
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/provider/add-trusted-certificates:
post:
tags:
- Provider Certificates
summary: Upload custom certs to be trusted
description: "Use this endpoint to upload custom certs to be trusted
Authorized\
\ Roles : PROVIDER"
operationId: uploadTrustedCerts
requestBody:
content:
multipart/form-data:
schema:
required:
- certificate
type: object
properties:
certificate:
type: string
format: binary
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/MultiNodeProviderOperationsResponseDto'
security:
- bearer-key: []
- orgHeader: []
/appliance/provider-ha/register:
post:
tags:
- Secondary Provider Operations
summary: Register Secondary Provider
description: "Use this endpoint to register a standalone as a Secondary with\
\ a Primary provider
Authorized Roles : PROVIDER"
operationId: registerSecondaryNode
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrimaryProviderDetailsDto'
required: true
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
/appliance/provider-ha: {}
/appliance/loggers/configure-self:
post:
tags:
- Provider Log APIs
summary: Dynamically change log level for current node
description: "Use this endpoint to dynamically change log level for a specific\
\ service on current node
Authorized Roles : PROVIDER"
operationId: configureLogLevel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceLogConfigDto'
required: true
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/loggers/configure-all:
post:
tags:
- Provider Log APIs
summary: Dynamically change log level for all nodes in HA cluster
description: "Use this endpoint to dynamically change log level for a specific\
\ service on all nodes in HA cluster
Authorized Roles : PROVIDER"
operationId: configureLogLevelOnAllNodes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceLogConfigDto'
required: true
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/appliance/ha/certificates: {}
/appliance/es-config:
get:
tags:
- Provider Log APIs
summary: Get configured ElasticSearch details
description: "Use this endpoint to fetch ElasticSearch configuration
Authorized\
\ Roles : PROVIDER"
operationId: getLogstashConfig
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/EsConfigurationDto'
security:
- bearer-key: []
- orgHeader: []
/appliance/certificate:
post:
tags:
- Provider Certificates
summary: Replace Server SSL Certificate on current provider node
description: "Use this endpoint to replace the server SSL certificate on current\
\ provider node
Authorized Roles : PROVIDER"
operationId: uploadNewProviderCertificates
requestBody:
content:
multipart/form-data:
schema:
required:
- certificate
- key
type: object
properties:
key:
type: string
format: binary
certificate:
type: string
format: binary
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
security:
- bearer-key: []
- orgHeader: []
/api/provider-certificates: {}
/api/load-boot-entities: {}
/api/appliance: {}
/appliance/status:
get:
tags:
- Provider Health APIs
description: "Authorized Roles : PROVIDER"
operationId: serviceStatus
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/ServiceStatusDTO'
/appliance/providerhealth:
get:
tags:
- Provider Health APIs
description: "Authorized Roles : PROVIDER"
operationId: getProviderHealths
parameters:
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageProviderEnvironmentHealth'
/appliance/provider/get-trusted-certificates:
get:
tags:
- Provider Certificates
summary: Fetch trusted certificates
description: "Use this endpoint to fetch the custom certificates trusted by\
\ the appliance
Authorized Roles : PROVIDER"
operationId: fetchAllTrustedCerts
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
security:
- bearer-key: []
- orgHeader: []
'/appliance/provider-ha-nodes/{nodeUUID}/password':
get:
tags:
- Provider HA Operations
summary: Get Provider Node root password
description: "Use this endpoint to get root password of a provider node
Authorized\
\ Roles : PROVIDER"
operationId: getProviderVmPassword
parameters:
- name: nodeUUID
in: path
description: Provider Node instance ID
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/appliance/provider-ha-nodes/{id}': {}
/appliance/provider-ha-nodes:
get:
tags:
- Provider HA Operations
summary: Fetch all configured provider nodes
description: "Use this endpoint to get all the configured Provider nodes
Authorized\
\ Roles : PROVIDER"
operationId: getPage
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
/appliance/endpoint-support-versions: {}
/appliance/current-provider-ha-node:
get:
tags:
- Provider HA Operations
summary: Fetch Provider Node Information
description: "This endpoint will return the provider node's information on which\
\ this API has been triggered
Authorized Roles : PROVIDER"
operationId: getCurrentProviderNode
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/appliance/provider-ha/{instanceUuid}':
delete:
tags:
- Provider HA Operations
summary: Delete secondary node in cluster
description: "Use this endpoint to delete a secondary provider node in HA cluster
Authorized\
\ Roles : PROVIDER"
operationId: deleteNode
parameters:
- name: instanceUuid
in: path
description: Instance ID of the Provider Node to be deleted
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
security:
- bearer-key: []
- orgHeader: []
/session:
post:
tags:
- authentication-controller
summary: Authenticate DMS User
description: Authenticate DMS User
operationId: session
requestBody:
description: AuthenticateRequest Body.
content:
application/json:
schema:
$ref: '#/components/schemas/AuthDTO'
required: true
responses:
'200':
description: Successful authentication
content:
'*/*':
schema:
$ref: '#/components/schemas/UserSessionInfo'
'400':
description: Authentication failure
content:
'*/*':
schema:
$ref: '#/components/schemas/ErrorDto'
'/environments/{environmentId}/hosts/{hostMoid}/vms/{dbUUID}/metrics':
get:
tags:
- Infrastructure Metrics
summary: Get list of specified Database VM Metrics
description: "Use this endpoint to retrieve specified VM Metrics by Environment\
\ UUID, Host Moid, DB UUID and Metric Key
Authorized Roles : PROVIDER\
\ or ORG_ADMIN or ORG_USER"
operationId: getVmMetrics
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: hostMoid
in: path
description: Host Moid
required: true
schema:
type: string
- name: dbUUID
in: path
description: DB UUID
required: true
schema:
type: string
format: uuid
- name: metricKey
in: query
description: Metric Key name
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageInfraMetricsDTO'
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/hosts/{hostMoid}/vms/filter-by-usage':
get:
tags:
- Infrastructure Metrics
summary: Order Database VMs by specified Metric Usage under particular Host
description: "Use this endpoint to Order Database VMs by specified Metric Usage\
\ using Environment UUID, Host Moid and Metric Key
Authorized Roles\
\ : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: getVMByUsage
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: hostMoid
in: path
description: Host Moid
required: true
schema:
type: string
- name: orderby
in: query
description: Order By Metric Key name
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageVMUsageDTO'
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/hosts/{hostMoid}/vms':
get:
tags:
- Infrastructure Metrics
summary: Get list of Database VMs by Host Moid
description: "Use this endpoint to retrieve VM details by Environment UUID and\
\ Host Moid
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: getVMs
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: hostMoid
in: path
description: Host Moid
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/hosts/{hostMoid}/metrics':
get:
tags:
- Infrastructure Metrics
summary: Get list of specified Host Metrics
description: "Use this endpoint to retrieve specified host metrics by Environment\
\ UUID, Host Moid and Metric Key
Authorized Roles : PROVIDER or\
\ ORG_ADMIN or ORG_USER"
operationId: getHostsMetrics
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: hostMoid
in: path
description: Host Moid
required: true
schema:
type: string
- name: metricKey
in: query
description: Metric Key name
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageInfraMetricsDTO'
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/hosts':
get:
tags:
- Infrastructure Metrics
summary: Get list of Hosts by Environment UUID
description: "Use this endpoint to retrieve hosts information under the Environment
Authorized\
\ Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: getHosts
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/datastores/{datastoreMoid}/metrics':
get:
tags:
- Infrastructure Metrics
summary: Get list of specified Datastore Metrics by Environment UUID
description: "Use this endpoint to retrieve specified Datastore Metrics by Environment\
\ UUID, Datastore Moid and Metric Key
Authorized Roles : PROVIDER\
\ or ORG_ADMIN or ORG_USER"
operationId: getDatastoreMetrics
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: datastoreMoid
in: path
description: Datastore Moid
required: true
schema:
type: string
- name: metricKey
in: query
description: Metric Key name
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageInfraMetricsDTO'
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/datastores':
get:
tags:
- Infrastructure Metrics
summary: Get list of Datastores by Environment UUID
description: "Use this endpoint to retrieve Datastores under particular Environment
Authorized\
\ Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: getDatastores
parameters:
- name: environmentId
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/database/{envUUID}/metrics/{metricKey}':
get:
tags:
- Infrastructure Metrics
summary: Get list of specified Agent Environment Postgres Metrics
description: "Use this endpoint to retrieve Agent Environment Postgres Metrics\
\ by Environment UUID
Authorized Roles : PROVIDER or ORG_ADMIN\
\ or ORG_USER"
operationId: findByKeyWithDurationEnvironment
parameters:
- name: metricKey
in: path
description: Metric Key Name
required: true
schema:
type: string
- name: envUUID
in: path
description: Environment UUID
required: true
schema:
type: string
format: uuid
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageTenantPostgresMonitoringMetricDTO'
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/vm/metrics/{metricKey}':
get:
tags:
- Database Metrics
summary: Get list of specified Database VM Metrics for the particular period
description: "Use this endpoint to retrieve specified VM Metrics by DB UUID\
\ and Metric Key
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: getVmMetrics_1
parameters:
- name: dbUUID
in: path
description: DB UUID
required: true
schema:
type: string
format: uuid
- name: metricKey
in: path
description: Metric Key name
required: true
schema:
type: string
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageInfraMetricsDTO'
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/metrics/{metricKey}':
get:
tags:
- Database Metrics
summary: Get list of specified Database Metrics for the particular period
description: "Use this endpoint to retrieve database metrics by DB UUID and\
\ Metric Key
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: findByKeyWithDuration
parameters:
- name: metricKey
in: path
description: Metric Key name
required: true
schema:
type: string
- name: dbUUID
in: path
description: Database UUID
required: true
schema:
type: string
format: uuid
- name: duration
in: query
description: Time Period
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: Time Unit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageMonitoringMetricDTO'
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/metric-keys':
get:
tags:
- Database Metrics
summary: Get List of Metric Keys By Database UUID
description: "Use this endpoint to retrieve list of all metric keys
Authorized\
\ Roles : PROVIDER or ORG_ADMIN or ORG_USER"
operationId: findMetricKeysByDatabase
parameters:
- name: dbUUID
in: path
description: Database UUID
required: true
schema:
type: string
format: uuid
responses:
"500":
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"204":
description: No Content
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionResponse'
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: array
items:
type: string
security:
- bearer-key: []
- orgHeader: []
'/users/{id}/update-user-details':
put:
tags:
- Users
summary: Update user details
description: >-
Use this endpoint to update user details
Authorized Roles :
PROVIDER
operationId: updateUserDetails
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/tdmUserUpdateDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/users/{id}/reset-password':
put:
tags:
- Users
summary: Reset user password
description: >-
Use this endpoint to reset user password
Authorized Roles :
PROVIDER
operationId: resetUserPassword
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/resetPasswordDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/users/change-password:
put:
tags:
- Users
summary: Change current user password
description: >-
Use this endpoint to change current user password
Authorized
Roles : ANY
operationId: changePassword
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/changePasswordDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/templates/{id}/unpublish':
put:
tags:
- Templates
summary: Unpublish template
description: >-
Use this endpoint to Unpublish template
Authorized Roles :
PROVIDER
operationId: unpublish
parameters:
- name: id
in: path
description: ID of the template
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/ProviderTemplate'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/templates/{id}/retire':
put:
tags:
- Templates
summary: Retire template
description: >-
Use this endpoint to Retire template
Authorized Roles :
PROVIDER
operationId: retire
parameters:
- name: id
in: path
description: ID of the template
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/ProviderTemplate'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/templates/{id}/publish':
put:
tags:
- Templates
summary: Publish template
description: >-
Use this endpoint to publish template
Authorized Roles :
PROVIDER
operationId: publish
parameters:
- name: id
in: path
description: ID of the template
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/ProviderTemplate'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/tanzusettings:
get:
tags:
- Tanzu Net Settings
summary: Get Tanzu Settings
description: >-
Use this endpoint to get tanzu net settings
Authorized Roles
: PROVIDER
operationId: getPage_2
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageTanzuNetStorageSettings'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
put:
tags:
- Tanzu Net Settings
summary: Update Tanzu Settings
description: >-
Use this endpoint to update tanzu net settings
Authorized
Roles : PROVIDER
operationId: modify
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TanzuNetStorageSettingsDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TanzuNetStorageSettings'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Tanzu Net Settings
summary: Create Tanzu Settings
description: >-
Use this endpoint to create tanzu net settings
Authorized
Roles : PROVIDER
operationId: create_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TanzuNetStorageSettingsDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TanzuNetStorageSettings'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Tanzu Net Settings
summary: Delete Tanzu Settings
description: >-
Use this endpoint to delete tanzu net settings
Authorized
Roles : PROVIDER
operationId: remove
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/storagesettings:
get:
tags:
- Provider Storage Settings
summary: Get Provider Storage Settings
description: >-
Endpoint for get provider storage settings
Authorized Roles :
PROVIDER
operationId: getPage_3
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelProviderStorageSettingsDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
put:
tags:
- Provider Storage Settings
summary: Update Provider Storage Settings
description: >-
Endpoint for update provider storage settings
Authorized
Roles : PROVIDER
operationId: put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderStorageSettingsDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Provider Storage Settings
summary: Create Provider Storage Settings
description: >-
Endpoint for create provider storage settings
Authorized
Roles : PROVIDER
operationId: create_2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderStorageSettingsDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/smtp-settings/{stype}':
put:
tags:
- SMTP Settings
summary: Update SMTP Settings for the type
description: 'Endpoint to update SMTP settings
Authorized Roles : PROVIDER'
operationId: updateProviderSmtpSettings
parameters:
- name: stype
in: path
description: Type of SMTP setting
required: true
schema:
type: string
enum:
- PROVIDER
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderSmtpSettingsDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- SMTP Settings
summary: Delete SMTP Settings
description: 'Endpoint to delete SMTP settings
Authorized Roles : PROVIDER'
operationId: deleteProviderSmtpSettings
parameters:
- name: stype
in: path
description: Type of SMTP setting
required: true
schema:
type: string
enum:
- PROVIDER
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/secondary-health/{nodeId}': {}
/recoverUserPassword: {}
'/orgs/{uuid}':
get:
tags:
- Organization
summary: Get organization by id
description: >-
Endpoint to get organization details by id
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getTenant
parameters:
- name: uuid
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
put:
tags:
- Organization
summary: Update organization
description: >-
Endpoint to update organizations details
Authorized Roles :
PROVIDER
operationId: updateTenant
parameters:
- name: uuid
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TenantDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/ldap-server/{id}':
put:
tags:
- LDAP Server Configuration
summary: Update LDAP server configuration
description: >-
Endpoint to update LDAP server configuration
Authorized Roles
: PROVIDER
operationId: updateProviderLdapServer
parameters:
- name: id
in: path
description: ID of the LDAP server details
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LdapServerDetailsDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/instancetype:
get:
tags:
- Instance Plans
summary: Get Instance plans
description: >-
Endpoint to get instance plans
Authorized Roles : PROVIDER or
ORG_ADMIN or ORG_USER
operationId: getAllInstanceTypes
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/InstanceTypeDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
put:
tags:
- Instance Plans
summary: Update Instance plans
description: 'Endpoint to update instance plans
Authorized Roles : PROVIDER'
operationId: updateInstanceType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceTypeDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/InstanceTypeDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Instance Plans
summary: Create Instance plans
description: 'Endpoint to create instance plans
Authorized Roles : PROVIDER'
operationId: saveInstanceType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInstanceTypeDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/InstanceTypeDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/environments: {}
'/environments/{environmentId}/{tenantId}/unassign-org':
put:
tags:
- Environment
summary: Remove Organization from environment
description: >-
Endpoint to remove organization from environment
Authorized
Roles : PROVIDER
operationId: unassignTenant
parameters:
- name: environmentId
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
- name: tenantId
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/{tenantId}/assign-org':
put:
tags:
- Environment
summary: Assign Organization to environment
description: >-
Endpoint to assign organization to environment
Authorized
Roles : PROVIDER
operationId: assignTenant
parameters:
- name: environmentId
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
- name: tenantId
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/password':
put:
tags:
- Agent Appliance management
summary: Update Agent environment SSH password by environment
description: >-
Endpoint to update Agent environment SSH password by
environment
Authorized Roles : PROVIDER
operationId: changeApplianceRootPassword
parameters:
- name: environmentId
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeAppliancePasswordDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/update-password':
put:
tags:
- DB Password Management
summary: Update database vm root password
description: >-
Endpoint to update database password
Authorized Roles :
PROVIDER
operationId: updateDbPassword
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DBPasswordUpdateDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/scale-db-config':
put:
tags:
- Databases
summary: Scale database
description: >-
Endpoint to scale the database instance
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: scaledbconfig
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScaleDbConfigDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/power-on':
put:
tags:
- Databases
summary: Power on database
description: >-
Endpoint to power on database
Authorized Roles : ORG_ADMIN or
ORG_USER
operationId: poweron
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/power-off':
put:
tags:
- Databases
summary: Power off database
description: >-
Endpoint to power off database
Authorized Roles : ORG_ADMIN
or ORG_USER
operationId: poweroff
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/extend-data-disk':
put:
tags:
- Databases
summary: Extend data disk for the database
description: >-
Endpoint to Extend data disk for the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: extendDbDisk
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendDbDiskDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/enable-provider-ssh':
put:
tags:
- Databases
summary: Enable ssh for provider
description: >-
Endpoint to enable ssh to provider
Authorized Roles :
PROVIDER
operationId: providerEnableDbVmSsh
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/enable-org-ssh':
put:
tags:
- Databases
summary: Enable ssh for organization
description: >-
Endpoint to enable ssh to organization
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: tenantEnableDbVmSsh
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/disable-provider-ssh':
put:
tags:
- Databases
summary: Disable ssh for provider
description: >-
Endpoint to disable ssh to provider
Authorized Roles :
PROVIDER
operationId: providerDisableDbVmSsh
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/disable-org-ssh':
put:
tags:
- Databases
summary: Disable ssh for organization
description: >-
Endpoint to disable ssh to organization
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: tenantDisableDbVmSsh
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/change-db-options':
put:
tags:
- Databases
summary: Change database options
description: >-
Endpoint to change database options
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: changeDbOptions
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DbOptionDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/{providerId}/rabbit-settings':
post:
tags:
- RabbitMQ Settings
summary: Create rabbit MQ settings
description: >-
Use this endpoint to create rabbitmq settings
Authorized
Roles : PROVIDER
operationId: saveRabbitMqSettings
parameters:
- name: providerId
in: path
description: ID of the provider
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RabbitMqSettingsDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/users:
get:
tags:
- Users
summary: Get list of DMS users
description: >-
Use this endpoint to retrieve list of all the users
Authorized
Roles : PROVIDER
operationId: getPage
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
- name: tenantId
in: query
description: ID of organization
required: false
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelDmsUserResponseDto'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Users
summary: Create user
description: 'Use this endpoint to create user
Authorized Roles : PROVIDER'
operationId: create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/userRequestDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/sync-rabbit-settings: {}
/smtp-settings:
get:
tags:
- SMTP Settings
summary: Get SMTP Settings
description: 'Endpoint for get SMTP settings
Authorized Roles : PROVIDER'
operationId: getProviderSmtpSettings
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- SMTP Settings
summary: Create SMTP Settings
description: 'Endpoint for create SMTP settings
Authorized Roles : PROVIDER'
operationId: saveProviderSmtpSettings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderSmtpSettingsDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/session/renew: {}
/session/logout: {}
/providerlogbundles/create-provider-logbundle:
post:
tags:
- Log Bundles
summary: Create Provider log bundle
description: >-
Use this endpoint to create provider logbundle
Authorized
Roles : PROVIDER
operationId: createProviderLogBundle
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/orgs:
get:
tags:
- Organization
summary: Get organizations
description: >-
Endpoint to get organizations details
Authorized Roles :
PROVIDER
operationId: getPage_4
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelTenantDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Organization
summary: Create organization
description: 'Endpoint to create organization
Authorized Roles : PROVIDER'
operationId: create_3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TenantDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/ldap-server:
get:
tags:
- LDAP Server Configuration
summary: Get LDAP server configuration
description: >-
Endpoint to get LDAP server configuration
Authorized Roles :
PROVIDER
operationId: getProviderLdapServer
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- LDAP Server Configuration
summary: Create LDAP server configuration
description: >-
Endpoint to create LDAP server configuration
Authorized Roles
: PROVIDER
operationId: saveProviderLdapServer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LdapServerDetailsDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/init-provider-backup: {}
/elasticsearch/download:
post:
tags:
- Elastic Search Log
summary: Download elastic search logs
description: >-
Use this endpoint to download elastic search logs
Authorized
Roles : PROVIDER
operationId: downloadLogsFromElkIndex
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TimestampDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/dbcluster: {}
'/databases/{uuid}/backup':
post:
tags:
- Databases
summary: Create backup of the database
description: >-
Endpoint to create backup of the database
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: create_6
parameters:
- name: uuid
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBackupDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbid}/protect':
post:
tags:
- Databases
summary: Protect the database
description: >-
Endpoint to protect the database
Authorized Roles : ORG_ADMIN
or ORG_USER
operationId: protect
parameters:
- name: dbid
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedDbBackupConfig'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUuid}/generate-log':
post:
tags:
- Databases
summary: Generate logs for the database
description: >-
Endpoint to generate database logs
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: generateDbLogs
parameters:
- name: dbUuid
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/MasterTaskResult'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/verify-alerts':
post:
tags:
- Databases
summary: Verify alerts for the database
description: >-
Endpoint to verify alerts for the database
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: updateAlertTypeAsVerified
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
- name: alertType
in: query
description: Alert type optional
required: false
schema:
type: string
enum:
- CONNECTIVITY_ALERT
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- CPU_HEALTH_ALERT
- MAX_CONNECTIONS_ALERT
- METRICS_ALERT
- NTP_SYNC_ALERT
- TELEGRAF_SERVICE_ALERT
- DATABASE_SERVICE_ALERT
- DATABASE_BIN_LOG_CLOUD_SYNC_ALERT
- DATABASE_BIN_LOG_ALERT
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/require-client-ssl-enable':
post:
tags:
- Databases
summary: Enable client SSL for the database
description: >-
Endpoint to enable client SSL for the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: enableRequireClientSsl
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/require-client-ssl-disable':
post:
tags:
- Databases
summary: Disable client SSL for the database
description: >-
Endpoint to disable client SSL for the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: disableRequireClientSsl
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/promote-read-replica':
post:
tags:
- Databases
summary: Promote repica for the database
description: >-
Endpoint to Promote repica for the database
Authorized Roles
: ORG_ADMIN or ORG_USER
operationId: promoteReadReplica
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/MasterTaskResult'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/create-read-replica':
post:
tags:
- Databases
summary: Create read repica for the database
description: >-
Endpoint to create read repica for the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: addReadReplica
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReadReplicaDto'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/MasterTaskResult'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/clone':
post:
tags:
- Databases
summary: Clone database
description: >-
Endpoint to clone database
Authorized Roles : ORG_ADMIN or
ORG_USER
operationId: submitCloneTask
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CloneDbDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/databases/restore-pitr:
post:
tags:
- Databases
summary: Point in Time Restore of the database
description: >-
Endpoint for point in Time Restore of the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: submitPITRTask
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PitrRestoreDbDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/databases/restore:
post:
tags:
- Databases
summary: Restore the database
description: >-
Endpoint to restore the database
Authorized Roles : ORG_ADMIN
or ORG_USER
operationId: submitRestoreTask
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreDbDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/databases:
get:
tags:
- Databases
summary: Get databases by environment
description: >-
Endpoint to get databases by environment
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: getPage_7_1
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
- name: tenantId
in: query
description: ID of the organization
required: false
schema:
type: string
format: uuid
- name: environmentId
in: query
description: ID of the environment
required: false
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelListViewManagedDbDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
post:
tags:
- Databases
summary: Create database
description: >-
Endpoint to create database
Authorized Roles : ORG_ADMIN or
ORG_USER
operationId: create_7
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDbDTO'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/blacklist: {}
'/backups/{backupUUID}/resync-cloud':
post:
tags:
- Backup
summary: ReSync cloud backup by id
description: >-
Use this endpoint to ReSync cloud backup by id
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: submitReSyncCloudBackupTask
parameters:
- name: backupUUID
in: path
description: ID of the backup
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/api/vcds/tenant/auth/login: {}
/agentlogbundles/create-agent-log-bundle:
post:
tags:
- Log Bundles
summary: Create agent log bundles
description: >-
Use this endpoint to create agent logbundles
Authorized Roles
: ORG_ADMIN or ORG_USER
operationId: createTenantLogBundle
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantLogBundleRequest'
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/update-db-engine':
patch:
tags:
- Databases
summary: Update DB Minor Version
description: >-
Use this to update DB to next minor version available
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: updateDbEngineRpm
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/refresh-trusted-certificates':
patch:
tags:
- Databases
summary: Refresh trusted certificate for the database
description: >-
Endpoint to refresh trusted certificate for the
database
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: resyncDbTrustedCertificates
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/refresh-server-certificate':
patch:
tags:
- Databases
summary: Refresh server certificate for the database
description: >-
Endpoint to refresh server certificate for the
database
Authorized Roles : ORG_ADMIN or ORG_USER
operationId: refreshDbCertificate
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/users/{id}/organizations':
get:
tags:
- Users
summary: Get user organizations
description: >-
Use this endpoint to retrieve all organizations of the
user
Authorized Roles : PROVIDER
operationId: getOrgsOfUser
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/users/{id}':
get:
tags:
- Users
summary: Get user detail by ID
description: >-
Use this endpoint to fetch specific user details
Authorized
Roles : PROVIDER
operationId: getUser
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Users
summary: Delete user
description: >-
Use this endpoint to delete DMS user
Authorized Roles :
PROVIDER
operationId: deleteUser
parameters:
- name: id
in: path
description: ID of the user
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/templates/{uuid}':
get:
tags:
- Templates
summary: Get template details by Id
description: >-
Use this endpoint to fetch template details by Id
Authorized
Roles : PROVIDER
operationId: getTemplate
parameters:
- name: uuid
in: path
description: ID of the template
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/templates/databasetypes:
get:
tags:
- Templates
summary: Get all available database types
description: >-
Use this endpoint to fetch all available database
types
Authorized Roles : PROVIDER
operationId: findDistinctDatabaseTypes
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: array
items:
type: string
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/templates/databasetype/{dbtype}':
get:
tags:
- Templates
summary: Get template details for the database type
description: >-
Use this endpoint to fetch template details for the database
type
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getDbTypeVersions
parameters:
- name: dbtype
in: path
description: Database Type
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: array
items:
$ref: '#/components/schemas/ProviderTemplate'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/templates:
get:
tags:
- Templates
summary: Get all template details
description: >-
Use this endpoint to fetch all template details
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getPage_1
parameters:
- name: databaseType
in: query
description: Database Type Optional
required: false
schema:
type: string
- name: environmentId
in: query
description: Environment Id Optional
required: false
schema:
type: string
format: uuid
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageProviderTemplateResponseDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/storagesettings/{stype}':
get:
tags:
- Provider Storage Settings
summary: Get Provider Storage Setting by Storage Type
description: >-
Endpoint for get provider storage settings details by storage
type
Authorized Roles : PROVIDER
operationId: getStorage
parameters:
- name: stype
in: path
description: Type of storage
required: true
schema:
type: string
enum:
- PROVIDERREPO
- PROVIDER_LOG_REPO
- PROVIDER_BACKUP_REPO
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Provider Storage Settings
summary: Delete Provider Backup Storage Setting
description: >-
Endpoint to delete Provider Backup Storage settings
Authorized
Roles : PROVIDER
operationId: deleteProviderBackupStorageSettings
parameters:
- name: stype
in: path
description: Type of storage
required: true
schema:
type: string
enum:
- PROVIDERREPO
- PROVIDER_LOG_REPO
- PROVIDER_BACKUP_REPO
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/storage-info:
get:
tags:
- Storage Information
summary: Get Storage information for the provider
description: >-
Use this endpoint to get Storage information for the
provider
Authorized Roles : PROVIDER
operationId: getProviderStorageDetails
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/status:
get:
tags:
- Provider Application Status
summary: Get Provider environment application status
description: >-
Use this endpoint to get provider environment application
status
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: generateProviderAppStatus
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/rabbit-settings: {}
'/providerlogbundles/{uuid}/generate-url':
get:
tags:
- Log Bundles
summary: Download Provider log bundles
description: >-
Use this endpoint to download provider logbundles
Authorized
Roles : PROVIDER
operationId: generateProviderPreSignedURL
parameters:
- name: uuid
in: path
description: ID of the log bundle
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/providerlogbundles/{uuid}':
get:
tags:
- Log Bundles
summary: Get Provider log bundle by ID
description: >-
Use this endpoint to get provider logbundle by id
Authorized
Roles : PROVIDER
operationId: getProviderLogBundle
parameters:
- name: uuid
in: path
description: ID of the log bundle
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/providerlogbundles:
get:
tags:
- Log Bundles
summary: Get Provider log bundles
description: >-
Use this endpoint to get provider logbundles
Authorized Roles
: PROVIDER
operationId: getProviderLogBundlePage
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelProviderLogBundleDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Log Bundles
summary: Delete Provider log bundles
description: >-
Use this endpoint to delete provider logbundles by list of
ids
Authorized Roles : PROVIDER
operationId: deleteProviderLogBundle
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
format: uuid
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/provider-backup-status/{taskId}': {}
'/orgs/{tenantUuid}/download-database-ca':
get:
tags:
- Organization
summary: Fetch Tenant's DB CA certificates
description: >-
Use this endpoint to fetch the Tenant's DB CA
certificates
Authorized Roles : ORG_ADMIN or ORG_USER
operationId: exportDbServerCertificate
parameters:
- name: tenantUuid
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/org/{uuid}/storage-info':
get:
tags:
- Storage Information
summary: Get Storage information for the organization
description: >-
Use this endpoint to get Storage information for the
organization
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getTenantStorageDetails
parameters:
- name: uuid
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/mastertasks/{uuid}':
get:
tags:
- Tasks
summary: Get task information for the task ID
description: >-
Use this endpoint to get task information for the task
ID
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getMasterTask
parameters:
- name: uuid
in: path
description: ID of the task
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/mastertasks:
get:
tags:
- Tasks
summary: Get all tasks information
description: >-
Use this endpoint to get all the tasks information or optionally by
database ID
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getPage_5
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
- name: dbUUID
in: query
description: ID of the database optional
required: false
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelMasterTaskResponseDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/init-purge-backups: {}
'/health/history/{nodeId}':
get:
tags:
- Provider External Storage
summary: Get all storage connectivity history
description: >-
Use this endpoint to get all storage connectivity
health
Authorized Roles : PROVIDER
operationId: getHealthHistory
parameters:
- name: nodeId
in: path
description: ID of the node
required: true
schema:
type: string
format: uuid
- name: alertType
in: query
description: Type of the storage
required: true
schema:
type: string
enum:
- PROVIDERREPO
- PROVIDER_LOG_REPO
- PROVIDER_DB_BACKUP_REPO
- TANZU_NET
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/health:
get:
tags:
- Provider External Storage
summary: Get all storage connectivity health
description: >-
Use this endpoint to get all storage connectivity
health
Authorized Roles : PROVIDER
operationId: getHealth
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/events/orgenvironments:
get:
tags:
- Events
summary: Get all events for the current organization
description: >-
Use this endpoint to get all events for the current
organization
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getTenantEvents
parameters:
- name: duration
in: query
description: Duration
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: TimeUnit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/events/database:
get:
tags:
- Events
summary: Get all database alerts for the organization
description: >-
Use this endpoint to get all database alerts for the
organization
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getDatabaseAlerts
parameters:
- name: tenantId
in: query
description: ID of the organization
required: false
schema:
type: string
format: uuid
- name: duration
in: query
description: Duration
required: true
schema:
type: integer
format: int32
- name: timeunit
in: query
description: TimeUnit
required: true
schema:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{uuid}/vm-password':
get:
tags:
- Environment
summary: Get Environment VM password
description: >-
Endpoint to get environments vm password
Authorized Roles :
PROVIDER
operationId: getTenantEnvVmPassword
parameters:
- name: uuid
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{uuid}/tenant':
get:
tags:
- Environment
summary: Get Organization by Environment
description: >-
Endpoint to get organization by environment
Authorized Roles
: PROVIDER or ORG_ADMIN or ORG_USER
operationId: getTenantByEnvironment
parameters:
- name: uuid
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{environmentId}/org-associations':
get:
tags:
- Environment
summary: Get Organizations associated with environment
description: >-
Endpoint to get organizations assigned to environment
Authorized
Roles : PROVIDER
operationId: getAllEnvironmentAssociatedTenants
parameters:
- name: environmentId
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{envId}': {}
'/environments/{envID}/certificates': {}
'/environments/{envID}/alerts':
get:
tags:
- Environment
summary: Get Alerts for the environment by id
description: >-
Endpoint to get alerts for the environment by id
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getAlerts
parameters:
- name: envID
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
- name: alertType
in: query
description: Type of alert
required: false
schema:
type: string
enum:
- AGENT_CONNECTIVITY
- LOCALSTORAGE
- CLOUDSTORAGE
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- VCENTER
- ONBOARDING
- MONITORING
- INFLUXDB
- TELEGRAF
- KAPACITOR
- RCLONE
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environments/{envID}':
get:
tags:
- Environment
summary: Get environment by id
description: >-
Endpoint to get environment by id
Authorized Roles : PROVIDER
or ORG_ADMIN or ORG_USER
operationId: getByEnvID
parameters:
- name: envID
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TenantEnvironmentDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/environments/search/withOrgId:
get:
tags:
- Environment
summary: Get Environment by Organization
description: >-
Endpoint to get environment by organization
Authorized Roles
: PROVIDER or ORG_ADMIN or ORG_USER
operationId: searchEnvironmentByTenantId
parameters:
- name: tenantId
in: query
description: ID of the environment
required: true
schema:
type: string
format: uuid
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/environment/{uuid}/storage-info':
get:
tags:
- Storage Information
summary: Get Storage information for the environment
description: >-
Use this endpoint to get Storage information for the
environment
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getEnvironmentStorageDetails
parameters:
- name: uuid
in: path
description: ID of the environment
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/endpoint-support-versions: {}
/elasticsearch/indices: {}
/elasticsearch/date-range:
get:
tags:
- Elastic Search Log
summary: Select date range to download elastic search logs
description: >-
Use this endpoint to select date range to download elastic search
logs
Authorized Roles : PROVIDER
operationId: getDateRange
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/TimestampDto'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{uuid}':
get:
tags:
- Databases
summary: Get databases by id
description: >-
Endpoint to get databases by id
Authorized Roles : PROVIDER
or ORG_ADMIN or ORG_USER
operationId: getDb
parameters:
- name: uuid
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUuid}/logs':
get:
tags:
- Database Logs
summary: Get logs avalilable for the database
description: >-
Use this endpoint to get all logs available for the
database
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getPage_6
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
- name: dbUuid
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PageDbLogMetadata'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/root-password':
get:
tags:
- Databases
summary: Get root password of the database
description: >-
Endpoint to get root password of the database
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getDBVmRootPassword
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/flagged-alerts':
get:
tags:
- Databases
summary: Get flagged alerts for the database
description: >-
Endpoint to get flagged alerts for the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: getFlaggedDbAlertTypes
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/download-server-cert':
get:
tags:
- Databases
summary: Fetch DB server certificate
description: >-
Use this endpoint to fetch the DB server certificates
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: exportDbServerCertificate_1
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/download-server-ca':
get:
tags:
- Databases
summary: Fetch DB CA certificate
description: >-
Use this endpoint to fetch DB CA certificate
Authorized Roles
: ORG_ADMIN or ORG_USER
operationId: exportDbCaCertificate
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+octet-stream: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/alerts':
get:
tags:
- Databases
summary: Get alerts for databse
description: >-
Endpoint to get alerts for the database
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getDatabaseAlertsHistory
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
- name: alertTypeEnum
in: query
description: Alert type optional
required: false
schema:
type: string
enum:
- CONNECTIVITY_ALERT
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- CPU_HEALTH_ALERT
- MAX_CONNECTIONS_ALERT
- METRICS_ALERT
- NTP_SYNC_ALERT
- TELEGRAF_SERVICE_ALERT
- DATABASE_SERVICE_ALERT
- DATABASE_BIN_LOG_CLOUD_SYNC_ALERT
- DATABASE_BIN_LOG_ALERT
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}/admin-password':
get:
tags:
- Databases
summary: Get admin password of the database
description: >-
Endpoint to get admin password of the database
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: getDBAdminPassword
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/version/{tenantId}':
get:
tags:
- Databases
summary: Get database version by organization
description: >-
Endpoint to get database version by organization
Authorized
Roles : ORG_ADMIN or ORG_USER
operationId: getDbVersion
parameters:
- name: tenantId
in: path
description: ID of the organization
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/logs/{logUuid}':
get:
tags:
- Database Logs
summary: Download database logs by id
description: >-
Use this endpoint to download database logs by the id
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getLogDownloadUrl
parameters:
- name: logUuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/dashboard:
get:
tags:
- Database Logs
summary: Get dashboard information
description: >-
Use this endpoint to get dashboard information
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: dashboard
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/DashboardInfo'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/backups/{uuid}':
get:
tags:
- Backup
summary: Get backups by id
description: >-
Use this endpoint to get backup by id
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getBackup
parameters:
- name: uuid
in: path
description: ID of the backup
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/backups/{backupId}/pitr/range':
get:
tags:
- Backup
summary: Get latest restorable time for database
description: >-
Endpoint to get latest restorable time for Point in time restore
operation
Authorized Roles : ORG_ADMIN or ORG_USER
operationId: getPITRAllowedRange
parameters:
- name: backupId
in: path
description: ID of the Backup
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/backups/search/{backupName}':
get:
tags:
- Backup
summary: Get backup by name
description: >-
Use this endpoint to get backup by name
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getBackupByBackupName
parameters:
- name: backupName
in: path
description: Name of the backup
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/backups:
get:
tags:
- Backup
summary: Get backups for the database
description: >-
Use this endpoint to get backups for the database
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getPage_7
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
- name: db
in: query
description: ID of the database
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelBackupDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/audit:
get:
tags:
- Audit
summary: Get all audit messages
description: >-
Use this endpoint to get all audit messages
Authorized Roles
: PROVIDER
operationId: getAuditMessages
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Audit
summary: Delete audit messages within date range
description: >-
Use this endpoint to delete all audit messages within the specified date
range
Authorized Roles : PROVIDER
operationId: deleteAuditMessages
parameters:
- name: fromTime
in: query
description: From datetime
required: true
schema:
type: string
format: date-time
- name: toTime
in: query
description: To datetime
required: true
schema:
type: string
format: date-time
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/alarms/orgenvironments:
get:
tags:
- Alarms
summary: Get environment alarms
description: >-
Use this endpoint to get all environment alarms of the current
organization
Authorized Roles : PROVIDER or ORG_ADMIN or
ORG_USER
operationId: getErrorTenantEnvironments
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/alarms/database:
get:
tags:
- Alarms
summary: Get database alarms
description: >-
Use this endpoint to get all database alarms
Authorized Roles
: PROVIDER or ORG_ADMIN or ORG_USER
operationId: getErrorDatabases
parameters:
- name: tenantId
in: query
description: ID of the organization
required: false
schema:
type: string
format: uuid
- name: alertType
in: query
description: ID of the alert type
required: false
schema:
type: string
enum:
- CONNECTIVITY_ALERT
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- CPU_HEALTH_ALERT
- MAX_CONNECTIONS_ALERT
- METRICS_ALERT
- NTP_SYNC_ALERT
- TELEGRAF_SERVICE_ALERT
- DATABASE_SERVICE_ALERT
- DATABASE_BIN_LOG_CLOUD_SYNC_ALERT
- DATABASE_BIN_LOG_ALERT
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: >-
Sorting criteria in the format: property(,asc|desc). Default sort
order is ascending. Multiple sort criteria are supported.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/alarmTypes/database:
get:
tags:
- Alarms
summary: Get database alarm types
description: >-
Use this endpoint to get all database alarm types
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: getDbAlarmTypes
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: array
items:
type: string
enum:
- CONNECTIVITY_ALERT
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- CPU_HEALTH_ALERT
- MAX_CONNECTIONS_ALERT
- METRICS_ALERT
- NTP_SYNC_ALERT
- TELEGRAF_SERVICE_ALERT
- DATABASE_SERVICE_ALERT
- DATABASE_BIN_LOG_CLOUD_SYNC_ALERT
- DATABASE_BIN_LOG_ALERT
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/agentlogbundles/{uuid}/generate-url':
get:
tags:
- Log Bundles
summary: Download agent log bundles
description: >-
Use this endpoint to download agent logbundles
Authorized
Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: generateTenantPreSignedURL
parameters:
- name: uuid
in: path
description: ID of the log bundle
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/agentlogbundles/{uuid}':
get:
tags:
- Log Bundles
summary: Get agent log bundles
description: >-
Use this endpoint to get agent logbundles
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getTenantLogBundle
parameters:
- name: uuid
in: path
description: ID of the log bundle
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/agentlogbundles:
get:
tags:
- Log Bundles
summary: Get agent log bundles
description: >-
Use this endpoint to get agent logbundles
Authorized Roles :
PROVIDER or ORG_ADMIN or ORG_USER
operationId: getTenantLogBundlePage
parameters:
- name: pageable
in: query
required: true
schema:
$ref: '#/components/schemas/Pageable'
- name: environmentid
in: query
required: false
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelTenantLogBundleDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
delete:
tags:
- Log Bundles
summary: Delete agent log bundles
description: >-
Use this endpoint to delete agent logbundles
Authorized Roles
: ORG_ADMIN or ORG_USER
operationId: deleteTenantLogBundle
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
format: uuid
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/instancetype/{id}':
delete:
tags:
- Instance Plans
summary: Delete Instance plans
description: 'Endpoint to delete instance plans
Authorized Roles : PROVIDER'
operationId: deleteInstanceType
parameters:
- name: id
in: path
description: ID of the instance plan
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/databases/{dbUUID}':
delete:
tags:
- Databases
summary: Delete database
description: >-
Endpoint to delete database
Authorized Roles : ORG_ADMIN or
ORG_USER
operationId: delete
parameters:
- name: dbUUID
in: path
description: ID of the database
required: true
schema:
type: string
format: uuid
- name: force
in: query
description: Force to delete
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/databases/logs:
delete:
tags:
- Database Logs
summary: Delete database logs by ids
description: >-
Use this endpoint to delete database logs by the list of
id
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
operationId: deleteLogFiles
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
format: uuid
required: true
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json: {}
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
'/backups/{backupUUID}':
delete:
tags:
- Backup
summary: Delete backup by id
description: >-
Use this endpoint to delete backup by id
Authorized Roles :
ORG_ADMIN or ORG_USER
operationId: delete_1
parameters:
- name: backupUUID
in: path
description: ID of the backup
required: true
schema:
type: string
format: uuid
- name: force
in: query
description: Force to delete
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
'400':
description: Bad Request
content:
'*/*':
schema:
oneOf:
- $ref: '#/components/schemas/ErrorDto'
- type: object
security:
- bearer-key: []
- orgHeader: []
/stage-apply:
post:
tags:
- Trigger Provider Update
summary: Stage and Install provider node update
description: "Use this endpoint to stage and install next immediate provider\
\ node update
Authorized Roles : PROVIDER"
operationId: stageAndApplyPatch
parameters:
- name: nodeId
in: query
description: ID of the provider node
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/taskResultDto'
security:
- bearer-key: []
- orgHeader: []
/stage:
post:
tags:
- Trigger Provider Update
summary: Stage provider node update
description: "Use this endpoint to stage next immediate provider node update
Authorized\
\ Roles : PROVIDER"
operationId: stagePatch
parameters:
- name: nodeId
in: query
description: ID of the provider node
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/taskResultDto'
security:
- bearer-key: []
- orgHeader: []
/apply:
post:
tags:
- Trigger Provider Update
summary: Install provider node update
description: "Use this endpoint to install next immediate provider node update
Authorized\
\ Roles : PROVIDER"
operationId: applyPatch
parameters:
- name: nodeId
in: query
description: ID of the provider node
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/taskResultDto'
security:
- bearer-key: []
- orgHeader: []
/version:
get:
tags:
- Trigger Provider Update
summary: Fetch Provider Node Version
description: "Use this endpoint to retrive provider node version
Authorized\
\ Roles : PROVIDER"
operationId: getProviderVersion
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
/next-update:
get:
tags:
- Available Provider Updates
summary: Fetch next provider node update
description: "Use this endpoint to retrieve next applicable update of all provider\
\ nodes
Authorized Roles : PROVIDER"
operationId: getNextProviderUpdate
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
'/history/{uuid}':
get:
tags:
- Provider Update Task History
summary: Fetch specific update task history details
description: "Use this endpoint to retrieve specific update task history details
Authorized\
\ Roles : PROVIDER"
operationId: getPatchTask
parameters:
- name: uuid
in: path
description: ID of the update task history
required: true
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
/history:
get:
tags:
- Provider Update Task History
summary: Fetch provider node update history
description: "Use this endpoint to retrieve all provider node update history
Authorized\
\ Roles : PROVIDER"
operationId: getUpdateHistory
parameters:
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
minimum: 0
type: integer
default: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
minimum: 1
type: integer
default: 20
- name: sort
in: query
description: "Sorting criteria in the format: property(,asc|desc). Default\
\ sort order is ascending. Multiple sort criteria are supported."
required: false
schema:
type: array
items:
type: string
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
$ref: '#/components/schemas/PagedModelProviderEnvironmentPatchHistoryDto'
security:
- bearer-key: []
- orgHeader: []
/future-updates:
get:
tags:
- Available Provider Updates
summary: Fetch future provider node update
description: "Use this endpoint to retrieve future updates of provider
Authorized\
\ Roles : PROVIDER"
operationId: getFutureControlPlaneUpdates
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
/compatible-agent-versions:
get:
tags:
- Trigger Provider Update
summary: Find compatible agent versions for onboarding
description: "Use this endpoint to find the min and max agent versions allowed\
\ to onbaording with the current provider sion
Authorized Roles\
\ : PROVIDER"
operationId: getCompatibleAgentVersions
responses:
"200":
description: OK
content:
application/vnd.vmware.dms-v1+json:
schema:
type: object
security:
- bearer-key: []
- orgHeader: []
components:
schemas:
ChangeAppliancePasswordDto:
required:
- newPassword
type: object
properties:
newPassword:
pattern: "^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\\\
d?!@#$%^&*]{8,20}$"
type: string
ProviderNodeDetailsDto:
type: object
properties:
nodeIp:
type: string
nodeFqdn:
type: string
RabbitmqClusterDetailsDto:
type: object
properties:
clusterNodeDetails:
$ref: '#/components/schemas/ProviderNodeDetailsDto'
erlangCookie:
type: string
EsConfigurationDto:
type: object
properties:
ip:
type: string
port:
type: integer
format: int32
indexName:
type: string
MultiNodeProviderOperationsResponseDto:
type: object
properties:
successfulNodes:
type: array
items:
type: string
format: uuid
failedNodes:
type: array
items:
type: string
format: uuid
PrimaryProviderDetailsDto:
type: object
properties:
providerCredentials:
$ref: '#/components/schemas/ProviderCredentialsDto'
providerThumbprint:
type: string
description: Thumbprint of the Primary Provider if certificate not trusted
ProviderCredentialsDto:
type: object
properties:
endpoint:
type: string
username:
type: string
password:
type: string
trustStorePath:
type: string
trustStorePassword:
type: string
KeyCertificateDto:
type: object
properties:
certificate:
type: string
privateKey:
type: string
PrimaryEnvConfigurationDto:
type: object
properties:
primaryRabbitmqDetails:
$ref: '#/components/schemas/RabbitmqClusterDetailsDto'
allRabbitNodesInCluster:
type: array
items:
$ref: '#/components/schemas/ProviderNodeDetailsDto'
allPgNodesInCluster:
type: array
items:
$ref: '#/components/schemas/ProviderPgNodeDetailsDto'
providerCertificates:
$ref: '#/components/schemas/ProviderCertificatesDto'
esConfiguration:
$ref: '#/components/schemas/EsConfigurationDto'
postgresPassword:
type: string
ProviderCertificatesDto:
type: object
properties:
providerNginxCertificate:
type: array
items:
$ref: '#/components/schemas/KeyCertificateDto'
providerRabbitMqServerCertificate:
type: array
items:
$ref: '#/components/schemas/KeyCertificateDto'
providerRabbitMqClientCertificate:
type: array
items:
$ref: '#/components/schemas/KeyCertificateDto'
providerTrustedCertificates:
type: array
items:
$ref: '#/components/schemas/KeyCertificateDto'
ProviderPgNodeDetailsDto:
type: object
properties:
nodeId:
type: string
format: uuid
ip:
type: string
pgNodeName:
type: string
repmgrNodeId:
type: integer
format: int32
role:
type: string
enum:
- STANDALONE
- PRIMARY
- SECONDARY
sshKey:
type: string
netmask:
type: string
ApplianceAuditDTO:
type: object
properties:
status:
type: string
enum:
- SUCCESS
- FAILED
description:
type: string
component:
type: string
enum:
- DB_OPERATION
- MONITORING
- AUTHENTICATION
- USER_MANAGEMENT
- DB_MANAGEMENT
- UPDATE
- PROVIDER
- PROVIDER_HA
- ELASTIC_SEARCH
- PUBLIC_SSL
- INFRASTRUCTURE
- TENANT
- DMS_RELEASE
- EXTERNAL_STORAGE
- INSTANCE_PLANS
- LOG_BUNDLE
- LDAP_SETTINGS
- SMTP_SETTINGS
- ORGANIZATIONS
- SYSTEM
operation:
type: string
enum:
- LOGIN
- LOGOUT
- PASSWORD_RECOVERY
- PASSWORD_CHANGE
- CREATE_USER
- UPDATE_USER
- DELETE_USER
- CREATE_ORG
- UPDATE_ORG
- PROVIDER_FORCE_RESET_PASSWORD
- RESET_SSO_USER_PASSWORD
- CREATE_DB
- RESTORE_DB
- PITR
- ONBOARD
- DEBOARD
- ADD_DATASTORES
- GENERATE_TENANT_LOG_BUNDLE
- NEW_DB_TEMPLATE
- CHANGE_OF_TEMPLATE_STATUS
- EULA_NOT_ACCEPTED
- CLONE_DB
- DELETE_DB
- DELETE_BACKUP
- POWER_ON_DB
- POWER_OFF_DB
- CREATE_READ_REPLICA
- REFRESH_DB_SERVER_CERT
- DB_LOG_GENERATION
- BACKUP_DB
- PROTECT_DB
- EXTEND_DB_DISK
- EXTEND_DB_DISK_BACKUP
- ENABLE_DB_VM_SSH
- DISABLE_DB_VM_SSH
- TENANT_ENABLE_DB_VM_SSH
- TENANT_DISABLE_DB_VM_SSH
- SCALE_DB_CONFIG
- ENABLE_SSL
- DISABLE_SSL
- CHANGE_DB_OPTIONS
- PROMOTE_REPLICA
- PROVIDER_UPDATE
- AGENT_UPDATE
- DB_UPDATE
- PROVIDER_BACKUP
- PROVIDER_RESTORE
- REGISTER_CLUSTER
- PROVIDER_FAILOVER
- DELETE_STANDBY_FROM_PRIMARY
- REGISTER_PRIMARY
- CONFIGURE_ES
- PUBLIC_SSL_CHANGE_CERT
- ASSIGN_ORG
- UNASSIGN_ORG
- DB_TRUSTED_CERT_SYNC
- UPDATE_DB_PASSWORD
- DMS_LOAD_RELEASES
- CREATE_EXTERNAL_STORAGE
- UPDATE_EXTERNAL_STORAGE
- REMOVE_EXTERNAL_STORAGE
- PROVIDER_LOG_BUNDLE
- AGENT_LOG_BUNDLE
- RABBIT_SETTINGS_CHANGE
- DB_ENGINE_UPDATE
- CREATE_INSTANCE_PLAN
- UPDATE_INSTANCE_PLAN
- DELETE_INSTANCE_PLAN
- CREATE_LDAP_SETTINGS
- UPDATE_LDAP_SETTINGS
- CREATE_SMTP_SETTINGS
- UPDATE_SMTP_SETTINGS
- PURGE_AUDIT
ProviderEnvironmentsConfigDto:
type: object
properties:
pgNodeDetailsDto:
type: array
items:
$ref: '#/components/schemas/ProviderPgNodeDetailsDto'
rabbitNodeDetails:
type: array
items:
$ref: '#/components/schemas/ProviderNodeDetailsDto'
PackageLogDto:
type: object
properties:
packageName:
type: string
logLevel:
type: string
enum:
- "OFF"
- ERROR
- WARN
- INFO
- DEBUG
- TRACE
ServiceLogConfigDto:
type: object
properties:
packageLogLevels:
type: array
items:
$ref: '#/components/schemas/PackageLogDto'
service:
type: string
enum:
- APMS
- PROVIDER
- MONITORING
- UPDATE
ProviderFqdnDto:
type: object
properties:
providerMgmtFqdn:
type: string
providerRabbitFqdn:
type: string
ServiceStatusDTO:
type: object
properties:
postgres:
type: string
rabbitMQ:
type: string
provider:
type: string
monitoring:
type: string
apms:
type: string
updateManager:
type: string
Pageable:
type: object
properties:
page:
minimum: 0
type: integer
format: int32
size:
minimum: 1
type: integer
format: int32
sort:
type: array
items:
type: string
PageProviderEnvironmentHealth:
type: object
properties:
totalPages:
type: integer
format: int32
totalElements:
type: integer
format: int64
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
last:
type: boolean
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/ProviderEnvironmentHealth'
number:
type: integer
format: int32
empty:
type: boolean
ProviderEnvironmentHealth:
type: object
properties:
id:
type: string
format: uuid
nodeId:
type: string
format: uuid
status:
type: string
enum:
- UP
- DOWN
createdTime:
type: string
format: date-time
Sort:
type: object
properties:
sorted:
type: boolean
unsorted:
type: boolean
empty:
type: boolean
EndpointVersionMappingResponse:
type: object
properties:
endpointVersionMapping:
type: object
additionalProperties:
type: array
items:
type: string
BaseTdmErrorCodes:
required:
- type
type: object
properties:
type:
type: string
discriminator:
propertyName: type
ErrorDto:
type: object
properties:
message:
type: string
errorCodes:
$ref: '#/components/schemas/BaseTdmErrorCodes'
AuthDTO:
type: object
properties:
email:
type: string
password:
type: string
OrgMemberShip:
type: object
properties:
orgId:
type: string
format: uuid
companyName:
type: string
email:
type: string
userRoles:
type: array
writeOnly: true
items:
type: string
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
roles:
type: array
items:
type: string
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
UserSessionInfo:
type: object
properties:
firstName:
type: string
lastName:
type: string
contactNumber:
type: string
email:
type: string
type:
type: string
enum:
- TDM
- LDAP
orgMemberships:
type: array
items:
$ref: '#/components/schemas/OrgMemberShip'
ExceptionResponse:
type: object
properties:
timestamp:
type: string
format: date-time
message:
type: string
details:
type: string
uri:
type: string
InfraMetricsDTO:
type: object
properties:
metricKey:
type: string
time:
type: string
format: date-time
value:
type: number
format: double
PageInfraMetricsDTO:
type: object
properties:
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/InfraMetricsDTO'
number:
type: integer
format: int32
last:
type: boolean
numberOfElements:
type: integer
format: int32
empty:
type: boolean
PageVMUsageDTO:
type: object
properties:
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/VMUsageDTO'
number:
type: integer
format: int32
last:
type: boolean
numberOfElements:
type: integer
format: int32
empty:
type: boolean
VMUsageDTO:
type: object
properties:
instanceName:
type: string
dbUUID:
type: string
format: uuid
usage:
type: number
time:
type: string
format: date-time
PageTenantPostgresMonitoringMetricDTO:
type: object
properties:
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/TenantPostgresMonitoringMetricDTO'
number:
type: integer
format: int32
last:
type: boolean
numberOfElements:
type: integer
format: int32
empty:
type: boolean
TenantPostgresMonitoringMetricDTO:
type: object
properties:
environmentId:
type: string
format: uuid
metricKey:
type: string
metricValue:
type: string
hostName:
type: string
time:
type: string
format: date-time
MonitoringMetricDTO:
type: object
properties:
tenantId:
type: string
format: uuid
environmentId:
type: string
format: uuid
dbUUID:
type: string
format: uuid
metricKey:
type: string
metricValue:
type: string
time:
type: string
format: date-time
PageMonitoringMetricDTO:
type: object
properties:
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/MonitoringMetricDTO'
number:
type: integer
format: int32
last:
type: boolean
numberOfElements:
type: integer
format: int32
empty:
type: boolean
tdmUserUpdateDTO:
required:
- roles
type: object
properties:
contactNumber:
maxLength: 30
minLength: 0
type: string
tenantId:
type: string
format: uuid
roles:
uniqueItems: true
type: array
description: Valid values are - TENANT_ADMIN and/or TENANT_USER
items:
type: string
description: Valid values are - TENANT_ADMIN and/or TENANT_USER
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
description: Data object of user details which can be updated
resetPasswordDTO:
required:
- newPassword
type: object
properties:
newPassword:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
description: >-
Password Rule - Minimum 8 and Maximum 20 characters, at least one
uppercase letter, one lowercase letter, one number and one special
character(?!@#$%^&*)
description: Data object for updating user password
changePasswordDTO:
required:
- currentPassword
- newPassword
type: object
properties:
currentPassword:
type: string
newPassword:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
description: >-
Password Rule - Minimum 8 and Maximum 20 characters, at least one
uppercase letter, one lowercase letter, one number and one special
character(?!@#$%^&*)
description: Data object for changing loggedin user password
AdapterRpm:
type: object
properties:
name:
type: string
version:
type: string
path:
type: string
sha256:
type: string
nextVersion:
type: string
monitoringKeys:
type: array
items:
$ref: '#/components/schemas/MonitoringKey'
BaseRpmDto:
type: object
properties:
name:
type: string
version:
type: string
path:
type: string
sha256:
type: string
nextVersion:
type: string
CPUSettings:
type: object
properties:
min:
type: integer
format: int32
max:
type: integer
format: int32
defaultCPU:
type: integer
format: int32
DBEngineRpm:
type: object
properties:
name:
type: string
version:
type: string
path:
type: string
sha256:
type: string
nextVersion:
type: string
dbVersion:
type: string
DbOption:
type: object
properties:
key:
type: string
value:
type: string
type:
type: string
enum:
- STATIC
- DYNAMIC
url:
type: string
DiskSettings:
type: object
properties:
min:
type: integer
format: int32
max:
type: integer
format: int32
defaultDisk:
type: integer
format: int32
unit:
type: string
MemorySettings:
type: object
properties:
min:
type: integer
format: int32
max:
type: integer
format: int32
defaultMemory:
type: integer
format: int32
unit:
type: string
MonitoringKey:
required:
- description
- key
- query
- type
type: object
properties:
key:
type: string
query:
type: string
type:
type: string
description:
type: string
ProviderTemplate:
type: object
properties:
logicalBuildId:
type: string
format: uuid
version:
type: string
databaseType:
type: string
latestShellOvaVersion:
type: string
latestCoreRpmVersion:
type: string
latestAdapterRpmVersion:
type: string
latestDbengineRpmVersion:
type: string
shellOvaUpdates:
type: object
additionalProperties:
$ref: '#/components/schemas/ShellOva'
coreRpmUpdates:
type: object
additionalProperties:
$ref: '#/components/schemas/BaseRpmDto'
adapterRpmUpdates:
type: object
additionalProperties:
$ref: '#/components/schemas/AdapterRpm'
dbEngineRpmUpdates:
type: object
additionalProperties:
$ref: '#/components/schemas/DBEngineRpm'
systemDefaults:
$ref: '#/components/schemas/SystemDefaults'
dbOptions:
type: array
items:
$ref: '#/components/schemas/DbOption'
deleted:
type: boolean
providerStatus:
type: string
enum:
- PUBLISHED
- UNPUBLISHED
- RETIRED
- REQUESTED
- INPROGRESS
- FAILED
- AVAILABLE
- NOT_AVAILABLE
lastProcessedTime:
type: string
format: date-time
maxReadReplica:
type: integer
format: int32
ShellOva:
type: object
properties:
version:
type: string
path:
type: string
updateRepoPath:
type: string
updateRepoSha256:
type: string
ovaSha256:
type: string
nextVersion:
type: string
restart:
type: boolean
SystemDefaults:
type: object
properties:
cpu:
$ref: '#/components/schemas/CPUSettings'
memory:
$ref: '#/components/schemas/MemorySettings'
disk:
$ref: '#/components/schemas/DiskSettings'
Link:
type: object
properties:
rel:
type: string
href:
type: string
hreflang:
type: string
media:
type: string
title:
type: string
type:
type: string
deprecation:
type: string
profile:
type: string
name:
type: string
TanzuNetStorageSettingsDTO:
type: object
properties:
refreshToken:
type: string
links:
type: array
items:
$ref: '#/components/schemas/Link'
TanzuNetStorageSettings:
type: object
properties:
storageType:
type: string
enum:
- TANZU_NET_REFRESH_TOKEN
refreshToken:
type: string
ProviderStorageSettingsDTO:
type: object
properties:
storageType:
type: string
url:
type: string
accessKey:
type: string
secretKey:
type: string
bucket:
type: string
region:
type: string
thumbprint:
type: string
links:
type: array
items:
$ref: '#/components/schemas/Link'
ProviderSmtpSettingsDto:
required:
- senderEmail
- smtpHost
- smtpPort
type: object
properties:
senderEmail:
type: string
smtpHost:
type: string
smtpPort:
type: integer
format: int32
username:
type: string
password:
type: string
authEnabled:
type: boolean
autoTls:
type: boolean
thumbprint:
type: string
UserPasswordResetDTO:
required:
- email
- newPassword
- token
type: object
properties:
email:
type: string
token:
type: string
newPassword:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
LdapOrgDetailsDto:
type: object
properties:
id:
type: string
format: uuid
ldapServerDetailsId:
type: string
format: uuid
ldapType:
type: string
enum:
- PROVIDER_MANAGED
- TENANT_MANAGED
ldapServerDetails:
$ref: '#/components/schemas/LdapServerDetailsDto'
adminGroups:
type: array
items:
type: string
userGroups:
type: array
items:
type: string
providerGroups:
type: array
items:
type: string
deleted:
type: boolean
createdTimestamp:
type: string
format: date-time
LdapServerDetailsDto:
required:
- domain
- hostAddress
type: object
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- PROVIDER_MANAGED
- TENANT_MANAGED
hostAddress:
type: string
port:
type: integer
format: int32
firstNameAttribute:
type: string
lastNameAttribute:
type: string
domain:
type: string
baseDn:
type: string
searchFilter:
type: string
loginAttribute:
type: string
thumbprint:
type: string
deleted:
type: boolean
userName:
type: string
password:
type: string
sslEnabled:
type: boolean
sslCert:
$ref: '#/components/schemas/SslCertificateStoreDTO'
createdTimestamp:
type: string
format: date-time
SslCertificateStoreDTO:
type: object
properties:
privateKey:
type: string
certificate:
type: string
parentCert:
type: string
TenantDTO:
type: object
properties:
id:
type: string
format: uuid
companyName:
maxLength: 255
minLength: 1
type: string
email:
type: string
instanceMode:
type: string
enum:
- FREE_MODE
- PLANS_MODE
deleted:
type: boolean
orgType:
type: string
enum:
- PROVIDER_ORG
- TENANT_ORG
ldapOrgDetails:
$ref: '#/components/schemas/LdapOrgDetailsDto'
links:
type: array
items:
$ref: '#/components/schemas/Link'
InstanceTypeDTO:
required:
- cpu
- memory
- name
type: object
properties:
id:
type: string
format: uuid
name:
type: string
cpu:
maximum: 256
minimum: 2
type: integer
format: int32
memory:
maximum: 256
minimum: 2
type: integer
format: int32
deleted:
type: boolean
CloudStorage:
required:
- accessKey
- bucket
- endpoint
- secretKey
- thumbprint
type: object
properties:
endpoint:
type: string
bucket:
type: string
region:
type: string
accessKey:
type: string
secretKey:
type: string
thumbprint:
type: string
DatastoreMorNameKeyPair:
required:
- datastoreName
- mor
type: object
properties:
mor:
type: string
datastoreName:
type: string
default:
type: boolean
Endpoint:
type: object
properties:
endpoint:
type: string
port:
type: integer
format: int32
LocalStorage:
required:
- accessKey
- bucket
- endpoint
- secretKey
- thumbprint
type: object
properties:
endpoint:
type: string
bucket:
type: string
region:
type: string
accessKey:
type: string
secretKey:
type: string
thumbprint:
type: string
ProviderRabbitMqSettingsDto:
type: object
properties:
rabbitEndpoints:
type: array
items:
$ref: '#/components/schemas/Endpoint'
username:
type: string
password:
type: string
TenantEnvRuntimeInfoDTO:
type: object
properties:
environmentId:
type: string
format: uuid
alertType:
type: string
enum:
- AGENT_CONNECTIVITY
- LOCALSTORAGE
- CLOUDSTORAGE
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- VCENTER
- ONBOARDING
- MONITORING
- INFLUXDB
- TELEGRAF
- KAPACITOR
- RCLONE
alertStatus:
type: string
enum:
- CRITICAL
- WARNING
- OK
- UNKNOWN
alertTime:
type: string
format: date-time
environmentName:
type: string
TenantEnvironmentDTO:
required:
- cloudStorage
- dbFqdnSuffix
- lcpNetwork
- localStorage
- providerIpAddress
- tenantId
- vcCluster
- vcDatacenter
- vcIpAddress
- vcNetwork
- vcSsoPassword
- vcSsoUsername
- vcVMFolder
- vcVmDatastores
type: object
properties:
environmentId:
type: string
format: uuid
tenantId:
type: string
format: uuid
vcInstanceUuid:
type: string
format: uuid
vcIpAddress:
type: string
pscFqdn:
type: string
vcThumbprint:
type: string
pscThumbprint:
type: string
vcDatacenter:
$ref: '#/components/schemas/VcManagedObject'
vcVMFolder:
$ref: '#/components/schemas/VcManagedObject'
cloudStorage:
$ref: '#/components/schemas/CloudStorage'
localStorage:
$ref: '#/components/schemas/LocalStorage'
vcCluster:
$ref: '#/components/schemas/VcManagedObject'
vcVmDatastores:
$ref: '#/components/schemas/VcDatastores'
vcNetwork:
$ref: '#/components/schemas/VcManagedObject'
lcpNetwork:
$ref: '#/components/schemas/VcManagedObject'
vcSsoUsername:
type: string
vcSolutionUsername:
type: string
vcSsoPassword:
type: string
tenantNtp:
type: string
dbFqdnSuffix:
type: string
tenantIpAddress:
type: string
providerIpAddress:
type: string
state:
type: string
enum:
- ACTIVE_MODE
- MAINTENANCE_INIT_MODE
- MAINTENANCE_ACTIVATED_MODE
providerRabbitSettings:
$ref: '#/components/schemas/ProviderRabbitMqSettingsDto'
runtimeInfo:
type: array
items:
$ref: '#/components/schemas/TenantEnvRuntimeInfoDTO'
status:
type: string
enum:
- INIT
- ONLINE
- MAINTENANCE_MODE
- DEGRADED
- WARNING
version:
type: string
vmRootPassword:
type: string
links:
type: array
items:
$ref: '#/components/schemas/Link'
VcDatastores:
type: object
properties:
list:
type: array
items:
$ref: '#/components/schemas/DatastoreMorNameKeyPair'
VcManagedObject:
type: object
properties:
id:
type: string
format: uuid
moId:
type: string
name:
type: string
DBPasswordUpdateDto:
type: object
properties:
dbPassword:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
ScaleDbConfigDto:
type: object
properties:
instanceTypeId:
type: string
format: uuid
cpu:
type: integer
format: int32
memory:
type: integer
format: int32
ExtendDbDiskDTO:
required:
- isBackUpRequired
- sizeInGB
type: object
properties:
sizeInGB:
type: integer
format: int32
isBackUpRequired:
type: boolean
DbOptionDTO:
type: object
properties:
key:
type: string
value:
type: string
RabbitMqSettingsDto:
type: object
properties:
endpoint:
type: string
port:
type: integer
format: int32
userRequestDto:
required:
- email
- firstName
- lastName
- password
- roles
- tenantId
type: object
properties:
firstName:
type: string
lastName:
type: string
contactNumber:
maxLength: 30
minLength: 0
type: string
email:
type: string
password:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
tenantId:
type: string
format: uuid
roles:
uniqueItems: true
type: array
description: Valid values are PROVIDER or (TENANT_ADMIN and/or TENANT_USER)
items:
type: string
description: Valid values are PROVIDER or (TENANT_ADMIN and/or TENANT_USER)
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
description: Data object for an user creation request
PasswordRecoveryRequestDTO:
type: object
properties:
registeredEmail:
type: string
CreateInstanceTypeDTO:
required:
- cpu
- memory
- name
type: object
properties:
name:
type: string
cpu:
maximum: 256
minimum: 2
type: integer
format: int32
memory:
maximum: 256
minimum: 2
type: integer
format: int32
ProviderBackupTaskResponseDTO:
type: object
properties:
taskId:
type: string
format: uuid
backupEnable:
type: boolean
TimestampDto:
type: object
properties:
fromDate:
type: string
toDate:
type: string
CreateDbDTO:
required:
- dataStoreName
- dbConfig
- environmentId
- instanceName
- provisioningConfig
- templateId
type: object
properties:
environmentId:
type: string
format: uuid
templateId:
type: string
format: uuid
instanceName:
type: string
dataStoreName:
type: string
dbConfig:
$ref: '#/components/schemas/DbInstanceConfigDTO'
dbBackupConfig:
$ref: '#/components/schemas/DbInstanceBackupConfigDTO'
dbMaintenanceConfig:
$ref: '#/components/schemas/DbInstanceMaintenanceConfigDTO'
enableProtection:
type: boolean
requireClientSsl:
type: boolean
dbOptions:
type: array
items:
$ref: '#/components/schemas/DbOptionDTO'
provisioningConfig:
oneOf:
- $ref: '#/components/schemas/GpDbClusterConfig'
- $ref: '#/components/schemas/ReadReplicaConfig'
- $ref: '#/components/schemas/SingleNodeDbConfig'
DbClusterMasterConfig:
required:
- hwConfig
type: object
properties:
hwConfig:
$ref: '#/components/schemas/DbHardwareConfigDTO'
DbHardwareConfigDTO:
type: object
properties:
hdDiskSizeGB:
maximum: 65535
minimum: 2
type: integer
format: int32
cpuCores:
type: integer
format: int32
memoryGB:
type: integer
format: int32
instancePlanId:
type: string
format: uuid
thinDisk:
type: boolean
DbInstanceBackupConfigDTO:
required:
- automatedBackupStartTime
- numLocalBackupDays
type: object
properties:
numLocalBackupDays:
maximum: 30
minimum: 1
type: integer
format: int64
numRemoteBackupDays:
type: integer
format: int64
automatedBackupStartTime:
pattern: ([01]?[0-9]|2[0-3]):[0-5][0-9]
type: string
DbInstanceConfigDTO:
required:
- adminPassword
- adminUser
- dbName
- monitoringType
type: object
properties:
dbName:
type: string
port:
maximum: 65535
minimum: 1024
type: integer
format: int32
adminUser:
type: string
adminPassword:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
replicationUser:
type: string
replicationPassword:
type: string
rootPassword:
type: string
monitoringType:
type: string
enum:
- NORMAL
- ENHANCED
DbInstanceMaintenanceConfigDTO:
type: object
properties:
maintenanceWindowStartDay:
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
maintenanceWindowStartTime:
pattern: ([01]?[0-9]|2[0-3]):[0-5][0-9]
type: string
maintenanceWindowDuration:
type: string
minorVersionUpgradeEnabled:
type: boolean
maintenanceWindowSelected:
type: boolean
GpDbClusterConfig:
required:
- master
- segment
type: object
allOf:
- $ref: '#/components/schemas/ProvisioningConfig'
- type: object
properties:
master:
$ref: '#/components/schemas/DbClusterMasterConfig'
segment:
$ref: '#/components/schemas/GpSegmentConfig'
GpSegmentConfig:
required:
- hwConfig
type: object
properties:
hwConfig:
$ref: '#/components/schemas/DbHardwareConfigDTO'
primarySegmentsCount:
type: integer
format: int32
ProvisioningConfig:
required:
- type
type: object
properties:
type:
type: string
discriminator:
propertyName: type
ReadReplicaConfig:
type: object
allOf:
- $ref: '#/components/schemas/ProvisioningConfig'
SingleNodeDbConfig:
required:
- hwConfig
type: object
allOf:
- $ref: '#/components/schemas/ProvisioningConfig'
- type: object
properties:
hwConfig:
$ref: '#/components/schemas/DbHardwareConfigDTO'
CreateBackupDTO:
required:
- backupName
type: object
properties:
backupName:
type: string
automated:
type: boolean
ManagedDbBackupConfig:
required:
- automatedBackupStartTime
- numLocalBackupDays
- numRemoteBackupDays
type: object
properties:
id:
type: string
format: uuid
numLocalBackupDays:
maximum: 30
minimum: 1
type: integer
format: int64
numRemoteBackupDays:
type: integer
format: int64
automatedBackupStartTime:
pattern: ([01]?[0-9]|2[0-3]):[0-5][0-9]
type: string
MasterTaskResult:
type: object
properties:
task_id:
type: string
format: uuid
CreateReadReplicaDto:
required:
- dataStoreName
- instanceName
type: object
properties:
instanceName:
type: string
dataStoreName:
type: string
CloneDbDTO:
required:
- dataStoreName
- instanceName
type: object
properties:
instanceName:
type: string
dataStoreName:
type: string
dbBackupConfig:
$ref: '#/components/schemas/DbInstanceBackupConfigDTO'
dbMaintenanceConfig:
$ref: '#/components/schemas/DbInstanceMaintenanceConfigDTO'
enableProtection:
type: boolean
requireClientSsl:
type: boolean
PitrRestoreDbDTO:
required:
- dataStoreName
- instanceName
- protectionId
- restoreTimeStamp
type: object
properties:
instanceName:
type: string
environmentId:
type: string
format: uuid
dbaasPortGroupMor:
type: string
dataStoreName:
type: string
enableProtection:
type: boolean
dbBackupConfig:
$ref: '#/components/schemas/DbInstanceBackupConfigDTO'
dbMaintenanceConfig:
$ref: '#/components/schemas/DbInstanceMaintenanceConfigDTO'
requireClientSsl:
type: boolean
protectionId:
type: string
format: uuid
restoreTimeStamp:
type: string
format: date-time
RestoreDbDTO:
required:
- backupId
- dataStoreName
- instanceName
type: object
properties:
instanceName:
type: string
environmentId:
type: string
format: uuid
dbaasPortGroupMor:
type: string
dataStoreName:
type: string
enableProtection:
type: boolean
dbBackupConfig:
$ref: '#/components/schemas/DbInstanceBackupConfigDTO'
dbMaintenanceConfig:
$ref: '#/components/schemas/DbInstanceMaintenanceConfigDTO'
requireClientSsl:
type: boolean
backupId:
type: string
format: uuid
TokenBlacklistDto:
type: object
properties:
token:
type: string
TdmUserDTO:
required:
- email
- firstName
- lastName
- password
- roles
type: object
properties:
id:
type: integer
format: int32
firstName:
type: string
lastName:
type: string
contactNumber:
type: string
email:
type: string
password:
pattern: >-
^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[?!@#$%^&*])[A-Za-z\d?!@#$%^&*]{8,20}$
type: string
tenantId:
type: string
format: uuid
companyName:
type: string
type:
type: string
enum:
- TDM
- LDAP
roles:
uniqueItems: true
type: array
items:
type: string
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
forcePasswordChange:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/Link'
TenantLogBundleRequest:
required:
- environmentId
- tenant
type: object
properties:
environmentId:
type: string
format: uuid
tenant:
type: boolean
dbvms:
type: array
items:
type: string
format: uuid
PageMetadataDmsUserResponseDto:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelDmsUserResponseDto:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/dmsUserResponseDto'
page:
$ref: '#/components/schemas/PageMetadataDmsUserResponseDto'
dmsUserResponseDto:
type: object
properties:
id:
type: integer
format: int32
firstName:
type: string
lastName:
type: string
contactNumber:
type: string
email:
type: string
tenantId:
type: string
format: uuid
companyName:
type: string
roles:
uniqueItems: true
type: array
items:
type: string
enum:
- ORG_ADMIN
- ORG_USER
- PROVIDER
type:
type: string
enum:
- TDM
- LDAP
links:
type: array
items:
$ref: '#/components/schemas/Link'
description: Data object for newly created/modified user
PageProviderTemplateResponseDTO:
type: object
properties:
totalPages:
type: integer
format: int32
totalElements:
type: integer
format: int64
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/ProviderTemplateResponseDTO'
number:
type: integer
format: int32
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
last:
type: boolean
empty:
type: boolean
ProviderTemplateResponseDTO:
type: object
properties:
logicalBuildId:
type: string
format: uuid
serviceType:
type: string
version:
type: string
deployedInstances:
type: integer
format: int64
status:
type: string
enum:
- PUBLISHED
- UNPUBLISHED
- RETIRED
- REQUESTED
- INPROGRESS
- FAILED
- AVAILABLE
- NOT_AVAILABLE
systemDefaults:
$ref: '#/components/schemas/SystemDefaults'
dbOptions:
type: array
items:
$ref: '#/components/schemas/DbOption'
PageTanzuNetStorageSettings:
type: object
properties:
totalPages:
type: integer
format: int32
totalElements:
type: integer
format: int64
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/TanzuNetStorageSettings'
number:
type: integer
format: int32
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
last:
type: boolean
empty:
type: boolean
PageMetadataProviderStorageSettingsDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelProviderStorageSettingsDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/ProviderStorageSettingsDTO'
page:
$ref: '#/components/schemas/PageMetadataProviderStorageSettingsDTO'
PageMetadataProviderLogBundleDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelProviderLogBundleDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/ProviderLogBundleDTO'
page:
$ref: '#/components/schemas/PageMetadataProviderLogBundleDTO'
ProviderLogBundleDTO:
required:
- createdTime
- id
- isLogDownloaded
- logBundlePath
type: object
properties:
id:
type: string
format: uuid
createdTime:
type: string
format: date-time
logBundlePath:
type: string
isLogDownloaded:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/Link'
ProviderBackupTaskEntity:
required:
- source
- status
type: object
properties:
taskId:
type: string
format: uuid
backupStartTime:
type: string
format: date-time
backupEndTime:
type: string
format: date-time
source:
type: string
enum:
- SCHEDULED
- MANUAL
- UPDATE
status:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- TENANT_TASK_QUEUED
- SUCCESS
- COMMUNICATION_LOST
- FAILED
PageMetadataTenantDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelTenantDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/TenantDTO'
page:
$ref: '#/components/schemas/PageMetadataTenantDTO'
FsmHistoryPointDTO:
type: object
properties:
state:
type: string
createdTimestamp:
type: string
format: date-time
ManagedObjectRefDto:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
MasterTaskResponseDTO:
type: object
properties:
id:
type: string
format: uuid
taskType:
type: string
enum:
- CREATE_DB
- RESTORE_DB
- DELETE_DB
- EXTEND_DB_DISK
- SCALE_DB_CONFIG
- CLONE_DB
- DELETE_BACKUP
- BACKUP_DB
- RE_SYNC_CLOUD_BACKUP
- POWER_ON
- POWER_OFF
- PROTECT_DB
- DB_CLIENT_SSL_ENABLE
- DB_CLIENT_SSL_DISABLE
- DB_SERVER_CERT_REFRESH
- DB_TRUSTED_CERT_SYNC
- PITR_RESTORE_DB
- CREATE_READ_REPLICA
- PROMOTE_READ_REPLICA
- LOG_BUNDLE
- DB_LOG_GENERATION
- ENABLE_DB_VM_SSH
- DISABLE_DB_VM_SSH
- CHANGE_DB_OPTIONS
- TENANT_APPLIANCE_MGMT
- DB_ENGINE_UPDATE
- UPDATE_DB_PASSWORD
userName:
type: string
createdTimestamp:
type: string
format: date-time
stateHistory:
type: array
items:
$ref: '#/components/schemas/FsmHistoryPointDTO'
infrastructureDetails:
$ref: '#/components/schemas/ManagedObjectRefDto'
dbDetails:
$ref: '#/components/schemas/ManagedObjectRefDto'
status:
type: string
enum:
- NOT_STARTED
- IN_PROGRESS
- TENANT_TASK_QUEUED
- SUCCESS
- COMMUNICATION_LOST
- FAILED
percent:
type: integer
format: int32
links:
type: array
items:
$ref: '#/components/schemas/Link'
PageMetadataMasterTaskResponseDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelMasterTaskResponseDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/MasterTaskResponseDTO'
page:
$ref: '#/components/schemas/PageMetadataMasterTaskResponseDTO'
BackupChainDTO:
type: object
properties:
id:
type: string
format: uuid
backupInstances:
type: array
items:
$ref: '#/components/schemas/BackupInstanceDTO'
status:
type: string
enum:
- ACTIVE
- INACTIVE
creationTime:
type: string
format: date-time
BackupInstanceDTO:
type: object
properties:
id:
type: string
format: uuid
sequenceNum:
type: integer
format: int32
metaData:
type: string
metaDataType:
type: string
s3Path:
type: string
name:
type: string
creationTime:
type: string
format: date-time
instanceType:
type: string
enum:
- FULL
- INCREMENTAL
localStatus:
type: string
enum:
- NOT_STARTED
- INITIATED
- IN_PROGRESS
- COMPLETED
- FAILED
cloudStatus:
type: string
enum:
- NOT_STARTED
- INITIATED
- IN_PROGRESS
- COMPLETED
- FAILED
localAvailable:
type: boolean
cloudAvailable:
type: boolean
automated:
type: boolean
ManagedDbHwConfigDTO:
type: object
properties:
hdDiskSizeGB:
type: integer
format: int32
cpuCores:
type: integer
format: int32
memoryGB:
type: integer
format: int32
thinDisk:
type: boolean
ManagedDbInstanceConfigDTO:
type: object
properties:
port:
type: integer
format: int32
rootUser:
type: string
rootPassword:
type: string
adminUser:
type: string
adminPassword:
type: string
dbName:
type: string
monitoringType:
type: string
enum:
- NORMAL
- ENHANCED
ManagedDbMaintenanceConfigDTO:
type: object
properties:
id:
type: string
format: uuid
maintenanceWindowStartDay:
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
maintenanceWindowStartTime:
type: string
maintenanceWindowDuration:
type: integer
format: int32
minorVersionUpgradeEnabled:
type: boolean
maintenanceWindowSelected:
type: boolean
ManagedDbRuntimeInfoDomainDTO:
type: object
properties:
id:
type: string
format: uuid
alertTypeEnum:
type: string
enum:
- CONNECTIVITY_ALERT
- DATA_DISK_HEALTH_ALERT
- SYSTEM_DISK_HEALTH_ALERT
- CPU_HEALTH_ALERT
- MAX_CONNECTIONS_ALERT
- METRICS_ALERT
- NTP_SYNC_ALERT
- TELEGRAF_SERVICE_ALERT
- DATABASE_SERVICE_ALERT
- DATABASE_BIN_LOG_CLOUD_SYNC_ALERT
- DATABASE_BIN_LOG_ALERT
alertLevel:
type: string
enum:
- CRITICAL
- WARNING
- OK
- UNKNOWN
updatedTimestamp:
type: string
format: date-time
ProtectionDTO:
type: object
properties:
id:
type: string
format: uuid
localRetentionDays:
type: integer
format: int64
cloudRetentionDays:
type: integer
format: int64
active:
type: boolean
scheduledCronEntry:
type: string
s3Path:
type: string
protectionStatus:
type: string
enum:
- INITIATED
- COMPLETED
- FAILED
backupChains:
type: array
items:
$ref: '#/components/schemas/BackupChainDTO'
TenantDbClusterDTO:
type: object
properties:
id:
type: string
format: uuid
dbClusterType:
type: string
enum:
- SINGLE_NODE
- GP_CLUSTER
- READ_REPLICA
deleted:
type: boolean
status:
type: string
enum:
- ONLINE
- ERROR
- DEGRADED
- CRITICAL
- INIT
- DELETED
- CONTROL_PLANE_UPDATE_IN_PROGRESS
- DB_ENGINE_UPDATE_IN_PROGRESS
- OS_UPDATE_IN_PROGRESS
protectionDTO:
$ref: '#/components/schemas/ProtectionDTO'
TenantManagedDbDTO:
type: object
properties:
id:
type: string
format: uuid
instanceName:
type: string
logicalBuildId:
type: string
format: uuid
physicalBuildId:
type: string
format: uuid
status:
type: string
enum:
- ONLINE
- ERROR
- LOST_CONNECTIVITY
- WARNING
- FATAL
- CRITICAL
- INIT
- DELETED
- POWEREDOFF
- POWEREDON
- CONTROL_PLANE_UPDATE_IN_PROGRESS
- CONTROL_PLANE_UPDATE_FAILED
- DB_ENGINE_UPDATE_IN_PROGRESS
- DB_ENGINE_UPDATE_FAILED
- OS_UPDATE_IN_PROGRESS
- OS_UPDATE_FAILED
- DELETING
- MODIFYING
- BACKUP_IN_PROGRESS
fqdn:
type: string
ip:
type: string
dbMgmtIp:
type: string
vmId:
type: string
deleted:
type: boolean
createdTimestamp:
type: string
format: date-time
datastoreId:
type: string
dbInstanceConfig:
$ref: '#/components/schemas/ManagedDbInstanceConfigDTO'
hwConfig:
$ref: '#/components/schemas/ManagedDbHwConfigDTO'
managedDbMaintenanceConfigDTO:
$ref: '#/components/schemas/ManagedDbMaintenanceConfigDTO'
runtimeInfoDomainDTOList:
type: array
items:
$ref: '#/components/schemas/ManagedDbRuntimeInfoDomainDTO'
enableProtection:
type: boolean
requireClientSsl:
type: boolean
shellOvaVersion:
type: string
dbAdapterRpmVersion:
type: string
dbEngineRpmVersion:
type: string
coreRpmVersion:
type: string
protectionDTO:
$ref: '#/components/schemas/ProtectionDTO'
dbOptions:
type: array
items:
$ref: '#/components/schemas/DbOption'
dbCluster:
$ref: '#/components/schemas/TenantDbClusterDTO'
TenantRecoveryDTO:
type: object
properties:
managedDbDTOList:
type: array
items:
$ref: '#/components/schemas/TenantManagedDbDTO'
TenantCertificatesDto:
type: object
properties:
providerCaCert:
type: string
tenantCaCert:
type: string
providerRabbitServerCert:
type: string
tenantMgmtCert:
$ref: '#/components/schemas/KeyCertificateDto'
tenantShovelClientCert:
$ref: '#/components/schemas/KeyCertificateDto'
tenantRabbitServerCert:
$ref: '#/components/schemas/KeyCertificateDto'
tenantRabbitClientCert:
$ref: '#/components/schemas/KeyCertificateDto'
DbLogMetadata:
type: object
properties:
id:
type: string
format: uuid
logName:
type: string
s3FilePath:
type: string
logExtractionTime:
type: string
format: date-time
PageDbLogMetadata:
type: object
properties:
totalPages:
type: integer
format: int32
totalElements:
type: integer
format: int64
first:
type: boolean
sort:
$ref: '#/components/schemas/Sort'
size:
type: integer
format: int32
content:
type: array
items:
$ref: '#/components/schemas/DbLogMetadata'
number:
type: integer
format: int32
numberOfElements:
type: integer
format: int32
pageable:
$ref: '#/components/schemas/Pageable'
last:
type: boolean
empty:
type: boolean
Environment:
type: object
properties:
environmentId:
type: string
format: uuid
vcHost:
type: string
vcClusterName:
type: string
ListViewManagedDbDTO:
type: object
properties:
id:
type: string
format: uuid
instanceName:
type: string
environment:
$ref: '#/components/schemas/Environment'
dbType:
type: string
role:
type: string
enum:
- STAND_ALONE
- PRIMARY
- STANDBY
- SEGMENT
- READ_REPLICA
version:
type: string
status:
type: string
enum:
- ONLINE
- ERROR
- LOST_CONNECTIVITY
- WARNING
- FATAL
- CRITICAL
- INIT
- DELETED
- POWEREDOFF
- POWEREDON
- CONTROL_PLANE_UPDATE_IN_PROGRESS
- CONTROL_PLANE_UPDATE_FAILED
- DB_ENGINE_UPDATE_IN_PROGRESS
- DB_ENGINE_UPDATE_FAILED
- OS_UPDATE_IN_PROGRESS
- OS_UPDATE_FAILED
- DELETING
- MODIFYING
- BACKUP_IN_PROGRESS
createdTimestamp:
type: string
format: date-time
user:
type: string
enableProtection:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/Link'
PageMetadataListViewManagedDbDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelListViewManagedDbDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/ListViewManagedDbDTO'
page:
$ref: '#/components/schemas/PageMetadataListViewManagedDbDTO'
DashboardInfo:
type: object
properties:
dbStatistics:
type: array
items:
$ref: '#/components/schemas/DatabaseStatistics'
tenantDbStatistics:
type: array
items:
$ref: '#/components/schemas/TenantStatistics'
localCompletedBackups:
type: integer
format: int64
cloudCompletedBackups:
type: integer
format: int64
publishedTemplatesCount:
type: integer
format: int64
totalTenants:
type: integer
format: int64
totalUsers:
type: integer
format: int64
DatabaseStatistics:
type: object
properties:
count:
type: integer
format: int64
databaseType:
type: string
enum:
- MYSQL
- POSTGRES
- SQLSERVER
- ORACLE
TenantStatistics:
type: object
properties:
tenantId:
type: string
format: uuid
databaseType:
type: string
enum:
- MYSQL
- POSTGRES
- SQLSERVER
- ORACLE
tenantCompanyName:
type: string
databaseCount:
type: integer
format: int64
BackupDTO:
type: object
properties:
backupId:
type: string
format: uuid
backupChainId:
type: string
format: uuid
backupName:
type: string
backupInstanceType:
type: string
backupChainStatus:
type: string
metaData:
type: string
metaDataType:
type: string
s3Path:
type: string
isLocalAvailable:
type: boolean
localStatus:
type: string
isCloudAvailable:
type: boolean
cloudStatus:
type: string
snapshotCreationTime:
type: string
user:
$ref: '#/components/schemas/TdmUserDTO'
tenantId:
type: string
format: uuid
environmentId:
type: string
format: uuid
protectionId:
type: string
format: uuid
dataStoreMor:
type: string
logicalBuildId:
type: string
format: uuid
dbId:
type: string
format: uuid
dbInstanceName:
type: string
automated:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/Link'
PageMetadataBackupDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelBackupDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/BackupDTO'
page:
$ref: '#/components/schemas/PageMetadataBackupDTO'
PageMetadataTenantLogBundleDTO:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelTenantLogBundleDTO:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/TenantLogBundleDTO'
page:
$ref: '#/components/schemas/PageMetadataTenantLogBundleDTO'
TenantLogBundleDTO:
required:
- createdTime
- id
- logBundlePath
type: object
properties:
id:
type: string
format: uuid
createdTime:
type: string
format: date-time
logBundlePath:
type: string
user:
$ref: '#/components/schemas/TdmUserDTO'
tenantId:
type: string
format: uuid
environmentId:
type: string
format: uuid
links:
type: array
items:
$ref: '#/components/schemas/Link'
taskResultDto:
type: object
properties:
task_id:
type: string
description: Data object for newly created task
PageMetadataProviderEnvironmentPatchHistoryDto:
type: object
properties:
size:
type: integer
format: int64
totalElements:
type: integer
format: int64
totalPages:
type: integer
format: int64
number:
type: integer
format: int64
PagedModelProviderEnvironmentPatchHistoryDto:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/Link'
content:
type: array
items:
$ref: '#/components/schemas/ProviderEnvironmentPatchHistoryDto'
page:
$ref: '#/components/schemas/PageMetadataProviderEnvironmentPatchHistoryDto'
ProviderEnvironmentDTO:
type: object
properties:
id:
type: string
format: uuid
state:
type: string
enum:
- HA_CONFIG_IN_PROGRESS
- ACTIVE_MODE
- MAINTENANCE_MODE
role:
type: string
enum:
- STANDALONE
- PRIMARY
- SECONDARY
ip1:
type: string
ip2:
type: string
fqdn:
type: string
rabbitmqEndpoint:
type: string
rabbitmqPort:
type: integer
format: int32
version:
type: string
links:
type: array
items:
$ref: '#/components/schemas/Link'
ProviderEnvironmentPatchHistoryDto:
type: object
properties:
id:
type: string
format: uuid
providerEnvironment:
$ref: '#/components/schemas/ProviderEnvironmentDTO'
currentVersion:
type: string
targetVersion:
type: string
requestType:
type: string
enum:
- STAGE
- STAGE_INSTALL
- INSTALL
status:
type: string
enum:
- STAGE_IN_PROGRESS
- STAGE_SUCCESS
- BACKUP_IN_PROGRESS
- BACKUP_PASSED
- BACKUP_FAILED
- STAGE_FAILURE
- INSTALLING
- REBOOTING
- SUCCESS
- FAILURE
createdTime:
type: string
format: date-time
lastUpdatedTime:
type: string
format: date-time
links:
type: array
items:
$ref: '#/components/schemas/Link'
securitySchemes:
bearer-key:
type: http
scheme: bearer
bearerFormat: JWT
orgHeader:
type: apiKey
name: X-Org-ID
in: header