1. REST API for Unified Assurance Core
  2. Tasks
  3. Databases
  4. Databases

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
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The list of databases that match the specified parameters.
Show Source
Nested Schema : databaseDatabasesRead
Type: object
Show Source
  • The database ID for individual CRUD operations.
    Example: 1002
  • The database display name.
    Example: Primary Graph Database on someone.example.com
  • The database FQDN host name.
    Example: someone.example.com
  • The database schema name.
    Example: Graph
  • The database port. The default is 3306.
    Example: 7687
  • The database type used in the connection string. The possible values are:
    • mysql: MySQL. This is the default.
    • Sybase: MS SQL Server/Sybase
    • Neo4j: Neo4j Graph Database
    • influxDB: InfluxDB Metric Database
    Example: Neo4j
  • The description of the database.
    Example: Graph database
  • The failover type ID. Either 1 for a primary database or 2 for a backup or redundant database.
    Example: 1
  • Whether the database is a Unified Assurance database (1) or not (0). If the database name is Assure1, Event, Graph, Metric, or Vision, then it is a Unified Assurance database.
    Example: 1
  • The database shard ID.
    Example: 1
  • The state.
    Example: Loading...
  • The state icon.
    Example: barSpinner.gif
  • Allowed Values: [ "Enabled", "Disabled" ]
    The status.
    Example: Enabled
  • Allowed Values: [ "OrbGreen.png", "OrbRed.png" ]
    The status icon.
    Example: OrbGreen.png
  • The database status ID. Either 0 (disabled) or 1 (enabled).
    Example: 1
  • The database connection timeout value in seconds. The default is 30.
    Example: 30
  • The database login username.
    Example:

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top