Skip to main content
PATCH
/
api
/
v1
/
ssh-keys
/
{id}
Update SSH key
curl --request PATCH \
  --url https://neo.api.projectdiscovery.io/api/v1/ssh-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default_host": "<string>",
  "default_port": 32768,
  "default_username": "<string>",
  "name": "<string>",
  "password": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "default_host": "<string>",
  "default_port": 123,
  "default_username": "<string>",
  "fingerprint": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "public_key": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT authentication token

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
default_host
string

Default SSH host for connections using this key

Maximum string length: 255
​
default_port
integer

Default SSH port

Required range: 1 <= x <= 65535
​
default_username
string

Default SSH username for connections using this key

Maximum string length: 128
​
name
string

New unique name for this SSH connection

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$
​
password
string

New SSH password for password-based auth. Not accepted for generated-key auth.

Required string length: 1 - 1000

Response

SSH key updated successfully

​
algorithm
enum<string>
required
Available options:
ed25519,
rsa-2048,
rsa-4096,
ecdsa-256,
ecdsa-384,
ecdsa-521,
password
​
auth_type
enum<string>
required

Authentication type (key = generated key pair, password = password-based)

Available options:
key,
password
​
id
string<uuid>
required
​
name
string
required
​
created_at
string<date-time>
​
default_host
string | null
​
default_port
integer | null
​
default_username
string | null
​
fingerprint
string | null

SHA256 fingerprint of the public key (null for password auth)

​
project_id
string<uuid> | null
​
public_key
string | null

OpenSSH authorized_keys format public key (null for password auth)