Classic RESTful Services Utility Command Mapping

Oracle Key Vault release 21.1 introduced a new RESTful services utility with a redesigned command structure that differs from the Classic RESTful services utility.

Classic RESTful services are deprecated starting with Oracle Key Vault release 21.5. You can use the new RESTful services utility introduced with Oracle Key Vault release 21.1.

Note: Do not use Java Development Toolkit (JDK) 9, 10, or 19 with Classic RESTful services utility. Using these JDK versions with Classic RESTful Services may result in an exception.

The Classic RESTful services utility commands enable you to work with endpoints, endpoint groups, wallets, keys, and security objects. The following table describes the equivalent commands in the new Oracle Key Vault RESTful services utility.

Classic RESTful services utility command Equivalent command in the new RESTful services utility
activate okv managed-object object activate
add_attr okv managed-object attribute add
add_custom_attr okv managed-object custom-attribute add
add_epg_member okv manage-access endpoint-group add-endpoint
add_member okv managed-object wallet add-member
add_wallet_access_ep An option in okv manage-access wallet add-access
add_wallet_access_epg An option in okv manage-access wallet add-access
check_object_status Covered by the following commands:
- okv admin endpoint check-status
- okv manage-access endpoint-group check-status
- okv manage-access wallet check-status
create_endpoint okv admin endpoint create
create_endpoint_group okv manage-access endpoint-group create
create_key okv managed-object key create
create_unique_endpoint As an option in okv admin endpoint create
create_unique_endpoint_group As an option in okv manage-access endpoint-group create
create_unique_wallet As an option in okv manage-access wallet create
create_wallet okv manage-access wallet create
del_attr okv managed-object attribute delete
del_custom_attr okv managed-object custom-attribute delete
del_member okv managed-object wallet delete-member
delete_endpoint okv admin endpoint delete
delete_endpoint_group okv manage-access endpoint-group delete
delete_wallet okv manage-access wallet delete
destroy okv managed-object object destroy
download okv admin endpoint download
drop_epg_member okv manage-access endpoint-group remove-endpoint
drop_wallet_access_ep An option in okv manage-access wallet remove-access
drop_wallet_access_epg An option in okv manage-access wallet remove-access
get_attr okv managed-object attribute get
get_cert okv managed-object certificate get
get_default_wallet okv manage-access wallet get-default
get_enrollment_token okv admin endpoint get-enrollment-token
get_key okv managed-object key get
get_opaque okv managed-object opaque get
get_secret okv managed-object secret get
get_system_info Covered by the following commands:
- okv cluster info get
- okv primary-standby info get
- okv server info get
get_wallets okv manage-access wallet list-endpoint-wallets
list_attr okv managed-object attribute list
list_wallet okv managed-object wallet list
locate okv managed-object object locate
mod_attr okv managed-object attribute modify
mod_custom_attr okv managed-object custom-attribute modify
modify_endpoint_desc An option in okv admin endpoint update
modify_endpoint_email An option in okv admin endpoint update
modify_endpoint_group_desc An option in okv manage-access endpoint-group update
modify_endpoint_group_name An option in okv manage-access endpoint-group update
modify_endpoint_name An option in okv admin endpoint update
modify_endpoint_platform An option in okv admin endpoint update
modify_endpoint_type An option in okv admin endpoint update
modify_wallet_access_ep An option in okv manage-access wallet update-access
modify_wallet_access_epg An option in okv manage-access wallet update-access
modify_wallet_desc An option in okv manage-access wallet update
modify_wallet_name An option in okv manage-access wallet update
provision okv admin endpoint provision
query okv managed-object object query
re_enroll okv admin endpoint re-enroll
re_enroll_all okv admin endpoint re-enroll-all
reg_cert okv managed-object certificate register
reg_key okv managed-object key register
reg_opaque okv managed-object opaque register
reg_secret okv managed-object secret register
revoke okv managed-object object revoke
set_default_wallet okv manage-access wallet set-default

Note: The new RESTful services utility includes additional commands that were not available in the Classic RESTful services utility. These commands are documented in this guide.