
### The API token:
Log Harvestor API utilizes [*JSON Web Tokens (JWT)*](https://jwt.io/) for authentication.
  Both [users](/docs/api/users) and [forwarders](/docs/api/forwarders) utilize these tokens for sending requests. 
  The [users](/docs/api/users) use the tokens to access their own data, while [forwarders](/docs/api/forwarders) use the tokens to send data to Log harvestor.

### Obtaining an API token:
1. [Users](/docs/api/users) can obtain an API token by signing in with their credentials. See the [sign-in](/auth/sign-in) endpoint.
2. [Forwarders](/docs/api/forwarders) tokens can be generated within the app, or via the API. **See the [forwarder generate-token](/docs/api/forwarders/generate-token) endpoint.**

### Token usage:
- Both [users](/docs/api/users) and [forwarders](/docs/api/forwarders) must embed their token in the **Authorization** header of their requests.
- The token must be prefixed with the string "Bearer <token>".
- Example: `{ Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...." }`

### Token permissions:
- [Users](/docs/api/users) tokens can perform almost all the actions that can be performed via the application. 
- [Users](/docs/api/users) cannot send logs to Log Harvestor.
- [Forwarders](/docs/api/forwarders) can only send data. They cannot access any data.


### Important:
> - Log Harvestor has restricted irreversible actions to the application only. So even if someone obtains your token, they cannot delete your account, or forwarders, or data.
> - Howerver, API tokens can do a lot of damage if they fall into the wrong hands. If someone obtains your token, they can access your data, make serious changes, or even add false data.
> - Ensure that you are keeping your tokens secure. NEVER share your tokens in a public forum, a public repository, or any place where someone nefarious could access them. 

  

Auth

This endpoint generates a [user](/docs/api/users) token returns a token that can be used to access the API.

Sign in

email

password

Invalid Credentials

Unauthorized

Internal Server Error


This endpoint generates a new [user](/docs/api/users) token from a valid, non-expired [users](/docs/api/users) token. 

Once a [users](/docs/api/users) token is expired, it can no longer be refreshed and instead, a new token must be generated via the [sign-in](/auth/sign-in) endpoint.

A refresh token returns a new [users](/docs/api/users) token that will replace the old one. The old token will no longer be valid.
      
The new token is utilized in the same way the previous token is utilized.
      

Refresh token

Authorization

Invalid Token


This endpoint validates a [user](/docs/api/users)token.

A valid token must meet the following criteria:
- The token must be signed and originated by Log Harvestor.
- The token must not be expired.
- The token must not be revoked.
- The token must not be blacklisted.
- The token must not be malformed.
- The token must not be tampered with.
      

Validate token


### The Card:
Cards are the primary building blocks for [dashboards](/docs/api/dashboards).

They are created from **queries** and can be configured to display data in a variety of ways.

### Card permissions:
A card can be created and shared between multiple [dashboards](/docs/api/dashboards). However, the card will only be able to query data that the [user](/docs/api/users) has access to.

Only the [user](/docs/api/users) that created the card can edit or delete the card.

### Card types: 
>**Count**: *A single number*. -- total users, the number of errors, etc.
>
>**List**: *List of items*. -- the most recent errors, the most recent users, etc.
>
>**Bar**: *Bar chart*. -- number [logs](/docs/api/logs) over time, the number of users over time, etc.
>
>**Line**: *Line chart*. -- the number of [logs](/docs/api/logs) over time, the number of users over time, etc.
>
>**Pie**: *Pie chart*. -- the number of [logs](/docs/api/logs) by type, the number of [logs](/docs/api/logs) by origin, etc.

### Card data:
- Card data is updated in real-time as new data is added to the system and whenever the query is ran.
- A shared card can display different data depending on the permissions of the [user](/docs/api/users) that is viewing the card.
> **For example:** 
> 
> If a card is configured to display a certain number of error [logs](/docs/api/logs), then the card will display the number of errors [logs](/docs/api/logs) that the [user](/docs/api/users) has access to.
> 
> So a [user](/docs/api/users) that has access to all the orgs [projects](/docs/api/projects), will see the total number of errors [logs](/docs/api/logs) across all [projects](/docs/api/projects).
> 
> But a [user](/docs/api/users) that only has access to a single [project](/docs/api/projects), will only see the number of errors [logs](/docs/api/logs) for that [project](/docs/api/projects).

### Note:
- Please reach out to us if you have any questions or need help with anything.
- If you have any suggestions for new card types, please let us know.
    

Cards

Fetch all cards that the user has access to.

Get all

Error line card

Returns a list of logs with a type of error

Logs with type of error

Errors over time

Invalid Role

Entity not found

Not Found

Find the card that matches the {cardId} query parameter.

Get by id

cardId

Retrieve the query data that the card is configured to display.

Get data

Count data

List data

Bar data

Line data

Pie data

Create

name

notes

type

title

topLabel

query

ownerEntityType

ownerEntity

Update


Delete a card. 
- This will permanently delete the card and all associated data.
- A successful response will return a snapshot of the card before it was deleted.
- If the card is already deleted, a 404 will be returned.

⚠️ WARNING ⚠️
- This action cannot be undone.
- If you do not want to permanently delete the card, consider archiving it instead.
            

Delete

Returns a snapshot of the card before it was deleted.

Unarchive


### The Dashboard:
Dashboards are a group of [cards](/docs/api/cards) that allow you to visualize your data in a variety of ways.

### Sharing:
A dashboard can be shared between multiple [users](/docs/api/users), [organizations](/docs/api/orgs), and [projects](/docs/api/projects). However, the [dashboard's](/docs/api/dashboards) [cards](/docs/api/cards) will only be able to query data that the [user](/docs/api/users) has access to.

### Ownership:
The owner of a [dashboard](/docs/api/dashboards) is determined by the `{ownerEntityType} ` and `{ownerEntity}` fields.
A dashboard can be owned by a [user](/docs/api/users), [organization](/docs/api/orgs), or [project](/docs/api/projects). 

The owner of the dashboard will be able to edit the dashboard and its [cards](/docs/api/cards). The owner will also be able to share the dashboard with other [users](/docs/api/users), [organizations](/docs/api/orgs), and [projects](/docs/api/projects).

### Card Configurations:
A dashboard is made up of [cards](/docs/api/cards). Each card has a configuration that determines what data the card will query and how it will be displayed.
A card configuration is made up of the following fields:
| Field | Type | Description |
| --- | --- | --- |
| `{card}` | string (identifier) | Card id |
| `{x}` | number | The distance from the left that the card's top-left corner begins |
| `{y}` | number | The distance from the top that the card's top-left begins |
| `{w}` | number | The width of the card |
| `{h}` | number | The height of the card |

    

Dashboards

Fetch all [dashboards](/docs/api/dashboards) that the [user](/docs/api/users) has access to.

Returns an array of [dashboards](/docs/api/dashboards).

Dashboard one

Find the [dashboards](/docs/api/dashboards) that matches the {dashboardId} query parameter.

dashboardId

Create a new [dashboard](/docs/api/dashboards).

cardConfigs

Update a [dashboard](/docs/api/dashboards).


Delete a [dashboard](/docs/api/dashboards). 
- This will permanently delete the [dashboard](/docs/api/dashboards) and all associated meta data.
- This will not delete any {cards} that are associated with the [dashboard](/docs/api/dashboards).
- A successful response will return a snapshot of the deleted [dashboard](/docs/api/dashboards).
- If the [dashboard](/docs/api/dashboards) is already deleted, this will return a 404.

⚠️ WARNING ⚠️
- This action cannot be undone.
- If you do not want to permanently delete the [dashboard](/docs/api/dashboards), consider archiving it instead.


Returns a snapshot of the deleted [dashboard](/docs/api/dashboards).

Archive a [dashboard](/docs/api/dashboards). This will prevent the [dashboard](/docs/api/dashboards) from being used, but will not delete it.

Unarchive a [dashboards](/docs/api/dashboards). This will allow the [dashboard](/docs/api/dashboards). to be used again.


### The Forwarder:
Forwarders are the main way to get data into LogHarvestor.

### Ownership:
Forwarders are owned by [projects](/docs/api/projects), which are owned by [organizations](/docs/api/orgs). This means that you can have multiple [forwarders](/docs/api/forwarders) per [project](/docs/api/projects), and multiple [projects](/docs/api/projects) per [organization](/docs/api/orgs).

### Security:
Forwarders are assigned tokens that are used to authenticate with the LogHarvestor API.
The tokens only allow the forwarder to send data to the LogHarvestor API, and do not allow the [forwarder](/docs/api/forwarders) to read any data from the LogHarvestor API.
Tokens are generated when the [forwarders](/docs/api/forwarders) is created, and can be regenerated at any time.
For more information about authentication, see the [authentication](/docs/api/auth) documentation.


Forwarders

Fetch all [forwarders](/docs/api/forwarders) that the [user](/docs/api/user) has access to.

Web server 1

Find the [forwarder](/docs/api/forwarders) that matches the {forwarderId} query parameter.

forwarderId

Get all events that the [forwarder](/docs/api/forwarders) has generated. These events are generated when the [forwarder](/docs/api/forwarders) is created, updated, enabled, or deleted.

Get events

Get all notifications settings configured for the forwarder.

Get notifications

Returns all notifications for the forwarder.

Error notification

Get all stats for the [forwarder](/docs/api/forwarders). This includes things like total logs, logs over time by type, total logs by type, etc.

Get stats

Create a new [forwarder](/docs/api/forwarders).

host

project

enabled

Update a [forwarder](/docs/api/forwarders). Note that the token can only be updated by generating a new token.

Returns the updated [forwarder](/docs/api/forwarders).


Delete a card. 
- This will permanently a [forwarder](/docs/api/forwarders) and all associated data.
- A successful response will return a snapshot of the [forwarder](/docs/api/forwarders) before it was deleted.
- If the [forwarder](/docs/api/forwarders) is already deleted, a 404 will be returned.
- Associated data that will be deleted includes: Events, Notifications & Stats
- [Logs](/docs/api/logs) will not be deleted. But will no longer be indexed by attributes of the [forwarder](/docs/api/forwarders).

⚠️ WARNING ⚠️
- This action cannot be undone.
- If you do not want to permanently delete the [forwarder](/docs/api/forwarders), consider archiving it instead.
            

Returns a snapshot of the forwarder before it was deleted.

Archive a forwarder. Archived forwarders cannot send logs even if they are enabled.

Unarchive a [forwarder](/docs/api/forwarders). Unarchived [forwarders](/docs/api/forwarders) can send [logs](/docs/api/logs) as long as they are enabled.

Enable a [forwarder](/docs/api/forwarders) - this allows the [forwarder](/docs/api/forwarders) to send [logs](/docs/api/logs).

Enable

Disable a [forwarder](/docs/api/forwarders) - disabled [forwarders](/docs/api/forwarders) cannot send [forwarder](/docs/api/forwarders).

Disable

Generate or regenerate a token for the forwarder. This token is used to send logs to LogHarvestor. Previous tokens no longer be valid.

Generate token

Validate a [forwarder](/docs/api/forwarders) token.
            A valid token must meet the following criteria:
            - The token must be signed and originated by Log Harvestor.
            - The token must not be expired.
            - The token must not be revoked.
            - The token must not be blacklisted.
            - The token must not be malformed.
            - The token must not be tampered with.
            - The forwarder must not be disabled, archived or deleted.
            - The forwarder settings must not be invalid. (ie. host, port, protocol, etc.)
            

token

True if the token is valid, false otherwise.


### The Log:
Logs, or events, are data records that indicate the state of a system at a specific point in time.

### Lifecycle of a log:
1. A [forwarder](/docs/api/forwarders) collects or generated a log
2. The [log](/docs/api/logs) is sent ("forwarded") by the [forwarder](/docs/api/forwarders) to Log Harvestor
3. Log Harvestor validates the [log](/docs/api/logs) and the [forwarder](/docs/api/forwarders) that sent it - invalid logs are rejected
4. If the [log](/docs/api/logs) is valid, it is then processed
5. The [log](/docs/api/logs) is then available for search and analysis
6. Once the log has reached a certain age, it is automatically rotated into cold storage/archival.

### Log Processing:
1. Parsing the [log](/docs/api/logs) into a structured format
2. Enriching the [log](/docs/api/logs) with additional data
3. Indexing the [log](/docs/api/logs) for search
4. Storing the [log](/docs/api/logs) in a database
5. Sending if any [notifications](/docs/api/notifications) if necessary

### Log Rotation:
- Log rotation is determined by the rentention policy for the [project](/docs/api/projects) and [organization](/docs/api/orgs) that the [log](/docs/api/logs) belongs to.
- Once a [log](/docs/api/logs) has reached the end of its retention period, it is automatically rotated into cold storage/archival.
- Once a [log](/docs/api/logs) has been rotated, it is no longer available for search or analysis.
- A log will remain in cold storage/archival until it is deleted by the user.

### Log Billing:
- For more information on how logs are billed, see the [pricing](/pricing) section.
- A log is only billed for once it has been processed and stored.
- Logs are billed based on the quantity, not their size.

### Flagging: 
- Flags help [users](/docs/api/users) identify [logs](/docs/api/logs) that may be problematic.
- Flags are visbile to all [users](/docs/api/users) who have access to the [log](/docs/api/logs) .

### Notifications:
- Notifications are sent to [users](/docs/api/users) when a [log](/docs/api/logs) matches a certain criteria.
- These criteria can be configured by the [user](/docs/api/users) in the [notifications](/docs/api/notifications).
- For more information on how notifications work, see the [notifications](/docs/api/notifications) section.

### Comments:
- Comments allow [users](/docs/api/users) to add additional information to a [log](/docs/api/logs) .
- Comments are stored as {events} on the [log](/docs/api/logs) . 
    

Logs

Get All

The number of results to return. Default is 50.

limit

page

sort

filter

Search

text

The start date to search for. Default is 0.

start

The end date to search for. Default is 0.

Whether or not the text is a regex. Default is false.

isRegex

Find the forwarder that matches the {id} query parameter.

Get By Id

Get all the events for a log. These events include things like `{comments}`, `{flags}`, `[notifications](/docs/api/notifications)`, and when a [log](/docs/api/logs)  is created, updated, or rotated.

Get Events

Get a list of [logs](/docs/api/logs) that are similar. This list is generated by comparing the target [log](/docs/api/logs) to other [logs](/docs/api/logs) that have been processed, and are not rotated or archived.

Get Similar

Get a list of all log types - [log](/docs/api/logs) types are fetched from [logs](/docs/api/logs) that have been processed, and are not rotated or archived.

Get log types

Send a single log to be processed - The [forwarder](/docs/api/forwarders) that sends the log must be enabled. The fwd attribute for the log will be derived from the authorization token.

Send one

Flag

Unflag

Add a {comment} to a [log](/docs/api/logs)

Comment

message


### The Notification:
Notifications are configurations that send alerts to [users](/docs/api/users) when a certain criteria has been met.

This criteria is defined in the [notification's](/docs/api/notifications) configuration. Each log that is processed is checked against the [notification's](/docs/api/notifications) configuration. If the log matches the configuration, then the [user](/docs/api/users) will notified.

### Configuration parts:
###### Owner 
- [User](/docs/api/users), [organization](/docs/api/orgs), or [project](/docs/api/projects) that the [notification](/docs/api/notifications) belongs to.
- This determines which logs the [notification](/docs/api/notifications) will be checked against.
- This also determines which [users](/docs/api/users) will be notified.
###### Rules (criteria) 
- Set of criteria that the log must match in order to trigger the [notification](/docs/api/notifications).
- Essentially a query that is run against the log. If the log matches the query, then the [notification](/docs/api/notifications) is triggered.
###### Mediums 
- The methods that Log Harvestor will utilize in order to notify the [user](/docs/api/users).
- Email, SMS, Slack, etc.

### Practical example: 
- A [user](/docs/api/users) creates a notification that will send an email to all [users](/docs/api/users) in their [organization](/docs/api/orgs).
- The [notification](/docs/api/notifications) is configured to trigger whenever a log is received that has a severity of "error".

### Enabling/Disabling:
- A [notification](/docs/api/notifications) can be enabled or disabled at any time.
- When a [notification](/docs/api/notifications) is disabled, it will not be checked against any logs.

### Inheritance:
- A [user](/docs/api/users) can inherit [notifications](/docs/api/notifications) from their [organization](/docs/api/orgs) or [project](/docs/api/projects).
- A [project](/docs/api/projects) can inherit [notifications](/docs/api/notifications) from their [organization](/docs/api/orgs).

### Access Control:
- A [notification](/docs/api/notifications) can only be edited by a [user](/docs/api/users) with proper access to it's owner.
- So if an [user](/docs/api/users) inherits a [notification](/docs/api/notifications) from their [organization](/docs/api/orgs), then they can only edit it if they have proper access to the [organization](/docs/api/orgs). 

### Silencing:
- A [user](/docs/api/users) can silence a notification at any time via the [user](/docs/api/users) settings.
- Silencing a [notification](/docs/api/notifications) will only stop that specific [user](/docs/api/users) from receiving the [notification](/docs/api/notifications).
- Silencing a [notification](/docs/api/notifications) will not prevent other [users](/docs/api/users) from receiving the [notification](/docs/api/notifications).
- To silence a [notification](/docs/api/notifications) for all [users](/docs/api/users), the [notification](/docs/api/notifications) must be disabled at the owner level.
    

Notifications

Get all [notifications](/docs/api/notifications) that the user has access to.

Get all [notification](/docs/api/notifications) owner options that the user has access to.

Get owner options

The type of entity to get options for. Must be one of: "org", "project", or "user".

entityType

Find the [notification](/docs/api/notifications) that matches the {id} query parameter.

Get all events that the [notification](/docs/api/notifications) has triggered. These include how and to whom the [notification](/docs/api/notifications) was sent, as well as when the [notification](/docs/api/notifications) was created or updated.

Create a new [notification](/docs/api/notifications). The [notification](/docs/api/notifications) will be enabled by default.

owner

rules

mediums

Update an existing [notification](/docs/api/notifications).

Delete an existing [notification](/docs/api/notifications).

Returns a snapshot of the deleted notification.

Archive an existing [notification](/docs/api/notifications).

Unarchive an existing [notification](/docs/api/notifications).

Enable or disable an existing [notification](/docs/api/notifications).

Enable/Disable


### The Organization:
Organizations (Orgs) are the top level of the Log Harvestor permissions hierarchy.
All billing is done at the Org level, and all users must belong to an Org.

### Structure:
An [organization](/docs/api/orgs) can have multiple [projects](/docs/api/projects) and [users](/docs/api/users).

[Users](/docs/api/users) assigned to an [organization](/docs/api/orgs) can have different roles, which determine what they can do within the [organization](/docs/api/orgs).

[Users](/docs/api/users) roles will be inherited by all [projects](/docs/api/projects) within the [organization](/docs/api/orgs).

[Users](/docs/api/users) roles will also be inherited by all other entites that belong to the [organization](/docs/api/orgs), such as [notifications](/docs/api/notifications), [tickets](/docs/api/tickets), [dashboards](/docs/api/dashboards), and [cards](/docs/api/cards).

[Users](/docs/api/users) can be assigned to multiple [organizations](/docs/api/orgs).

### Archiving/Deleting:
- All associated entities will be archived/deleted, such as [projects](/docs/api/projects), [forwarders](/docs/api/forwarders), [notifications](/docs/api/notifications), [tickets](/docs/api/tickets), [dashboards](/docs/api/dashboards), and [cards](/docs/api/cards).
- If the [organization](/docs/api/orgs) is archived, all [user](/docs/api/users) roles will stay unchanged.
- However, if the [organization](/docs/api/orgs) is deleted, all [user](/docs/api/users) roles will be removed.

### Billing:
- All [projects](/docs/api/projects) within an [organization](/docs/api/orgs) will be billed together.
- All other entities within an [organization](/docs/api/orgs) will also be billed under that organization.
- Billing cannot be managed via the API - all billing management must be done through the Log Harvestor application
- For more information on billing, see the [pricing](/pricing) section.
    

Orgs

Get all {organizations} that the user belongs to or has access to.

LogHarvestor

Find the [organization](/docs/api/orgs) that matches the {orgId} query parameter.

orgId

Get all the events for an [organization](/docs/api/orgs). These events include things like [user](/docs/api/users) or [project](/docs/api/projects) changes, {billing} events, any other related updates.

Get all the [notifications](/docs/api/notifications) for an [organization](/docs/api/orgs).

Get all the {stats} for an [organization](/docs/api/orgs). This includes things like the total numbers of [users](/docs/api/users), [projects](/docs/api/projects), [forwarders](/docs/api/forwarders), etc.

Create a new [organization](/docs/api/orgs).

billing

Update an [organization](/docs/api/orgs).


Delete an [organization](/docs/api/orgs). 
- This will permanently a [organization](/docs/api/orgs) and all associated data.
- A successful response will return a snapshot of the [organization](/docs/api/orgs) before it was deleted.
- If the [organization](/docs/api/orgs) is already deleted, a 404 will be returned.
- Associated data that will be deleted includes: Events, Notifications, & Stats
- Before deleting an [organization](/docs/api/orgs) - please contact support if you have any questions

⚠️ WARNING ⚠️
- This action cannot be undone.
- If you do not want to permanently delete the [organization](/docs/api/orgs), consider archiving it instead.
                        

Archive an [organization](/docs/api/orgs).

Unarchive an [organization](/docs/api/orgs).

Get all [users](/docs/api/users) that belong to or have access to an [organization](/docs/api/orgs).

Get users

Find a [user](/docs/api/users), belonging to the [organization](/docs/api/orgs), that matches the {userId} query parameter.

Get user by id

Add a new [user](/docs/api/users) to an [organization](/docs/api/orgs).

Add user

role

Update the {role} of a [user](/docs/api/users) in an [organization](/docs/api/orgs).

Update user role

userid

Remove a [user](/docs/api/users) from an [organization](/docs/api/orgs).

Remove user

Get all [forwarders](/docs/api/forwarders) that belong to an [organization](/docs/api/orgs).

Get forwarders


### The Ticket:
Tickets are used to track issues and requests that are submitted by users.

### Creating a ticket:
- [Users](/docs/api/users) can submit [tickets](/docs/api/tickets) to Log Harvestor {support} on behalf of themselves, their [organization](/docs/api/orgs) or their [project](/docs/api/projects).
- If a [ticket](/docs/api/tickets) is submitted on behalf of a [project](/docs/api/projects) or [organization](/docs/api/orgs), the [ticket](/docs/api/tickets) will be visible to all [users](/docs/api/users) that have access to the [project](/docs/api/projects) or [organization](/docs/api/orgs).
- [Tickets](/docs/api/tickets) can be created, updated, and deleted by the [user](/docs/api/users) that created the [ticket](/docs/api/tickets) or by a [user](/docs/api/users) that has access to the [ticket](/docs/api/tickets)'s [organization](/docs/api/orgs) or [project](/docs/api/projects).

### Referencing other Log Harvestor entities:
- [Tickets](/docs/api/tickets) can reference other entities such as a specific [log](/docs/api/logs) or [forwarder](/docs/api/forwarders).
- When referencing another entity, the [ticket](/docs/api/tickets) will be visible to all [users](/docs/api/users) that have access to the referenced entity.

### Service level agreements (SLAs):
- The time in which Log Harvestor support team is commited to responding to a [ticket](/docs/api/tickets) is determined by the {support} plan that the [user's](/docs/api/users) [organization](/docs/api/orgs) is subscribed to.
- For more information on support plans, see the [pricing](/pricing) section.
    

Tickets

Get all [tickets](/docs/api/tickets) that the [user](/docs/api/users) has access to.

The [ticket](/docs/api/tickets) objects with populated attributes.

Found a bug

Find the [ticket](/docs/api/tickets) that matches the {id} query parameter.

The [ticket](/docs/api/tickets) object with populated attributes.

Create a new [ticket](/docs/api/tickets).

forwarder

The newly created [ticket](/docs/api/tickets) object with populated attributes.

The updated [ticket](/docs/api/tickets) object with populated attributes.

Update the status of a [ticket](/docs/api/tickets).

Update status

status


Delete a [ticket](/docs/api/tickets). 
- This will permanently a [ticket](/docs/api/tickets) and all associated data.
- A successful response will return a snapshot of the [ticket](/docs/api/tickets) before it was deleted.
- If the [ticket](/docs/api/tickets) is already deleted, a 404 will be returned.
- Associated data that will be deleted includes: Events, Comments, Permissions, and Attachments.
- Before deleting an [ticket](/docs/api/tickets) - please contact support if you have any questions

⚠️ WARNING ⚠️
- This action cannot be undone.
- If you do not want to permanently delete the [ticket](/docs/api/tickets), consider archiving it instead.
                        

A snapshot of the [ticket](/docs/api/tickets) object before deletion.

The archived [ticket](/docs/api/tickets) object with populated attributes.

The unarchived [ticket](/docs/api/tickets) object with populated attributes.

Add a {comment} to a [ticket](/docs/api/tickets).

Add comment

Get all events for a [ticket](/docs/api/tickets). This includes things like {status} changes, {comment} additions, etc.

The {events} for the [ticket](/docs/api/tickets).


### The User:
[Users](/docs/api/users) can manage almost all of their settings and preferences via the API.

The execeptions to this are account deletion, archival, and password reset.
These actions must be performed within the Log Harvestor application.


Util

Health Check