SSH Authorization Rules APIs

Manage SSH key authorization rules. This interface is valid only if you purchased SSH Manager.

A rule is an account on a host, together with the SSH keys that can log in to that account. Use these endpoints to find and review rules, hosts and keys, decide which keys are authorized under a rule, and control how each rule is enforced.

📄️ Search hosts

Returns the hosts that have reported SSH keys, most recently seen first.

📄️ Search keys

Returns the SSH keys in the inventory, most recently seen first. Keys used only to sign other keys

📄️ Search rules

Returns the SSH authorization rules that match the filters. A rule is an account on a host, together

📄️ Get a rule

Returns one rule and a page of its keys. The rule is identified by HostId and Account.

📄️ Get the impact of revoking a key

Returns how many rules and hosts would be affected if the key were revoked. Call this before

📄️ Revoke a key

Revokes the key everywhere. The key is refused under every rule that has it. This API provides no way

📄️ Allow a key within a rule

Allows the key under the rule identified by HostId and Account. Other rules with the same key are not

📄️ Deny a key within a rule

Denies the key under the rule identified by HostId and Account. Other rules with the same key are not

📄️ Switch a rule to Enforce mode

Switches the rule identified by HostId and Account to Enforce mode. In Enforce mode, the rule refuses

📄️ Switch a rule to Observe mode

Switches the rule identified by HostId and Account to Observe mode. In Observe mode, the rule records