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

Create a Database

post

/api/database/Databases

Creates a new database.
The minimum required properties in the request body are:
  • ShardID (defaults to 1 if not specified, but specify it if you are using database shards)
  • FailoverTypeID
  • DatabaseName
  • DBType
  • DBHost
  • DBName
  • DBPort
  • StatusID
  • Timeout
  • Password
  • Username

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • The database display name.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    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
  • The new database login password.
  • The database shard ID.
    Example: 1
  • 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:
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
The response body for a successful add operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The properties of the new database.
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