Get a Database by ID
get
/api/database/Databases/{id}
Gets the database that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The database ID.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 database properties.
-
total: integer
The total number of results regardless of paging.Example:
1
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