Delete Key

locationservice_delete_key

R Documentation

Deletes the specified API key¶

Description¶

Deletes the specified API key. The API key must have been deactivated more than 90 days previously.

Usage¶

locationservice_delete_key(KeyName, ForceDelete)

Arguments¶

KeyName

[required] The name of the API key to delete.

ForceDelete

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Value¶

An empty list.

Request syntax¶

svc$delete_key(
  KeyName = "string",
  ForceDelete = TRUE|FALSE
)