Jump to Content
Documentation
Guides
API Reference
Documentation
Home
Portal
Status
API Reference
Home
Portal
Status
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
User login
Search
All
Pages
Start typing to search…
JUMP TO
Administrator Authentication
Authentication
/login
User login
post
/login/refresh
Refresh API token
post
/user
Register a new user
post
/user/confirm/{token}
Confirm and activate user with a temporary token
get
/user/{user_id}
Show user info by user ID
get
Update an existing user
put
Border0 API
/audit_actions
Show all audit logs from organization
get
/audit_actions/actors
Show all actors from a given organization
get
Client authentication
/client/ai_assistants/database
Generate SQL query from an input that has a question and database schemas
post
/client/auth/org/{slug}
Authenticate a client with headers against organization email
get
/client/cda/authorize
Authorizes a device authorization code.
post
/client/cda/get_token
Fetches a client token in exchange for a device authorization code previously authorized via the (OAuth2.0) client device authorization flow
get
/client/device_authorizations
Posts details for a device initiating a new (OAuth2.0) client device authorization flow in exchange for a one-time-use code
post
/client/resources
Show socket client resources
get
/organization/identity_provider
Add a custom identity provider to the current organization
post
Update a custom identity provider in the current organization
patch
/organization/identity_provider/{name}
Get a custom identity provider for the current organization
get
Remove a custom identity provider from the current organization
delete
/organization/identity_provider_status
Toggle the status (enable/disable) of an identity provider in the current organization
put
/organization/identity_providers
List all identity providers for the current organization
get
/organizations
Create a new organization
post
/organizations/csr
Generate a cert request and sign the CSR with organization CA
post
/organizations/customdomains
List all custom domains
get
Update a custom domain
put
Create a custom domain
post
Delete a custom domain
delete
/organizations/iam/service_accounts
Retrieve the list of all service accounts in the current organization.
get
Create a service account in the current organization.
post
/organizations/iam/service_accounts/{name}
Retrieve a service account in the current organization by name.
get
Update a service account in the current organization by name.
put
Delete a service account in the current organization.
delete
/organizations/iam/service_accounts/{name}/tokens
Retrieve a service account tokens based on a service account name.
get
Create a service account token in the current organization.
post
/organizations/iam/service_accounts/{name}/tokens/{token_id}
Delete a service account token in the current organization by service account name and token id.
delete
/organizations/notifications
List all notifications
get
Create a notification
post
/organizations/notifications/{name}
Describe a notification
get
Update a notification
put
Delete a notification
delete
/organizations/recording_storage
Verify the recording storage
get
Create a recording storage
post
Unset the organization's recording storage
delete
/organizations/settings
Update organization settings
put
/organizations/sign_ssh
Generate a signed SSH cert for organization
post
/organizations/switch
Switch Organization
post
/organizations/tokens
Disable an access token
get
Create a new access token
post
Disable an access token
delete
/organizations/users/leave
Leave an organization
put
/policies
get policies paginated
get
Create a new policy and attach sockets to them
post
/policies/find
find policies by a specific param
get
/policy/{uuid}
get a policy by id
get
Updates a policy but not updates the associations
put
delete a policy by id
delete
/sessions
Show all sessions from a organization
get
/sessions/stats/{stats_type}
Get session stats by type (locations, sockets, users)
get
/socket/{socket_id_or_name}
Show a socket by ID
get
Update a socket by ID
put
Delete a socket by ID
delete
/socket/{socket_id_or_name}/customcert
Show a custom cert from a socket
get
/socket/{socket_id_or_name}/evaluate
Evaluate policy for a socket
post
/socket/{socket_id_or_name}/signkey
Generate a signed cert for a tunnel
post
/socket/{socket_id_or_name}/tunnel
Show all tunnels from a socket
get
Create a socket tunnel
post
/socket/{socket_id_or_name}/tunnel/{tunnel_id}
Show one tunnel from a socket by socket ID and tunnel ID
get
Delete one tunnel from a socket by socket ID and tunnel ID
delete
/socket/{socket_id_or_name}/tunnel/{tunnel_id}/signkey
Generate a signed cert for a tunnel
post
/socket/{socket_id_or_name}/update_session
Update session for a socket
post
/socket/{socket_id}/sessions
Show all sessions from a socket by socket ID, paginated including active and killed sessions
get
/user/password
Update an existing (authenticated) user's account password
put
/users/mfa_challenge
MFA Challenge
post
/users/mfa_confirm
MFA Setup Confirm
post
/users/mfa_disabled
Disable MFA
put
/users/mfa_setup
MFA Setup
get
/users/organizations/switch
Switch Organization
post
Sockets
Sockets
/socket
Show all sockets
get
Create a socket
post
Connect
/connect
Show all connected sockets
get
Create a socket connection
post
Sessions
/session/{socket_id}
Show all sessions from a socket by socket ID, including active and killed sessions
get
/session/{socket_id}/{session_id}
Show a socket's session info by socket ID and session ID
get
Kill a socket's session with socket ID, session ID and json payload with killed flag
put
/session/{socket_id}/{session_id}/session_log
Download a socket's session recording
get
Statistics
/stats/{socket_id}/bandwidth
Get number of requests by status code
get
/stats/{socket_id}/requests
Get number of requests by status code
get
Certificate Signing
/mtls-ca/socket/{socket_dnsname}/auth
Generate a JWT for CA request on socket's DNS name
get
/mtls-ca/socket/{socket_dnsname}/csr
Generate a cert request and sign the CSR with socket's CA cert
post
/mtls-ca/socket/{socket_dnsname}/ssh
Generate a signed SSH cert for socket
post
Powered by
User login
post
https://example.com/login
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
