API Reference

Search databases

get
https://{host}/platform/admindata/v1/databases

Returns a list of databases.

🍐

Permissions

To perform this operation, a principal must belong to a user group that has been assigned the Data Admin role.

To learn more about role-based permissions, see Access Controls.

Query Params
string

Query string to select response data based on property values.

PropertyComparisonList
createDate=, !=, >=, <=
customServerName=, !=, LIKE, NOT LIKEIN, NOT IN
databaseId=, !=, LIKE, NOT LIKEIN, NOT IN
databaseName=, !=, LIKE, NOT LIKEIN, NOT IN
databaseType=, !=, LIKE, NOT LIKEIN, NOT IN
lastModified=, !=, >=, <=
owner=, !=, LIKE, NOT LIKEIN, NOT IN
securableId=, !=, >=, <=IN, NOT IN
securableName=, !=, LIKE, NOT LIKEIN, NOT IN
securableType=, !=, LIKE, NOT LIKEIN, NOT IN
serverName=, !=, LIKE, NOT LIKEIN, NOT IN
serverType=, !=, LIKE, NOT LIKEIN, NOT IN
sizeInMb=, !=, >=, <=IN, NOT IN

To learn more, see Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: databaseId, databaseName, databaseType, serverType, serverName, securableId, securableType, securableName, sizeInMb, owner, createDate, lastModified

int32

Number of records to display per page

int32

Number of the page displaying the returned records, starting at 0

Responses

Updated about 8 hours ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 8 hours ago