v34
v34
v31
v32
v33
Search...
⌘K
Home
Guides
API Reference
Search...
⌘K
v34
v34
v31
v32
v33
Home
Guides
API Reference
Authentication
Overview
oauth
/auth/api/v1/oauth/authorize
get
/auth/api/v1/oauth/token
post
password
/auth/api/v1/password
put
/auth/api/v1/forced-password-change
put
status
/auth/api/v1/status
get
token exchange
/auth/api/v1/token/login
post
mobile mfa
/auth/api/v1/users/{user_id}/devices
get
/auth/api/v1/users/current/devices
get
/auth/api/v1/users/{user_id}/devices/{device_id}
del
/auth/api/v1/users/current/devices/{device_id}
del
auth
/auth/api/v1/oauth/clientcredentials/{domain}/token
post
/auth/api/v1/logout
post
identity_provider_client
/auth/api/v1/idp/clients
post
/auth/api/v1/idp/clients/{idp_id}
get
/auth/api/v1/idp/clients/{idp_id}
put
/auth/api/v1/idp/clients/{idp_id}
del
/auth/api/v1/idp/clients/{idp_id}/regenerate
post
sessionstorage
/auth/api/v1/sessionstorage/users/{user_id}/sessions
get
/auth/api/v1/sessionstorage/users/current/sessions
get
/auth/api/v1/sessionstorage/sources/{source_id}/sessions
get
/auth/api/v1/sessionstorage/sessions/search
post
/auth/api/v1/sessionstorage/sessions/{session_id}/terminate
post
/auth/api/v1/sessionstorage/users/{user_id}/sessions/terminate
post
/auth/api/v1/sessionstorage/users/current/sessions/{session_id}/terminate
post
/auth/api/v1/sessionstorage/users/current/sessionpassword
post
Authorizer
Overview
accessgroups
/authorizer/api/v1/accessgroups
get
/authorizer/api/v1/accessgroups
post
/authorizer/api/v1/accessgroups/search
post
/authorizer/api/v1/accessgroups/{id}
get
/authorizer/api/v1/accessgroups/{id}
put
/authorizer/api/v1/accessgroups/{id}
del
/authorizer/api/v1/accessgroups/{id}/cas
post
/authorizer/api/v1/accessgroups/{id}/cas/{ca_id}
del
ca
/authorizer/api/v1/ca/authorize
post
cas
/authorizer/api/v1/cas
get
/authorizer/api/v1/cas/{id}
get
/authorizer/api/v1/cas/{id}/crl
get
/authorizer/api/v1/accessgroups/{id}/cas
post
/authorizer/api/v1/accessgroups/{id}/cas/{ca_id}
del
carrier
/authorizer/api/v1/carrier/conf/{trusted_client_id}
post
/authorizer/api/v1/carrier/conf/{trusted_client_id}/{session_id}
get
cert
/authorizer/api/v1/cert/search
post
/authorizer/api/v1/cert
get
/authorizer/api/v1/cert/{id}
get
deploy
/authorizer/api/v1/deploy/{trusted_client_id}
post
/authorizer/api/v1/deploy/{trusted_client_id}/{session_id}
get
/authorizer/api/v1/deploy/principals_command.sh
get
extender
/authorizer/api/v1/{ca_type}/cas
get
/authorizer/api/v1/{ca_type}/cas/{id}
get
/authorizer/api/v1/{ca_type}/cas/{id}/crl
get
/authorizer/api/v1/{ca_type}/enroll
post
/authorizer/api/v1/{ca_type}/revoke
post
/authorizer/api/v1/extender/conf/{trusted_client_id}
post
/authorizer/api/v1/extender/conf/{trusted_client_id}/{session_id}
get
extender-trust-anchor
/authorizer/api/v1/extender-trust-anchor
get
icap
/authorizer/api/v1/icap/conf/{trusted_client_id}
post
/authorizer/api/v1/icap/conf/{trusted_client_id}/{session_id}
get
principals
/authorizer/api/v1/principals
get
/authorizer/api/v1/principals/{group_id}
get
/authorizer/api/v1/principals/{group_id}
del
/authorizer/api/v1/principals/{group_id}/create
post
/authorizer/api/v1/principals/{group_id}/import
post
/authorizer/api/v1/principals/{group_id}/sign
post
ssl-trust-anchor
/authorizer/api/v1/ssl-trust-anchor
get
status
/authorizer/api/v1/status
get
templates
/authorizer/api/v1/cert/templates
get
version
/authorizer/api/v1/version.js
get
Connection Manager
Overview
connections
/connection-manager/api/v1/connections
get
/connection-manager/api/v1/connections/search
post
/connection-manager/api/v1/connections/{connection_id}
get
/connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/file/{file_id}
post
/connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/file/{file_id}/{session_id}
get
/connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/log
post
/connection-manager/api/v1/connections/{connection_id}/channel/{channel_id}/log/{session_id}
get
/connection-manager/api/v1/connections/{connection_id}/access_roles
get
/connection-manager/api/v1/connections/{connection_id}/access_roles/{role_id}
post
/connection-manager/api/v1/connections/{connection_id}/access_roles/{role_id}
del
/connection-manager/api/v1/connections/access_roles/{role_id}
del
/connection-manager/api/v1/connections/tags
get
/connection-manager/api/v1/connections/{connection_id}/tags
put
status
/connection-manager/api/v1/status
get
/connection-manager/api/v1/ueba/status
get
/connection-manager/api/v1/ueba/status/internal
get
terminate
/connection-manager/api/v1/terminate/connection/{connection_id}
post
/connection-manager/api/v1/terminate/host/{host_id}
post
/connection-manager/api/v1/terminate/user/{user_id}
post
ueba management
/connection-manager/api/v1/ueba/configure
get
/connection-manager/api/v1/ueba/configure
post
/connection-manager/api/v1/ueba/anomaly-settings
get
/connection-manager/api/v1/ueba/anomaly-settings
post
/connection-manager/api/v1/ueba/start-analyzing/{dataset_id}
post
/connection-manager/api/v1/ueba/stop-analyzing
post
ueba train
/connection-manager/api/v1/ueba/datasets
get
/connection-manager/api/v1/ueba/datasets
post
/connection-manager/api/v1/ueba/datasets/{dataset_id}
get
/connection-manager/api/v1/ueba/datasets/{dataset_id}
put
/connection-manager/api/v1/ueba/datasets/{dataset_id}
del
/connection-manager/api/v1/ueba/train/{dataset_id}
post
/connection-manager/api/v1/ueba/query-connection-count
post
ueba setup
/connection-manager/api/v1/ueba/setup-script
post
/connection-manager/api/v1/ueba/setup-script/{session_id}
get
ueba status
/connection-manager/api/v1/ueba/status
get
/connection-manager/api/v1/ueba/status/internal
get
Database Proxy
Overview
status
/db-proxy/api/v1/status
get
conf
/db-proxy/api/v1/conf
get
Extender Service
Overview
status
/extender-service/api/v1/status
get
extenderlisteners
/extender-service/api/v1/listeners
get
/extender-service/api/v1/listeners
post
/extender-service/api/v1/listeners/{id}
get
/extender-service/api/v1/listeners/{id}
put
/extender-service/api/v1/listeners/{id}
del
Host Store
Overview
hosts
/host-store/api/v1/hosts/search
post
/host-store/api/v1/hosts
get
/host-store/api/v1/hosts
post
/host-store/api/v1/hosts/resolve
post
/host-store/api/v1/hosts/{host_id}
get
/host-store/api/v1/hosts/{host_id}
put
/host-store/api/v1/hosts/{host_id}
del
/host-store/api/v1/hosts/deploy
post
/host-store/api/v1/hosts/{host_id}/deployable
put
/host-store/api/v1/hosts/tags
get
/host-store/api/v1/hosts/{host_id}/disabled
put
settings
/host-store/api/v1/settings/default_service_options
get
status
/host-store/api/v1/status
get
whitelists
/host-store/api/v1/whitelists
get
/host-store/api/v1/whitelists
post
/host-store/api/v1/whitelists/{id}
get
/host-store/api/v1/whitelists/{id}
put
/host-store/api/v1/whitelists/{id}
del
/host-store/api/v1/whitelists/search
post
/host-store/api/v1/whitelists/evaluate
post
Keyvault
Overview
asymmetric
/keyvault/api/v1/asymmetric
get
/keyvault/api/v1/asymmetric
post
/keyvault/api/v1/asymmetric/search
post
/keyvault/api/v1/asymmetric/get
post
/keyvault/api/v1/asymmetric/{id}
get
/keyvault/api/v1/asymmetric/{id}
del
/keyvault/api/v1/asymmetric/{id}/sign
post
/keyvault/api/v1/asymmetric/{id}/asn1
get
passphrase
/keyvault/api/v1/passphrase
get
/keyvault/api/v1/passphrase
post
/keyvault/api/v1/passphrase/generate
post
/keyvault/api/v1/passphrase/{name}
get
/keyvault/api/v1/passphrase/{name}
put
/keyvault/api/v1/passphrase/{name}
del
status
/keyvault/api/v1/status
get
symmetric
/keyvault/api/v1/symmetric
get
/keyvault/api/v1/symmetric
post
/keyvault/api/v1/symmetric/search
post
/keyvault/api/v1/symmetric/get
post
/keyvault/api/v1/symmetric/{id}
get
/keyvault/api/v1/symmetric/{id}
del
/keyvault/api/v1/symmetric/{id}/hmac
post
/keyvault/api/v1/symmetric/{id}/seal
post
/keyvault/api/v1/symmetric/{id}/open
post
License Manager
Overview
license
/license-manager/api/v1/license
get
/license-manager/api/v1/license
post
/license-manager/api/v1/license/refresh
post
/license-manager/api/v1/license/optin
post
/license-manager/api/v1/license/deactivate
post
/license-manager/api/v1/license.js
get
status
/license-manager/api/v1/status
get
mobile gateway
/license-manager/api/v1/mobilegw/status
get
/license-manager/api/v1/mobilegw/register
post
/license-manager/api/v1/mobilegw/unregister
post
Local User Store
Overview
apiclient
/local-user-store/api/v1/api-clients
get
/local-user-store/api/v1/api-clients
post
/local-user-store/api/v1/api-clients/search
post
/local-user-store/api/v1/api-clients/{api_client_id}
get
/local-user-store/api/v1/api-clients/{api_client_id}
put
/local-user-store/api/v1/api-clients/{api_client_id}
del
extender-clients
/local-user-store/api/v1/extender-clients
get
status
/local-user-store/api/v1/status
get
users
/local-user-store/api/v1/users
get
/local-user-store/api/v1/users
post
/local-user-store/api/v1/users/{user_id}
get
/local-user-store/api/v1/users/{user_id}
put
/local-user-store/api/v1/users/{user_id}
del
/local-user-store/api/v1/users/{user_id}/password
put
/local-user-store/api/v1/users/tags
get
trusted-clients
/local-user-store/api/v1/trusted-clients
get
/local-user-store/api/v1/trusted-clients
post
/local-user-store/api/v1/trusted-clients/{trusted_client_id}
get
/local-user-store/api/v1/trusted-clients/{trusted_client_id}
put
/local-user-store/api/v1/trusted-clients/{trusted_client_id}
del
Monitor Service
Overview
auditevents
/monitor-service/api/v1/auditevents/search
post
/monitor-service/api/v1/auditevents
get
/monitor-service/api/v1/auditevents/codes
get
components
/monitor-service/api/v1/components
get
/monitor-service/api/v1/components/{hostname}
get
instance
/monitor-service/api/v1/instance/status
get
/monitor-service/api/v1/instance/exit
post
status
/monitor-service/api/v1/status
get
time
/monitor-service/api/v1/time
get
Network Access Manager
Overview
status
/network-access-manager/api/v1/status
get
nwtargets
/network-access-manager/api/v1/nwtargets
get
/network-access-manager/api/v1/nwtargets
post
/network-access-manager/api/v1/nwtargets/search
post
/network-access-manager/api/v1/nwtargets/tags
get
/network-access-manager/api/v1/nwtargets/{id}
get
/network-access-manager/api/v1/nwtargets/{id}
put
/network-access-manager/api/v1/nwtargets/{id}
del
/network-access-manager/api/v1/nwtargets/{id}/disabled
put
RDP Bastion
Overview
conf
/rdp-mitm/api/v1/conf
get
playback
/rdp-mitm/api/v1/playback/{connection_id}/{channel_id}
post
/rdp-mitm/api/v1/playback/sessions/{session_id}
get
/rdp-mitm/api/v1/playback/sessions/{session_id}/keepalive
post
/rdp-mitm/api/v1/playback/sessions/{session_id}/status
get
/rdp-mitm/api/v1/playback/status
del
status
/rdp-mitm/api/v1/status
get
RDP Proxy
Overview
connections
/rdp-proxy/api/v1/connections/{connection_id}/keepalive
post
/rdp-proxy/api/v1/connections/{connection_id}/file
post
/rdp-proxy/api/v1/connections/{connection_id}/file/upload/{upload_id}
post
/rdp-proxy/api/v1/connections/{connection_id}/file/download/{download_id}
get
playback
/rdp-proxy/api/v1/playback/{session_id}/keepalive
post
status
/rdp-proxy/api/v1/status
get
Role Store
Overview
status
/role-store/api/v1/status
get
sources
/role-store/api/v1/sources
get
/role-store/api/v1/sources
post
/role-store/api/v1/sources/{source_id}
get
/role-store/api/v1/sources/{source_id}
put
/role-store/api/v1/sources/{source_id}
del
/role-store/api/v1/sources/refresh
post
awsroles
/role-store/api/v1/awsroles
get
/role-store/api/v1/awsroles/{awsrole_id}
get
/role-store/api/v1/awsroles/{awsrole_id}
del
/role-store/api/v1/awsroles/{awsrole_id}/roles
get
/role-store/api/v1/awsroles/{awsrole_id}/roles
put
users
/role-store/api/v1/users/{user_id}
get
/role-store/api/v1/users/{user_id}/settings
get
/role-store/api/v1/users/{user_id}/settings
put
/role-store/api/v1/users/{user_id}/roles
get
/role-store/api/v1/users/{user_id}/roles
put
/role-store/api/v1/users/mfa/enable
post
/role-store/api/v1/users/mfa/disable
post
/role-store/api/v1/users/mfa/reset
post
/role-store/api/v1/users/current
get
/role-store/api/v1/users/current/awsroles
get
/role-store/api/v1/users/current/settings
get
/role-store/api/v1/users/current/settings
put
/role-store/api/v1/users/{user_id}/resolve
get
/role-store/api/v1/users/search
post
/role-store/api/v1/users/search/external
post
/role-store/api/v1/users/{user_id}/authorizedkeys
get
/role-store/api/v1/users/{user_id}/authorizedkeys
post
/role-store/api/v1/users/{user_id}/authorizedkeys/{key_id}
get
/role-store/api/v1/users/{user_id}/authorizedkeys/{key_id}
put
/role-store/api/v1/users/{user_id}/authorizedkeys/{key_id}
del
/role-store/api/v1/users/current/authorizedkeys
get
/role-store/api/v1/users/current/authorizedkeys
post
/role-store/api/v1/users/current/authorizedkeys/{key_id}
get
/role-store/api/v1/users/current/authorizedkeys/{key_id}
put
/role-store/api/v1/users/current/authorizedkeys/{key_id}
del
role
/role-store/api/v1/roles
get
/role-store/api/v1/roles
post
/role-store/api/v1/roles/resolve
post
/role-store/api/v1/roles/search
post
/role-store/api/v1/roles/evaluate
post
/role-store/api/v1/roles/{role_id}
get
/role-store/api/v1/roles/{role_id}
put
/role-store/api/v1/roles/{role_id}
del
/role-store/api/v1/roles/{role_id}/members
get
/role-store/api/v1/roles/{role_id}/awstoken
get
/role-store/api/v1/roles/{role_id}/principalkeys
get
/role-store/api/v1/roles/{role_id}/principalkeys/generate
post
/role-store/api/v1/roles/{role_id}/principalkeys/import
post
/role-store/api/v1/roles/{role_id}/principalkeys/{key_id}
get
/role-store/api/v1/roles/{role_id}/principalkeys/{key_id}
del
identity-providers
/role-store/api/v1/identity-providers
get
/role-store/api/v1/identity-providers
post
/role-store/api/v1/identity-providers/{id}
get
/role-store/api/v1/identity-providers/{id}
put
/role-store/api/v1/identity-providers/{id}
del
/role-store/api/v1/identity-providers/search
post
authorizedkeys
/role-store/api/v1/authorizedkeys
get
/role-store/api/v1/authorizedkeys/resolve
post
logconf
/role-store/api/v1/logconf/collectors
get
/role-store/api/v1/logconf/collectors
post
/role-store/api/v1/logconf/collectors/{collector_id}
get
/role-store/api/v1/logconf/collectors/{collector_id}
put
/role-store/api/v1/logconf/collectors/{collector_id}
del
webauthn
/role-store/api/v1/users/{user_id}/webauthn-credentials
get
/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}
get
/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}
put
/role-store/api/v1/users/{user_id}/webauthn-credentials/{id}
del
Secrets Manager
Overview
manage password policies
/secrets-manager/api/v1/password-policies
get
/secrets-manager/api/v1/password-policy
post
/secrets-manager/api/v1/password-policy/{id}
get
/secrets-manager/api/v1/password-policy/{id}
put
/secrets-manager/api/v1/password-policy/{id}
del
manage passwords
/secrets-manager/api/v1/rotate/{host_id}/{account}
post
/secrets-manager/api/v1/set-password/{host_id}/{account}
post
manage rotation scripts
/secrets-manager/api/v1/script-templates
get
/secrets-manager/api/v1/script-template
post
/secrets-manager/api/v1/script-template/{id}
get
/secrets-manager/api/v1/script-template/{id}
put
/secrets-manager/api/v1/script-template/{id}
del
/secrets-manager/api/v1/script-template/compile
post
manage secrets
/secrets-manager/api/v1/host-secret/{host_id}
get
/secrets-manager/api/v1/host-secret/{host_id}
post
/secrets-manager/api/v1/host-secret/{host_id}
del
status
/secrets-manager/api/v1/status
get
Settings
Overview
schema
/settings/api/v1/schema/{scope}
get
/settings/api/v1/schema/{scope}/{section}
get
settings
/settings/api/v1/settings/{scope}
get
/settings/api/v1/settings/{scope}
put
/settings/api/v1/settings/{scope}/{section}
get
/settings/api/v1/settings/{scope}/{section}
put
status
/settings/api/v1/status
get
restart-required
/settings/api/v1/restart_required/{scope}
post
SSH Bastion
Overview
conf
/ssh-mitm/api/v1/conf
get
connections
/ssh-mitm/api/v1/connections/{connection_id}/file
post
/ssh-mitm/api/v1/connections/{connection_id}/file/upload/{upload_id}
post
/ssh-mitm/api/v1/connections/{connection_id}/file/download/{download_id}
get
exec
/ssh-mitm/api/v1/exec
post
status
/ssh-mitm/api/v1/status
get
SSH Proxy
Overview
connections
/ssh-proxy/api/v1/connections/{connection_id}/keepalive
post
/ssh-proxy/api/v1/connections/{connection_channel_id}/file
post
/ssh-proxy/api/v1/connections/{connection_channel_id}/file/upload/{upload_id}
post
/ssh-proxy/api/v1/connections/{connection_channel_id}/file/download/{download_id}
get
forwarder
/ssh-proxy/api/v1/forwarder/{connection_id}/keepalive
post
playback
/ssh-proxy/api/v1/playback/{connection_id}/keepalive
post
status
/ssh-proxy/api/v1/status
get
Trail Index
Overview
index
/trail-index/api/v1/index/{connection_id}/status
get
/trail-index/api/v1/index/status
post
/trail-index/api/v1/index/start
post
/trail-index/api/v1/index/search
post
status
/trail-index/api/v1/status
get
Vault
Overview
metadata
/vault/api/v1/metadata/secrets/{name}
get
/vault/api/v1/user/{user_id}/metadata/secrets/{name}
get
personal secrets
/vault/api/v1/user/{user_id}/secrets
get
/vault/api/v1/user/{user_id}/secrets
post
/vault/api/v1/user/{user_id}/secrets/{name}
get
/vault/api/v1/user/{user_id}/secrets/{name}
put
/vault/api/v1/user/{user_id}/secrets/{name}
del
schemas
/vault/api/v1/schemas
get
status
/vault/api/v1/status
get
secrets
/vault/api/v1/secrets
get
/vault/api/v1/secrets
post
/vault/api/v1/secrets/{name}
get
/vault/api/v1/secrets/{name}
put
/vault/api/v1/secrets/{name}
del
search
/vault/api/v1/search/secrets
post
v2-metadata
/vault/api/v1/secret/metadata/{path}
get
/vault/api/v1/secret/metadata/{path}
post
/vault/api/v1/secret/metadata/{path}
del
/vault/api/v1/secret/keys/{path}
get
v2-versions
/vault/api/v1/secret/delete/{path}
post
/vault/api/v1/secret/undelete/{path}
post
/vault/api/v1/secret/destroy/{path}
post
/vault/api/v1/secret/data/{path}
get
/vault/api/v1/secret/data/{path}
post
/vault/api/v1/secret/data/{path}
del
Workflow Engine
Overview
workflows
/workflow-engine/api/v1/workflows
get
/workflow-engine/api/v1/workflows
post
/workflow-engine/api/v1/workflows/{workflow_id}
get
/workflow-engine/api/v1/workflows/{workflow_id}
put
/workflow-engine/api/v1/workflows/{workflow_id}
del
status
/workflow-engine/api/v1/status
get
requests
/workflow-engine/api/v1/requests
get
/workflow-engine/api/v1/requests
post
/workflow-engine/api/v1/requests/{request_id}
get
/workflow-engine/api/v1/requests/{request_id}
del
/workflow-engine/api/v1/requests/{request_id}/decision
post
/workflow-engine/api/v1/requests/{request_id}/role/revoke
post
/workflow-engine/api/v1/requests/search
post
settings
/workflow-engine/api/v1/settings
get
/workflow-engine/api/v1/settings
put
testsmtp
/workflow-engine/api/v1/testsmtp
post
SSH PrivX Key Vault API
Current Version:
1.0
Servers
Was this page helpful?
On this page
Servers
