AKakeyless
Secure Remote Access

POST /connect

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/connect
  • Auth
    none declared

Request body

HelperConnectHepler
RcFileOverridestring

used to override .akeyless-connect.rc in tests

bastion-ctrl-pathstring

Deprecated. use bastion-ctrl-path

bastion-ctrl-portstring

Deprecated. use sra-ctrl-port

bastion-ctrl-protostring

Deprecated. use sra-ctrl-proto

bastion-ctrl-subdomainstring

Deprecated. use sra-ctrl-subdomain

cert-issuer-namestring

The Akeyless certificate issuer name

gateway-urlstring

The Gateway URL (configuration management) address, e.g. http://localhost:8000

identity-filestring

The file from which the identity (private key) for public key authentication is read

jsonboolean

Set output format to JSON

justificationstring
namestring

The Secret name (for database and AWS producers - producer name)

requested-ttlinteger

For how long to grant the requested access, in minutes

sra-ctrl-pathstring

The Bastion API path

sra-ctrl-portstring

The Bastion API Port

sra-ctrl-protostring

The SRA API protocol

sra-ctrl-subdomainstring

The SRA API prefix

ssh-commandstring

Path to SSH executable. e.g. /usr/bin/ssh

ssh-extra-argsstring

Additional SSH arguments (except -i)

ssh-legacy-signing-algboolean

Set this option to output legacy ('ssh-rsa-cert-v01@openssh.com') signing algorithm name in the ssh certificate.

targetstring

The target

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

use-ssh-agentboolean

Deprecated

via-bastionstring

Deprecated. Use via-sra

via-srastring

The jump box server

Response

connectResponse wraps response body.

ConnectOutput required

Changes

No recorded changes to this operation across all 1 revision of this API.