NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Authentication/API Key (Machine 2 Machine) → Revoke API Key

AI-generated

Summary

Revoke an authentication API key

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • RevokeApikey__path__key_id (required) — Identifier of the API key to revoke

Output shape

no body — success/failure only

HTTP 204 on success; errors return standard HTTP error codes with a message body

Examples

Example 1: Revoke a key by its ID

Set Key ID to the target key’s ID; leave Refresh Dropdown Cache as false (default)

Example 2: Refresh dropdown cache before revocation

Enable Refresh Dropdown Cache; optionally specify Key ID

Example 3: Attempt revocation without a Key ID

Leave Key ID empty — operation fails because the field is required

Links

Discussion