Synatic Relays API

A Relay.

Operations 22

POST /v1/organizations(?:/([^/]+?))/relays/v3 Generates a new v3 relay #
POST /v1/organizations(?:/([^/]+?))/relays/{relayId}/rekey Generates a new key pair for a relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/exampleConfig Generates a new key pair for a relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/test Tests that a relay is active #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/test/sync Tests an sync relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/test/async Tests an async relay #
GET /v1/organizations(?:/([^/]+?))/relays/connectionTypes/{connectionType} Gets a list of relays for a connection type #
POST /v1/organizations(?:/([^/]+?))/relays/{relayId}/restart Restarts a Relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions Queries the Relay History #
POST /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions Commits a new version of the Relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions/{versionId} Returns a version of a Relay #
POST /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions/{versionId}/checkout Checkout an existing version of the relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/export Export a Relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/queue-stats Retrieves a relays queue stats #
POST /v1/organizations(?:/([^/]+?))/relays/{relayId}/clear-queue Clears a relays queue #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId}/download-logs Fetches logs from a relay #
GET /v1/organizations(?:/([^/]+?))/relays Queries the Relays #
POST /v1/organizations(?:/([^/]+?))/relays Creates a Relay #
GET /v1/organizations(?:/([^/]+?))/relays/{relayId} Retrieves a Relay #
PUT /v1/organizations(?:/([^/]+?))/relays/{relayId} Updates a Relay #
DELETE /v1/organizations(?:/([^/]+?))/relays/{relayId} Deletes a Relay #
PATCH /v1/organizations(?:/([^/]+?))/relays/{relayId} Patches a Relay given the JSON Patch #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/synatic:synatic-relays-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

synatic-relays-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Main Relays API
  version: 3.5.1
  description: A Relay.
servers:
- url: /
tags:
- name: Relays
  description: A Relay.
