Get an SSH security zone

get https://{sandfly-api-host}/v4/sshhunter/zones/{id}

Get details of an SSH security zone by ID.

Responses

Response body

object

host_policies

array of objects

required

host_policies*

object

mode

string

required

The type of tag list this is: include items with the tag(s), or exclude items with the tag(s).

include except

tags

array of strings

required

Host tags

tags*

violation_key_count

integer

required

The number of keys on this host that are in violation of security zone policy.

banned_keys_count

integer

required

The number of banned key entries found on this host.

included_keys

array of objects

required

Keys that are included in this SSH zone.

included_keys*

object

ssh_public_key_id

integer

required

SSH key ID

key_friendly_name

string

required

Key friendly name

key_type

string

required

Key type

bits

integer

required

Key strength

first_seen

date-time | null

required

Date Sandfly first saw this key

last_seen

date-time | null

required

Date Sandfly last saw this key

key_tags

array of strings

required

Key tags

key_tags*

num_hosts_current

integer

required

Number of hosts currently using this key.

num_users_current

integer

required

Number of users currently using this key.

name

string

required

Name of this SSH zone.

description

string

required

Description for this SSH zone.

hosts_count

integer

required

Number of hosts in this zone.

permitted_keys_count

integer

required

The number of keys this zone allows on hosts.

violation_host_count

integer

required

The number of hosts in this zone that current have one or more keys in violation of zone policies.

banned_keys_count

integer

required

The number of banned key entries found on hosts in this zone.

integer

required

Database-assigned ID of this SSH zone.

create_date

date-time

required

Date this SSH zone was created.

modification_date

date-time

required

Date this SSH zone was last modified.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandfly-api-host/v4/sshhunter/zones/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200SSH security zone details retrieved.

404SSH security zone not found.

defaultUnexpected error