Skip to content

Latest commit

 

History

History
178 lines (109 loc) · 5.56 KB

RelaysApi.md

File metadata and controls

178 lines (109 loc) · 5.56 KB

\RelaysApi

All URIs are relative to https://localhost

Method HTTP request Description
RelaySessionCreate Post /v1/relays/sessions Create a Relay Session
RelaySessionDelete Delete /v1/relays/sessions/{session_id} Delete a Relay Session
RelaySessionGet Get /v1/relays/sessions/{session_id} Get a Relay Session
RelaySessionList Get /v1/relays/sessions List all Relay Sessions
RelayUserAuthorize Post /v1/relays/sessions:authorize-user Authorize a user on a Relay Session
RelayUserRevoke Post /v1/relays/sessions:revoke-user Remove a user on a Relay Session

RelaySessionCreate

RelaySessionBaseResponse RelaySessionCreate(ctx, payload) Create a Relay Session

Create a relay session with users.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
payload RelaySessionCreatePayload

Return type

RelaySessionBaseResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RelaySessionDelete

RelaySessionDelete(ctx, sessionId) Delete a Relay Session

Delete a relay session.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionId string

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RelaySessionGet

RelaySessionBaseResponse RelaySessionGet(ctx, sessionId) Get a Relay Session

Retrieve the information for a relay session.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionId string

Return type

RelaySessionBaseResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RelaySessionList

RelaySessionListResponse RelaySessionList(ctx, ) List all Relay Sessions

List all the active relay sessions.

Required Parameters

This endpoint does not need any parameter.

Return type

RelaySessionListResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RelayUserAuthorize

RelaySessionUserBaseResponse RelayUserAuthorize(ctx, payload) Authorize a user on a Relay Session

Authorize a user on a Relay Session

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
payload RelayUserAuthorizePayload

Return type

RelaySessionUserBaseResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RelayUserRevoke

RelaySessionBaseResponse RelayUserRevoke(ctx, payload) Remove a user on a Relay Session

Authorize a user on a Relay Session

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
payload RelayUserRevokePayload

Return type

RelaySessionBaseResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]