API Documentation

Last Update: 28 December 2022

GET api/MSSQLDatabase/{id}



Request Information


URI Parameters
Name Description Type Additional information
id

integer

Required

Body Parameters

None.

Response Information


Resource Description
MSSQLDatabase
Name Description Type Additional information
ID

integer

None.

ReportDate

date

None.

HostID

integer

None.

DatabaseID

integer

None.

DatabaseGuid

string

None.

InstanceName

string

None.

Name

string

None.

AnsiNullDefault

string

None.

AnsiNullsEnabled

string

None.

AnsiPaddingEnabled

string

None.

AnsiWarningsEnabled

string

None.

ArithmeticAbortEnabled

string

None.

AutoClose

string

None.

AutoCreateIncrementalStatisticsEnabled

string

None.

AutoCreateStatisticsEnabled

string

None.

AutoShrink

string

None.

AutoUpdateStatisticsAsync

string

None.

AutoUpdateStatisticsEnabled

string

None.

AvailabilityDatabaseSynchronizationState

string

None.

AvailabilityGroupName

string

None.

BrokerEnabled

string

None.

CaseSensitive

string

None.

ChangeTrackingAutoCleanUp

string

None.

ChangeTrackingEnabled

string

None.

ChangeTrackingRetentionPeriod

string

None.

ChangeTrackingRetentionPeriodUnits

string

None.

CloseCursorsOnCommitEnabled

string

None.

Collation

string

None.

CompatibilityLevel

string

None.

ConcatenateNullYieldsNull

string

None.

ContainmentType

string

None.

CreateDate

date

None.

DatabaseSnapshotBaseName

string

None.

DateCorrelationOptimization

string

None.

DboLogin

string

None.

DefaultFileGroup

string

None.

DefaultFileStreamFileGroup

string

None.

DefaultFullTextCatalog

string

None.

DefaultSchema

string

None.

DelayedDurability

string

None.

EncryptionEnabled

string

None.

FilestreamDirectoryName

string

None.

FilestreamNonTransactedAccess

string

None.

HasFileInCloud

string

None.

HasMemoryOptimizedObjects

string

None.

HonorBrokerPriority

string

None.

IsAccessible

string

None.

IsDatabaseSnapshot

string

None.

IsDatabaseSnapshotBase

string

None.

IsDbAccessAdmin

string

None.

IsDbBackupOperator

string

None.

IsDbDatareader

string

None.

IsDbDatawriter

string

None.

IsDbDdlAdmin

string

None.

IsDbDenyDatareader

string

None.

IsDbDenyDatawriter

string

None.

IsDbOwner

string

None.

IsDbSecurityAdmin

string

None.

IsFullTextEnabled

string

None.

IsManagementDataWarehouse

string

None.

IsMirroringEnabled

string

None.

IsParameterizationForced

string

None.

IsReadCommittedSnapshotOn

string

None.

IsSystemObject

string

None.

IsUpdateable

string

None.

LastBackupDate

date

None.

LastDifferentialBackupDate

date

None.

LastLogBackupDate

date

None.

LocalCursorsDefault

string

None.

LogReuseWaitStatus

string

None.

MirroringFailoverLogSequenceNumber

integer

None.

MirroringID

string

None.

MirroringPartner

string

None.

MirroringPartnerInstance

string

None.

MirroringRedoQueueMaxSize

integer

None.

MirroringRoleSequence

integer

None.

MirroringSafetyLevel

string

None.

MirroringSafetySequence

integer

None.

MirroringStatus

string

None.

MirroringTimeout

integer

None.

MirroringWitness

string

None.

MirroringWitnessStatus

string

None.

NestedTriggersEnabled

string

None.

NumericRoundAbortEnabled

string

None.

Owner

string

None.

PageVerify

string

None.

PrimaryFilePath

string

None.

QuotedIdentifiersEnabled

string

None.

ReadOnly

string

None.

RecoveryForkGuid

string

None.

RecoveryModel

string

None.

RecursiveTriggersEnabled

string

None.

ReplicationOptions

string

None.

ServiceBrokerGuid

string

None.

SnapshotIsolationState

string

None.

Status

string

None.

TargetRecoveryTime

integer

None.

TransformNoiseWords

string

None.

Trustworthy

string

None.

UserAccess

string

None.

UserName

string

None.

Version

string

None.

RecordStatus

integer

None.

