--- title: "Update a socket by ID" method: PUT path: "/socket/{socket_id_or_name}" --- # Update a socket by ID `PUT /socket/{socket_id_or_name}` ## Request - Base URL: `https://api.border0.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.border0.com/socket/{socket_id_or_name}` - Auth: API key in header `Authorization` ## Path parameters - `socket_id_or_name` string, required ## Request body - V1UpdateSocketRequest - `cloud_authentication_email_allowed_addressses` string[] - `cloud_authentication_email_allowed_domains` string[] - `connector_authentication_enabled` boolean - `connector_data` ModelsConnectorData - `config` ServiceConfiguration - `aws_access_service_configuration` ServiceAwsAccessServiceConfiguration - `aws_accounts` ServiceAwsAccount[] - `aws_account_alias` string - `aws_account_id` string - `aws_iam_roles` ServiceAwsIamRole[] - `arn` string - `description` string - `name` string - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `aws_s3_service_configuration` ServiceAwsS3ServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `bucket_allowlist` string[] - `database_service_configuration` ServiceDatabaseServiceConfiguration - `aws_documentdb_database_service_configuration` ServiceAwsDocumentDBDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `iam_auth_configuration` ServiceMongoAWSAuthConfiguration - `aws_credentials` CommonAwsCredentials - … - `ca_certificate` string - `cluster_region` string - `port` integer - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `aws_rds_database_service_configuration` ServiceAwsRdsDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `iam_auth_configuration` ServiceAwsRdsIamAuthConfiguration - `aws_credentials` CommonAwsCredentials - … - `ca_certificate` string - `rds_instance_region` string - `username` string - `port` integer - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `azure_sql_database_service_configuration` ServiceAzureSqlDatabaseServiceConfiguration - `azure_active_directory_integrated_configuration` object - `azure_active_directory_password_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `hostname` string - `kerberos_configuration` ServiceDatabaseKerberosAuthConfiguration - `password` string - `username` string - `port` integer - `protocol` string - `sql_authentication_configuration` ServiceDatabaseSqlAuthConfiguration - `password` string - `username` string - `database_service_type` string - `gcp_cloudsql_database_service_configuration` ServiceGcpCloudSqlDatabaseServiceConfiguration - `cloudsql_connector_configuration` ServiceGcpCloudSqlConnectorAuthConfiguration - `gcp_credentials_json` string - `instance_id` string - `password` string - `username` string - `cloudsql_connector_iam_configuration` ServiceGcpCloudSqlConnectorIamAuthConfiguration - `gcp_credentials_json` string - `instance_id` string - `username` string - `hostname` string - `port` integer - `protocol` string - `tls_auth_configuration` ServiceDatabaseTlsAuthConfiguration - `ca_certificate` string - `certificate` string - `key` string - `password` string - `username` string - `username_and_password_auth_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `mongodb_atlas_database_service_configuration` ServiceMongoDBAtlasDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string: Hostname is the MongoDB Atlas cluster hostname (e.g., cluster0.xxxxx.mongodb.net) Note: Port is not used for Atlas as it uses SRV records - `iam_auth_configuration` ServiceMongoAWSAuthConfiguration - `aws_credentials` CommonAwsCredentials - … - `ca_certificate` string - `cluster_region` string - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `standard_database_service_configuration` ServiceStandardDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `kerberos_configuration` ServiceDatabaseKerberosAuthConfiguration - `password` string - `username` string - `port` integer - `protocol` string - `sql_authentication_configuration` ServiceDatabaseSqlAuthConfiguration - `password` string - `username` string - `tls_auth_configuration` ServiceDatabaseTlsAuthConfiguration - `ca_certificate` string - `certificate` string - `key` string - `password` string - `username` string - `username_and_password_auth_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `elasticsearch_service_configuration` ServiceElasticsearchServiceConfiguration - `elasticsearch_service_type` string - `standard_elasticsearch_service_configuration` ServiceStandardElasticsearchServiceConfiguration - `authentication_type` string - `basic_auth_configuration` ServiceElasticsearchServiceTypeBasicAuth - `password` string - `username` string - `host_header` string - `hostname` string - `port` integer - `protocol` string - `exit_node_service_configuration` ServiceExitNodeServiceConfiguration - `http_service_configuration` ServiceHttpServiceConfiguration - `fileserver_http_service_configuration` ServiceFileServerHttpServiceConfiguration - `top_level_directory` string - `http_service_type` string - `standard_http_service_configuration` ServiceStandardHttpServiceConfiguration - `headers` ServiceHeader[] - `key` string - `value` string - `host_header` string - `hostname` string - `port` integer - `scheme` string - `kubernetes_service_configuration` ServiceKubernetesServiceConfiguration - `aws_eks_kubernetes_service_configuration` ServiceAwsEksKubernetesServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `eks_cluster_name` string - `eks_cluster_region` string - `impersonation_enabled` boolean - `kubernetes_service_type` string - `standard_kubernetes_service_configuration` ServiceStandardKubernetesServiceConfiguration - `certificate_authority` string - `certificate_authority_data` string - `client_certificate` string: for the kubernetes api server to authenticate the connector with client certificates - `client_certificate_data` string - `client_key` string - `client_key_data` string - `context` string - `kubeconfig_path` string: for the connector to load config from the filesystem - `server` string: for the connector to communicate to the kubernetes api server - `token` string: for the kubernetes api server to authenticate the connector with a token - `token_file` string - `rdp_service_configuration` ServiceRdpServiceConfiguration - `domain` string - `hostname` string - `password` string - `port` integer - `username` string - `service_type` string - `snowflake_service_configuration` ServiceSnowflakeServiceConfiguration - `account` string - `password` string - `username` string - `ssh_service_configuration` ServiceSshServiceConfiguration - `aws_ec2ic_ssh_service_configuration` ServiceAwsEc2ICSshServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ec2_instance_connect_endpoint_id` string - `ec2_instance_id` string - `ec2_instance_region` string - `hostname` string - `port` integer - `username` string - `username_provider` string - `aws_ssm_ssh_service_configuration` ServiceAwsSsmSshServiceConfiguration - `aws_ssm_ec2_target_configuration` ServiceAwsSsmEc2TargetConfiguration - `aws_credentials` CommonAwsCredentials - … - `ec2_instance_id` string - `ec2_instance_region` string - `aws_ssm_ecs_target_configuration` ServiceAwsSsmEcsTargetConfiguration - `aws_credentials` CommonAwsCredentials - … - `ecs_cluster_name` string - `ecs_cluster_region` string - `ecs_service_name` string - `ssm_target_type` string - `built_in_ssh_service_configuration` ServiceBuiltInSshServiceConfiguration - `username` string - `username_provider` string - `docker_exec_ssh_service_configuration` ServiceDockerExecSshServiceConfiguration - `container_name_allowlist` string[] - `kubectl_exec_ssh_service_configuration` ServiceKubectlExecSshServiceConfiguration - `aws_eks_kubectl_exec_target_configuration` ServiceAwsEksKubectlExecTargetConfiguration - `aws_credentials` CommonAwsCredentials - … - `eks_cluster_name` string - `eks_cluster_region` string - `kubectl_exec_target_type` string - `namespace_allowlist` string[]: slice of allowed namespaces. - `namespace_selectors_allowlist` object: map of namespace to selectors in that namespace. - `standard_kubectl_exec_target_configuration` ServiceStandardKubectlExecTargetConfiguration - `kubeconfig_path` string - `master_url` string - `ssh_service_type` string - `standard_ssh_service_configuration` ServiceStandardSshServiceConfiguration - `border0_certificate_auth_configuration` ServiceBorder0CertificateAuthConfiguration - `username` string - `username_provider` string - `hostname` string - `port` integer - `private_key_auth_configuration` ServicePrivateKeyAuthConfiguration - `private_key` string - `username` string - `username_provider` string - `ssh_authentication_type` string - `username_and_password_auth_configuration` ServiceUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `username_provider` string - `subnet_router_service_configuration` ServiceSubnetRouterServiceConfiguration - `dns_patterns` string[] - `ipv4_cidr_ranges` string[] - `ipv6_cidr_ranges` string[] - `subnet_routes_service_configuration` ServiceSubnetRouterServiceConfiguration - `dns_patterns` string[] - `ipv4_cidr_ranges` string[] - `ipv6_cidr_ranges` string[] - `tls_service_configuration` ServiceTlsServiceConfiguration - `http_proxy_tls_service_configuration` ServiceHttpProxyTlsServiceConfiguration - `host_allowlist` string[] - `standard_tls_service_configuration` ServiceStandardTlsServiceConfiguration - `hostname` string - `port` integer - `tls_service_type` string - `vpn_tls_service_configuration` ServiceVpnTlsServiceConfiguration - `routes` string[] - `vpn_subnet` string - `vnc_service_configuration` ServiceVncServiceConfiguration - `hostname` string - `password` string - `port` integer - `vpn_service_configuration` ServiceVpnServiceConfiguration - `advertised_routes` string[] - `dhcp_pool_subnet` string - `connector_id` string - `connector_id` string - `connector_ids` string[] - `custom_domains` string[] - `description` string - `display_name` string - `name` string - `org_custom_domain` string - `recording_enabled` boolean - `socket_type` string - `tags` object - `upstream_ca` string - `upstream_cert` string - `upstream_configuration` ServiceConfiguration - `aws_access_service_configuration` ServiceAwsAccessServiceConfiguration - `aws_accounts` ServiceAwsAccount[] - `aws_account_alias` string - `aws_account_id` string - `aws_iam_roles` ServiceAwsIamRole[] - `arn` string - `description` string - `name` string - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `aws_s3_service_configuration` ServiceAwsS3ServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `bucket_allowlist` string[] - `database_service_configuration` ServiceDatabaseServiceConfiguration - `aws_documentdb_database_service_configuration` ServiceAwsDocumentDBDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `iam_auth_configuration` ServiceMongoAWSAuthConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ca_certificate` string - `cluster_region` string - `port` integer - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `aws_rds_database_service_configuration` ServiceAwsRdsDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `iam_auth_configuration` ServiceAwsRdsIamAuthConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ca_certificate` string - `rds_instance_region` string - `username` string - `port` integer - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `azure_sql_database_service_configuration` ServiceAzureSqlDatabaseServiceConfiguration - `azure_active_directory_integrated_configuration` object - `azure_active_directory_password_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `hostname` string - `kerberos_configuration` ServiceDatabaseKerberosAuthConfiguration - `password` string - `username` string - `port` integer - `protocol` string - `sql_authentication_configuration` ServiceDatabaseSqlAuthConfiguration - `password` string - `username` string - `database_service_type` string - `gcp_cloudsql_database_service_configuration` ServiceGcpCloudSqlDatabaseServiceConfiguration - `cloudsql_connector_configuration` ServiceGcpCloudSqlConnectorAuthConfiguration - `gcp_credentials_json` string - `instance_id` string - `password` string - `username` string - `cloudsql_connector_iam_configuration` ServiceGcpCloudSqlConnectorIamAuthConfiguration - `gcp_credentials_json` string - `instance_id` string - `username` string - `hostname` string - `port` integer - `protocol` string - `tls_auth_configuration` ServiceDatabaseTlsAuthConfiguration - `ca_certificate` string - `certificate` string - `key` string - `password` string - `username` string - `username_and_password_auth_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `mongodb_atlas_database_service_configuration` ServiceMongoDBAtlasDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string: Hostname is the MongoDB Atlas cluster hostname (e.g., cluster0.xxxxx.mongodb.net) Note: Port is not used for Atlas as it uses SRV records - `iam_auth_configuration` ServiceMongoAWSAuthConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ca_certificate` string - `cluster_region` string - `protocol` string - `username_and_password_auth_configuration` ServiceUsernamePasswordCaAuthConfiguration - `ca_certificate` string - `password` string - `username` string - `standard_database_service_configuration` ServiceStandardDatabaseServiceConfiguration - `authentication_type` string - `database_name` string - `hostname` string - `kerberos_configuration` ServiceDatabaseKerberosAuthConfiguration - `password` string - `username` string - `port` integer - `protocol` string - `sql_authentication_configuration` ServiceDatabaseSqlAuthConfiguration - `password` string - `username` string - `tls_auth_configuration` ServiceDatabaseTlsAuthConfiguration - `ca_certificate` string - `certificate` string - `key` string - `password` string - `username` string - `username_and_password_auth_configuration` ServiceDatabaseUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `elasticsearch_service_configuration` ServiceElasticsearchServiceConfiguration - `elasticsearch_service_type` string - `standard_elasticsearch_service_configuration` ServiceStandardElasticsearchServiceConfiguration - `authentication_type` string - `basic_auth_configuration` ServiceElasticsearchServiceTypeBasicAuth - `password` string - `username` string - `host_header` string - `hostname` string - `port` integer - `protocol` string - `exit_node_service_configuration` ServiceExitNodeServiceConfiguration - `http_service_configuration` ServiceHttpServiceConfiguration - `fileserver_http_service_configuration` ServiceFileServerHttpServiceConfiguration - `top_level_directory` string - `http_service_type` string - `standard_http_service_configuration` ServiceStandardHttpServiceConfiguration - `headers` ServiceHeader[] - `key` string - `value` string - `host_header` string - `hostname` string - `port` integer - `scheme` string - `kubernetes_service_configuration` ServiceKubernetesServiceConfiguration - `aws_eks_kubernetes_service_configuration` ServiceAwsEksKubernetesServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `eks_cluster_name` string - `eks_cluster_region` string - `impersonation_enabled` boolean - `kubernetes_service_type` string - `standard_kubernetes_service_configuration` ServiceStandardKubernetesServiceConfiguration - `certificate_authority` string - `certificate_authority_data` string - `client_certificate` string: for the kubernetes api server to authenticate the connector with client certificates - `client_certificate_data` string - `client_key` string - `client_key_data` string - `context` string - `kubeconfig_path` string: for the connector to load config from the filesystem - `server` string: for the connector to communicate to the kubernetes api server - `token` string: for the kubernetes api server to authenticate the connector with a token - `token_file` string - `rdp_service_configuration` ServiceRdpServiceConfiguration - `domain` string - `hostname` string - `password` string - `port` integer - `username` string - `service_type` string - `snowflake_service_configuration` ServiceSnowflakeServiceConfiguration - `account` string - `password` string - `username` string - `ssh_service_configuration` ServiceSshServiceConfiguration - `aws_ec2ic_ssh_service_configuration` ServiceAwsEc2ICSshServiceConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ec2_instance_connect_endpoint_id` string - `ec2_instance_id` string - `ec2_instance_region` string - `hostname` string - `port` integer - `username` string - `username_provider` string - `aws_ssm_ssh_service_configuration` ServiceAwsSsmSshServiceConfiguration - `aws_ssm_ec2_target_configuration` ServiceAwsSsmEc2TargetConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ec2_instance_id` string - `ec2_instance_region` string - `aws_ssm_ecs_target_configuration` ServiceAwsSsmEcsTargetConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `ecs_cluster_name` string - `ecs_cluster_region` string - `ecs_service_name` string - `ssm_target_type` string - `built_in_ssh_service_configuration` ServiceBuiltInSshServiceConfiguration - `username` string - `username_provider` string - `docker_exec_ssh_service_configuration` ServiceDockerExecSshServiceConfiguration - `container_name_allowlist` string[] - `kubectl_exec_ssh_service_configuration` ServiceKubectlExecSshServiceConfiguration - `aws_eks_kubectl_exec_target_configuration` ServiceAwsEksKubectlExecTargetConfiguration - `aws_credentials` CommonAwsCredentials - `aws_access_key_id` string - `aws_profile` string - `aws_secret_access_key` string - `aws_session_token` string - `eks_cluster_name` string - `eks_cluster_region` string - `kubectl_exec_target_type` string - `namespace_allowlist` string[]: slice of allowed namespaces. - `namespace_selectors_allowlist` object: map of namespace to selectors in that namespace. - `standard_kubectl_exec_target_configuration` ServiceStandardKubectlExecTargetConfiguration - `kubeconfig_path` string - `master_url` string - `ssh_service_type` string - `standard_ssh_service_configuration` ServiceStandardSshServiceConfiguration - `border0_certificate_auth_configuration` ServiceBorder0CertificateAuthConfiguration - `username` string - `username_provider` string - `hostname` string - `port` integer - `private_key_auth_configuration` ServicePrivateKeyAuthConfiguration - `private_key` string - `username` string - `username_provider` string - `ssh_authentication_type` string - `username_and_password_auth_configuration` ServiceUsernameAndPasswordAuthConfiguration - `password` string - `username` string - `username_provider` string - `subnet_router_service_configuration` ServiceSubnetRouterServiceConfiguration - `dns_patterns` string[] - `ipv4_cidr_ranges` string[] - `ipv6_cidr_ranges` string[] - `subnet_routes_service_configuration` ServiceSubnetRouterServiceConfiguration - `dns_patterns` string[] - `ipv4_cidr_ranges` string[] - `ipv6_cidr_ranges` string[] - `tls_service_configuration` ServiceTlsServiceConfiguration - `http_proxy_tls_service_configuration` ServiceHttpProxyTlsServiceConfiguration - `host_allowlist` string[] - `standard_tls_service_configuration` ServiceStandardTlsServiceConfiguration - `hostname` string - `port` integer - `tls_service_type` string - `vpn_tls_service_configuration` ServiceVpnTlsServiceConfiguration - `routes` string[] - `vpn_subnet` string - `vnc_service_configuration` ServiceVncServiceConfiguration - `hostname` string - `password` string - `port` integer - `vpn_service_configuration` ServiceVpnServiceConfiguration - `advertised_routes` string[] - `dhcp_pool_subnet` string - `upstream_http_hostname` string - `upstream_key` string - `upstream_password` string - `upstream_type` string - `upstream_username` string ## Response `200` OK - SerializerSocket - `alive` boolean - `autocreation_rule_id` integer - `cloud_authentication_email_allowed_addressses` string[] - `cloud_authentication_email_allowed_domains` string[] - `cloud_authentication_enabled` boolean - `connector_authentication_enabled` boolean - `connector_managed` boolean - `connectors` SerializerSlimConnector[] - `connector_id` string - `name` string - `public_ips` SerializerPublicIP[] - `ip` string - `metadata` MetadataIPMetadata - `city_name` string - `country_code` string - `country_name` string - `isp` string - `latitude` number - `longitude` number - `region_code` string - `region_name` string - `custom_domains` string[] - `description` string - `display_name` string - `dnsname` string - `end_to_end_encryption_enabled` boolean - `messages` SerializerMessage[] - `level` string - `text` string - `type` string - `name` string - `org_custom_domain` string - `policies` SerializerPolicy[] - `created_at` string - `deleted` boolean - `description` string - `expires` boolean - `expires_at` string - `id` string - `messages` SerializerMessage[] - `level` string - `text` string - `type` string - `name` string - `org_id` string - `org_wide` boolean - `policy_data` DatatypesJSONMap - `read_only` boolean - `socket_ids` string[] - `tag_rules` object[] - `version` string - `private_network_enabled` boolean - `private_network_ipv4` string - `private_network_ipv6` string - `private_socket` boolean - `protected_password` string - `protected_socket` boolean - `protected_username` string - `recording_enabled` boolean - `socket_id` string - `socket_tcp_ports` integer[] - `socket_type` string - `ssh_ca` string - `sshkey` string - `tags` object - `tunnels` SerializerTunnel[] - `local_port` integer - `tunnel_id` string - `tunnel_server` string - `upstream_ca` string - `upstream_cert` string - `upstream_http_hostname` string - `upstream_key` string - `upstream_password` string - `upstream_type` string - `upstream_username` string - `user_name` string ## Other responses - `400`: Bad Request - `401`: Unauthorized - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/border0/apis/border0-api.md) - [All operations](https://skmtc.dev/border0/apis/border0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/border0/apis/border0-api/revisions/f0ccef7418d8?raw)