paths:
  /v1/organizations(?:/([^/]+?))/relays/v3:
    post:
      tags:
      - Relays
      summary: Generates a new v3 relay
      description: ''
      responses:
        '200':
          description: The v3 Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      operationId: postV1Organizations(?:([^]+?))RelaysV3
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/rekey:
    post:
      tags:
      - Relays
      summary: Generates a new key pair for a relay
      description: ''
      responses:
        '200':
          description: The rekeyed Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: postV1Organizations(?:([^]+?))RelaysByRelayIdRekey
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/exampleConfig:
    get:
      tags:
      - Relays
      summary: Generates a new key pair for a relay
      description: ''
      responses:
        '200':
          description: The rekeyed Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdExampleConfig
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/test:
    get:
      tags:
      - Relays
      summary: Tests that a relay is active
      description: ''
      responses:
        '200':
          description: The result of the Relay Test
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdTest
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/test/sync:
    get:
      tags:
      - Relays
      summary: Tests an sync relay
      description: ''
      responses:
        '200':
          description: The result of the Relay Test
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdTestSync
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/test/async:
    get:
      tags:
      - Relays
      summary: Tests an async relay
      description: ''
      responses:
        '200':
          description: The result of the Relay Test
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '408':
          description: Request timed out
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdTestAsync
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/connectionTypes/{connectionType}:
    get:
      tags:
      - Relays
      summary: Gets a list of relays for a connection type
      description: ''
      responses:
        '200':
          description: The relays available for the connection type
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: connectionType
        in: path
        required: true
        schema:
          type: string
      operationId: getV1Organizations(?:([^]+?))RelaysConnectionTypesByConnectionType
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/restart:
    post:
      tags:
      - Relays
      summary: Restarts a Relay
      description: ''
      responses:
        '200':
          description: The result of the Relay Restart
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: postV1Organizations(?:([^]+?))RelaysByRelayIdRestart
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions:
    get:
      tags:
      - Relays
      summary: Queries the Relay History
      description: ''
      responses:
        '200':
          description: Returns an array of relay history
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: $filter
        description: The odata formatted filter e.g. $filter=field eq value
        required: false
        in: query
        schema:
          type: string
      - name: $select
        description: The fields to select e.g. $select=field1,field2
        required: false
        in: query
        schema:
          type: string
      - name: $sort
        description: The sort order of records e.g. $sort=field1,-field2
        required: false
        in: query
        schema:
          type: string
      - name: $limit
        description: The number of records to return
        required: false
        in: query
        schema:
          type: integer
          default: 50
      - name: $rawQuery
        description: 'A mongodb json find statement as a string. e.g. {"field1": 1}'
        required: false
        in: query
        schema:
          type: string
      - name: $skip
        description: The records to skip
        required: false
        in: query
        schema:
          type: integer
          default: 0
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        query:
          $filter: true
          $select: true
          $sort: true
          $limit: true
          $rawQuery: true
          $skip: true
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdVersions
      x-operation-id-source: derived
    post:
      tags:
      - Relays
      summary: Commits a new version of the Relay
      description: ''
      responses:
        '204':
          description: The version commit response
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: $filter
        description: The odata formatted filter e.g. $filter=field eq value
        required: false
        in: query
        schema:
          type: string
      - name: $select
        description: The fields to select e.g. $select=field1,field2
        required: false
        in: query
        schema:
          type: string
      - name: $sort
        description: The sort order of records e.g. $sort=field1,-field2
        required: false
        in: query
        schema:
          type: string
      - name: $limit
        description: The number of records to return
        required: false
        in: query
        schema:
          type: integer
          default: 50
      - name: $rawQuery
        description: 'A mongodb json find statement as a string. e.g. {"field1": 1}'
        required: false
        in: query
        schema:
          type: string
      - name: $skip
        description: The records to skip
        required: false
        in: query
        schema:
          type: integer
          default: 0
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        query:
          $filter: true
          $select: true
          $sort: true
          $limit: true
          $rawQuery: true
          $skip: true
        path:
          relayId: true
      operationId: postV1Organizations(?:([^]+?))RelaysByRelayIdVersions
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions/{versionId}:
    get:
      tags:
      - Relays
      summary: Returns a version of a Relay
      description: ''
      responses:
        '200':
          description: A version of a Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: versionId
        in: path
        required: true
        schema:
          type: string
      - name: $filter
        description: The odata formatted filter e.g. $filter=field eq value
        required: false
        in: query
        schema:
          type: string
      - name: $select
        description: The fields to select e.g. $select=field1,field2
        required: false
        in: query
        schema:
          type: string
      - name: $sort
        description: The sort order of records e.g. $sort=field1,-field2
        required: false
        in: query
        schema:
          type: string
      - name: $limit
        description: The number of records to return
        required: false
        in: query
        schema:
          type: integer
          default: 50
      - name: $rawQuery
        description: 'A mongodb json find statement as a string. e.g. {"field1": 1}'
        required: false
        in: query
        schema:
          type: string
      - name: $skip
        description: The records to skip
        required: false
        in: query
        schema:
          type: integer
          default: 0
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        query:
          $filter: true
          $select: true
          $sort: true
          $limit: true
          $rawQuery: true
          $skip: true
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdVersionsByVersionId
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/versions/{versionId}/checkout:
    post:
      tags:
      - Relays
      summary: Checkout an existing version of the relay
      description: ''
      responses:
        '204':
          description: The version checkout response
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: versionId
        in: path
        required: true
        schema:
          type: string
      - name: $filter
        description: The odata formatted filter e.g. $filter=field eq value
        required: false
        in: query
        schema:
          type: string
      - name: $select
        description: The fields to select e.g. $select=field1,field2
        required: false
        in: query
        schema:
          type: string
      - name: $sort
        description: The sort order of records e.g. $sort=field1,-field2
        required: false
        in: query
        schema:
          type: string
      - name: $limit
        description: The number of records to return
        required: false
        in: query
        schema:
          type: integer
          default: 50
      - name: $rawQuery
        description: 'A mongodb json find statement as a string. e.g. {"field1": 1}'
        required: false
        in: query
        schema:
          type: string
      - name: $skip
        description: The records to skip
        required: false
        in: query
        schema:
          type: integer
          default: 0
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        query:
          $filter: true
          $select: true
          $sort: true
          $limit: true
          $rawQuery: true
          $skip: true
        path:
          relayId: true
      operationId: postV1Organizations(?:([^]+?))RelaysByRelayIdVersionsByVersionIdCheckout
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/export:
    get:
      tags:
      - Relays
      summary: Export a Relay
      description: ''
      responses:
        '200':
          description: The exported Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdExport
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/queue-stats:
    get:
      tags:
      - Relays
      summary: Retrieves a relays queue stats
      description: ''
      responses:
        '200':
          description: The relays queue stats
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdQueueStats
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/clear-queue:
    post:
      tags:
      - Relays
      summary: Clears a relays queue
      description: ''
      responses:
        '204':
          description: No response
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: postV1Organizations(?:([^]+?))RelaysByRelayIdClearQueue
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}/download-logs:
    get:
      tags:
      - Relays
      summary: Fetches logs from a relay
      description: ''
      responses:
        '200':
          description: No response
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayIdDownloadLogs
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays:
    get:
      tags:
      - Relays
      summary: Queries the Relays
      description: ''
      responses:
        '200':
          description: Returns an array of Relays
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: $filter
        description: The odata formatted filter e.g. $filter=field eq value
        required: false
        in: query
        schema:
          type: string
      - name: $select
        description: The fields to select e.g. $select=field1,field2
        required: false
        in: query
        schema:
          type: string
      - name: $sort
        description: The sort order of records e.g. $sort=field1,-field2
        required: false
        in: query
        schema:
          type: string
      - name: $limit
        description: The number of records to return
        required: false
        in: query
        schema:
          type: integer
          default: 50
      - name: $rawQuery
        description: 'A mongodb json find statement as a string. e.g. {"field1": 1}'
        required: false
        in: query
        schema:
          type: string
      - name: $skip
        description: The records to skip
        required: false
        in: query
        schema:
          type: integer
          default: 0
      addedParameters:
        query:
          $filter: true
          $select: true
          $sort: true
          $limit: true
          $rawQuery: true
          $skip: true
      operationId: getV1Organizations(?:([^]+?))Relays
      x-operation-id-source: derived
    post:
      tags:
      - Relays
      summary: Creates a Relay
      description: ''
      responses:
        '201':
          description: Returns the created Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '409':
          description: Conflict, item exists
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      operationId: postV1Organizations(?:([^]+?))Relays
      x-operation-id-source: derived
  /v1/organizations(?:/([^/]+?))/relays/{relayId}:
    merge:
      tags:
      - Relays
      summary: Merges the object on the body with the Relay
      description: ''
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          schema:
            $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        type: string
        in: path
      addedParameters:
        path:
          relayId: true
    get:
      tags:
      - Relays
      summary: Retrieves a Relay
      description: ''
      responses:
        '200':
          description: Returns a Relay
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '404':
          description: Not Found
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: getV1Organizations(?:([^]+?))RelaysByRelayId
      x-operation-id-source: derived
    put:
      tags:
      - Relays
      summary: Updates a Relay
      description: ''
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: putV1Organizations(?:([^]+?))RelaysByRelayId
      x-operation-id-source: derived
    delete:
      tags:
      - Relays
      summary: Deletes a Relay
      description: ''
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: deleteV1Organizations(?:([^]+?))RelaysByRelayId
      x-operation-id-source: derived
    patch:
      tags:
      - Relays
      summary: Patches a Relay given the JSON Patch
      description: ''
      responses:
        '204':
          description: No Content
        '400':
          description: Validation error
        '401':
          description: Not Authorised
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverError'
      parameters:
      - name: relayId
        description: The unique name of the Relay
        required: true
        in: path
        schema:
          type: string
      addedParameters:
        path:
          relayId: true
      operationId: patchV1Organizations(?:([^]+?))RelaysByRelayId
      x-operation-id-source: derived
components:
  schemas:
    serverError:
      description: A Server Error
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type:
          - string
          - object