Skip to content

README.md

Latest commit

 

History

History
226 lines (215 loc) · 16.8 KB

README.md

File metadata and controls

226 lines (215 loc) · 16.8 KB

Documentation for OpenZeppelin Relayer API

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
HealthApi health GET /v1/health Health routes implementation
MetricsApi listMetrics GET /metrics Metrics routes implementation
MetricsApi metricDetail GET /metrics/{metric_name} Returns the details of a specific metric in plain text format.
MetricsApi scrapeMetrics GET /debug/metrics/scrape Triggers an update of system metrics and returns the result in plain text format.
NotificationsApi createNotification POST /api/v1/notifications Creates a new notification.
NotificationsApi deleteNotification DELETE /api/v1/notifications/{notification_id} Deletes a notification by ID.
NotificationsApi getNotification GET /api/v1/notifications/{notification_id} Retrieves details of a specific notification by ID.
NotificationsApi listNotifications GET /api/v1/notifications Notification routes implementation
NotificationsApi updateNotification PATCH /api/v1/notifications/{notification_id} Updates an existing notification.
PluginsApi callPlugin POST /api/v1/plugins/{plugin_id}/call Calls a plugin method.
RelayersApi cancelTransaction DELETE /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Cancels a specific transaction by its ID.
RelayersApi createRelayer POST /api/v1/relayers Creates a new relayer.
RelayersApi deletePendingTransactions DELETE /api/v1/relayers/{relayer_id}/transactions/pending Deletes all pending transactions for a specific relayer.
RelayersApi deleteRelayer DELETE /api/v1/relayers/{relayer_id} Deletes a relayer by ID.
RelayersApi getRelayer GET /api/v1/relayers/{relayer_id} Retrieves details of a specific relayer by ID.
RelayersApi getRelayerBalance GET /api/v1/relayers/{relayer_id}/balance Retrieves the balance of a specific relayer.
RelayersApi getRelayerStatus GET /api/v1/relayers/{relayer_id}/status Fetches the current status of a specific relayer.
RelayersApi getTransactionById GET /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Retrieves a specific transaction by its ID.
RelayersApi getTransactionByNonce GET /api/v1/relayers/{relayer_id}/transactions/by-nonce/{nonce} Retrieves a transaction by its nonce value.
RelayersApi listRelayers GET /api/v1/relayers Relayer routes implementation
RelayersApi listTransactions GET /api/v1/relayers/{relayer_id}/transactions/ Lists all transactions for a specific relayer with pagination.
RelayersApi replaceTransaction PUT /api/v1/relayers/{relayer_id}/transactions/{transaction_id} Replaces a specific transaction with a new one.
RelayersApi rpc POST /api/v1/relayers/{relayer_id}/rpc Performs a JSON-RPC call using the specified relayer.
RelayersApi sendTransaction POST /api/v1/relayers/{relayer_id}/transactions Sends a transaction through the specified relayer.
RelayersApi sign POST /api/v1/relayers/{relayer_id}/sign Signs data using the specified relayer.
RelayersApi signTransaction POST /api/v1/relayers/{relayer_id}/sign-transaction Signs a transaction using the specified relayer (Stellar only).
RelayersApi signTypedData POST /api/v1/relayers/{relayer_id}/sign-typed-data Signs typed data using the specified relayer.
RelayersApi updateRelayer PATCH /api/v1/relayers/{relayer_id} Updates a relayer's information based on the provided update request.
SignersApi createSigner POST /api/v1/signers Creates a new signer.
SignersApi deleteSigner DELETE /api/v1/signers/{signer_id} Deletes a signer by ID.
SignersApi getSigner GET /api/v1/signers/{signer_id} Retrieves details of a specific signer by ID.
SignersApi listSigners GET /api/v1/signers Signer routes implementation
SignersApi updateSigner PATCH /api/v1/signers/{signer_id} Updates an existing signer.

Documentation for Models

Documentation for Authorization

bearer_auth

  • Type: HTTP Bearer Token authentication