TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

{
  "id": "<string>",
  "name": "<string>",
  "status": "active",
  "type": "http",
  "isPriority": true,
  "filters": [
    {
      "type": "category",
      "name": "auth.login.fail"
    }
  ],
  "pii_config": {
    "log_fields": [
      "first_name"
    ],
    "method": "mask",
    "algorithm": "xxhash"
  },
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentFormat": "JSONARRAY",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Update a log stream

Update a log stream. <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted. <h5>Update the status of a log stream</h5><pre><code>{ "status": "active|paused" }</code></pre> <h5>Update the name of a log stream</h5><pre><code>{ "name": "string" }</code></pre> <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{ "sink": { "httpEndpoint": "string", "httpContentType": "string", "httpContentFormat": "JSONARRAY|JSONLINES", "httpAuthorization": "string" } }</code></pre> <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{ "sink": { "datadogRegion": "string", "datadogApiKey": "string" } }</code></pre> <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{ "sink": { "splunkDomain": "string", "splunkToken": "string", "splunkPort": "string", "splunkSecure": "boolean" } }</code></pre> <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{ "sink": { "sumoSourceAddress": "string" } }</code></pre>

PATCH

/

log-streams

/

{id}

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.update("id", {});
}
main();

{
  "id": "<string>",
  "name": "<string>",
  "status": "active",
  "type": "http",
  "isPriority": true,
  "filters": [
    {
      "type": "category",
      "name": "auth.login.fail"
    }
  ],
  "pii_config": {
    "log_fields": [
      "first_name"
    ],
    "method": "mask",
    "algorithm": "xxhash"
  },
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentFormat": "JSONARRAY",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

The id of the log stream to get

Body

name

string

log stream name

status

enum<string>

The status of the log stream. Possible values: active, paused, suspended

Available options:

active,

paused,

suspended

isPriority

boolean

True for priority log streams, false for non-priority

filters

object[]

Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered.

Show child attributes

pii_config

object

Show child attributes

sink

object

Show child attributes

Response

Log stream updated

id

string<log-stream-id>

The id of the log stream

name

string

log stream name

status

enum<string>

The status of the log stream. Possible values: active, paused, suspended

Available options:

active,

paused,

suspended

type

enum<string>

Available options:

http

isPriority

boolean

True for priority log streams, false for non-priority

filters

object[]

Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered.

Show child attributes

pii_config

object

Show child attributes

sink

object

Show child attributes

Delete log stream

Search log events

⌘I