Update SSH collect session
Updates the SSH collect session with the given ID.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The ID of the session.
The ID of the session.
Request Body required
Section titled “Request Body required ”object
A URL to the JSON Schema for this object.
The time when the session expires. Cannot be used in combination with timeout.
The external ID of the session. Can be used to connect sessions to other systems.
Whether this session should keep collecting keys after the first connection.
Whether multiple keys should be collected in this session.
When enabled, the user has to confirm the collecting by pressing y on the SSH client.
The SSH banner to show when connecting to the session.
The SSH message to show after connecting to the session.
The time after which the session expires. Cannot be used in combination with expired_at.
Responses
Section titled “ Responses ”OK
object
A URL to the JSON Schema for this object.
The username used to connect to the SSH server. This is used to identify the session.
The connections that that connected to this session.
object
The client version of the SSH connection.
The time when the public key was created.
The ID of the public key.
The IP address of the SSH connection.
The public keys that have been collected.
object
The time when the public key was created.
The ID of the public key.
The algorithm of the public key.
The MD5 hash of the public key.
The public key in PEM format.
The SHA256 hash of the public key.
The public key in SSH(RFC4716) format.
The time when the session was created.
The time when the session expires. Cannot be used in combination with timeout.
The external ID of the session. Can be used to connect sessions to other systems.
The ID of the session.
Whether this session should keep collecting keys after the first connection.
Whether multiple keys should be collected in this session.
When enabled, the user has to confirm the collecting by pressing y on the SSH client.
The SSH banner to show when connecting to the session.
The SSH message to show after connecting to the session.
The status of the session.
The time when the session was updated.
The webhooks to call when the session is updated.
object
A URL to the JSON Schema for this object.
The multiplier to use when calculating the backoff time.
The events to trigger the webhook for. If none are provided, all events are triggered.
The headers to include in the request.
object
The ID of the webhook.
The initial time in seconds to wait before retrying the webhook.
The HTTP method to use.
The maximum number of retries.
The webhook URL to call.
default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.