BOborder0

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)
  • Auth
    API key in header Authorization

Path parameters

socket_id_or_namestring required

Socket ID or Name

Request body

cloud_authentication_email_allowed_addresssesstring[]
cloud_authentication_email_allowed_domainsstring[]
connector_authentication_enabledboolean
connector_idstring
connector_idsstring[]
custom_domainsstring[]
descriptionstring
display_namestring
namestring
org_custom_domainstring
recording_enabledboolean
socket_typestring
tagsobject
upstream_castring
upstream_certstring
upstream_http_hostnamestring
upstream_keystring
upstream_passwordstring
upstream_typestring
upstream_usernamestring

Response

OK

aliveboolean
autocreation_rule_idinteger
cloud_authentication_email_allowed_addresssesstring[]
cloud_authentication_email_allowed_domainsstring[]
cloud_authentication_enabledboolean
connector_authentication_enabledboolean
connector_managedboolean
custom_domainsstring[]
descriptionstring
display_namestring
dnsnamestring
end_to_end_encryption_enabledboolean
namestring
org_custom_domainstring
private_network_enabledboolean
private_network_ipv4string
private_network_ipv6string
private_socketboolean
protected_passwordstring
protected_socketboolean
protected_usernamestring
recording_enabledboolean
socket_idstring
socket_tcp_portsinteger[]
socket_typestring
ssh_castring
sshkeystring
tagsobject
upstream_castring
upstream_certstring
upstream_http_hostnamestring
upstream_keystring
upstream_passwordstring
upstream_typestring
upstream_usernamestring
user_namestring

Changes

No recorded changes to this operation across all 1 revision of this API.