# Synatic Relays API

**Canonical:** https://apis.io/apis/synatic/synatic-relays-api/  
**Provider:** Synatic — https://apis.io/providers/synatic/  
**Base URL:** https://api.synatic.com  
**Documentation:** https://api.synatic.com/swagger.json

Synatic Relays API is one of 37 APIs that [Synatic](https://apis.io/providers/synatic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Relays. The published artifact set on APIs.io includes an OpenAPI specification.

A Relay.

## Operations (22)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/synatic/openapi/synatic-relays-api-openapi.yml

## Other Synatic APIs (12)

- [Synatic Agency Fuse Ams360 Webhooks API](https://apis.io/apis/synatic/synatic-agencyfuseams360webhooks-api/)
- [Synatic Agency Fuse Assist API Keys API](https://apis.io/apis/synatic/synatic-agencyfuseassistapikeys-api/)
- [Synatic API Keys API](https://apis.io/apis/synatic/synatic-api-keys-api/)
- [Synatic Billing API](https://apis.io/apis/synatic/synatic-billing-api/)
- [Synatic Buffers API](https://apis.io/apis/synatic/synatic-buffers-api/)
- [Synatic Change Logs API](https://apis.io/apis/synatic/synatic-changelogs-api/)
- [Synatic Comments API](https://apis.io/apis/synatic/synatic-comments-api/)
- [Synatic Content API](https://apis.io/apis/synatic/synatic-content-api/)
- [Synatic Data Stores API](https://apis.io/apis/synatic/synatic-datastores-api/)
- [Synatic Entity Sync API](https://apis.io/apis/synatic/synatic-entity-sync-api/)
- [Synatic Event Logs API](https://apis.io/apis/synatic/synatic-event-logs-api/)
- [Synatic Files API](https://apis.io/apis/synatic/synatic-files-api/)

## Tags

Relays

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/synatic/synatic-relays-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/synatic/.