---
title: "Creates a remote connection"
method: POST
path: "/remote_connections"
tags: ["remote_connections"]
---

# Creates a remote connection

`POST /remote_connections`

Creates a remote connection

## Request body

- RemoteConnectionIntentInput — An intentful representation of a remote_connection
  - `spec` RemoteConnection, required — Remote connection information.
    - `name` string, required — Remote connection name.
    - `resources` RemoteConnectionResources, required — Remote connection resources
      - `local_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `role` string — Role of the cluster in remote connection
      - `remote_address` Address — Host address.
        - `ip` string — IPV4 address.
        - `ipv6` string — IPV6 address.
        - `port` integer — Port Number
        - `fqdn` string — Fully qualified domain name.
      - `remote_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `remote_credential` RemoteConnectionCredential — Credentials to connect with remote endpoint
        - `auth_type` string — Type of credentials to use
        - `bearer_token` string — token to use with bearer authorization, must for BEARER auth_type
        - `basic_credential` BasicCredential — Basic Credentials to connect with remote endpoint
          - `username` string — username of authorized user on remote cluster, must for BASIC auth_type
          - `password` string — password of authorized user on remote cluster, must for BASIC auth_type
    - `description` string, required — Remote connection description
  - `api_version` string
  - `metadata` RemoteConnectionMetadata, required — The remote_connection kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when remote_connection was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — remote_connection uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when remote_connection was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the remote_connection
    - `name` string — remote_connection name

## Response `202`

Request Accepted

- RemoteConnectionIntentResponse — Response object for intentful operations on a remote_connection
  - `status` RemoteConnectionDefStatus — Remote connection status definition
    - `state` string — The state of the remote connection entity.
    - `message_list` MessageResource[]
      - `message` string, required — If state is ERROR, a message describing the error.
      - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
      - `details` object — Custom key-value details relevant to the status.
    - `name` string, required — Remote connection name
    - `resources` RemoteConnectionResources, required — Remote connection resources
      - `local_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `role` string — Role of the cluster in remote connection
      - `remote_address` Address — Host address.
        - `ip` string — IPV4 address.
        - `ipv6` string — IPV6 address.
        - `port` integer — Port Number
        - `fqdn` string — Fully qualified domain name.
      - `remote_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `remote_credential` RemoteConnectionCredential — Credentials to connect with remote endpoint
        - `auth_type` string — Type of credentials to use
        - `bearer_token` string — token to use with bearer authorization, must for BEARER auth_type
        - `basic_credential` BasicCredential — Basic Credentials to connect with remote endpoint
          - `username` string — username of authorized user on remote cluster, must for BASIC auth_type
          - `password` string — password of authorized user on remote cluster, must for BASIC auth_type
    - `description` string, required — Remote connection description
  - `spec` RemoteConnection — Remote connection information.
    - `name` string, required — Remote connection name.
    - `resources` RemoteConnectionResources, required — Remote connection resources
      - `local_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `role` string — Role of the cluster in remote connection
      - `remote_address` Address — Host address.
        - `ip` string — IPV4 address.
        - `ipv6` string — IPV6 address.
        - `port` integer — Port Number
        - `fqdn` string — Fully qualified domain name.
      - `remote_connection_info` RemoteConnectionInfo — Connection information
        - `node_address_list` Address[]
          - `ip` string — IPV4 address.
          - `ipv6` string — IPV6 address.
          - `port` integer — Port Number
          - `fqdn` string — Fully qualified domain name.
        - `token` RemoteConnectionToken — Token information for communicating with remote peer
          - `access_token` string — Access token
          - `client_secret` string — Client Secret
          - `refresh_token_endpoint` string — Refresh token endpoint
          - `refresh_token` string — Refresh token
          - `client_id` string — Client Id
        - `peer_remote_connection_uuid` string, UUID — Connection uuid for remote Peer
        - `cluster_uuid` string, UUID — UUID of cluster
        - `cluster_function` string — cluster function string
        - `additional_capabilities` string[]
      - `remote_credential` RemoteConnectionCredential — Credentials to connect with remote endpoint
        - `auth_type` string — Type of credentials to use
        - `bearer_token` string — token to use with bearer authorization, must for BEARER auth_type
        - `basic_credential` BasicCredential — Basic Credentials to connect with remote endpoint
          - `username` string — username of authorized user on remote cluster, must for BASIC auth_type
          - `password` string — password of authorized user on remote cluster, must for BASIC auth_type
    - `description` string, required — Remote connection description
  - `api_version` string, required
  - `metadata` RemoteConnectionMetadata, required — The remote_connection kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when remote_connection was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — remote_connection uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when remote_connection was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the remote_connection
    - `name` string — remote_connection name

## Other responses

- `default` — Internal Error

---

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