---
title: "POST /gateway-get-remote-access"
method: POST
path: "/gateway-get-remote-access"
tags: ["v2"]
---

# POST /gateway-get-remote-access

`POST /gateway-get-remote-access`

## Request body

- GatewayGetRemoteAccess — gatewayGetRemoteAccess is a command that returns remote access config
  - `json` boolean — Set output format to JSON
  - `token` string — Authentication token (see `/auth` and `/configure`)
  - `uid-token` string — The universal identity token, Required only for universal_identity authentication

## Response `200`

gatewayGetRemoteAccessResponse wraps response body.

- BastionConfigReplyObj
  - `cluster_id` string
  - `desktop_app` SraDesktopAppConf
    - `default_cert_issuer_id` integer
    - `secure_web_access_url` string
    - `secure_web_proxy_url` string
  - `gator_cluster_id` integer
  - `global` BastionGlobalConf
    - `allowed_bastion_urls` string[]
    - `allowed_ssh_url` string
    - `default_session_ttl_minutes` integer
    - `legacy_signing_alg` boolean
    - `rdp_username_sub_claim` string
    - `ssh_username_sub_claim` string
  - `ssh_bastion` SshBastionConf
    - `hide_session_recording` boolean
    - `kexalgs` string
    - `log_forwarding` LogForwardingConfigPart
      - `aws_s3_config` AwsS3LogForwardingConfig
        - `aws_access_id` string
        - `aws_access_key` string
        - `aws_auth_type` string
        - `aws_region` string
        - `aws_role_arn` string
        - `aws_use_gateway_cloud_identity` boolean — deprecated
        - `bucket_name` string
        - `log_folder` string
      - `azure_analytics_config` AzureLogAnalyticsForwardingConfig
        - `azure_enable_batch` string
        - `azure_workspace_id` string
        - `azure_workspace_key` string
      - `datadog_config` DatadogForwardingConfig
        - `datadog_api_key` string
        - `datadog_host` string
        - `datadog_log_service` string
        - `datadog_log_source` string
        - `datadog_log_tags` string
      - `elasticsearch_config` ElasticsearchLogForwardingConfig
        - `elasticsearch_api_key` string
        - `elasticsearch_auth_type` string
        - `elasticsearch_cloud_id` string
        - `elasticsearch_enable_tls` boolean
        - `elasticsearch_index` string
        - `elasticsearch_nodes` string
        - `elasticsearch_password` string
        - `elasticsearch_server_type` string
        - `elasticsearch_tls_certificate` string
        - `elasticsearch_user_name` string
      - `google_chronicle_config` GoogleChronicleForwardingConfig
        - `customer_id` string
        - `log_type` string
        - `region` string
        - `service_account_key` string
      - `json_output` boolean
      - `logan_enable` boolean
      - `logan_url` string
      - `logstash_config` LogstashLogForwardingConfig
        - `logstash_dns` string
        - `logstash_enable_tls` boolean
        - `logstash_protocol` string
        - `logstash_tls_certificate` string
      - `logz_io_config` LogzIoLogForwardingConfig
        - `target_logz_io_protocol` string
        - `target_logz_io_token` string
      - `pull_interval_sec` string
      - `splunk_config` SplunkLogForwardingConfig
        - `splunk_enable_batch` string
        - `splunk_enable_tls` boolean
        - `splunk_index` string
        - `splunk_source` string
        - `splunk_sourcetype` string
        - `splunk_tls_certificate` string
        - `splunk_token` string
        - `splunk_url` string
      - `sumo_logic_config` SumologicLogForwardingConfig
        - `sumo_logic_endpoint` string
        - `sumo_logic_host` string
        - `sumo_logic_tags` string
      - `syslog_config` SyslogLogForwardingConfig
        - `syslog_enable_tls` boolean
        - `syslog_formatter` string
        - `syslog_host` string
        - `syslog_network` string
        - `syslog_target_tag` string
        - `syslog_tls_certificate` string
      - `target_log_type` string
    - `session_termination` SshBastionSessionTermination
      - `api_password` string
      - `api_token` string
      - `api_url` string
      - `api_username` string
      - `enabled` boolean
  - `web_bastion` WebBastionConf
    - `guacamole` WebBastionGuacamole
      - `keyboard_layout` string
    - `rdp_record` WebBastionRdpRecord
      - `aws` AwsStorage
        - `access_key_id` string — creds
        - `access_key_secret` string
        - `auth_type` string
        - `bucket` string
        - `endpoint_url` string
        - `prefix` string
        - `region` string
      - `azure` AzureStorage
        - `auth_type` string
        - `client_id` string
        - `client_secret` string
        - `storage_account` string
        - `storage_container_name` string
        - `tenant_id` string — creds
      - `compress` boolean
      - `encryption_key` string
      - `netapp` NetappStorage
        - `access_key_id` string
        - `access_key_secret` string
        - `auth_type` string
        - `bucket` string
        - `endpoint_url` string
        - `prefix` string
        - `region` string
      - `recording_quality` string
      - `storage_type` string

## 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/revisions/0ceb25634501/schema)