Our next-gen architecture is built to help you make sense of your ever-growing data. Watch a 4-min demo video!

Back to All Docs

Coralogix REST API /singles

Last Updated: Jan. 04, 2024

Send your logs using the Coralogix REST API /singles.

Endpoint URL

Input your Coralogix domain into the following endpoint URL: https://ingress.<domain>/logs/v1/singles.

Schema

Endpoint Details

URLhttps://ingress.<domain>/logs/v1/singles
HTTP MethodPOST
Content-Typeapplication/json
HeaderAuthorization: Bearer <Send-Your-Data API key>
  • We recommend sending logs in batches to minimize network calls.
  • The API is limited to a message size of 2MB which is approximately 3,000 medium-sized logs.
  • If you are using Ajax or a similar technology, you may need to send the data with JSON.stringify()).

POST Body

An array of JSON objects which contain:

RequiredProperty NameProperty TypeNote
timestampnumberUTC milliseconds since 1970 (supports sub-millisecond via a floating point)
YesapplicationNamestringusually used to separate environments
YessubsystemNamestringusually used to separate components
computerNamestring
severitynumber1 – Debug, 2 – Verbose, 3 – Info, 4 – Warn, 5 – Error, 6 – Critical
categorystringCategory field
classNamestringClass field
methodNamestringMethod field
threadIdstringThread ID field
hiResTimestampstringUTC nanoseconds since 1970(supports millisecond, microsecond and nanosecond)
Yestextstring/jsonevent log

Example

curl --location --request POST 'https://ingress.<domain>/logs/v1/singles' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <Send-Your-Data API key>' \
  --data-raw '[{
      "applicationName": "*insert desired application name*",
      "subsystemName": "*insert desired subsystem name*",
      "computerName": "*insert computer name*",
      "severity": 3,
      "text": "this is a normal text message",
      "category": "cat-1",
      "className": "class-1",
      "methodName": "method-1",
      "threadId": "thread-1",
      "timestamp": 1675148539123.342
    }, {
      "applicationName": "*insert desired application name*",
      "subsystemName": "*insert desired subsystem name*",
      "computerName": "*insert computer name*",
      "hiResTimestamp": "1675148539789123123",
      "severity": 5,
      "text": "{\"key1\":\"val1\",\"key2\":\"val2\",\"key3\":\"val3\",\"key4\":\"val4\"}",
      "category": "DAL",
      "className": "UserManager",
      "methodName": "RegisterUser",
      "threadId": "a-352"
    }]'

Note:

  • If you are sending a JSON payload note, we suggest escaping it and then inserting it into the text field, which should be sent as a string.
  • If timestamp is present, use milliseconds or microseconds. If not, we will inject the UTC time at the time the request is received.

Coralogix Dashboard

View your logs, with all metadata fields, in your Coralogix dashboard.

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].

On this page