Add remote system login credentials

post https://{sandfly-api-host}/v4/credentials/{credentials_id}

Creates either an sshkey/sshkey password or username/password to an encrypted remote host credential record.

Path Params

credentials_id

string

required

credentials_id to create.

Body Params

Credentials json blob.

credentials_type

string

required

Supported Credential Types.

external_ca_cert_b64

string

If an external credential type, base64-encoded trusted root CA certificate for the credential provider service, if necessary.

external_extra_data

string

If an external credential type, extra data to provide to the credential provider service.

external_unique_per_host

boolean

If an external credential type, does the provider provide a unique credential per target host?

external_url

string

If an external credential type, the URL of the credential provider service.

password

string

This is the password we can use to login if using username credentials or needed for sudo.

ssh_key_b64

string

The ssh_key we can use to login that is base 64 encoded.

ssh_key_certificate_b64

string

The ssh_key_certificate if using SSH CA signed credentials.

ssh_key_password

string

This is the password used to decrypt the ssh_key if we have one.

username

string

This is the username we can use to login.

ima_signing_key_b64

string

Base64-encoded PKCS#1, PKCS#8, or encrypted PKCS#8 PEM-format RSA private key. If present on a credential, when the credential is used to connect to a host, Sandfly will add an IMA signature to the scanning binary on the target host using this private key.

ima_signing_key_password

string

If ima_signing_key_b64 contains an encrypted PKCS#8 private key, this password will be used to decrypt it. Do not set this property if ima_signing_key_b64 is empty.

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandfly-api-host/v4/credentials/credentials_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "credentials_type": "ssh_key"
8
}
9
'

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

application/json

201Remote credentials encrypted and inserted.

400Remote credentials already exist. Not overwritten.

defaultUnexpected error