Introduction
Data Virtualization for Cloud Pak for Data integrates data sources across multiple types and locations and turns all this data into one logical data view.
The Data Virtualization REST API connects to your service deployment, so you can manage your virtual data, data sources, and user roles. Additionally, by using the Data Virtualization REST API, you can virtualize and publish data to the default catalog in Watson Knowledge Catalog.
Authentication
To authenticate to the API, you pass an access token in an Authorization header. The token is associated with a user name, for example: admin. To generate an access token, call the Get authorization token method.
Endpoint URL
The Data Virtualization API endpoint URL is based on your IBM Cloud Pak deployment URL.
Data Virtualization provides two different endpoint URLs, depending on the method that you are using. Ensure that you use the correct endpoint URL for the method that you want to use.
https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v1/{method}
https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/{method}
When you call the API, add the path for each method to form the complete API endpoint for your request. For example, if your instance is deployed at https://www.example.com:31843, you can access the APIs at https://www.example.com:31843/icp4data-databases/dv/{namespace}/dvapiserver/v1/{method} or https://www.example.com:31843/icp4data-databases/dv/{namespace}/dvapiserver/v2/{method}.
Example
curl -H "cache-control: no-cache" -X {request_method} -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v1/{method}"
or
curl -H "cache-control: no-cache" -X {request_method} -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/{method}"
Disabling SSL verification
The Data Virtualization service uses Secure Sockets Layer (SSL) (or Transport Layer Security (TLS)) for secure connections between the client and server. The connection is verified against the local certificate store to ensure authentication, integrity, and confidentiality.
If you use a self-signed certificate, you need to disable SSL verification to make a successful connection.
Enabling SSL verification is highly recommended. Disabling SSL jeopardizes the security of the connection and data. Disable SSL only if necessary, and take steps to enable SSL as soon as possible.
To disable SSL verification for a curl request, use the --insecure (-k) option with the request.
Example that disables SSL verification
curl -k -X {request_method} -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "{url}/icp4data-databases/dv/{namespace}/dvapiserver/v2/{method}"
Error handling
Data Virtualization uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that cannot be resolved by the user. Response codes are listed with the method.
ErrorResponse
| Name | Description |
|---|---|
| code{: .parameter-name .required} string |
An identifier of the response. |
| message{: .parameter-name .required} string |
An explanation of the problem. |
Methods
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/agent_nodes"
Response
The type of connector used by the data source. This includes internal and remote connectors.
Number of connectors.
Name of the host of the connector.
Determines whether the data source uses Docker.
Describes the connector.
Name of the node.
Name of the operating system user.
Specifies the node port that the connector will use on the remote data source. Each connector that you install on the remote data source can use a different node port.
agent_node_array
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "agent_node_array": { "agent_class": "F", "dscount": "0", "hostname": "dv-0.dv.tns.svc.cluster.local", "is_docker": "false", "node_description": "Not specified", "node_name": "AdminNode", "os_user": "bigsql", "port": "6414" } }
Get data source connections
Gets all data source connections that are connected to the service.
GET /dvapiserver/v2/datasource/connections
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer $token" "https://{HOSTNAME}:{PORT_NUMBER}/icp4data-databases/dv/{namespace}/dvapiserver/v2/datasource/connections"
Response
The name of the node that a data source is associated with.
The description of the node that a data source is associated with.
The type of connector, for example, H stands for Hosted or running within the cluster, F means Fenced Mode Process or directly within the Data Virtualization instance.
The hostname or IP address that is used to access the connection.
The port number that is used to access the connection.
Determines whether the data source uses Docker.
The number of data sources.
The identifier of the connection for the Data Virtualization.
The name of the database.
The connection identifier for the platform.
The hostname or IP address of the data source.
The port number of the data source.
The type of the data source.
The user that has access to the data source.
The URI of the data source.
The status of the data source.
The name of the connection.
data_sources
datasource_connections
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "datasource_connections": [ { "agent_class": "F", "dscount": "0", "hostname": "dv-0.dv.tns.svc.cluster.local", "is_docker": "N", "node_name": "AdminNode", "node_description": "Not specified", "port": "6414", "os_user": "bigsql", "data_sources": [ { "cid": "MSSQL10000", "dbname": "mssql2014db1", "connection_id": "75e4d01b-7417-4abc-b267-8ffb393fb970", "srchostname": "example.ibm.com", "srcport": "1433", "srctype": "MSSQLServer", "status": "string", "usr": "DV-user", "uri": "example.ibm.com:1433/" } ] } ] }
Add data source connection
Adds a data source connection to the Data Virtualization service.
POST /dvapiserver/v2/datasource/connections
Request
The type of data source that you want to add.
Example:
DB2The name of data source.
Example:
DB2The location of data source that you want to add.
Example:
usExample:
ya29.Il-_Example:
ibmdatastage.us-east-1Example:
ApiKey-a31d60c5-0f7b-4995-a4ae-69bf09d3de50Example:
Bearer TokenExample:
81571342315Example:
uIn8rVyIRsdExample:
test_collectionExample:
-----BEGIN PRIVATE KEY-----Example:
TPCDSExample:
192.168.0.1Example:
cliserviceExample:
/v2/asset_files/dbdrivers/ngdbc.jarExample:
SnowflakeExample:
/v2/asset_files/dbdrivers/ngdbc.jarExample:
passwordExample:
50000Example:
housecanary-comExample:
key=valueExample:
1//06uwhP7_312gExample:
SYSADMINExample:
https://sapes5.sapdevcenter.comExample:
ol_informix1410Example:
pdborcl.fyre.ibm.comExample:
orclExample:
falseExample:
-----BEGIN CERTIFICATE-----Example:
test.comExample:
falseExample:
db2inst1Example:
wdpcondev
properties
Example:
USER
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer $token" -d "{\"datasource_type\":\"Db2\",\"name\":\"Db2\",\"origin_country\":\"us\",\"properties\":{\"database\":\"TPDCS\",\"host\":\"{hostname}\", \"password\":\"myPassword\", \"port\":\"50000\", \"ssl\":\"true\", \"username\":\"DV-user\"}}" "https://{HOSTNAME}:{PORT_NUMBER}/icp4data-databases/dv/{namespace}/dvapiserver/v2/datasource/connections"
Delete data source connection
Deletes a data source connection from the Data Virtualization service.
DELETE /dvapiserver/v2/datasource/connections/{connection_id}Request
Path Parameters
The connection identifier for the platform.
Example:
75e4d01b-7417-4abc-b267-8ffb393fb970
Query Parameters
The identifier of the connection for the Data Virtualization.
Example:
DB210013
curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer $token" "https://{HOSTNAME}:{PORT_NUMBER}/icp4data-databases/dv/{namespace}/dvapiserver/v2/datasource/connections/75e4d01b-7417-4abc-b267-8ffb393fb970?cid=DB210013"
Get data source nodes
Gets all data source nodes that are connected to the service.
GET /dvapiserver/v1/datasource_nodes
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v1/datasource_nodes"
Response
The name of the node.
The description of the node.
The type of connector, which includes internal connector and remote connector.
The hostname or IP address that is used to access the connection.
The port number that is used to access the connection.
Determines whether the data source uses Docker.
The number of data sources.
The identifier of the connection.
The name of the database.
The hostname or IP address of the data source.
The port number of the data source.
The type of the data source.
The user that has access to the data source.
The URI of the data source.
The status of the data source.
The name of the connection.
data_sources
datasource_nodes_array
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "datasource_nodes_array": [ { "agent_class": "F", "dscount": "0", "hostname": "dv-0.dv.tns.svc.cluster.local", "is_docker": "N", "node_name": "AdminNode", "node_description": "Not specified", "port": "6414", "os_user": "bigsql", "data_sources": [ { "cid": "MSSQL10000", "dbname": "mssql2014db1", "connection_id": "75e4d01b-7417-4abc-b267-8ffb393fb970", "srchostname": "example.ibm.com", "srcport": "1433", "srctype": "MSSQLServer", "status": "string", "usr": "DV-user", "uri": "example.ibm.com:1433/" } ] } ] }
Discover data sources
Automatically discovers the data sources that can be connected to Data Virtualization.
GET /dvapiserver/v2/discover_datasource
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/discover_datasource"
Response
The hostname or IP address that is required to access the database.
Determines whether the data source is configured.
Determines whether the data source is connected.
Determines whether the data source was discovered.
The description of the node.
The name of the node.
The port number that is required to access the connection.
The type of the data source.
datasource_array
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "datasource_array": [ { "db_hostname": "halon1", "is_configured": "0", "is_connected": "0", "is_discovered": "1", "node_description": "This is my example node description", "node_name": "halon1:6421", "port": "50000", "src_type": "DB2" } ] }
Generate installation script for remote connectors
Generates a script to install connectors on remote data sources.
GET /dvapiserver/v2/endpoint_script
Request
Query Parameters
Specifies the external hostname of the
dv-engineservice component.Specifies the external port of the
dv-engineservice component.Default:
443Specifies whether to use SSL connection for the remote data source.
Default:
trueSpecifies the operating system of the remote data source.
Default:
LinuxSpecifies the type of the installation package.
Default:
tarSpecifies the directory where Java is installed on the remote data source.
Default:
/opt/ibm/javaSpecifies the directory where you want to install the remote connector.
Default:
/opt/ibm/dvSpecifies the service node.
Specifies the service node description.
Specifies the node port that the connector will use on the remote data source. Each connector that you install on the remote data source can use a different node port.
Default:
6414
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" -d "{\"admin_host\":\"{EXTERNAL_HOSTNAME}\",\"admin_port\":\"443\",\"use_ssl\":\"true\",\"platform\":\"Linux\",\"file_type\":\"TAR\",\"java_home\":\"/opt/ibm/java\",\"install_path\":\"/opt/ibm/dv\",\"node_name\":\"dv-node\",\"node_desc\":\"my DV node\",\"data_port\":\"6414\"\}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/endpoint_script"
Grant user access
Grants a user access to a specific virtual object.
POST /dvapiserver/v2/privileges/users
Request
The name of the virtual object.
Possible values: length ≥ 1
Example:
EMPLOYEEThe schema of the virtual object.
Possible values: length ≥ 1
Example:
USER999The identifier of the authorization.
Possible values: length ≥ 1
Example:
PUBLIC
body
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" -d "\[{\"table_name\":\"EMPLOYEE\",\"table_schema\":\"USER999\", \"authid\":\"PUBLIC\"}]" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/privileges/users"
Revoke user acccess
Revoke user access to virtual object.
DELETE /dvapiserver/v2/privileges/users/{authid}Request
Path Parameters
The identifier of the authorization.
Example:
PUBLIC
Query Parameters
The schema of the virtual object.
Example:
USER999The name of the virtual object.
Example:
EMPLOYEE
curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/privileges/users/{authid}?table_schema={table_schema}&table_name={table_name}"
Grant user role
Grants a user role access to a specific virtual object.
POST /dvapiserver/v2/privileges/roles
Request
Grants a role to manage virtual objects.
The name of the virtual object.
Possible values: length ≥ 1
Example:
EMPLOYEEThe schema of the virtual object.
Possible values: length ≥ 1
Example:
USER999The role to grant to the user.
Possible values: length ≥ 1
Example:
DV_ENGINEER
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" -d "{\"table_name\":\"EMPLOYEE\",\"table_schema\":\"USER999\",\"role_name\":\"DV_ENGINEER\"}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/privileges/roles"
Request
Path Parameters
The role to revoke from the user.
Example:
DV_ENGINEER
Query Parameters
The schema of the virtual object.
Example:
USER999The name of the virtual object.
Example:
EMPLOYEE
curl -k -X DELETE -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/privileges/roles/{role_name}?table_schema={table_schema}&table_name={table_name}"
Get objects by role
Retrieves the list of virtual objects that have a specific role.
GET /dvapiserver/v1/privileges/objects/role/{rolename}Create remote table for data files in the remote connector
Creates a remote table for data files in the remote connector.
POST /dvapiserver/v2/virtualization/files
Request
Creates a remote table for data files on the remote connectors.
Specifies the column names for the virtual table.
Specifies the column data types for the virtual table.
Specifies the full path on the remote data source.
Example:
/home/data.csvSpecifies the name of the node where the file will be created.
Example:
qpendpoint_1:6415Specifies the virtual table name.
Specifies the virtual table schema.
Specifies whether the creation of the virtual table is case sensitive.
Default:
falseSpecifies whether to replace an existing file with the new virtual table.
Default:
falseLists all options that you can specify to create a virtualized file.
Example:
COLNAMES=true
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" -d "{\"column_names\":\"{COLUMN_NAMES}\",\"column_types\":\"{COLUMN_DATA_TYPES}\",\"file_path\":\"/home/data.csv\",\"is_ignore_case\":\"false\",\"is_replace\":\"false\",\"node_name\":\"AdminNode\",\"options\":\"COLNAMES=true\",\"virtual_name\":\"Tab1\",\"virtual_schema\":\"USER999\"}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/virtualize/files"
Virtualize table
Transforms a given data source table into a virtual table.
POST /dvapiserver/v2/virtualization/tables
Request
request body
The name of the source table.
Example:
Tab1The name of the column.
Example:
Column1The type of the column.
Example:
INTEGER
source_table_def
The value of sources is composition of connection CID and schema, the format looks like ["CID:SCHEMA"], the connection CID can be retrived by this API: GET /dvapiserver/v2/datasource/connections.
The name of virtual table.
Example:
Tab1The schema of the virtual table.
Example:
USER999The name of the column.
Example:
Column_1The type of the column.
Example:
INTEGER
virtual_table_def
The columns that are included in the table.
Example:
Y, Y, NDetermines whether to replace columns in the virtual table.
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" -d "{\"is_included_columns\":\"Y, Y, N\",\"replace\":false,\"source_name\":\"Tab1\",\"source_table_def\":[{\"column_name\":\"Column1\",\"column_type\":\"INTEGER\"}],\"sources\":[\"DB210001:DB2INST1\"],\"virtual_name\":\"Tab1\",\"virtual_schema\":\"USER999\",\"virtual_table_def\":[{\"column_name\":\"Column1\",\"column_type\":\"INTEGER\"}]}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/virtualization/tables"
Delete table
Removes the specified table. You must specify the schema and table name.
DELETE /dvapiserver/v2/mydata/tables/{schema_name}/{table_name}Delete view
Removes the specified table. You must specify the schema and view name.
DELETE /dvapiserver/v2/mydata/views/{schema_name}/{view_name}Request
Path Parameters
The schema of the view to be deleted.
The name of the view to be deleted.
curl -k -X DELETE -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/mydata/views/{schema_name}/{view_name}"
List caches
List all active, inactive and deleted caches in Data Virtualization
GET /dv-caching/api/v1/caches
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dv-caching/api/v1/caches"
Response
The name of this cache.
The unique ID of this cache.
The query that defines this cache.
Owner ID of this cache.
Type of the cache - User-defined (U), Recommended (R).
Database timestamp at the time of cache creation.
Database timestamp when this cache was last modified (state change).
Database timestamp when this cache was last refreshed.
Database timestamp when this cache was last used.
State of this cache - one of Enabled,Disabled,Deleted,Failed,Populating,Activating,Enabling,Disabling,Refreshing,Deleting.
Size of this cache (in KB).
Cardinality (number of rows) of this cache.
Time taken to refresh this cache most recently (in milliseconds).
Number of times this cache has been refreshed since creation.
Hit Count of the cache (number of times this cache was used).
Encoded cron-style representation of the cache refresh schedule.
Human-readable description of the cache refresh schedule.
Status message indicating the most recent error/issue with the cache, if any.
caches
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "caches": [ { "name": "ItemsCache", "id": "DV20210427043634532286", "query": "SELECT A0.\"I_ITEM_SK\" as COL3, A0.\"I_CATEGORY\" as COL2, A0.\"I_CATEGORY_ID\" as COL1 FROM \"ADMIN\".\"ITEM\" as A0", "owner_id": "ADMIN", "type": "R", "created_timestamp": "2021-04-27 04:36:34.531234", "last_modified_timestamp": "2021-04-27 04:36:50.883267", "last_refresh_timestamp": "2021-04-27 05:00:20.729498", "last_used_timestamp": "2021-04-29 16:33:32.319953", "state": "Enabled", "size": "14171", "cardinality": "2880404", "time_taken_for_refresh": "20", "refresh_count": "1", "hit_count": "1", "refresh_schedule": "0 0 0/5 ? * * *", "refresh_schedule_desc": "every 5 hours at minute 0", "status_msg": "" }, { "name": "TestCache_DELETED_20210406034223883688", "id": "DV20210406034041592922", "query": "select * from ADMIN.CUSTOMER", "owner_id": "ADMIN", "type": "U", "created_timestamp": "2021-04-06 03:40:41.590105", "last_modified_timestamp": "2021-04-06 03:42:23.97146", "last_refresh_timestamp": "2021-04-06 03:40:52.872691", "last_used_timestamp": "", "state": "Deleted", "size": "136", "cardinality": "100", "time_taken_for_refresh": "0", "refresh_count": "0", "hit_count": "0", "refresh_schedule": "", "refresh_schedule_desc": "", "status_msg": "" } ] }
Request
Path Parameters
The ID of the cache to be listed
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dv-caching/api/v1/caches/{id}"
Response
The name of this cache.
The unique ID of this cache.
The query that defines this cache.
Owner ID of this cache.
Type of the cache - User-defined (U), Recommended (R).
Database timestamp at the time of cache creation.
Database timestamp when this cache was last modified (state change).
Database timestamp when this cache was last refreshed.
Database timestamp when this cache was last used.
State of this cache - one of Enabled,Disabled,Deleted,Failed,Populating,Activating,Enabling,Disabling,Refreshing,Deleting.
Size of this cache (in KB).
Cardinality (number of rows) of this cache.
Time taken to refresh this cache most recently (in milliseconds).
Number of times this cache has been refreshed since creation.
Hit Count of the cache (number of times this cache was used).
Encoded cron-style representation of the cache refresh schedule.
Human-readable description of the cache refresh schedule.
Status message indicating the most recent error/issue with the cache, if any.
Status Code
Success
Bad Request
Unauthorized
Not found
Internal Server Error
{ "name": "ItemsCache", "id": "DV20210427043634532286", "query": "SELECT A0.\"I_ITEM_SK\" as COL3, A0.\"I_CATEGORY\" as COL2, A0.\"I_CATEGORY_ID\" as COL1 FROM \"ADMIN\".\"ITEM\" as A0", "owner_id": "ADMIN", "type": "R", "created_timestamp": "2021-04-27 04:36:34.531234", "last_modified_timestamp": "2021-04-27 04:36:50.883267", "last_refresh_timestamp": "2021-04-27 05:00:20.729498", "last_used_timestamp": "2021-04-29 16:33:32.319953", "state": "Enabled", "size": "14171", "cardinality": "2880404", "time_taken_for_refresh": "20", "refresh_count": "1", "hit_count": "1", "refresh_schedule": "0 0 0/5 ? * * *", "refresh_schedule_desc": "every 5 hours at minute 0", "status_msg": "" }
Fetch the cache storage
Fetch the total cache storage and used capacities for active and inactive caches in Data Virtualization
GET /dv-caching/api/v1/caches/storage
Request
No Request Parameters
curl -k -X GET -H "cache-control: no-cache" -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dv-caching/api/v1/caches/storage"
Response
Total cache storage size.
Storage details of active caches.
Total size of all active caches (in KB).
Number of active caches.
enabled
Storage details of inactive caches.
Total size of all inactive caches (in KB).
Number of inactive caches.
disabled
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "total_size": "100Gi", "enabled": { "size": 16918, "count": 4 }, "disabled": { "size": 0, "count": 0 } }
Publish virtual data to the default catalog
Publishes your virtual data to the default catalog in Watson Knowledge Catalog.
POST /dvapiserver/v2/integration/catalog/publish
Request
The schema of the virtual object.
The name of the virtual object.
assets
Determines whether the virtual object can be duplicated in the catalog.
Default:
falseThe catalog ID.
curl -k -X POST -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer {token}" -d "{\"allow_duplicates\":\"false\",\"assets\":\[\"schema\":\"USER999\",\"table\":\"Tab1\"]\}" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/integration/catalog/publish"
Response
The schema name of the virtual object.
The name of the virtual table that was published.
The identifier of the asset in Watson Knowledge Catalog.
published_assets
The schema name of the virtual object.
The name of the virtual table that was published.
duplicate_assets
Status Code
Success
Bad Request
Unauthorized
Internal Server Error
{ "published_assets": { "schema_name": "USER999", "table_name": "customer", "wkc_asset_id": "37fa4a15-1071-4a20-bc9e-0283d3dfb6e1" }, "duplicate_assets": [ { "schema_name": "USER999", "table_name": "customer" } ] }
Turn policy enforcement status on or off
Turns policy enforcement status on or off.
PUT /dvapiserver/v2/security/policy/status
Request
Query Parameters
Set the status of policy enforcement.
Example:
enabled
curl -k -X PUT -H "cache-control: no-cache" -H "content-type: application/json" -H "Authorization: Bearer $token" "https://{cpd_cluster_host}{:port}/icp4data-databases/dv/{namespace}/dvapiserver/v2/security/policy/status?status=enabled"
Get policy enforcement status
Get policy enforcement status, return enabled or disabled
GET /dvapiserver/v2/security/policy/status