Get Databases
get
/api/database/Databases
Gets the databases that match the specified parameters. If no parameters are specified, all databases are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of databases that match the specified parameters.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The list of databases that match the specified parameters.
Show Source
Nested Schema : databaseDatabasesRead
Type:
Show Source
object
-
DatabaseID: integer
Database ID specified for individual CRUD operationsExample:
1002
-
DatabaseName: string
Database Display NameExample:
Primary Graph Database on someone.example.com
-
DBHost: string
Database FQDN Host NameExample:
someone.example.com
-
DBName: string
Database schema name e.g. GraphExample:
Graph
-
DBPort: integer
Database Port (3306 is default)Example:
7687
-
DBType: string
DBType used in connection string (mysql is default) Allowed Values: - mysql => MySQL - Sybase => MS SQL Server/Sybase - Neo4j => Neo4j Graph Database - InfluxDB => InfluxDB Metric DatabaseExample:
Neo4j
-
Description: string
Description, human label of databaseExample:
Graph database
-
FailoverTypeID: integer
Failover Type ID Allowed Values: - 1 => Primary - 2 => Backup/RedundantExample:
1
-
IsAssure1Database:
If the database name is Assure1, Event, Graph, Metric, or Vision, then it is an Assure1 database. 0 -> No 1 -> YesExample:
1
-
ShardID: integer
Database Shard ID, Identification of database within the shardExample:
1
-
State: string
StateExample:
Loading...
-
StateIcon: string
State iconExample:
barSpinner.gif
-
Status: string
Allowed Values:
[ "Enabled", "Disabled" ]
StatusExample:Enabled
-
StatusIcon: string
Allowed Values:
[ "OrbGreen.png", "OrbRed.png" ]
Status IconExample:OrbGreen.png
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
Timeout: integer
Database connection timeout value in seconds (30 is default)Example:
30
-
Username: string
Database login user nameExample:
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object