Jump to Content

API Reference

SSH PrivX Authentication API

status
- /auth/api/v1/statusget
oauth
- /auth/api/v1/oauth/authorizeget
- /auth/api/v1/oauth/tokenpost
auth
- /auth/api/v1/logoutpost
token exchange
- /auth/api/v1/token/loginpost
password
- /auth/api/v1/passwordput
identity_provider_client
sessionstorage
mobile mfa

SSH PrivX Authorizer API

status
- /authorizer/api/v1/statusget
cas
ca
- /authorizer/api/v1/ca/authorizepost
principals
extender
version
- /authorizer/api/v1/version.jsget
deploy
carrier
- /authorizer/api/v1/carrier/conf/{trusted_client_id}post
- /authorizer/api/v1/carrier/conf/{trusted_client_id}/{session_id}get
icap
- /authorizer/api/v1/icap/conf/{trusted_client_id}post
- /authorizer/api/v1/icap/conf/{trusted_client_id}/{session_id}get
templates
- /authorizer/api/v1/cert/templatesget
ssl-trust-anchor
- /authorizer/api/v1/ssl-trust-anchorget
extender-trust-anchor
- /authorizer/api/v1/extender-trust-anchorget
accessgroups
cert

SSH PrivX Connection Manager API

status
connections
terminate
ueba management
ueba setup
- /connection-manager/api/v1/ueba/setup-scriptpost
- /connection-manager/api/v1/ueba/setup-script/{session_id}get
ueba train
ueba status

SSH PrivX Host Store API

status
- /host-store/api/v1/statusget
hosts
settings
- /host-store/api/v1/settings/default_service_optionsget
whitelists

SSH PrivX License Manager API

status
- /license-manager/api/v1/statusget
license
mobile gateway

SSH PrivX Monitor Service API

status
- /monitor-service/api/v1/statusget
components
- /monitor-service/api/v1/componentsget
- /monitor-service/api/v1/components/{hostname}get
auditevents
instance
- /monitor-service/api/v1/instance/statusget
- /monitor-service/api/v1/instance/exitpost
time
- /monitor-service/api/v1/timeget

SSH PrivX Role Store API

status
- /role-store/api/v1/statusget
sources
awsroles
role
users
logconf
authorizedkeys
- /role-store/api/v1/authorizedkeysget
- /role-store/api/v1/authorizedkeys/resolvepost
identity-providers
webauthn

SSH PrivX Settings API

status
- /settings/api/v1/statusget
settings
schema
- /settings/api/v1/schema/{scope}get
- /settings/api/v1/schema/{scope}/{section}get

SSH PrivX Trail-index API

status
- /trail-index/api/v1/statusget
index

SSH PrivX Local User Store API

status
- /local-user-store/api/v1/statusget
users
trusted-clients
extender-clients
- /local-user-store/api/v1/extender-clientsget
apiclient

SSH PrivX Vault API

status
- /vault/api/v1/statusget
secrets
personal secrets
metadata
- /vault/api/v1/metadata/secrets/{name}get
- /vault/api/v1/user/{user_id}/metadata/secrets/{name}get
search
- /vault/api/v1/search/secretspost
schemas
- /vault/api/v1/schemasget
v2-metadata
v2-versions

SSH PrivX Workflow Engine API

status
- /workflow-engine/api/v1/statusget
workflows
requests
settings
- /workflow-engine/api/v1/settingsget
- /workflow-engine/api/v1/settingsput
testsmtp
- /workflow-engine/api/v1/testsmtppost

SSH PrivX Local Network Access Manager API

status
- /network-access-manager/api/v1/statusget
nwtargets

SSH PrivX Secrets Manager API

status
- /secrets-manager/api/v1/statusget
manage secrets
manage passwords
- /secrets-manager/api/v1/rotate/{host_id}/{account}post
- /secrets-manager/api/v1/set-password/{host_id}/{account}post
manage password policies
manage rotation scripts

SSH PrivX Database Proxy API

status
- /db-proxy/api/v1/statusget
conf
- /db-proxy/api/v1/confget

/monitor-service/api/v1/time

get https://example.com/monitor-service/api/v1/time

Current PrivX server time.

Language

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