Mezmo

Use this method to delete the archiving configuration. Changes the organization-wide log archive destination.

Use this method to delete a board.

Use this method to delete a category.

Use this method to delete a log group. Changes the organization's role-based access groups.

Use this method to delete an exclusion rule.

Delete a specific key by its `id`. Changes the organization's shared keys: a deleted or rotated key stops working for everything that uses it.

Removes a member from the organization. This does not delete the user. Changes organization membership and roles.

Use this method to delete a parsing template.

Use this method to delete a preset alert.

Deletes a screen.

Use this method to delete a view and any attached alerts.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Detaches a child organization from the enterprise. The child organization is not deleted and can continue to work afterwards. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Delete an Enterprise ServiceKey from list of keys for the Enterprise. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Removes existing Edge heartbeats. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Remove a data sample from the pipeline.

Removes a pipeline from the account.

Removes an alert attached to a pipeline component.

Remove sink from a pipeline.

Removes a source from a pipeline.

Removes transform from pipeline.

Remove Processor Group from a pipeline.

Removes an existing threshold alert.

Delete an unused gateway route. If the route is used by any active pipeline, an error will be returned.

Delete an access key. Changes the secrets pipeline ingress accepts for this shared source; a new key is returned once.

Removes a signing key attached to a gateway route. Changes the secrets pipeline ingress accepts for this shared source; a new key is returned once.

Delete a Processor Group.

Delete a Processor from a Processor Group.

Use this method to get an existing archiving configuration.

Get a list of boards.

Gets the configuration for a specific board.

Returns all Categories of a type.

Get a specific category.

Use this method to list the log groups.

Use this method to get information on a group.

Gets the configuration for an Index Rate Alert.

Returns a list of exclusion rules. Note: This does not return usage quota rules.

Returns an exclusion rule with the id specified.

Retrieve the status of ingestion.

Retrieve a list of all the keys for an account. Supported key types include `ingestion` and `service`. Use the `type` parameter to filter which type of keys to retrieve.

Retrieves a specific key by its `id`.

Retrieves all of the current members in an organization and returns their email, role, and groups.

Returns the role and groups of the specified member.

Get a list of custom parsing templates.

Gets the configuration for a specific parsing template.

Returns all Preset Alerts in the account.

Get a specific preset alert.

List all screens in a short form that only includes the screen id and title.

Retrieve a specific screen.

Get a list of views.

Gets the configuration for a specific view.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Retrieves a list of all child organizations that belong to the enterprise. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Retrieves a specific child organization by its id. If the organization does not belong to the enterprise, a 404 error is returned. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Retrieves all keys of the enterprise. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Retrieves a specific enterprise key by its `id`. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Use this method to export logs in JSON format from a logging instance.

Lists aggregated usage information for all apps during a time period.

Gets the aggregated usage information for an app matching the name provided as a path parameter, during a time period. Returns null when not found.

Lists aggregated usage information for all hosts during a time period.

Gets the aggregated usage information for a host matching the name provided as a path parameter, during a time period. Returns null when not found.

Lists aggregated usage information for all tags during a time period.

Gets the aggregated usage information for a tag matching the name provided as a path parameter, during a time period. Returns null when not found.

Use this method to export logs in JSON format from a logging instance.

Get aggregated usage information for an account's data during a time period.

Lists aggregated usage information for all apps during a time period.

Gets the aggregated usage information for an app matching the name provided as a path parameter during a time period. The `results` will either have a singular item, or be an empty array.

Lists aggregated usage information for all hosts during a time period.

Gets the aggregated usage information for a host matching the name provided as a path parameter during a time period. The `results` will either have a singular item, or be an empty array.

Lists aggregated usage information for all tags during a time period.

Gets the aggregated usage information for a tag matching the name provided as a path parameter during a time period. The `results` will either have a singular item, or be an empty array.

Retrieve a list of AI investigations for the account.

Retrieve a specific AI investigation by its ID.

Get an Enterprise and its child Accounts. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Retrieve a specific child account under an enterprise organization. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Get pipelines for all child organizations of an enterprise. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Get pipeline health metrics for all child organizations of an enterprise. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Get pipeline usage metrics for all child organizations of an enterprise. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Get pipeline node types, operators and alert schemas. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

