connections
Download Specoffset
int
Offset from which to start fetching objects
- Default
- 0
limit
int
Maximum number of objects to return
- Default
- 50
sortkey
string
Sort by specific object property
- Default
- "id"
sortdir
string
Sort direction, asc or desc
- Default
- "ASC"
- Enum
-
- ASC
- DESC
fuzzycount
boolean
If keyword is present the queries will return a fuzzy total count instead of exact total count
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
connectionsView
service
user
Get connections
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Successful request, respond with a list of connections
{
"count": 123,
"items": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"type": "SSH",
"authentication_method": [
"CERT"
],
"user_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"display_name": "user@domain.com"
},
"user_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"target_host_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"common_name": "linux-host"
},
"target_host_address": "123.123.123.123",
"target_host_account": "dbuser",
"target_host_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"remote_address": "123.123.123.123",
"connected": "2017-01-01T15:05:05Z",
"disconnected": "2017-01-01T15:05:05Z",
"duration": "PT00:15:38",
"status": "CONNECTED",
"last_activity": "2017-01-01T15:05:05Z",
"bytes_in": 123456,
"bytes_out": 12345678,
"force_disconnect": "2017-01-01T15:05:05Z",
"created": "2017-01-01T15:05:05Z",
"updated": "2017-01-01T15:05:05Z",
"updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"audit_enabled": true,
"access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"trail": {
"connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
"host_id": "5bf77342-221c-11ee-be56-0242ac120002",
"user_id": "5bf77342-221c-11ee-be56-0242ac120002",
"protocol": "string",
"channels": [
{
"id": "string",
"type": "string",
"bytes_client_to_server": 123,
"bytes_server_to_client": 123,
"protocol_file": {
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
},
"transferred_files": [
{
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
}
]
}
]
},
"index_status": "NOT_INDEXED",
"access_roles": [
{
"added": "2023-06-07T17:32:28Z",
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string"
}
],
"tags": [
"string"
]
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursivecount
int
items
array[object]
object
A connection object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
proxy_id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
type
string
- Enum
-
- SSH
- RDP
authentication_method
array[string]
string
- Enum
-
- CERT
- PUBKEY
- PASSPHRASE
- PROMPTED_PASSPHRASE
- UNKNOWN
user_data
object (user_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
display_name
string
- Example
- "user@domain.com"
user_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
target_host_data
object (target_host_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
common_name
string
- Example
- "linux-host"
target_host_address
string
- Example
- "123.123.123.123"
target_host_account
string
- Example
- "dbuser"
target_host_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
remote_address
string
- Example
- "123.123.123.123"
connected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
disconnected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
duration
string
Connection duration in ISO8601 format.
- Example
- "PT00:15:38"
status
string
- Enum
-
- CONNECTED
- DISCONNECTED
- TERMINATING
- TERMINATED
- CONNMGR_TIMEOUT
- CONNMGR_CLIENT_LOST
last_activity
string
date-time
The time when connection was last interacted with by user.
- Example
- "2017-01-01T15:05:05Z"
bytes_in
int
- Example
- 123456
bytes_out
int
- Example
- 12345678
force_disconnect
string
date-time
The connection termination was requested
- Example
- "2017-01-01T15:05:05Z"
created
string
date-time
When the object was created
- Example
- "2017-01-01T15:05:05Z"
updated
string
date-time
When the object was updated
- Example
- "2017-01-01T15:05:05Z"
updated_by
string
uuid
Id of the user who updated the object
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
audit_enabled
boolean
Wether connection is audited or not.
access_group_id
string
uuid
The access group ID
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
trail
object (trail)
The trail metadata for audited connection. Not available for connection listing.
connection_id
string
uuid
host_id
string
uuid
user_id
string
uuid
protocol
string
channels
array[object]
object
id
string
type
string
Type description for the channel.
bytes_client_to_server
int
Bytes transferred from client to server.
bytes_server_to_client
int
Bytes transferred from server to client.
protocol_file
object (protocol_file)
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
transferred_files
array[object]
object
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
index_status
string
describes the indexing status of the connection
- Enum
-
- NOT_INDEXED
- INDEXING
- INDEXED
- ERROR
access_roles
array[object]
The access roles set for this connection
object
Connection access role object
added
string
date-time
id
string
uuid
Role ID
name
string
Role name
tags
array[string]
string
keywords
string
Comma or space-separated strings to search across all connection attributes. The leading and trailing wildcards for the keywords are implicit.
id
array[string]
string
proxy_id
array[string]
string
type
array[string]
string
- Enum
-
- SSH
- RDP
- VNC
- WEB
authentication_method
array[string]
string
- Enum
-
- CERT
- PUBKEY
- PASSPHRASE
- PROMPTED_PASSPHRASE
- UNKNOWN
user_id
array[string]
string
uuid
user_display_name
array[string]
string
user_roles
array[string]
The role ids.
string
target_host_id
array[string]
string
uuid
target_host_address
array[string]
string
target_host_account
array[string]
string
target_host_roles
array[string]
The role ids.
string
remote_address
array[string]
string
connected
object (connected)
start
string
end
string
disconnected
object (disconnected)
start
string
end
string
status
array[string]
string
- Enum
-
- CONNECTED
- DISCONNECTED
- TERMINATING
- TERMINATED
- CONNMGR_TIMEOUT
- CONNMGR_CLIENT_LOST
last_activity
object (last_activity)
start
string
end
string
force_disconnect
string
access_roles
array[string]
string
uuid
tags
array[string]
string
has_access_roles
boolean
mode
array[string]
string
- Enum
-
- MITM
- UI
- FORWARDED
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
offset
int
Offset from which to start fetching objects
- Default
- 0
limit
int
Maximum number of objects to return
- Default
- 50
sortkey
string
Sort by specific object property
- Default
- "id"
sortdir
string
Sort direction, asc or desc
- Default
- "ASC"
- Enum
-
- ASC
- DESC
fuzzycount
boolean
If keyword is present the queries will return a fuzzy total count instead of exact total count
oauth
Required Scopes:
admin
connectionsView
service
user
Search for connections.
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Request
{
"keywords": "string",
"id": [
"string"
],
"proxy_id": [
"string"
],
"type": [
"SSH"
],
"authentication_method": [
"CERT"
],
"user_id": [
"5bf77342-221c-11ee-be56-0242ac120002"
],
"user_display_name": [
"string"
],
"user_roles": [
"string"
],
"target_host_id": [
"5bf77342-221c-11ee-be56-0242ac120002"
],
"target_host_address": [
"string"
],
"target_host_account": [
"string"
],
"target_host_roles": [
"string"
],
"remote_address": [
"string"
],
"connected": {
"start": "string",
"end": "string"
},
"disconnected": {
"start": "string",
"end": "string"
},
"status": [
"CONNECTED"
],
"last_activity": {
"start": "string",
"end": "string"
},
"force_disconnect": "string",
"access_roles": [
"5bf77342-221c-11ee-be56-0242ac120002"
],
"tags": [
"string"
],
"has_access_roles": true,
"mode": [
"MITM"
]
}
Response
Successful request, respond with a list of connections
{
"count": 123,
"items": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"type": "SSH",
"authentication_method": [
"CERT"
],
"user_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"display_name": "user@domain.com"
},
"user_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"target_host_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"common_name": "linux-host"
},
"target_host_address": "123.123.123.123",
"target_host_account": "dbuser",
"target_host_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"remote_address": "123.123.123.123",
"connected": "2017-01-01T15:05:05Z",
"disconnected": "2017-01-01T15:05:05Z",
"duration": "PT00:15:38",
"status": "CONNECTED",
"last_activity": "2017-01-01T15:05:05Z",
"bytes_in": 123456,
"bytes_out": 12345678,
"force_disconnect": "2017-01-01T15:05:05Z",
"created": "2017-01-01T15:05:05Z",
"updated": "2017-01-01T15:05:05Z",
"updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"audit_enabled": true,
"access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"trail": {
"connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
"host_id": "5bf77342-221c-11ee-be56-0242ac120002",
"user_id": "5bf77342-221c-11ee-be56-0242ac120002",
"protocol": "string",
"channels": [
{
"id": "string",
"type": "string",
"bytes_client_to_server": 123,
"bytes_server_to_client": 123,
"protocol_file": {
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
},
"transferred_files": [
{
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
}
]
}
]
},
"index_status": "NOT_INDEXED",
"access_roles": [
{
"added": "2023-06-07T17:32:28Z",
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string"
}
],
"tags": [
"string"
]
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursivecount
int
items
array[object]
object
A connection object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
proxy_id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
type
string
- Enum
-
- SSH
- RDP
authentication_method
array[string]
string
- Enum
-
- CERT
- PUBKEY
- PASSPHRASE
- PROMPTED_PASSPHRASE
- UNKNOWN
user_data
object (user_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
display_name
string
- Example
- "user@domain.com"
user_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
target_host_data
object (target_host_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
common_name
string
- Example
- "linux-host"
target_host_address
string
- Example
- "123.123.123.123"
target_host_account
string
- Example
- "dbuser"
target_host_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
remote_address
string
- Example
- "123.123.123.123"
connected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
disconnected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
duration
string
Connection duration in ISO8601 format.
- Example
- "PT00:15:38"
status
string
- Enum
-
- CONNECTED
- DISCONNECTED
- TERMINATING
- TERMINATED
- CONNMGR_TIMEOUT
- CONNMGR_CLIENT_LOST
last_activity
string
date-time
The time when connection was last interacted with by user.
- Example
- "2017-01-01T15:05:05Z"
bytes_in
int
- Example
- 123456
bytes_out
int
- Example
- 12345678
force_disconnect
string
date-time
The connection termination was requested
- Example
- "2017-01-01T15:05:05Z"
created
string
date-time
When the object was created
- Example
- "2017-01-01T15:05:05Z"
updated
string
date-time
When the object was updated
- Example
- "2017-01-01T15:05:05Z"
updated_by
string
uuid
Id of the user who updated the object
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
audit_enabled
boolean
Wether connection is audited or not.
access_group_id
string
uuid
The access group ID
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
trail
object (trail)
The trail metadata for audited connection. Not available for connection listing.
connection_id
string
uuid
host_id
string
uuid
user_id
string
uuid
protocol
string
channels
array[object]
object
id
string
type
string
Type description for the channel.
bytes_client_to_server
int
Bytes transferred from client to server.
bytes_server_to_client
int
Bytes transferred from server to client.
protocol_file
object (protocol_file)
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
transferred_files
array[object]
object
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
index_status
string
describes the indexing status of the connection
- Enum
-
- NOT_INDEXED
- INDEXING
- INDEXED
- ERROR
access_roles
array[object]
The access roles set for this connection
object
Connection access role object
added
string
date-time
id
string
uuid
Role ID
name
string
Role name
tags
array[string]
string
connection_id
string
uuid
required
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
connectionsView
service
user
Get a single connection.
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Connection successfully found
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"type": "SSH",
"authentication_method": [
"CERT"
],
"user_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"display_name": "user@domain.com"
},
"user_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"target_host_data": {
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"common_name": "linux-host"
},
"target_host_address": "123.123.123.123",
"target_host_account": "dbuser",
"target_host_roles": [
{
"id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"name": "example-admins"
}
],
"remote_address": "123.123.123.123",
"connected": "2017-01-01T15:05:05Z",
"disconnected": "2017-01-01T15:05:05Z",
"duration": "PT00:15:38",
"status": "CONNECTED",
"last_activity": "2017-01-01T15:05:05Z",
"bytes_in": 123456,
"bytes_out": 12345678,
"force_disconnect": "2017-01-01T15:05:05Z",
"created": "2017-01-01T15:05:05Z",
"updated": "2017-01-01T15:05:05Z",
"updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"audit_enabled": true,
"access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
"trail": {
"connection_id": "5bf77342-221c-11ee-be56-0242ac120002",
"host_id": "5bf77342-221c-11ee-be56-0242ac120002",
"user_id": "5bf77342-221c-11ee-be56-0242ac120002",
"protocol": "string",
"channels": [
{
"id": "string",
"type": "string",
"bytes_client_to_server": 123,
"bytes_server_to_client": 123,
"protocol_file": {
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
},
"transferred_files": [
{
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string",
"offset": 123,
"direction": 123,
"open_time": "2023-06-07T17:32:28Z",
"close_time": "2023-06-07T17:32:28Z",
"payload_size": 123,
"closed": true,
"status": "OK"
}
]
}
]
},
"index_status": "NOT_INDEXED",
"access_roles": [
{
"added": "2023-06-07T17:32:28Z",
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string"
}
],
"tags": [
"string"
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveid
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
proxy_id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
type
string
- Enum
-
- SSH
- RDP
authentication_method
array[string]
string
- Enum
-
- CERT
- PUBKEY
- PASSPHRASE
- PROMPTED_PASSPHRASE
- UNKNOWN
user_data
object (user_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
display_name
string
- Example
- "user@domain.com"
user_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
target_host_data
object (target_host_data)
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
common_name
string
- Example
- "linux-host"
target_host_address
string
- Example
- "123.123.123.123"
target_host_account
string
- Example
- "dbuser"
target_host_roles
array[object]
object
id
string
uuid
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
name
string
- Example
- "example-admins"
remote_address
string
- Example
- "123.123.123.123"
connected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
disconnected
string
date-time
- Example
- "2017-01-01T15:05:05Z"
duration
string
Connection duration in ISO8601 format.
- Example
- "PT00:15:38"
status
string
- Enum
-
- CONNECTED
- DISCONNECTED
- TERMINATING
- TERMINATED
- CONNMGR_TIMEOUT
- CONNMGR_CLIENT_LOST
last_activity
string
date-time
The time when connection was last interacted with by user.
- Example
- "2017-01-01T15:05:05Z"
bytes_in
int
- Example
- 123456
bytes_out
int
- Example
- 12345678
force_disconnect
string
date-time
The connection termination was requested
- Example
- "2017-01-01T15:05:05Z"
created
string
date-time
When the object was created
- Example
- "2017-01-01T15:05:05Z"
updated
string
date-time
When the object was updated
- Example
- "2017-01-01T15:05:05Z"
updated_by
string
uuid
Id of the user who updated the object
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
audit_enabled
boolean
Wether connection is audited or not.
access_group_id
string
uuid
The access group ID
- Example
- "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
trail
object (trail)
The trail metadata for audited connection. Not available for connection listing.
connection_id
string
uuid
host_id
string
uuid
user_id
string
uuid
protocol
string
channels
array[object]
object
id
string
type
string
Type description for the channel.
bytes_client_to_server
int
Bytes transferred from client to server.
bytes_server_to_client
int
Bytes transferred from server to client.
protocol_file
object (protocol_file)
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
transferred_files
array[object]
object
id
string
uuid
name
string
offset
int
direction
int
From server to client = 1, from client to server = 2
open_time
string
date-time
close_time
string
date-time
payload_size
int
closed
boolean
status
string
- Enum
-
- OK
- PERMISSION_DENIED
- TIMEOUT
- MISSING
- LENGTH_MISMATCH
- CHECKSUM_MISMATCH
- DECRYPTION_ERROR
- STORAGE_UNDEFINED
- ID_UNDEFINED
- UNCLEAN_CLOSE
- GENERIC_ERROR
- ONGOING
index_status
string
describes the indexing status of the connection
- Enum
-
- NOT_INDEXED
- INDEXING
- INDEXED
- ERROR
access_roles
array[object]
The access roles set for this connection
object
Connection access role object
added
string
date-time
id
string
uuid
Role ID
name
string
Role name
tags
array[string]
string
Create session ID for trail stored file download.
connection_id
string
uuid
required
channel_id
string
required
file_id
string
uuid
required
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
service
connectionsPlayback
admin
Create session ID for trail stored file download.
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Session ID created
{
"session_id": "5bf77342-221c-11ee-be56-0242ac120002"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
session_id
string
uuid
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveDownload trail stored file transferred within audited connection channel.
connection_id
string
uuid
required
channel_id
string
required
file_id
string
uuid
required
session_id
string
uuid
required
Response
File found, download ok
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveCreate session ID for trail log download.
connection_id
string
uuid
required
channel_id
string
required
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
service
connectionsTrail
admin
Create session ID for trail log download.
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Session ID created
{
"session_id": "5bf77342-221c-11ee-be56-0242ac120002"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
session_id
string
uuid
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveDownload trail log of audited connection channel.
format
string
Trail log format, jsonl or hex
- Default
- "hex"
filter
string
Trail log event filter, comma separated list of event types. For SSH the options are: stdin, stdout, stderr, forward-request, reverse-request, forward-reply, reverse-reply, forward-global-request, reverse-global-request, forward-new-channel-request, reverse-new-channel-request, forward-global-reply, reverse-global-reply, forward-new-channel-reply, reverse-new-channel-reply"
connection_id
string
uuid
required
channel_id
string
required
session_id
string
uuid
required
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
Response
Trail log found, download ok
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveGet saved access roles for a connection
connection_id
string
uuid
required
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
service
Get saved access roles for a connection
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
connectionsManage
· Admin user with connection-manage scope -
connectionsPlayback
· Admin user with connections-playback scope -
connectionsTerminate
· Admin user with connections-terminate scope -
connectionsTrail
· Admin user with connections-trail scope -
connectionsView
· Admin user with connections-view scope -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Permissions returned
[
{
"added": "2023-06-07T17:32:28Z",
"id": "5bf77342-221c-11ee-be56-0242ac120002",
"name": "string"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}