Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dgw): /jet/jrec/pull/{id}/{filename} endpoint #416

Merged
merged 2 commits into from
Apr 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 182 additions & 0 deletions devolutions-gateway/openapi/doc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -491,6 +491,186 @@ ifdef::internal-generation[]
endif::internal-generation[]


[.Jrec]
=== Jrec


[.listRecordings]
==== listRecordings

`GET /jet/jrec/list`

Lists all recordings stored on this instance

===== Description

Lists all recordings stored on this instance


// markup not found, no include::{specDir}jet/jrec/list/GET/spec.adoc[opts=optional]


===== Security

[cols="2,1,1"]
|===
| Name | Type | Scheme

| `scope_token`
| http
| bearer
|===


===== Return Type


<<List>>


===== Content Type

* application/json

===== Responses

.http response codes
[cols="2,3,1"]
|===
| Code | Message | Datatype


| 200
| List of recordings on this Gateway instance
| List[<<UUID>>]


| 400
| Bad request
| <<>>


| 401
| Invalid or missing authorization token
| <<>>


| 403
| Insufficient permissions
| <<>>

|===


ifdef::internal-generation[]
===== Implementation

// markup not found, no include::{specDir}jet/jrec/list/GET/implementation.adoc[opts=optional]


endif::internal-generation[]


[.pullRecordingFile]
==== pullRecordingFile

`GET /jet/jrec/pull/{id}/{filename}`

Retrieves a recording file for a given session

===== Description

Retrieves a recording file for a given session


// markup not found, no include::{specDir}jet/jrec/pull/\{id\}/\{filename\}/GET/spec.adoc[opts=optional]


===== Security

-

===== Parameters

====== Path Parameters

[cols="2,3,1,1,1"]
|===
|Name| Description| Required| Default| Pattern

| id
| Recorded session ID
| X
| null
|

| filename
| Name of recording file to retrieve
| X
| null
|

|===






===== Return Type


<<File>>


===== Content Type

* application/octet-stream

===== Responses

.http response codes
[cols="2,3,1"]
|===
| Code | Message | Datatype


| 200
| Recording file
| <<File>>


| 400
| Bad request
| <<>>


| 401
| Invalid or missing authorization token
| <<>>


| 403
| Insufficient permissions
| <<>>


| 404
| File not found
| <<>>

|===


ifdef::internal-generation[]
===== Implementation

// markup not found, no include::{specDir}jet/jrec/pull/\{id\}/\{filename\}/GET/implementation.adoc[opts=optional]


endif::internal-generation[]


[.Jrl]
=== Jrl

Expand Down Expand Up @@ -869,6 +1049,8 @@ endif::internal-generation[]
| `"gateway.config.write"`

| `"gateway.heartbeat.read"`

| `"gateway.recordings.read"`
|===


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ docs/HealthApi.md
docs/Heartbeat.md
docs/HeartbeatApi.md
docs/Identity.md
docs/JrecApi.md
docs/JrlApi.md
docs/JrlInfo.md
docs/ListenerUrls.md
Expand All @@ -25,6 +26,7 @@ src/Devolutions.Gateway.Client/Api/ConfigApi.cs
src/Devolutions.Gateway.Client/Api/DiagnosticsApi.cs
src/Devolutions.Gateway.Client/Api/HealthApi.cs
src/Devolutions.Gateway.Client/Api/HeartbeatApi.cs
src/Devolutions.Gateway.Client/Api/JrecApi.cs
src/Devolutions.Gateway.Client/Api/JrlApi.cs
src/Devolutions.Gateway.Client/Api/SessionsApi.cs
src/Devolutions.Gateway.Client/Client/ApiClient.cs
Expand Down
2 changes: 2 additions & 0 deletions devolutions-gateway/openapi/dotnet-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ Class | Method | HTTP request | Description
*DiagnosticsApi* | [**GetLogs**](docs/DiagnosticsApi.md#getlogs) | **GET** /jet/diagnostics/logs | Retrieves latest logs.
*HealthApi* | [**GetHealth**](docs/HealthApi.md#gethealth) | **GET** /jet/health | Performs a health check
*HeartbeatApi* | [**GetHeartbeat**](docs/HeartbeatApi.md#getheartbeat) | **GET** /jet/heartbeat | Performs a heartbeat check
*JrecApi* | [**ListRecordings**](docs/JrecApi.md#listrecordings) | **GET** /jet/jrec/list | Lists all recordings stored on this instance
*JrecApi* | [**PullRecordingFile**](docs/JrecApi.md#pullrecordingfile) | **GET** /jet/jrec/pull/{id}/{filename} | Retrieves a recording file for a given session
*JrlApi* | [**GetJrlInfo**](docs/JrlApi.md#getjrlinfo) | **GET** /jet/jrl/info | Retrieves current JRL (Json Revocation List) info
*JrlApi* | [**UpdateJrl**](docs/JrlApi.md#updatejrl) | **POST** /jet/jrl | Updates JRL (Json Revocation List) using a JRL token
*SessionsApi* | [**GetSessions**](docs/SessionsApi.md#getsessions) | **GET** /jet/sessions | Lists running sessions
Expand Down
Loading