List all pipelines for the account.

Get list of settings applied to an account.

Gets client configuration for Edge pipelines. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

List all Edge check-ins for the account. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Poll and claim available local deployment tasks for a pipeline. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Retrieve a paginated list of pipeline audit events for an account.

Returns a list of data samples that exist in the pipeline.

Returns a data sample.

Retrieve a pipeline configuration.

List of alerts attached to a pipeline's components.

Retrieves an alert attached to a pipeline component.

Query and fetch event metrics for a pipeline.

Returns a list of revisions that exist in the pipeline.

Returns a pipeline configuration from a particular version.

Fetch a sink configuration of a pipeline.

Fetches configuration of a source.

Fetch transform configuration.

Fetch classifier analysis for a pipeline transform.

Fetch Processor Group in a pipeline.

Returns configuration of existing threshold alerts.

Returns usage threshold configuration.

Retrieve information about a classification of a shared source.

Get Field Summary for an analysis.

Get Field Summary values for a field in an analysis.

List all of the shareable gateway routes for an account.

Retreive a gateway route.

Retrieves a list of grok patterns available to use.

Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources.

Query and fetch health information for the current account.

Query and fetch usage metrics for the current account.

Query and fetch usage metrics from data profiling.

Query and fetch log clustering usage metrics from data profiling.

Query and fetch log cluster samples from data profiling.

A list of all available nodes for use when creating pipelines.

List all state variables defined in the account.

Fetches the value of a state variable.

Export a SaaS pipeline to a portable YAML or JSON manifest. Requires pipeline:read.

Fetch transform classifier analyses.

List all Processor Groups for the account.

Get a Processor Group.

List all Processor Group revisions.

Fetch Processor Group revision.

Get a Processor from a Processor Group.

Use this method to modify a log group. You can change the name of the group and the access scope that defines the data that is accessible by members in that group. Changes the organization's role-based access groups.

Updates an existing exclusion rule.

Perform bulk operations (CREATE, UPDATE, DELETE) on Enterprise Accounts. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Moves an existing individual customer account under the owner ship of an existing enterprise with the option to change its direct owner. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Removes a specific account from under an enterprise making it an independant account. The account will be downgraded to a trial account once the process is complete. Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Update account settings.

Update a part of usage threshold alert.

Reset classification and profiling results.

Patches a gateway route.

Update one or many state variables.

