/connect

post

https://api.akeyless.io/connect

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Helper

object

RcFileOverride

string

used to override .akeyless-connect.rc in tests

bastion-ctrl-path

string

Deprecated. use bastion-ctrl-path

bastion-ctrl-port

string

Deprecated. use sra-ctrl-port

bastion-ctrl-proto

string

Deprecated. use sra-ctrl-proto

bastion-ctrl-subdomain

string

Deprecated. use sra-ctrl-subdomain

cert-issuer-name

string

The Akeyless certificate issuer name

gateway-url

string

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

identity-file

string

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

json

boolean

Defaults to false

Set output format to JSON

justification

string

name

string

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

sra-ctrl-path

string

The Bastion API path

sra-ctrl-port

string

Defaults to 9900

The Bastion API Port

sra-ctrl-proto

string

Defaults to http

The SRA API protocol

sra-ctrl-subdomain

string

The SRA API prefix

ssh-command

string

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

ssh-extra-args

string

Additional SSH arguments (except -i)

ssh-legacy-signing-alg

boolean

Defaults to false

Set this option to output legacy ('[email protected]') signing algorithm name in the ssh certificate.

target

string

The target

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

use-ssh-agent

boolean

Deprecated

via-bastion

string

Deprecated. Use via-sra

via-sra

string

The jump box server

Responses

200connectResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.