Response Formats
application/json, text/json
Sample:
{
  "ID": 1,
  "ReportDate": "2024-11-21T06:28:47.1472552+00:00",
  "HostID": 3,
  "DatabaseID": 4,
  "DatabaseGuid": "sample string 5",
  "InstanceName": "sample string 6",
  "Name": "sample string 7",
  "AnsiNullDefault": "sample string 8",
  "AnsiNullsEnabled": "sample string 9",
  "AnsiPaddingEnabled": "sample string 10",
  "AnsiWarningsEnabled": "sample string 11",
  "ArithmeticAbortEnabled": "sample string 12",
  "AutoClose": "sample string 13",
  "AutoCreateIncrementalStatisticsEnabled": "sample string 14",
  "AutoCreateStatisticsEnabled": "sample string 15",
  "AutoShrink": "sample string 16",
  "AutoUpdateStatisticsAsync": "sample string 17",
  "AutoUpdateStatisticsEnabled": "sample string 18",
  "AvailabilityDatabaseSynchronizationState": "sample string 19",
  "AvailabilityGroupName": "sample string 20",
  "BrokerEnabled": "sample string 21",
  "CaseSensitive": "sample string 22",
  "ChangeTrackingAutoCleanUp": "sample string 23",
  "ChangeTrackingEnabled": "sample string 24",
  "ChangeTrackingRetentionPeriod": "sample string 25",
  "ChangeTrackingRetentionPeriodUnits": "sample string 26",
  "CloseCursorsOnCommitEnabled": "sample string 27",
  "Collation": "sample string 28",
  "CompatibilityLevel": "sample string 29",
  "ConcatenateNullYieldsNull": "sample string 30",
  "ContainmentType": "sample string 31",
  "CreateDate": "2024-11-21T06:28:47.1472552+00:00",
  "DatabaseSnapshotBaseName": "sample string 33",
  "DateCorrelationOptimization": "sample string 34",
  "DboLogin": "sample string 35",
  "DefaultFileGroup": "sample string 36",
  "DefaultFileStreamFileGroup": "sample string 37",
  "DefaultFullTextCatalog": "sample string 38",
  "DefaultSchema": "sample string 39",
  "DelayedDurability": "sample string 40",
  "EncryptionEnabled": "sample string 41",
  "FilestreamDirectoryName": "sample string 42",
  "FilestreamNonTransactedAccess": "sample string 43",
  "HasFileInCloud": "sample string 44",
  "HasMemoryOptimizedObjects": "sample string 45",
  "HonorBrokerPriority": "sample string 46",
  "IsAccessible": "sample string 47",
  "IsDatabaseSnapshot": "sample string 48",
  "IsDatabaseSnapshotBase": "sample string 49",
  "IsDbAccessAdmin": "sample string 50",
  "IsDbBackupOperator": "sample string 51",
  "IsDbDatareader": "sample string 52",
  "IsDbDatawriter": "sample string 53",
  "IsDbDdlAdmin": "sample string 54",
  "IsDbDenyDatareader": "sample string 55",
  "IsDbDenyDatawriter": "sample string 56",
  "IsDbOwner": "sample string 57",
  "IsDbSecurityAdmin": "sample string 58",
  "IsFullTextEnabled": "sample string 59",
  "IsManagementDataWarehouse": "sample string 60",
  "IsMirroringEnabled": "sample string 61",
  "IsParameterizationForced": "sample string 62",
  "IsReadCommittedSnapshotOn": "sample string 63",
  "IsSystemObject": "sample string 64",
  "IsUpdateable": "sample string 65",
  "LastBackupDate": "2024-11-21T06:28:47.1472552+00:00",
  "LastDifferentialBackupDate": "2024-11-21T06:28:47.1472552+00:00",
  "LastLogBackupDate": "2024-11-21T06:28:47.1472552+00:00",
  "LocalCursorsDefault": "sample string 69",
  "LogReuseWaitStatus": "sample string 70",
  "MirroringFailoverLogSequenceNumber": 71,
  "MirroringID": "sample string 72",
  "MirroringPartner": "sample string 73",
  "MirroringPartnerInstance": "sample string 74",
  "MirroringRedoQueueMaxSize": 75,
  "MirroringRoleSequence": 76,
  "MirroringSafetyLevel": "sample string 77",
  "MirroringSafetySequence": 78,
  "MirroringStatus": "sample string 79",
  "MirroringTimeout": 80,
  "MirroringWitness": "sample string 81",
  "MirroringWitnessStatus": "sample string 82",
  "NestedTriggersEnabled": "sample string 83",
  "NumericRoundAbortEnabled": "sample string 84",
  "Owner": "sample string 85",
  "PageVerify": "sample string 86",
  "PrimaryFilePath": "sample string 87",
  "QuotedIdentifiersEnabled": "sample string 88",
  "ReadOnly": "sample string 89",
  "RecoveryForkGuid": "sample string 90",
  "RecoveryModel": "sample string 91",
  "RecursiveTriggersEnabled": "sample string 92",
  "ReplicationOptions": "sample string 93",
  "ServiceBrokerGuid": "sample string 94",
  "SnapshotIsolationState": "sample string 95",
  "Status": "sample string 96",
  "TargetRecoveryTime": 97,
  "TransformNoiseWords": "sample string 98",
  "Trustworthy": "sample string 99",
  "UserAccess": "sample string 100",
  "UserName": "sample string 101",
  "Version": "sample string 102",
  "RecordStatus": 103
}