Use this method to send logs to a logging instance. Authentication: You can find instructions on authentication here (/log-analysis-api/ref#authentication). Ingestion is similar to the other APIs, but instead of `servicekey` you will use `apikey` if you are using the header style authentication. Metadata: Meta is a field reserved for custom information associated with a log line. To add metadata to an API call, specify the `meta` field under the lines object. Metadata can be viewed inside that line's context WARNING: If inconsistent value types are used, that line's metadata, will not be parsed. For example, if a line is passed with a meta object, such as `meta.myfield` of type String, any subsequent lines with `meta.myfield` must have a String as the value type for `meta.myfield`. Please be aware of service limits (https://docs.mezmo.com/docs/Mezmo-ingestion-service-limits) on this endpoint. NOT CALLABLE with this integration's access key: ingestion needs an ingestion key on logs.mezmo.com.

Use this method to configure archiving for an instance. Only one archiving configuration may exist at any time. Changes the organization-wide log archive destination.

Use this method to create a board.

Creates a new category of this type.

Use this method to create a log group where you can scope the data that is accessible by members in that group. Changes the organization's role-based access groups.

Create a new ingestion exclusion rule to help reduce log volume.

Resumes ingestion if it has been previously suspended. Affects log ingestion for the WHOLE organization.

First step in suspending ingestion for the instance. Returns a token for use in /suspend/confirm to actually stop ingestion. Affects log ingestion for the WHOLE organization.

After /suspend is called, a token is returned for use with this route as a confirmation. Affects log ingestion for the WHOLE organization.

Create a new key of the type specified by the `type` parameter. If a name is not supplied, one will be auto generated. Changes the organization's shared keys: a deleted or rotated key stops working for everything that uses it.

Create a new user and add to the team by providing 'email', 'role' and an optional list of RBAC groups. Changes organization membership and roles.

Use this method to create a preset alert.

Creates a new screen.

Use this method to create a view and attach alerts to the view.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Attaches an existing organization to an enterprise. The `retention` and `owner` field are optional, and will be defaulted if not specified. To specify which child organization to attach, one of its service keys must be supplied through our typical service key authorization schema; either as basic authorization or through the `servicekey` header. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Generate a new ServiceKey for the enterprise. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Create a new Enterprise Child Organization (Account). Requires an Enterprise service-account (ste_) access key; an ordinary sts_/sta_ key is refused.

Creates a new pipeline (non published).

Posts deployment configuration+liveness for Edge pipelines, returning pipeline config. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Receive logs from an Edge pipeline. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Receive usage metrics from an Edge pipeline. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Add results for a given task. Intended for self-hosted Mezmo Edge instances; whether it answers on the cloud API is unverified.

Create sample data for use in simulation.

Create an alert attached to a pipeline component.

Prepare a pipeline for export into a terraform workspace.

Post log volume reduction actions to a pipeline.

Creates a new pipeline in the account.

Updates a pipeline configuration to a previous version.

Sends data to a vector instance with a simulated pipeline.

Add a sink to a pipeline.

Adds a source to a pipeline.

Start a tap operation to view data as it flows through the pipeline.

Add a transform to a pipeline.

Add Processor Group to a pipeline.

Creates a new usage threshold alert configuration.

Import a manifest as a new unpublished draft pipeline. Requires pipeline:write.

Inspect a manifest and report the secrets that must be supplied on import. Creates nothing. Requires pipeline:write.

Create a gateway route.

Create an access key associated with this gateway route. Changes the secrets pipeline ingress accepts for this shared source; a new key is returned once.

Simulate data flowing through a grok pattern.

Creates a new pipeline in the account that is prebuilt.

View results of sending data using a regular expression.

Add a pipeline state variable to the account.

Simulate data with a timestamp format.

Initialize a pipeline with provided components. All sources, transforms, and sinks are linked. Populates and publishes a new pipeline as specified.

Initialize a pipeline with provided components. The links for all components have to be determined by the caller. Populates and publishes a new pipeline as specified.

Create a new Processor Group.

Publish changes to a Processor Group.

Sends data to a vector instance with a simulated transform group.

Create a Processor in a Processor Group.

Create a new Processor Group from a set of Pipeline components.

Use this method to update an existing archiving configuration. Changes the organization-wide log archive destination.

Update a specific category.

Use this method to update an index rate alert. You can change the alert's configuration details.

Updates all of the fields described in the request body of the specified key. Fields left out of the body will remain unaffected. Changes the organization's shared keys: a deleted or rotated key stops working for everything that uses it.

Updates all the fields described in the request body of the specified member. Creates a member if the member doesn't exist already. Fields left out of the body will remain unaffected. Changes organization membership and roles.

Update a specific preset alert.

Use this method to update a view. You can change the view configuration details; add or remove view specific alerts; or attach and detach preset alerts.

Deprecated. Superseded by the `/v3/enterprise` endpoints under the Enterprise tag. Makes an update to the specified child organization. Used to modify the current retention with the `retention` field or the current owner with the `owner` field. NOT CALLABLE with this integration's access key: Enterprise v1 needs the enterprise-servicekey header. Use the Enterprise v3 tools.

Updates an existing data sample.

Update pipeline properties, like title.

Update an alert attached to a pipeline component.

Change a pipeline to enabled or disabled.

Updates a sink of a pipeline.

Updates a source in a pipeline.

Updates a transform of a pipeline.

Update Processor Group in a pipeline.

Replace an existing usage alert with this one.

Updates a gateway route.

Adds a signing key to a gateway route. Changes the secrets pipeline ingress accepts for this shared source; a new key is returned once.

Edits an existing state variable.

Update a Processor Group.

Update a Processor in a Processor Group.