# Mezmo Docs: API References

> Explore guides, APIs, tutorials, and reference materials for collecting telemetry and using Mezmo’s SRE agent to manage production environments.

## API References

- [Mezmo API](https://docs.mezmo.com/docs/api.md): API access to Mezmo

### Mezmo API

#### Account

- [Get account details](https://docs.mezmo.com/api-reference/account/get-account-details.md): Get list of settings applied to an account
- [Update account details](https://docs.mezmo.com/api-reference/account/update-account-details.md): Update account settings
- [Update pipeline processing status](https://docs.mezmo.com/api-reference/account/update-pipeline-processing-status.md): Change a pipeline to enabled or disabled

#### Alerting

- [Update component alert](https://docs.mezmo.com/api-reference/alerting/update-component-alert.md): Update an alert attached to a pipeline component
- [Delete component alert](https://docs.mezmo.com/api-reference/alerting/delete-component-alert.md): Removes an alert attached to a pipeline component
- [Fetch component alert](https://docs.mezmo.com/api-reference/alerting/fetch-component-alert.md): Retrieves an alert attached to a pipeline component
- [List component alerts](https://docs.mezmo.com/api-reference/alerting/list-component-alerts.md): List of alerts attached to a pipeline's components
- [Create component alert](https://docs.mezmo.com/api-reference/alerting/create-component-alert.md): Create an alert attached to a pipeline component
- [Retrieves an existing usage threshold alert](https://docs.mezmo.com/api-reference/alerting/retrieves-an-existing-usage-threshold-alert.md): Returns usage threshold configuration
- [Update threshold alert](https://docs.mezmo.com/api-reference/alerting/update-threshold-alert.md): Replace an existing usage alert with this one
- [Remove usage threshold alert](https://docs.mezmo.com/api-reference/alerting/remove-usage-threshold-alert.md): Removes an existing threshold alert
- [Partially update an existing threshold alert](https://docs.mezmo.com/api-reference/alerting/partially-update-an-existing-threshold-alert.md): Update a part of usage threshold alert
- [List all threshold alerts](https://docs.mezmo.com/api-reference/alerting/list-all-threshold-alerts.md): Returns configuration of existing threshold alerts
- [Add usage alert](https://docs.mezmo.com/api-reference/alerting/add-usage-alert.md): Creates a new usage threshold alert configuration

#### Archiving

- [Get Archive Configuration](https://docs.mezmo.com/api-reference/archiving/get-archive-configuration.md): Use this method to get an existing archiving configuration.
- [Update Archive Configuration](https://docs.mezmo.com/api-reference/archiving/update-archive-configuration.md): Use this method to update an existing archiving configuration.
- [Create Archive Configuration](https://docs.mezmo.com/api-reference/archiving/create-archive-configuration.md): Use this method to configure archiving for an instance. Only one archiving configuration may exist at any time.
- [Delete Archive Configuration](https://docs.mezmo.com/api-reference/archiving/delete-archive-configuration.md): Use this method to delete the archiving configuration.

#### Board

- [List Boards](https://docs.mezmo.com/api-reference/board/list-boards.md): Get a list of boards.
- [Create Board](https://docs.mezmo.com/api-reference/board/create-board.md): Use this method to create a board.
- [Get Board](https://docs.mezmo.com/api-reference/board/get-board.md): Gets the configuration for a specific board.
- [Delete Board](https://docs.mezmo.com/api-reference/board/delete-board.md): Use this method to delete a board.

#### Configuration

- [List Views](https://docs.mezmo.com/api-reference/configuration/list-views.md): Get a list of views.
- [Create View](https://docs.mezmo.com/api-reference/configuration/create-view.md): Use this method to create a view and attach alerts to the view.
- [Get View](https://docs.mezmo.com/api-reference/configuration/get-view.md): Gets the configuration for a specific view.
- [Update View](https://docs.mezmo.com/api-reference/configuration/update-view.md): 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.
- [Delete View](https://docs.mezmo.com/api-reference/configuration/delete-view.md): Use this method to delete a view and any attached alerts.
- [List Preset Alerts](https://docs.mezmo.com/api-reference/configuration/list-preset-alerts.md): Returns all Preset Alerts in the account.
- [Create Preset Alert](https://docs.mezmo.com/api-reference/configuration/create-preset-alert.md): Use this method to create a preset alert.
- [Get Preset Alert](https://docs.mezmo.com/api-reference/configuration/get-preset-alert.md): Get a specific preset alert
- [Update Alert](https://docs.mezmo.com/api-reference/configuration/update-alert.md): Update a specific preset alert.
- [Delete Alert](https://docs.mezmo.com/api-reference/configuration/delete-alert.md): Use this method to delete a preset alert.
- [List Categories](https://docs.mezmo.com/api-reference/configuration/list-categories.md): Returns all Categories of a type.
- [Create New Category](https://docs.mezmo.com/api-reference/configuration/create-new-category.md): Creates a new category of this type.
- [Get Category](https://docs.mezmo.com/api-reference/configuration/get-category.md): Get a specific category
- [Update Category](https://docs.mezmo.com/api-reference/configuration/update-category.md): Update a specific category.
- [Delete Category](https://docs.mezmo.com/api-reference/configuration/delete-category.md): Use this method to delete a category.

#### Data Classification & Profiling

- [Fetch classifier information](https://docs.mezmo.com/api-reference/data-classification-&-profiling/fetch-classifier-information.md): Retrieve information about a classification of a shared source
- [Update analysis options](https://docs.mezmo.com/api-reference/data-classification-&-profiling/update-analysis-options.md): Reset classification and profiling results
- [Get Field Summary for an analysis](https://docs.mezmo.com/api-reference/data-classification-&-profiling/get-field-summary-for-an-analysis.md): Get Field Summary for an analysis
- [Get Field Summary values for a field in an analysis](https://docs.mezmo.com/api-reference/data-classification-&-profiling/get-field-summary-values-for-a-field-in-an-analysis.md): Get Field Summary values for a field in an analysis
- [Fetch usage metrics](https://docs.mezmo.com/api-reference/data-classification-&-profiling/fetch-usage-metrics.md): Query and fetch usage metrics from data profiling.
- [Get v3pipeline transform classifieranalysis](https://docs.mezmo.com/api-reference/data-classification-&-profiling/get-v3pipeline-transform-classifieranalysis.md)
- [Get v3pipelinetransformclassifieranalysis](https://docs.mezmo.com/api-reference/data-classification-&-profiling/get-v3pipelinetransformclassifieranalysis.md)

#### Edge - Local Deploy

- [Get client config](https://docs.mezmo.com/api-reference/edge--local-deploy/get-client-config.md): Gets client configuration for Edge pipelines
- [Post client config](https://docs.mezmo.com/api-reference/edge--local-deploy/post-client-config.md): Posts deployment configuration+liveness for Edge pipelines, returning pipeline config
- [Fetch logs from Edge](https://docs.mezmo.com/api-reference/edge--local-deploy/fetch-logs-from-edge.md): Receive logs from an Edge pipeline
- [Poll tasks](https://docs.mezmo.com/api-reference/edge--local-deploy/poll-tasks.md): Poll and claim available local deployment tasks for a pipeline
- [Remove heartbeat](https://docs.mezmo.com/api-reference/edge--local-deploy/remove-heartbeat.md): Removes existing Edge heartbeats
- [List all heartbeats](https://docs.mezmo.com/api-reference/edge--local-deploy/list-all-heartbeats.md): List all Edge check-ins for the account
- [Get usage metrics](https://docs.mezmo.com/api-reference/edge--local-deploy/get-usage-metrics.md): Receive usage metrics from an Edge pipeline
- [Add task result](https://docs.mezmo.com/api-reference/edge--local-deploy/add-task-result.md): Add results for a given task

#### Enterprise

- [Get an Enterprise and its child Accounts](https://docs.mezmo.com/api-reference/enterprise/get-an-enterprise-and-its-child-accounts.md): Get an Enterprise and its child Accounts
- [Create a new Enterprise Child Organization (Account)](https://docs.mezmo.com/api-reference/enterprise/create-a-new-enterprise-child-organization-account.md): Create a new Enterprise Child Organization (Account)
- [Perform bulk operations on Enterprise Accounts](https://docs.mezmo.com/api-reference/enterprise/perform-bulk-operations-on-enterprise-accounts.md): Perform bulk operations (CREATE, UPDATE, DELETE) on Enterprise Accounts
- [Retrieve a specific child account under an enterprise organization](https://docs.mezmo.com/api-reference/enterprise/retrieve-a-specific-child-account-under-an-enterprise-organization.md): Retrieve a specific child account under an enterprise organization
- [Link Child Account](https://docs.mezmo.com/api-reference/enterprise/link-child-account.md): Moves an existing individual customer account under the owner ship of an existing enterprise with the option to change its direct owner
- [Unlink Child Account](https://docs.mezmo.com/api-reference/enterprise/unlink-child-account.md): 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.
- [Get pipelines for all child organizations of an enterprise](https://docs.mezmo.com/api-reference/enterprise/get-pipelines-for-all-child-organizations-of-an-enterprise.md): Get pipelines for all child organizations of an enterprise
- [Get pipeline health metrics for all child organizations of an enterprise](https://docs.mezmo.com/api-reference/enterprise/get-pipeline-health-metrics-for-all-child-organizations-of-an-enterprise.md): Get pipeline health metrics for all child organizations of an enterprise
- [Get pipeline usage metrics for all child organizations of an enterprise](https://docs.mezmo.com/api-reference/enterprise/get-pipeline-usage-metrics-for-all-child-organizations-of-an-enterprise.md): Get pipeline usage metrics for all child organizations of an enterprise
- [Get pipeline node types and schemas](https://docs.mezmo.com/api-reference/enterprise/get-pipeline-node-types-and-schemas.md): Get pipeline node types, operators and alert schemas

#### Enterprise v1

- [List all accounts](https://docs.mezmo.com/api-reference/enterprise-v1/list-all-accounts.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Attach a child organization to an enterprise](https://docs.mezmo.com/api-reference/enterprise-v1/attach-a-child-organization-to-an-enterprise.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Get details of a child organization](https://docs.mezmo.com/api-reference/enterprise-v1/get-details-of-a-child-organization.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Update Child Organization Contract](https://docs.mezmo.com/api-reference/enterprise-v1/update-child-organization-contract.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Detach a child org from Enterprise](https://docs.mezmo.com/api-reference/enterprise-v1/detach-a-child-org-from-enterprise.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [List all enterprise keys](https://docs.mezmo.com/api-reference/enterprise-v1/list-all-enterprise-keys.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Generate a new Key for the Enterprise](https://docs.mezmo.com/api-reference/enterprise-v1/generate-a-new-key-for-the-enterprise.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Retrieve a specific entperise key](https://docs.mezmo.com/api-reference/enterprise-v1/retrieve-a-specific-entperise-key.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.
- [Delete an Enterprise ServiceKey](https://docs.mezmo.com/api-reference/enterprise-v1/delete-an-enterprise-servicekey.md): > **Deprecated.** Superseded by the `/v3/enterprise` endpoints under the **Enterprise** tag.

#### Exclusions

- [List Exclusion Rules](https://docs.mezmo.com/api-reference/exclusions/list-exclusion-rules.md): Returns a list of exclusion rules. Note: This does not return usage quota rules.
- [Create Exclusion Rule](https://docs.mezmo.com/api-reference/exclusions/create-exclusion-rule.md): Create a new ingestion exclusion rule to help reduce log volume
- [Get Exclusion Rule](https://docs.mezmo.com/api-reference/exclusions/get-exclusion-rule.md): Returns an exclusion rule with the id specified.
- [Delete Exclusion Rule](https://docs.mezmo.com/api-reference/exclusions/delete-exclusion-rule.md): Use this method to delete an exclusion rule.
- [Update Exclusion Rule](https://docs.mezmo.com/api-reference/exclusions/update-exclusion-rule.md): Updates an existing exclusion rule

#### Export

- [Export log lines](https://docs.mezmo.com/api-reference/export/export-log-lines.md): Use this method to export logs in JSON format from a logging instance.
- [Export log lines](https://docs.mezmo.com/api-reference/export/export-log-lines-1.md): Use this method to export logs in JSON format from a logging instance.

#### Groups

- [List Groups](https://docs.mezmo.com/api-reference/groups/list-groups.md): Use this method to list the log groups.
- [Create Group](https://docs.mezmo.com/api-reference/groups/create-group.md): Use this method to create a log group where you can scope the data that is accessible by members in that group.
- [Get Group](https://docs.mezmo.com/api-reference/groups/get-group.md): Use this method to get information on a group.
- [Delete Group](https://docs.mezmo.com/api-reference/groups/delete-group.md): Use this method to list the log groups.
- [Update Group](https://docs.mezmo.com/api-reference/groups/update-group.md): 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.

#### Incident Mode

- [Fetch state variable](https://docs.mezmo.com/api-reference/incident-mode/fetch-state-variable.md): Fetches the value of a state variable
- [Update state variable](https://docs.mezmo.com/api-reference/incident-mode/update-state-variable.md): Edits an existing state variable
- [List all state variables](https://docs.mezmo.com/api-reference/incident-mode/list-all-state-variables.md): List all state variables defined in the account
- [Create state variable](https://docs.mezmo.com/api-reference/incident-mode/create-state-variable.md): Add a pipeline state variable to the account
- [Partially update state variable](https://docs.mezmo.com/api-reference/incident-mode/partially-update-state-variable.md): Update one or many state variables

#### Index Rate Alert

- [Get Index Rate Alert](https://docs.mezmo.com/api-reference/index-rate-alert/get-index-rate-alert.md): Gets the configuration for an Index Rate Alert
- [Update Index Rate Alert](https://docs.mezmo.com/api-reference/index-rate-alert/update-index-rate-alert.md): Use this method to update an index rate alert. You can change the alert's configuration details.

#### Ingestion

- [Send Log Lines](https://docs.mezmo.com/api-reference/ingestion/send-log-lines.md): Use this method to send logs to a logging instance.

#### investigation

- [Retrieve a list of AI investigations for the account](https://docs.mezmo.com/api-reference/investigation/retrieve-a-list-of-ai-investigations-for-the-account.md): Retrieve a list of AI investigations for the account.
- [Retrieve a specific AI investigation.](https://docs.mezmo.com/api-reference/investigation/retrieve-a-specific-ai-investigation.md): Retrieve a specific AI investigation by its ID.

#### Keys

- [Retrieve a list of all the keys](https://docs.mezmo.com/api-reference/keys/retrieve-a-list-of-all-the-keys.md): 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.
- [Create a new key](https://docs.mezmo.com/api-reference/keys/create-a-new-key.md): Create a new key of the type specified by the `type` parameter. If a name is not supplied, one will be auto generated.
- [Retrieve a specific key](https://docs.mezmo.com/api-reference/keys/retrieve-a-specific-key.md): Retrieves a specific key by its `id`.
- [Update one or more fields of a key resource](https://docs.mezmo.com/api-reference/keys/update-one-or-more-fields-of-a-key-resource.md): Updates all of the fields described in the request body of the specified key. Fields left out of the body will remain unaffected.
- [Delete a specific key](https://docs.mezmo.com/api-reference/keys/delete-a-specific-key.md): Delete a specific key by its `id`.

#### Log Volume Reduction

- [Log Volume Reduction](https://docs.mezmo.com/api-reference/log-volume-reduction/log-volume-reduction.md): Post log volume reduction actions to a pipeline

#### Members

- [Lists all members](https://docs.mezmo.com/api-reference/members/lists-all-members.md): Retrieves all of the current members in an organization and returns their email, role, and groups.
- [Creates a new member](https://docs.mezmo.com/api-reference/members/creates-a-new-member.md): Create a new user and add to the team by providing 'email', 'role' and an optional list of RBAC groups.
- [Retrieve a member](https://docs.mezmo.com/api-reference/members/retrieve-a-member.md): Returns the role and groups of the specified member.
- [Update a member](https://docs.mezmo.com/api-reference/members/update-a-member.md): 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.
- [Delete a member](https://docs.mezmo.com/api-reference/members/delete-a-member.md): Removes a member from the organization. This does not delete the user.

#### Metrics

- [Get event metrics for a pipeline](https://docs.mezmo.com/api-reference/metrics/get-event-metrics-for-a-pipeline.md): Query and fetch event metrics for a pipeline
- [Fetch pipeline health metrics](https://docs.mezmo.com/api-reference/metrics/fetch-pipeline-health-metrics.md): Query and fetch health information for the current account.
- [Fetch account usage metics](https://docs.mezmo.com/api-reference/metrics/fetch-account-usage-metics.md): Query and fetch usage metrics for the current account.
- [Fetch log usage metrics](https://docs.mezmo.com/api-reference/metrics/fetch-log-usage-metrics.md): Query and fetch log clustering usage metrics from data profiling.
- [Fetch log cluster samples](https://docs.mezmo.com/api-reference/metrics/fetch-log-cluster-samples.md): Query and fetch log cluster samples from data profiling.

#### Parsing Template

- [List Parsing Templates](https://docs.mezmo.com/api-reference/parsing-template/list-parsing-templates.md): Get a list of custom parsing templates.
- [Get Parsing Template](https://docs.mezmo.com/api-reference/parsing-template/get-parsing-template.md): Gets the configuration for a specific parsing template.
- [Delete Parsing Template](https://docs.mezmo.com/api-reference/parsing-template/delete-parsing-template.md): Use this method to delete a parsing template.

#### Pipeline Export

- [Trigger pipeline export](https://docs.mezmo.com/api-reference/pipeline-export/trigger-pipeline-export.md): Prepare a pipeline for export into a terraform workspace.
- [Export pipeline to manifest](https://docs.mezmo.com/api-reference/pipeline-export/export-pipeline-to-manifest.md): Export a SaaS pipeline to a portable YAML or JSON manifest. Requires pipeline:read.

#### Pipeline Management

- [Fetch pipeline confg](https://docs.mezmo.com/api-reference/pipeline-management/fetch-pipeline-confg.md): Retrieve a pipeline configuration
- [Update pipeline](https://docs.mezmo.com/api-reference/pipeline-management/update-pipeline.md): Update pipeline properties, like title
- [Deletes a pipeline](https://docs.mezmo.com/api-reference/pipeline-management/deletes-a-pipeline.md): Removes a pipeline from the account
- [List all pipelines](https://docs.mezmo.com/api-reference/pipeline-management/list-all-pipelines.md): List all pipelines for the account
- [Create pipeline](https://docs.mezmo.com/api-reference/pipeline-management/create-pipeline.md): Creates a new pipeline (non published)
- [Fetch audit events](https://docs.mezmo.com/api-reference/pipeline-management/fetch-audit-events.md): Retrieve a paginated list of pipeline audit events for an account
- [Inspect a manifest's required secrets](https://docs.mezmo.com/api-reference/pipeline-management/inspect-a-manifests-required-secrets.md): Inspect a manifest and report the secrets that must be supplied on import. Creates nothing. Requires pipeline:write.
- [Import a manifest as a new pipeline](https://docs.mezmo.com/api-reference/pipeline-management/import-a-manifest-as-a-new-pipeline.md): Import a manifest as a new unpublished draft pipeline. Requires pipeline:write.
- [Summarize pipeline health for one or more pipelines](https://docs.mezmo.com/api-reference/pipeline-management/summarize-pipeline-health-for-one-or-more-pipelines.md): Returns overall ingestion health as well as pipeline-specific health, such as lag in a pipeline's sources.
- [List available pipeline nodes](https://docs.mezmo.com/api-reference/pipeline-management/list-available-pipeline-nodes.md): A list of all available nodes for use when creating pipelines
- [Add prebuilt pipeline to account](https://docs.mezmo.com/api-reference/pipeline-management/add-prebuilt-pipeline-to-account.md): Creates a new pipeline in the account that is prebuilt
- [Fetch pipeline revision](https://docs.mezmo.com/api-reference/pipeline-management/fetch-pipeline-revision.md): Returns a pipeline configuration from a particular version
- [List all pipeline revisions](https://docs.mezmo.com/api-reference/pipeline-management/list-all-pipeline-revisions.md): Returns a list of revisions that exist in the pipeline
- [Publish pipeline](https://docs.mezmo.com/api-reference/pipeline-management/publish-pipeline.md): Creates a new pipeline in the account
- [Revert pipeline to version](https://docs.mezmo.com/api-reference/pipeline-management/revert-pipeline-to-version.md): Updates a pipeline configuration to a previous version
- [Initialize a pipeline with provided components. All sources, transforms, and sinks are linked.](https://docs.mezmo.com/api-reference/pipeline-management/initialize-a-pipeline-with-provided-components-all-sources-transforms-and-sinks-are-linked.md): 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.](https://docs.mezmo.com/api-reference/pipeline-management/initialize-a-pipeline-with-provided-components-the-links-for-all-components-have-to-be-determined-by-the-caller.md): Populates and publishes a new pipeline as specified.

#### Pipeline Nodes

- [Fetch sink](https://docs.mezmo.com/api-reference/pipeline-nodes/fetch-sink.md): Fetch a sink configuration of a pipeline
- [Update sink](https://docs.mezmo.com/api-reference/pipeline-nodes/update-sink.md): Updates a sink of a pipeline
- [Delete sink](https://docs.mezmo.com/api-reference/pipeline-nodes/delete-sink.md): Remove sink from a pipeline
- [Add a sink to a pipeline](https://docs.mezmo.com/api-reference/pipeline-nodes/add-a-sink-to-a-pipeline.md)
- [Retrieve source](https://docs.mezmo.com/api-reference/pipeline-nodes/retrieve-source.md): Fetches configuration of a source
- [Update source](https://docs.mezmo.com/api-reference/pipeline-nodes/update-source.md): Updates a source in a pipeline
- [Remove source](https://docs.mezmo.com/api-reference/pipeline-nodes/remove-source.md): Removes a source from a pipeline
- [Add source](https://docs.mezmo.com/api-reference/pipeline-nodes/add-source.md): Adds a source to a pipeline
- [Fetch transform](https://docs.mezmo.com/api-reference/pipeline-nodes/fetch-transform.md): Fetch transform configuration
- [Update transform](https://docs.mezmo.com/api-reference/pipeline-nodes/update-transform.md): Updates a transform of a pipeline
- [Remove transform](https://docs.mezmo.com/api-reference/pipeline-nodes/remove-transform.md): Removes transform from pipeline
- [Add transform](https://docs.mezmo.com/api-reference/pipeline-nodes/add-transform.md): Add a transform to a pipeline
- [Get v3pipeline transform group](https://docs.mezmo.com/api-reference/pipeline-nodes/get-v3pipeline-transform-group.md)
- [Put v3pipeline transform group](https://docs.mezmo.com/api-reference/pipeline-nodes/put-v3pipeline-transform-group.md)
- [Delete v3pipeline transform group](https://docs.mezmo.com/api-reference/pipeline-nodes/delete-v3pipeline-transform-group.md)
- [Post v3pipeline transform group](https://docs.mezmo.com/api-reference/pipeline-nodes/post-v3pipeline-transform-group.md)

#### Processor Groups

- [Get v3transform group](https://docs.mezmo.com/api-reference/processor-groups/get-v3transform-group.md): Get a Processor Group
- [Put v3transform group](https://docs.mezmo.com/api-reference/processor-groups/put-v3transform-group.md): Update a Processor Group
- [Delete v3transform group](https://docs.mezmo.com/api-reference/processor-groups/delete-v3transform-group.md): Delete a Processor Group
- [Get v3transform group 1](https://docs.mezmo.com/api-reference/processor-groups/get-v3transform-group-1.md): List all Processor Groups for the account
- [Post v3transform group](https://docs.mezmo.com/api-reference/processor-groups/post-v3transform-group.md): Create a new Processor Group
- [Post v3transform group publish](https://docs.mezmo.com/api-reference/processor-groups/post-v3transform-group-publish.md): Publish changes to a Processor Group
- [Post v3transform groupfrom pipeline](https://docs.mezmo.com/api-reference/processor-groups/post-v3transform-groupfrom-pipeline.md): Create a new Processor Group from a set of Pipeline components
- [Get v3transform group revision](https://docs.mezmo.com/api-reference/processor-groups/get-v3transform-group-revision.md)
- [Get v3transform group revision 1](https://docs.mezmo.com/api-reference/processor-groups/get-v3transform-group-revision-1.md)
- [Get v3transform group transform](https://docs.mezmo.com/api-reference/processor-groups/get-v3transform-group-transform.md): Get a Processor from a Processor Group
- [Put v3transform group transform](https://docs.mezmo.com/api-reference/processor-groups/put-v3transform-group-transform.md): Update a Processor in a Processor Group
- [Delete v3transform group transform](https://docs.mezmo.com/api-reference/processor-groups/delete-v3transform-group-transform.md): Delete a Processor from a Processor Group
- [Post v3transform group transform](https://docs.mezmo.com/api-reference/processor-groups/post-v3transform-group-transform.md): Create a Processor in a Processor Group

#### Sampling and Simulation

- [Retrieve grok pattern](https://docs.mezmo.com/api-reference/sampling-and-simulation/retrieve-grok-pattern.md): Retrieves a list of grok patterns available to use
- [Simulate grok pattern](https://docs.mezmo.com/api-reference/sampling-and-simulation/simulate-grok-pattern.md): Simulate data flowing through a grok pattern
- [Simulate regex pattern](https://docs.mezmo.com/api-reference/sampling-and-simulation/simulate-regex-pattern.md): View results of sending data using a regular expression
- [Start simulation of pipeline](https://docs.mezmo.com/api-reference/sampling-and-simulation/start-simulation-of-pipeline.md): Sends data to a vector instance with a simulated pipeline
- [Start pipeline tap](https://docs.mezmo.com/api-reference/sampling-and-simulation/start-pipeline-tap.md): Start a tap operation to view data as it flows through the pipeline.
- [Simulate timestamp pattern](https://docs.mezmo.com/api-reference/sampling-and-simulation/simulate-timestamp-pattern.md): Simulate data with a timestamp format
- [Fetch data sample](https://docs.mezmo.com/api-reference/sampling-and-simulation/fetch-data-sample.md): Returns a data sample
- [Update data sample](https://docs.mezmo.com/api-reference/sampling-and-simulation/update-data-sample.md): Updates an existing data sample
- [Delete data sample](https://docs.mezmo.com/api-reference/sampling-and-simulation/delete-data-sample.md): Remove a data sample from the pipeline
- [List data samples](https://docs.mezmo.com/api-reference/sampling-and-simulation/list-data-samples.md): Returns a list of data samples that exist in the pipeline
- [Create data sample](https://docs.mezmo.com/api-reference/sampling-and-simulation/create-data-sample.md): Create sample data for use in simulation
- [Post v3transform group simulate](https://docs.mezmo.com/api-reference/sampling-and-simulation/post-v3transform-group-simulate.md): Sends data to a vector instance with a simulated transform group

#### Screens

- [List all screens](https://docs.mezmo.com/api-reference/screens/list-all-screens.md): List all screens in a short form that only includes the screen id and title.
- [Creates a new screen](https://docs.mezmo.com/api-reference/screens/creates-a-new-screen.md): Creates a new screen
- [Retrieve a screen](https://docs.mezmo.com/api-reference/screens/retrieve-a-screen.md): Retrieve a specific screen
- [Delete a screen](https://docs.mezmo.com/api-reference/screens/delete-a-screen.md): Deletes a screen

#### Shared Sources

- [Retrieve gateway route](https://docs.mezmo.com/api-reference/shared-sources/retrieve-gateway-route.md): Retreive a gateway route
- [Update gateway route](https://docs.mezmo.com/api-reference/shared-sources/update-gateway-route.md): Updates a gateway route
- [Delete gateway route](https://docs.mezmo.com/api-reference/shared-sources/delete-gateway-route.md): Delete an unused gateway route. If the route is used by any active pipeline, an error will be returned.
- [Update gateway route property](https://docs.mezmo.com/api-reference/shared-sources/update-gateway-route-property.md): Patches a gateway route
- [List all gateway routes](https://docs.mezmo.com/api-reference/shared-sources/list-all-gateway-routes.md): List all of the shareable gateway routes for an account
- [Create gateway route](https://docs.mezmo.com/api-reference/shared-sources/create-gateway-route.md): Create a gateway route
- [Delete access key](https://docs.mezmo.com/api-reference/shared-sources/delete-access-key.md): Delete an access key
- [Create access key](https://docs.mezmo.com/api-reference/shared-sources/create-access-key.md): Create an access key associated with this gateway route
- [Delete signing key](https://docs.mezmo.com/api-reference/shared-sources/delete-signing-key.md): Removes a signing key attached to a gateway route
- [Add signing key](https://docs.mezmo.com/api-reference/shared-sources/add-signing-key.md): Adds a signing key to a gateway route

#### Suspensions

- [Get Ingestion Status](https://docs.mezmo.com/api-reference/suspensions/get-ingestion-status.md): Retrieve the status of ingestion
- [Initiate Ingestion Suspension](https://docs.mezmo.com/api-reference/suspensions/initiate-ingestion-suspension.md): First step in suspending ingestion for the instance. Returns a token for use in /suspend/confirm to actually stop ingestion
- [Confirm Ingestion Suspension](https://docs.mezmo.com/api-reference/suspensions/confirm-ingestion-suspension.md): After /suspend is called, a token is returned for use with this route as a confirmation.
- [Resume Ingestion](https://docs.mezmo.com/api-reference/suspensions/resume-ingestion.md): Resumes ingestion if it has been previously suspended

#### Usage v1

- [List Usage By App](https://docs.mezmo.com/api-reference/usage-v1/list-usage-by-app.md): Lists aggregated usage information for all apps during a time period.
- [Get Usage By App](https://docs.mezmo.com/api-reference/usage-v1/get-usage-by-app.md): 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.
- [List Usage by Tag](https://docs.mezmo.com/api-reference/usage-v1/list-usage-by-tag.md): Lists aggregated usage information for all tags during a time period.
- [Get Usage by Tag](https://docs.mezmo.com/api-reference/usage-v1/get-usage-by-tag.md): 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.
- [List Usage by Host](https://docs.mezmo.com/api-reference/usage-v1/list-usage-by-host.md): Lists aggregated usage information for all hosts during a time period.
- [Get Usage by Host](https://docs.mezmo.com/api-reference/usage-v1/get-usage-by-host.md): 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.

#### Usage v2

- [Retrieve account usage totals](https://docs.mezmo.com/api-reference/usage-v2/retrieve-account-usage-totals.md): Get aggregated usage information for an account's data during a time period.
- [List Usage By App](https://docs.mezmo.com/api-reference/usage-v2/list-usage-by-app.md): Lists aggregated usage information for all apps during a time period.
- [Get Usage By App](https://docs.mezmo.com/api-reference/usage-v2/get-usage-by-app.md): 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.
- [List Usage by Host](https://docs.mezmo.com/api-reference/usage-v2/list-usage-by-host.md): Lists aggregated usage information for all hosts during a time period.
- [Get Usage by Host](https://docs.mezmo.com/api-reference/usage-v2/get-usage-by-host.md): 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.
- [List Usage by Tag](https://docs.mezmo.com/api-reference/usage-v2/list-usage-by-tag.md): Lists aggregated usage information for all tags during a time period.
- [Get Usage by Tag](https://docs.mezmo.com/api-reference/usage-v2/get-usage-by-tag.md): 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.

## OpenAPI Specs

- [combined-mezmo-api](/apis/combined-mezmo-api.yaml)
