Get Page 7

Get Page 7

Endpoint to get databases
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER

Request
URI
GET
https://{api_host}/provider/databases
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string
environmentId
Optional

Filter based on environment ID

string of array
namespaceId
Optional

Filter based on namespace IDs

string
tenantId
Optional

Filter based on organization ID

string
instanceName
Optional

Filter based on instance name

string of array
engines
Optional

Filter based on engines

string of array
versions
Optional

Filter based on versions

string of array
tags
Optional

Filter based on tags

string of array
roles
Optional

Filter based on roles

string of array
statuses
Optional

Filter based on statuses

integer of array
userIds
Optional

Filter based on users ids

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedModelListViewManagedDbDTO of type(s) application/vnd.vmware.dms-v1+json 
{
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ],
    "content": [
        {
            "id": "string",
            "instanceName": "string",
            "environment": {
                "environmentId": "string",
                "vcHost": "string",
                "vcClusterName": "string"
            },
            "tenantId": "string",
            "dbType": "string",
            "role": "string",
            "version": "string",
            "status": "string",
            "createdTimestamp": "string",
            "user": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "contactNumber": "string",
                "email": "string",
                "password": "string",
                "tenantId": "string",
                "companyName": "string",
                "type": "string",
                "roles": [
                    "string"
                ],
                "forcePasswordChange": false,
                "links": [
                    {
                        "rel": "string",
                        "href": "string",
                        "hreflang": "string",
                        "media": "string",
                        "title": "string",
                        "type": "string",
                        "deprecation": "string",
                        "profile": "string",
                        "name": "string"
                    }
                ]
            },
            "tags": [
                {
                    "id": "string",
                    "orgId": "string",
                    "name": "string",
                    "createdTime": "string",
                    "modifiedTime": "string",
                    "lastModified": "string",
                    "assignedInstanceCount": 0
                }
            ],
            "enableProtection": false,
            "namespace": {
                "id": "string",
                "name": "string",
                "type": "string"
            },
            "edition": "string",
            "hwConfig": {
                "hdDiskSizeGB": 0,
                "cpuCores": 0,
                "memoryGB": 0,
                "thinDisk": false
            },
            "links": [
                {
                    "rel": "string",
                    "href": "string",
                    "hreflang": "string",
                    "media": "string",
                    "title": "string",
                    "type": "string",
                    "deprecation": "string",
                    "profile": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "page": {
        "size": 0,
        "totalElements": 0,
        "totalPages": 0,
        "number": 0
    }
}
array of object
links
Optional

links

array of object
content
Optional

content

object
page
Optional

page


400

Bad Request

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/provider/databases
On This Page
Databases Operations
PUT
Scaledbconfig
PUT
Change Backup Storage
PUT
Poweron
PUT
Poweroff
GET
Get Database Notifications
PUT
Update Database Notifications
PUT
Modify Db Config
PUT
Modify Backup Config
PUT
Extend Db Disk
PUT
Provider Enable Db Vm Ssh
PUT
Tenant Enable Db Vm Ssh
PUT
Provider Disable Db Vm Ssh
PUT
Tenant Disable Db Vm Ssh
PUT
Change Edition
PUT
Change Db Options
POST
Create 7
POST
Protect
POST
Generate Db Logs
POST
Update Alert Type As Verified
POST
Enable Require Client Ssl
POST
Disable Require Client Ssl
POST
Submit Recover Task
POST
Promote Read Replica
POST
Add Read Replica
POST
Submit Clone Task
POST
Submit PITR Task
POST
Submit Restore Task
GET
Get Page 7
POST
Create 8
PATCH
Update Db Os
PATCH
Update Db Engine Rpm
PATCH
Resync Db Trusted Certificates
PATCH
Refresh Db Certificate
PATCH
Change Db Owner
GET
Get Db
GET
Get Db Updates
GET
Fetch Supported Edition Upgrades
GET
Get DB Vm Root Password
GET
Get Replica Deployable Namespaces
GET
Get Protection Details
GET
Get Flagged Db Alert Types
GET
Export Db Server Certificate 1
GET
Export Db Ca Certificate
GET
Fetch Db Disk Freespace
GET
Get Database Alerts History
GET
Get DB Admin Password
GET
Get PITR Allowed Range By DB
GET
Get Db Version
GET
Get Database Search Filter Values
GET
Export To XLS
GET
Export To CSV
DELETE
Delete 1