delete-api-key

Estimated time to read: 1 minute

Experimental-feature notice

This page discusses experimental features. Experimental features are still in progress, and you may encounter bugs or unexpected behavior when using them.

If you experience an issue or want to know more about this feature's status, reach out to us at Era Software.

This command deletes a provided API key ID from EraSearch.

Warning

This command requires the security database permission.

usage: eractl rbac delete-api-key [-h] [--url URL] [--key KEY] api_key_id

positional arguments:
  api_key_id  ID of the API key to remove

optional arguments:
  -h, --help  show this help message and exit
  --url URL   EraSearch URL, set via environment with ERACTL_URL (default: http://localhost:9200)
  --key KEY   EraSearch API key, set via environment with ERACTL_API_KEY (default: None)

To run:

eractl rbac delete-api-key $API_KEY_ID --url https://erasearch.example.com --key ******

Or to pass arguments from the environment:

export ERACTL_URL="https://erasearch.example.com"
export ERACTL_API_KEY="******"
eractl rbac delete-api-key $API_KEY_ID

Examples¶

To list API keys in the system and then delete a particular API key by ID:

eractl rbac list-api-keys

eractl rbac delete-api-key 6

Last update: January 24, 2023