Get Event Database

Get Event Database

Optional privileges -

Privileges	Description
GLOBAL_CONFIG_VIEW	Caller should have permission to this privilege to view entire configuration details, else limited details would be returned.

Request

URI

GET

https://{api_host}/rest/config/v1/event-database

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

OK

Returns EventDatabaseInfo of type(s) */*

{
    "admin_events_count": 2000,
    "classify_events_as_new_for_days": 3,
    "database_name": "eventdb",
    "event_database_configured": true,
    "port": 1443,
    "query_timeout_seconds": 120,
    "server_name": "eventdb.horizon.com",
    "show_events_for_time": "THREE_MONTHS",
    "table_prefix": "tab_",
    "timing_profiler_data_longevity_days": 7,
    "type": "SQL_SERVER",
    "username": "administrator"
}

integer As int32 As int32

admin_events_count

Optional

The number of events administrator can see in the admin console.

integer As int32 As int32

classify_events_as_new_for_days

Optional

Events will be marked as new for a time based on the value.

string

database_name

Optional

Name of the database on the database server to use for storing events. Note that this database must exist on the server or the values cannot be saved.

boolean

event_database_configured

Optional

Indicates if the event database has been configured or not.

integer As int32 As int32

port

Optional

Port number on the database server to which Horizon will send events.

integer As int32 As int32

query_timeout_seconds

Optional

Query execution timeout in seconds.

string

server_name

Optional

The server that hosts the database which will be used to store events.

string

show_events_for_time

Optional

Events will be shown in the Horizon Admin console for a time based on this value.

ONE_WEEK: One week.
TWO_WEEKS: Two weeks.
THREE_WEEKS: Three weeks.
ONE_MONTH: One month.
TWO_MONTHS: Two months.
THREE_MONTHS: Three months.
SIX_MONTHS: Six months.

Possible values are : ONE_WEEK, TWO_WEEKS, THREE_WEEKS, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS,

string

table_prefix

Optional

If present, all tables for this instance will start with this prefix. This allows multiple brokers to use the same events database without trampling on other broker data.

integer As int32 As int32

timing_profiler_data_longevity_days

Optional

Timing Profiler data will be kept in database for a time based on the value. Timing Profiler Data will not be stored in Event DB.

string

type

Optional

The type of database to use for the event database.

ORACLE: An Oracle database.
SQL_SERVER: A SQL server database.
POSTGRESQL: A PostgreSQL database.

Possible values are : ORACLE, SQL_SERVER, POSTGRESQL,

string

username

Optional

Username to use for the connection to the event database.

401

User is not authenticated

Operation doesn't return any data structure

On This Page

Request

200 Response Body

Errors

Config Operations

Add App Volumes Manager

Add App Volumes Manager V2

Clear Event Database

Create Federation Access Group

Create Gateway Access User Or Group

Create GSSAPI Authenticator

Create IC Domain Account

Create IM Asset

Create IM Assets

Create IM Stream

Create IM Streams

Create IM Version

Create IM Versions

Create JWT Authenticator

Create Local Access Group

Create Message Client

Create Permissions

Create Permissions V2

Create RADIUS Authenticator

Create SAML Authenticator

Create Secondary Credential

Create True SSO Connector

Create Unauthenticated Access User

Create Virtual Center

Create Virtual Center V4

Create Virtual Center V5

Delete App Volumes Manager

Delete App Volumes Manager V2

Delete Certificate

Delete Federation Access Group

Delete Gateway Access User Or Group

Delete GSSAPI Authenticator

Delete IC Domain Account

Delete IM Asset

Delete IM Stream

Delete IM Version

Delete JWT Authenticator

Delete Local Access Group

Delete Message Client

Delete Permissions

Delete Permissions V2

Delete RADIUS Authenticator

Delete SAML Authenticator

Delete Secondary Credential

Delete True SSO Connector

Delete Unauthenticated Access User

Disable Connection Servers

Enable Connection Servers

Export Certificate

Get Admin Users Or Groups Permissions

Get AD Sites Info

Get Agent Restriction Settings

Get App Volumes Manager

Get App Volumes Manager V2

Get Client Settings

Get Connection Server

Get Connection Server V2

Get Enrollment Server

Get Environment

Get Environment V2

Get Event Database

Get Feature Settings

Get Federation Access Group

Get Federation Access Group V2

Get General Settings

Get General Settings V2

Get General Settings V3

Get General Settings V4

Get Global Policies

Get GSSAPI Authenticator

Get IC Domain Account

Get JWT Authenticator

Get Local Access Group

Get Local Access Group V2

Get Message Client

Get Permission V2

Get Preferences

Get Preferences V2

Get Pre Logon Settings

Get RADIUS Authenticator

Get SAML Authenticator

Get Secondary Credentials

Get Security Configuration Info

Get Security Settings

Get Security Settings V2

Get Security Settings V3

Get Security Settings V4

Get Settings V2

Get Settings V3

Get Settings V4

Get Settings V5

Get Storage Details

Get True SSO Connector

Get Unauthenticated Access User

Get Users Or Group Local Summary V2

Get Users Or Group Local Summary V3

Get Users Or Groups Global Summary

Get Virtual Center

Get Virtual Center V4

Get Virtual Center V5

Import Certificate

List App Volumes Managers

List App Volumes Managers V2

List Certificate Infos

List Certificate Infos V2

List Connection Servers

List Connection Servers V2

List Enrollment Servers

List Federation Access Groups

List Federation Access Groups V2

List Gateway Access User Or Group

List GSSAPI Authenticators

List IC Domain Accounts

List IM Streams

List IM Versions

List JWT Authenticators

List Licenses V2

List Local Access Groups

List Local Access Groups V2

List Log Collector Tasks

List Message Clients

List Permissions

List Permissions V2

List RADIUS Authenticators

List RCX Servers

List SAML Authenticators

List Secondary Credentials

List Selectable Privileges

List True SSO Connectors

List Unauthenticated Access Users

List Users Or Groups Global Summary

List Users Or Groups Local Summary

List Users Or Groups Local Summary V2

List Users Or Groups Local Summary V3

List VC Info V2

List VC Info V3

List VC Info V4

List VC Info V5

Mark Datastores For Archival

Override Certificate

Push Certificates

Recover Certificates

Register Gateway

Register RCX Client

Remove Virtual Center

Remove Virtual Center V5

Reset Highest Usage Metrics

Reset Named User Metrics

Set License Key

Set License Mode

Unregister Gateway

Unregister RCX Client

Update Agent Restriction Settings

Update App Volumes Manager

Update App Volumes Manager V2

Update CEIP Info

Update Client Settings

Update Connection Server

Update Connection Server V2

Update Event Database

Update Feature Settings

Update General Settings

Update General Settings V2

Update General Settings V3

Update General Settings V4

Update Global Policies

Update GSSAPI Authenticator

Update IC Domain Account

Update IM Asset

Update IM Stream

Update IM Version

Update JWT Authenticator

Update Message Client

Update Preferences

Update Preferences V2

Update RADIUS Authenticator

Update RCX Client

Update SAML Authenticator

Update Security Settings

Update Security Settings V3

Update Security Settings V4

Update Settings

Update Settings V2

Update Settings V3

Update Settings V4

Update Settings V5

Update True SSO Connector

Update Virtual Center

Update Virtual Center V4

Update Virtual Center V5

Validate AVM Certificate

Validate SAML Certificate

Validate Virtual Center Certificate