# Audit Stream

## Get the audit stream configuration

:endpoint{method="GET" path="/api/audit-stream"}

**Response**

`200` — The Audit Stream configuration

- **`Active`** :span[boolean]{.type-label}
- **`Description`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}  
  Gets or sets a unique identifier for this resource.
- **`LastModifiedBy`** :span[string]{.type-label}  
  Gets or sets the username of the user who last modified this resource.
- **`LastModifiedOn`** :span[string]{.type-label}  
  Gets or sets the date/time that this resource was last modified. Format `date-time`.
- **`Links`** :span[object]{.type-label}  
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- **`StreamConfigurationResource`** :span[object]{.type-label}

:::api-example{label="Response"}
```json
{
  "Active": true,
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "StreamConfigurationResource": {}
}
```
:::

## Modify the audit stream configuration

:endpoint{method="PUT" path="/api/audit-stream"}

**Request Body**

- **`Active`** :span[boolean]{.type-label}
- **`Description`** :span[string]{.type-label}
- **`StreamConfigurationResource`** :span[object]{.type-label}

:::api-example{label="Request"}
```json
{
  "Active": true,
  "Description": "string",
  "StreamConfigurationResource": {}
}
```
:::

**Response**

`200` — The modified Audit Stream configuration

- **`Active`** :span[boolean]{.type-label}
- **`Description`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}  
  Gets or sets a unique identifier for this resource.
- **`LastModifiedBy`** :span[string]{.type-label}  
  Gets or sets the username of the user who last modified this resource.
- **`LastModifiedOn`** :span[string]{.type-label}  
  Gets or sets the date/time that this resource was last modified. Format `date-time`.
- **`Links`** :span[object]{.type-label}  
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- **`StreamConfigurationResource`** :span[object]{.type-label}

:::api-example{label="Response"}
```json
{
  "Active": true,
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "StreamConfigurationResource": {}
}
```
:::