API Docs JSON file
📎 9810_external.json 📎 994_external.json
1. Authentication
- API Key HTTP Header name has been changed
Before Change | After Change | |
---|---|---|
Header Parameter name | X-QueryPie-Api-Token | Authorization |
2. Alert API
Changes/Improvements
API(9.8.10) | Changes |
---|---|
(GET) List |
|
(POST) Create |
|
(PUT) Update |
|
(Delete) Delete |
|
[New] (POST) Create, (PUT) Update, (GET) Detail API
- For detailed request content, refer to Docs
Alert Type (9.8.10 Standard) | Docs Location (9.9.4) |
---|---|
| [SQL Execution] |
| [Prevented SQL Execution] |
| [DB Connection Attempt] |
| [Sensitive Data Access]
|
| [Sensitive Data Access]
|
| [Data Export] |
| [Workflow New Request] |
Unusual Login Attempt |
(GET) List
/api/external/notifications
Request
- No changes
Response
Before Change | After Change |
---|---|
|
|
3. Approval Rule API
(GET) List
/api/external/approval-rules
Request
- Query Parameter
- RequestType changed from
SQL
,ACCESS
→SQL
,EXPORT
,ACCESS
with EXPORT added.
Response
- No changes
4. Audit Log API
(GET) List of Approval
/api/external/audit-logs
Request
- Query Parameter
Before Change | After Change |
---|---|
|
|
- cursor uses the nextCursor from Response as is. Leave empty for first call.
- Content shown in /api/docs is incorrect and will be corrected in future versions.
- count is the same as the existing pageSize, with a max value of 100.
Redis
has been added to databaseType.
Response
Before Change | After Change |
---|---|
|
|
- hasNext field has been added. Indicates whether there is next data after Response.
- execResult has been Deprecated. Will be removed in future versions.
- page field has disappeared and nextCursor has been added.
- Refers to executedAt of the last element in the current Response list within the startDate and endDate range of Request.
- Putting this value in the cursor of Request will continue from that time to fetch data. (startDate, endDate do not need to be changed.)
- Content shown in /api/docs is incorrect and will be corrected in future versions.
(GET) Detail
/api/external/audit-logs/{id}
Request
- No changes
Response
Before Change | After Change |
---|---|
|
|
- execResult has been Deprecated. Will be removed in future versions.
(GET) Detail
/api/external/audit-logs/{uuid}
Request
- No changes
Response
Before Change | After Change |
---|---|
|
|
- execResult has been Deprecated. Will be removed in future versions.
5. Authentication History API
(GET) List of Authentication
/api/external/connection-auth-logs
Request
- Query Parameter
Before Change | After Change |
---|---|
|
|
LOGIN
,LOGOUT
,LOCKED
,EXPIRED
,LOCKED_MANUALLY
,UNLOCK
have been removed from actionType.- Only
CONNECT
,DISCONNECT
are used.
- Only
Redis
has been added to databaseType.
Response
- No changes
6. User Access History API
(GET) List of User Access History
/api/external/system-auth-logs
Request & Response
CONNECT
,DISCONNECT
have been removed from actionType.- Only
LOGIN
,LOGOUT
,LOCKED
,EXPIRED
,LOCKED_MANUALLY
,UNLOCK
are used.
- Only
7. Cloud Provider API
(GET) List of Cloud Provider
/api/external/cloud-providers
Request
- No changes
Response
Before Change | After Change |
---|---|
|
|
- synchronizableDatabaseTypes has been added.
- Output field for database types (vendors) to be synchronized.
AURORA_MY_SQL
,AURORA_POSTGRESQL
,MY_SQL
,POSTGRESQL
,MARIA_DB
,ORACLE
,SQL_SERVER
,DYNAMO_DB
,DOCUMENT_DB
,REDSHIFT
,ATHENA
(POST) Create Cloud Provider
/api/external/cloud-providers
Request
Before Change | After Change |
---|---|
|
|
- synchronizableDatabaseTypes has been added.
- Input field for database types (vendors) to be synchronized.
AURORA_MY_SQL
,AURORA_POSTGRESQL
,MY_SQL
,POSTGRESQL
,MARIA_DB
,ORACLE
,SQL_SERVER
,DYNAMO_DB
,DOCUMENT_DB
,REDSHIFT
,ATHENA
Response
Before Change | After Change |
---|---|
|
|
- synchronizableDatabaseTypes has been added.
- Output field for database types (vendors) to be synchronized.
AURORA_MY_SQL
,AURORA_POSTGRESQL
,MY_SQL
,POSTGRESQL
,MARIA_DB
,ORACLE
,SQL_SERVER
,DYNAMO_DB
,DOCUMENT_DB
,REDSHIFT
,ATHENA
(PUT) Update Cloud Provider
/api/external/cloud-providers/{cloudProviderUuid}
Request
Before Change | After Change |
---|---|
|
|
- synchronizableDatabaseTypes has been added.
- Input field for database types (vendors) to be synchronized.
AURORA_MY_SQL
,AURORA_POSTGRESQL
,MY_SQL
,POSTGRESQL
,MARIA_DB
,ORACLE
,SQL_SERVER
,DYNAMO_DB
,DOCUMENT_DB
,REDSHIFT
,ATHENA
Response
Before Change | After Change |
---|---|
|
|
- synchronizableDatabaseTypes has been added.
- Output field for database types (vendors) to be synchronized.
AURORA_MY_SQL
,AURORA_POSTGRESQL
,MY_SQL
,POSTGRESQL
,MARIA_DB
,ORACLE
,SQL_SERVER
,DYNAMO_DB
,DOCUMENT_DB
,REDSHIFT
,ATHENA
8. Cluster Role API
(GET) List of Role
/api/external/roles
Request
- No changes
Response
Before Change | After Change |
---|---|
|
|
- privilegeVendor has been added.
SQL
,REDIS
(POST) Create Role
/api/external/roles
Request & Response
Before Change | After Change |
---|---|
|
|
- privilegeVendor has been added.
SQL
,REDIS
(PUT) Update Role
/api/external/roles/{roleUuid}
Request & Response
Before Change | After Change |
---|---|
|
|
- privilegeVendor has been added.
SQL
,REDIS
9. Connection API
(GET) List of Cluster Group
/api/external/connections
Request
- No changes
Response
Before Change | After Change | |
---|---|---|
Request | None | |
Response |
|
|
- dbUserInfo has been removed. userMultipleAccount has been removed.
- Content of these fields is passed through connectionAccount.
- Content of these fields is passed through connectionAccount.
- connectionAccount has been added.
- Field that passes account information of the connection.
- type refers to the type of account.
NOAUTH
SASL_KERBEROS
SASL_PLAIN_UID
UIDPWD
SASL_PLAIN_UIDPWD_SSL
NOAUTH_SSL
DELEGATION_TOKEN
O_AUTH_CLIENT_CREDENTIALS
- useMultipleAccount is a boolean value indicating whether to use multi-account.
- KerberosProtocols is a field that passes Kerberos account information.
- Kerberos accounts do not support proxy accounts.
- usernamePasswords is a field that passes usernamePassword account information.
(POST) Create Cluster Group
/api/external/connections
Request
Before Change | After Change | |
---|---|---|
Request | None | |
Response |
|
|
- dbUserInfo has been removed. userMultipleAccount has been removed.
- Content of these fields is passed through connectionAccount.
- Content of these fields is passed through connectionAccount.
- connectionAccount has been added.
- Field that passes account information of the connection.
- type refers to the type of account.
NOAUTH
SASL_KERBEROS
SASL_PLAIN_UID
UIDPWD
SASL_PLAIN_UIDPWD_SSL
NOAUTH_SSL
DELEGATION_TOKEN
O_AUTH_CLIENT_CREDENTIALS
- useMultipleAccount is a boolean value indicating whether to use multi-account.
- KerberosProtocols is a field that passes Kerberos account information.
- Kerberos accounts do not support proxy accounts.
- usernamePasswords is a field that passes usernamePassword account information.
Response
Before Change | After Change | |
---|---|---|
Request | None | |
Response |
|
|
- dbUserInfo has been removed. userMultipleAccount has been removed.
- Content of these fields is passed through connectionAccount.
- Content of these fields is passed through connectionAccount.
- connectionAccount has been added.
- Field that passes account information of the connection.
- type refers to the type of account.
NOAUTH
SASL_KERBEROS
SASL_PLAIN_UID
UIDPWD
SASL_PLAIN_UIDPWD_SSL
NOAUTH_SSL
DELEGATION_TOKEN
O_AUTH_CLIENT_CREDENTIALS
- useMultipleAccount is a boolean value indicating whether to use multi-account.
- KerberosProtocols is a field that passes Kerberos account information.
- Kerberos accounts do not support proxy accounts.
- usernamePasswords is a field that passes usernamePassword account information.
(PATCH) Update Cluster Group
/api/external/connections/{uuid}
Request
Before Change | After Change | |
---|---|---|
Request | None | |
Response |
|
|
- dbUserInfo has been removed. userMultipleAccount has been removed.
- Content of these fields is passed through connectionAccount.
- Content of these fields is passed through connectionAccount.
- connectionAccount has been added.
- Field that passes account information of the connection.
- type refers to the type of account.
NOAUTH
SASL_KERBEROS
SASL_PLAIN_UID
UIDPWD
SASL_PLAIN_UIDPWD_SSL
NOAUTH_SSL
DELEGATION_TOKEN
O_AUTH_CLIENT_CREDENTIALS
- useMultipleAccount is a boolean value indicating whether to use multi-account.
- KerberosProtocols is a field that passes Kerberos account information.
- Kerberos accounts do not support proxy accounts.
- usernamePasswords is a field that passes usernamePassword account information.
Response
Before Change | After Change | |
---|---|---|
Request | None | |
Response |
|
|
- dbUserInfo has been removed. userMultipleAccount has been removed.
- Content of these fields is passed through connectionAccount.
- Content of these fields is passed through connectionAccount.
- connectionAccount has been added.
- Field that passes account information of the connection.
- type refers to the type of account.
NOAUTH
SASL_KERBEROS
SASL_PLAIN_UID
UIDPWD
SASL_PLAIN_UIDPWD_SSL
NOAUTH_SSL
DELEGATION_TOKEN
O_AUTH_CLIENT_CREDENTIALS
- useMultipleAccount is a boolean value indicating whether to use multi-account.
- KerberosProtocols is a field that passes Kerberos account information.
- Kerberos accounts do not support proxy accounts.
- usernamePasswords is a field that passes usernamePassword account information.
10. Notification Channels API
(GET) List of Notification channel
/api/external/notification-channels
Request
- Query Parameter field addition
Before Change | After Change |
---|---|
|
|
- dataflowRequest. filterKey is for entering filter key. ex) “Title”
- dataflowRequest. filterValue is for entering filter value (search term). ex) “channelName123”
- dataflowRequest. sortKey is for entering column name to sort. ex) “createdAt”
- dataflowRequest. sortType is for entering whether to sort in descending or ascending order. ex) “ASC”, “DESC”