Databases

Quick Navigation

For more information on related topics, please see:

GET Databases

Returns a list of Databases.

Asset Management (Read)

None

Content-Type: application/json

[
    {
        AssetID: int,
        DatabaseID : int,
        PlatformID : int,
        InstanceName : string,
        IsDefaultInstance : bool,
        Port : int,
        Version : string,
        Template:string
    },
    …
]

201 – Request successful. Databases in the response body.

For more information, please see Common Response Codes.

GET Databases/{id}

Returns a Database by ID.

Asset Management (Read)

id: ID of the Database.

None

Content-Type: application/json

{
    AssetID:int,
    DatabaseID : int,
    PlatformID : int,
    InstanceName : string,
    IsDefaultInstance : bool,
    Port : int,
    Version : string
}

201 – Request successful. Databases in the response body.

For more information, please see Common Response Codes.

GET Assets/{id}/Databases

Returns a list of Databases for the given Asset.

Asset Management (Read)

id: ID of the Asset.

None

Content-Type: application/json

[
    {
        AssetID: int,
        DatabaseID : int,
        PlatformID : int,
        InstanceName : string,
        IsDefaultInstance : bool,
        Port : int,
        Version : string,
        Template:string
    },
…

201 – Request successful. Databases in the response body.

For more information, please see Common Response Codes.

POST Assets/{id}/Databases

Creates a new Database in the Asset referenced by ID.

Asset Management (Read/Write)

id: ID of the Asset.

Content-Type: application/json

{
    PlatformID : int,
    InstanceName : string,
    IsDefaultInstance : bool,
    Port : int,
    Version : string,
    Template : string,
}
  • PlatformID: (required) ID of the Platform
  • InstanceName: Name of the database instance. Required when IsDefaultInstance is false. Max string length is 100.
  • IsDefaultInstance: True if the database instance is the default instance, otherwise false.

Only MS SQL Server and MySQL platforms support setting this value to true.

  • Port: (required) The Database port.
  • Version: The database version. Max string value is 20.
  • Template: The database connection template.

Content-Type: application/json

{
    AssetID: int,
    DatabaseID : int,
    PlatformID : int,
    InstanceName : string,
    IsDefaultInstance : bool,
    Port : int,
    Version : string,
    Template:string
}

200 – Request successful. Databases in the response body.

For more information, please see Common Response Codes.

PUT Databases/{id}

Updates an existing Database by ID.

Asset Management (Read/Write)

id: ID of the Database.

Content-Type: application/json

{
    PlatformID: int,
    InstanceName: string,
    IsDefaultInstance: bool,
    Port: int,
    Version: string,
    Template: string
}
  • PlatformID: (required) ID of the Platform.
  • InstanceName: Name of the database instance. Required when IsDefaultInstance is false. Max string length is 100.
  • IsDefaultInstance: True if the database instance is the default instance, otherwise false.

Only MS SQL Server and MySQL platforms support setting this value to true.

  • Port: The Database port.
  • Version: The database version. Max string length is 20.
  • Template: The database connection template.

Content-Type: application/json

{
    AssetID: int,
    DatabaseID: int,
    PlatformID: int,
    InstanceName: string,
    IsDefaultInstance: bool,Port: int,
    Version: string,
    Template: string
}

200 – Request successful. Databases in the response body.

For more information, please see Common Response Codes.

DELETE Databases/{id}

Deletes a Database by ID.

Asset Management (Read/Write)

id: ID of the Database.

None

None

200 – Request successful.

For more information, please see Common Response Codes.