elmah.io

elmah.io API

This is the public REST API for elmah.io. All of the integrations communicates with elmah.io through this API. For additional help getting started with the…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the public REST API for elmah.io. All of the integrations communicates with elmah.io through this API. For additional help getting started with the API, visit the following help articles: Using the REST API Where is my API key? Where is my log ID? How to configure API key permissions

Endpoints 22

Deployments

  • GETFetch a list of deployments./v3/deploymentsRequired permission: deployments_read
  • POSTCreate a new deployment./v3/deploymentsRequired permission: deployments_write
  • GETFetch a deployment by its ID./v3/deployments/:idRequired permission: deployments_read
  • DELETEDelete a deployment by its ID./v3/deployments/:idThis endpoint doesn't clear the version number of messages already annotated with this deployment version.<br/><br/>Required permission: deployments_delete

Heartbeats

  • POSTCreate a new heartbeat./v3/heartbeats/:logId/:idRequired permission: heartbeats_write

Logs

  • GETFetch a list of logs./v3/logsRequired permission: logs_read
  • POSTCreate a new log./v3/logsRequired permission: logs_write
  • GETFetch a log by its ID./v3/logs/:idRequired permission: logs_read
  • GETHelp diagnose logging problems./v3/logs/:id/_diagnoseRequired permission: messages_write
  • POSTDisable a log by its ID./v3/logs/:id/_disableRequired permission: logs_write
  • POSTEnable a log by its ID./v3/logs/:id/_enableRequired permission: logs_write

Messages

  • GETFetch messages from a log./v3/messages/:logId?pageIndex=0&pageSize=15&query=string&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&includeHeaders=falseRequired permission: messages_read
  • POSTCreate a new message./v3/messages/:logIdRequired permission: messages_write
  • DELETEDeletes a list of messages by logid and query./v3/messages/:logIdRequired permission: messages_delete
  • POSTCreate one or more new messages./v3/messages/:logId/_bulkRequired permission: messages_write
  • POSTMark a list of messages as fixed by logid and query./v3/messages/:logId/_fixRequired permission: messages_write
  • GETFetch a message by its ID./v3/messages/:logId/:idRequired permission: messages_read
  • DELETEDelete a message by its ID./v3/messages/:logId/:idRequired permission: messages_delete
  • POSTFix a message by its ID./v3/messages/:logId/:id/_fix?markAllAsFixed=falseRequired permission: messages_write
  • POSTHide a message by its ID./v3/messages/:logId/:id/_hideRequired permission: messages_write

SourceMaps

  • POSTCreate or update a translation between a minified JavaScript path to the minified JavaScript and source map files./v3/sourcemaps/:logIdRequired permission: sourcemaps_write

UptimeChecks

  • GETFetch a list of uptime checks. Currently in closed beta. Get in contact to get access to this endpoint./v3/uptimechecksRequired permission: uptimechecks_read

API details

Authentication
An API key in the api_key query parameter
Operations
22 operations on 16 pathsPOST 11GET 8DELETE 3
Main resources
Messages 9Logs 6Deployments 4Heartbeats 1SourceMaps 1UptimeChecks 1
Response formats
application/json text/json text/plain
Description format
OpenAPI 3.0.0, API version v3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the elmah.io API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the elmah.io API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Fetch a list of deployments.” (GET /v3/deployments), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the elmah.io API?

This is the public REST API for elmah.io. All of the integrations communicates with elmah.io through this API. For additional help getting started with the… It is listed under Developer tools and has 22 endpoints.

Who publishes the elmah.io API?

It is listed from elmah.io's public API description (an OpenAPI document), not published by elmah.io on Swastik Codes. Anyone who controls elmah.io can claim the profile by adding a DNS TXT record.

How do I authenticate with the elmah.io API?

With an API key in the api_key query parameter.

How many endpoints does the elmah.io API have?

22 operations on 16 paths (11 POST, 8 GET, 3 DELETE). The largest groups are Messages, Logs, Deployments, Heartbeats.

Is forking the elmah.io API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.