Jump to Content

Guides API Reference

Documentation Home Portal Status

API Reference

Home Portal Status

Guides API Reference

Administrator Authentication

Authentication
/login
- User loginpost
/login/refresh
- Refresh API tokenpost
/user
- Register a new userpost
/user/confirm/{token}
- Confirm and activate user with a temporary tokenget
/user/{user_id}
- Show user info by user IDget
- Update an existing userput

Border0 API

/audit_actions
- Show all audit logs from organizationget
/audit_actions/actors
- Show all actors from a given organizationget
Client authentication
/client/ai_assistants/database
- Generate SQL query from an input that has a question and database schemaspost
/client/auth/org/{slug}
- Authenticate a client with headers against organization emailget
/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 flowget
/client/device_authorizations
- Posts details for a device initiating a new (OAuth2.0) client device authorization flow in exchange for a one-time-use codepost
/client/resources
- Show socket client resourcesget
/organization/identity_provider
- Add a custom identity provider to the current organizationpost
- Update a custom identity provider in the current organizationpatch
/organization/identity_provider/{name}
- Get a custom identity provider for the current organizationget
- Remove a custom identity provider from the current organizationdelete
/organization/identity_provider_status
- Toggle the status (enable/disable) of an identity provider in the current organizationput
/organization/identity_providers
- List all identity providers for the current organizationget
/organizations
- Create a new organizationpost
/organizations/csr
- Generate a cert request and sign the CSR with organization CApost
/organizations/customdomains
/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}
/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 notificationsget
- Create a notificationpost
/organizations/notifications/{name}
/organizations/recording_storage
/organizations/settings
- Update organization settingsput
/organizations/sign_ssh
- Generate a signed SSH cert for organizationpost
/organizations/switch
- Switch Organizationpost
/organizations/tokens
/organizations/users/leave
- Leave an organizationput
/policies
- get policies paginatedget
- Create a new policy and attach sockets to thempost
/policies/find
- find policies by a specific paramget
/policy/{uuid}
/sessions
- Show all sessions from a organizationget
/sessions/stats/{stats_type}
- Get session stats by type (locations, sockets, users)get
/socket/{socket_id_or_name}
/socket/{socket_id_or_name}/customcert
- Show a custom cert from a socketget
/socket/{socket_id_or_name}/evaluate
- Evaluate policy for a socketpost
/socket/{socket_id_or_name}/signkey
- Generate a signed cert for a tunnelpost
/socket/{socket_id_or_name}/tunnel
- Show all tunnels from a socketget
- Create a socket tunnelpost
/socket/{socket_id_or_name}/tunnel/{tunnel_id}
- Show one tunnel from a socket by socket ID and tunnel IDget
- Delete one tunnel from a socket by socket ID and tunnel IDdelete
/socket/{socket_id_or_name}/tunnel/{tunnel_id}/signkey
- Generate a signed cert for a tunnelpost
/socket/{socket_id_or_name}/update_session
- Update session for a socketpost
/socket/{socket_id}/sessions
- Show all sessions from a socket by socket ID, paginated including active and killed sessionsget
/user/password
- Update an existing (authenticated) user's account passwordput
/users/mfa_challenge
- MFA Challengepost
/users/mfa_confirm
- MFA Setup Confirmpost
/users/mfa_disabled
- Disable MFAput
/users/mfa_setup
- MFA Setupget
/users/organizations/switch
- Switch Organizationpost

Sockets

Sockets
/socket
- Show all socketsget
- Create a socketpost

Connect

/connect
- Show all connected socketsget
- Create a socket connectionpost

Sessions

/session/{socket_id}
- Show all sessions from a socket by socket ID, including active and killed sessionsget
/session/{socket_id}/{session_id}
- Show a socket's session info by socket ID and session IDget
- Kill a socket's session with socket ID, session ID and json payload with killed flagput
/session/{socket_id}/{session_id}/session_log
- Download a socket's session recordingget

Statistics

/stats/{socket_id}/bandwidth
- Get number of requests by status codeget
/stats/{socket_id}/requests
- Get number of requests by status codeget

Certificate Signing

/mtls-ca/socket/{socket_dnsname}/auth
- Generate a JWT for CA request on socket's DNS nameget
/mtls-ca/socket/{socket_dnsname}/csr
- Generate a cert request and sign the CSR with socket's CA certpost
/mtls-ca/socket/{socket_dnsname}/ssh
- Generate a signed SSH cert for socketpost

Powered by

Administrator Authentication

