Auth0 API | Log Streams

Log Streams

log_streams

Methods

Delete Log Stream ->

delete/log-streams/{id}

Delete a log stream.

Get Log Streams -> Array<{ id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | 5 more...>

get/log-streams

Retrieve details on log streams.

Sample Response

[{
    "id": "string",
    "name": "string",
    "type": "eventbridge",
    "status": "active|paused|suspended",
    "sink": {
        "awsAccountId": "string",
        "awsRegion": "string",
        "awsPartnerEventSource": "string"
    }
}, {
    "id": "string",
    "name": "string",
    "type": "http",
    "status": "active|paused|suspended",
    "sink": {
        "httpContentFormat": "JSONLINES|JSONARRAY",
        "httpContentType": "string",
        "httpEndpoint": "string",
        "httpAuthorization": "string"
    }
},
{
    "id": "string",
    "name": "string",
    "type": "eventgrid",
    "status": "active|paused|suspended",
    "sink": {
        "azureSubscriptionId": "string",
        "azureResourceGroup": "string",
        "azureRegion": "string",
        "azurePartnerTopic": "string"
    }
},
{
    "id": "string",
    "name": "string",
    "type": "splunk",
    "status": "active|paused|suspended",
    "sink": {
        "splunkDomain": "string",
        "splunkToken": "string",
        "splunkPort": "string",
        "splunkSecure": "boolean"
    }
},
{
    "id": "string",
    "name": "string",
    "type": "sumo",
    "status": "active|paused|suspended",
    "sink": {
        "sumoSourceAddress": "string",
    }
},
{
    "id": "string",
    "name": "string",
    "type": "datadog",
    "status": "active|paused|suspended",
    "sink": {
        "datadogRegion": "string",
        "datadogApiKey": "string"
    }
}]

Get Log Stream By ID -> { id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | 5 more...

get/log-streams/{id}

Retrieve a log stream configuration and status.

Sample responses

Amazon EventBridge Log Stream

{
    "id": "string",
    "name": "string",
    "type": "eventbridge",
    "status": "active|paused|suspended",
    "sink": {
        "awsAccountId": "string",
        "awsRegion": "string",
        "awsPartnerEventSource": "string"
    }
}

HTTP Log Stream

{
    "id": "string",
    "name": "string",
    "type": "http",
    "status": "active|paused|suspended",
    "sink": {
        "httpContentFormat": "JSONLINES|JSONARRAY",
        "httpContentType": "string",
        "httpEndpoint": "string",
        "httpAuthorization": "string"
    }
}

Datadog Log Stream

{
    "id": "string",
    "name": "string",
    "type": "datadog",
    "status": "active|paused|suspended",
    "sink": {
        "datadogRegion": "string",
        "datadogApiKey": "string"
    }

}

Mixpanel

Request: <pre><code>{
  "name": "string",
  "type": "mixpanel",
  "sink": {
    "mixpanelRegion": "string", // "us" | "eu",
    "mixpanelProjectId": "string",
    "mixpanelServiceAccountUsername": "string",
    "mixpanelServiceAccountPassword": "string"
  }
} </code></pre>


Response: <pre><code>{
    "id": "string",
    "name": "string",
    "type": "mixpanel",
    "status": "active",
    "sink": {
      "mixpanelRegion": "string", // "us" | "eu",
      "mixpanelProjectId": "string",
      "mixpanelServiceAccountUsername": "string",
      "mixpanelServiceAccountPassword": "string" // the following is redacted on return
    }
  } </code></pre>

<h5>Segment</h5>

Request: <pre><code> {
  "name": "string",
  "type": "segment",
  "sink": {
    "segmentWriteKey": "string"
  }
}</code></pre>

Response: <pre><code>{
  "id": "string",
  "name": "string",
  "type": "segment",
  "status": "active",
  "sink": {
    "segmentWriteKey": "string"
  }
} </code></pre>

Splunk Log Stream

{
    "id": "string",
    "name": "string",
    "type": "splunk",
    "status": "active|paused|suspended",
    "sink": {
        "splunkDomain": "string",
        "splunkToken": "string",
        "splunkPort": "string",
        "splunkSecure": "boolean"
    }
}

Sumo Logic Log Stream

{
    "id": "string",
    "name": "string",
    "type": "sumo",
    "status": "active|paused|suspended",
    "sink": {
        "sumoSourceAddress": "string",
    }
}

Status

The status of a log stream maybe any of the following: 1. active - Stream is currently enabled. 2. paused - Stream is currently user disabled and will not attempt log delivery. 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.

Update A Log Stream -> { id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | { id, filters, isPriority, 4 more... } | 5 more...

patch/log-streams/{id}

Update a log stream.

Examples of how to use the PATCH endpoint.

The following fields may be updated in a PATCH operation:

name
status
sink

Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.

Update the status of a log stream

{
    "status": "active|paused"
}

Update the name of a log stream

{
    "name": "string"
}

Update the sink properties of a stream of type `http`

{
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONARRAY|JSONLINES",
    "httpAuthorization": "string"
  }
}

Update the sink properties of a stream of type `datadog`

{
  "sink": {
        "datadogRegion": "string",
        "datadogApiKey": "string"
  }
}

Update the sink properties of a stream of type `splunk`

{
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Update the sink properties of a stream of type `sumo`

{
  "sink": {
    "sumoSourceAddress": "string"
  }
}