v35
v31
v32
v33
v34

v35
v31
v32
v33
v34

Authentication

Overview
oauth
- /auth/api/v1/oauth/authorizeget
- /auth/api/v1/oauth/tokenpost
password
- /auth/api/v1/passwordput
- /auth/api/v1/forced-password-changeput
status
- /auth/api/v1/statusget
token exchange
- /auth/api/v1/token/loginpost
mobile mfa
auth
- /auth/api/v1/oauth/clientcredentials/{domain}/tokenpost
- /auth/api/v1/logoutpost
identity_provider_client
sessionstorage

Authorizer

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

Connection Manager

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

Database Proxy

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

Extender Service

Overview
status
- /extender-service/api/v1/statusget
extenderlisteners

Host Store

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

Keyvault

Overview
asymmetric
passphrase
status
- /keyvault/api/v1/statusget
symmetric

License Manager

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

Local User Store

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

Monitor Service

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

Network Access Manager

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

RDP Bastion

Overview
conf
- /rdp-mitm/api/v1/confget
playback
status
- /rdp-mitm/api/v1/statusget

RDP Proxy

Overview
connections
playback
- /rdp-proxy/api/v1/playback/{session_id}/keepalivepost
status
- /rdp-proxy/api/v1/statusget

Role Store

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

Secrets Manager

Overview
manage password policies
manage passwords
- /secrets-manager/api/v1/rotate/{host_id}/{account}post
manage rotation scripts
manage secrets
status
- /secrets-manager/api/v1/statusget
targetdomains
targetdomain accounts
managed accounts

Settings

Overview
schema
- /settings/api/v1/schema/{scope}get
- /settings/api/v1/schema/{scope}/{section}get
settings
status
- /settings/api/v1/statusget
restart-required
- /settings/api/v1/restart_required/{scope}post

SSH Bastion

Overview
conf
- /ssh-mitm/api/v1/confget
connections
exec
- /ssh-mitm/api/v1/execpost
status
- /ssh-mitm/api/v1/statusget

SSH Proxy

Overview
connections
forwarder
- /ssh-proxy/api/v1/forwarder/{connection_id}/keepalivepost
playback
- /ssh-proxy/api/v1/playback/{connection_id}/keepalivepost
status
- /ssh-proxy/api/v1/statusget

Trail Index

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

Vault

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

Workflow Engine

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

manage passwords

post /secrets-manager/api/v1/rotate/{host_id}/{account}

initiate rotation

host_id

string

required

account

string

required

Response

ExamplesSchema

Request added to rotation queue

Empty response

Was this page helpful?