Authentication
/login
- User loginpost
/login/refresh
- Refresh API tokenpost
/user
- Register a new userpost
/user/confirm/{token}
- Confirm and activate user with a temporary tokenget
/user/{user_id}
- Show user info by user IDget
- Update an existing userput

Border0 API

/audit_actions
- Show all audit logs from organizationget
/audit_actions/actors
- Show all actors from a given organizationget
Client authentication
/client/ai_assistants/database
- Generate SQL query from an input that has a question and database schemaspost
/client/auth/org/{slug}
- Authenticate a client with headers against organization emailget
/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 flowget
/client/device_authorizations
- Posts details for a device initiating a new (OAuth2.0) client device authorization flow in exchange for a one-time-use codepost
/client/resources
- Show socket client resourcesget
/organization/identity_provider
- Add a custom identity provider to the current organizationpost
- Update a custom identity provider in the current organizationpatch
/organization/identity_provider/{name}
- Get a custom identity provider for the current organizationget
- Remove a custom identity provider from the current organizationdelete
/organization/identity_provider_status
- Toggle the status (enable/disable) of an identity provider in the current organizationput
/organization/identity_providers
- List all identity providers for the current organizationget
/organizations
- Create a new organizationpost
/organizations/csr
- Generate a cert request and sign the CSR with organization CApost
/organizations/customdomains
/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}
/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 notificationsget
- Create a notificationpost
/organizations/notifications/{name}
/organizations/recording_storage
/organizations/settings
- Update organization settingsput
/organizations/sign_ssh
- Generate a signed SSH cert for organizationpost
/organizations/switch
- Switch Organizationpost
/organizations/tokens
/organizations/users/leave
- Leave an organizationput
/policies
- get policies paginatedget
- Create a new policy and attach sockets to thempost
/policies/find
- find policies by a specific paramget
/policy/{uuid}
/sessions
- Show all sessions from a organizationget
/sessions/stats/{stats_type}
- Get session stats by type (locations, sockets, users)get
/socket/{socket_id_or_name}
/socket/{socket_id_or_name}/customcert
- Show a custom cert from a socketget
/socket/{socket_id_or_name}/evaluate
- Evaluate policy for a socketpost
/socket/{socket_id_or_name}/signkey
- Generate a signed cert for a tunnelpost
/socket/{socket_id_or_name}/tunnel
- Show all tunnels from a socketget
- Create a socket tunnelpost
/socket/{socket_id_or_name}/tunnel/{tunnel_id}
- Show one tunnel from a socket by socket ID and tunnel IDget
- Delete one tunnel from a socket by socket ID and tunnel IDdelete
/socket/{socket_id_or_name}/tunnel/{tunnel_id}/signkey
- Generate a signed cert for a tunnelpost
/socket/{socket_id_or_name}/update_session
- Update session for a socketpost
/socket/{socket_id}/sessions
- Show all sessions from a socket by socket ID, paginated including active and killed sessionsget
/user/password
- Update an existing (authenticated) user's account passwordput
/users/mfa_challenge
- MFA Challengepost
/users/mfa_confirm
- MFA Setup Confirmpost
/users/mfa_disabled
- Disable MFAput
/users/mfa_setup
- MFA Setupget
/users/organizations/switch
- Switch Organizationpost

Sockets

Sockets
/socket
- Show all socketsget
- Create a socketpost

Connect

/connect
- Show all connected socketsget
- Create a socket connectionpost

Sessions

/session/{socket_id}
- Show all sessions from a socket by socket ID, including active and killed sessionsget
/session/{socket_id}/{session_id}
- Show a socket's session info by socket ID and session IDget
- Kill a socket's session with socket ID, session ID and json payload with killed flagput
/session/{socket_id}/{session_id}/session_log
- Download a socket's session recordingget

Statistics

/stats/{socket_id}/bandwidth
- Get number of requests by status codeget
/stats/{socket_id}/requests
- Get number of requests by status codeget

Certificate Signing

/mtls-ca/socket/{socket_dnsname}/auth
- Generate a JWT for CA request on socket's DNS nameget
/mtls-ca/socket/{socket_dnsname}/csr
- Generate a cert request and sign the CSR with socket's CA certpost
/mtls-ca/socket/{socket_dnsname}/ssh
- Generate a signed SSH cert for socketpost

Powered by

Delete a notification

delete https://example.com/organizations/notifications/{name}

Language

Credentials

Header

Log in to use your API keys

Click Try It! to start a request and see the response here!