Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
host
string

Host alias

hostName
string

HostName

user
string

User

port
number

Port

identityFile
string

IdentityFile

proxyJump
string

ProxyJump

serverAliveInterval
number

ServerAliveInterval

strictHostKeyChecking
enum<string>

StrictHostKeyChecking

Available options:
,
yes,
accept-new,
no,
ask
forwardAgent
boolean

ForwardAgent

identitiesOnly
boolean

IdentitiesOnly

addKeysToAgent
boolean

Add keys to agent automatically (Host * → AddKeysToAgent yes)

useKeychain
boolean

Store passphrases in macOS keychain (Host * → UseKeychain yes)

includeHeader
boolean

Include descriptive header comment

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.