---
title: "POST /connect"
method: POST
path: "/connect"
tags: ["v2"]
---

# POST /connect

`POST /connect`

## Request body

- Connect — Connect is a command that performs secure remote access
  - `Helper` ConnectHepler
  - `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 — 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 — The Bastion API Port
  - `sra-ctrl-proto` string — 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 — Set this option to output legacy ('ssh-rsa-cert-v01@openssh.com') 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

## Response `200`

connectResponse wraps response body.

- ConnectOutput

## Other responses

- `default` — errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.net/akeyless/apis/akeyless-api.md) · [All operations](https://skmtc.net/akeyless/apis/akeyless-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeyless/akeyless-api/versions/0ceb25634501/schema)