---
schema_version: "1"
id: 9a49a5ef678cb085c621d2c69d3d13645539d3168c79b02891946e81de30abb6
title: Getting Started with API Functional Monitoring
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/api-functional-monitoring/afm-getting-started.md
canonical_url: https://docs.mulesoft.com/api-functional-monitoring/afm-getting-started
source_site: docs.mulesoft.com
content_type: documentation
content_hash: b74f5e7bce89f28656fa2662240ea1adbe76f5cdba47b4bb038668820272beaa
description: MuleSoft Documentation Site
latest: true
---
---
product: API Functional Monitoring
---

# Getting Started with API Functional Monitoring

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

After you become familiar with the API Functional Monitoring UI and concepts covered in the
[API Functional Monitoring Overview](https://docs.mulesoft.com/api-functional-monitoring/), you are ready to start monitoring your APIs.

## Before You Begin

To use API Functional Monitoring, you must have the permissions required for the actions you want to
execute. Permissions are set by your organization administrator.

<table><colgroup><col> <col></colgroup><thead><tr><th>Permission</th><th>Actions</th></tr></thead><tbody><tr><td><p>Create Applications (Runtime Manager)</p></td><td><p>Create private locations</p></td></tr><tr><td><p>Delete Applications (Runtime Manager)</p></td><td><p>Delete private locations</p></td></tr><tr><td><p>Manage Settings (Runtime Manager)</p></td><td><p>Update private locations</p></td></tr><tr><td><p>View Environment</p></td><td><p>Log in using BAT CLI</p></td></tr><tr><td><p>View Organization</p></td><td><p>Use Secrets Manager through BAT CLI</p></td></tr><tr><td><p>Exchange Contributor (Exchange)</p></td><td><p>Create or modify a monitor; add or modify a schedule</p></td></tr><tr><td><p>Exchange Administrator (Exchange)</p></td><td><p>Create, modify, or delete a monitor; add, modify, or delete a schedule</p></td></tr></tbody><tfoot><tr><td><p>Grant access to secrets (Secrets Manager)</p></td><td><p>Use Secrets Manager</p></td></tr></tfoot></table>

## Monitor Your APIs Using the Functional Monitoring UI

To monitor your APIs in Functional Monitoring:

1.  [Create monitors](https://docs.mulesoft.com/api-functional-monitoring/afm-create-monitor) for the APIs that you want to test. This includes:

    - Adding locations and schedules

    - Configuring tests for the API endpoints

    - Setting notifications through reporting tools

2.  [View monitor history](https://docs.mulesoft.com/api-functional-monitoring/afm-view-test-history).

## Monitor Your APIs Using BAT CLI

To monitor your APIs using BAT CLI:

1.  [Install BAT CLI](https://docs.mulesoft.com/api-functional-monitoring/bat-install-task).

2.  Create a test suite [from an example](https://docs.mulesoft.com/api-functional-monitoring/bat-example-test-suite) or by
    [populating the lines yourself](https://docs.mulesoft.com/api-functional-monitoring/bat-start-new-project).

3.  [Write tests](https://docs.mulesoft.com/api-functional-monitoring/bat-write-tests-task) using BDD test-writing syntax.

4.  [Run a test suite](https://docs.mulesoft.com/api-functional-monitoring/bat-execute-task).

5.  [Schedule testing and monitoring](https://docs.mulesoft.com/api-functional-monitoring/bat-schedule-test-task).

6.  [Create monitors that use a specific location](https://docs.mulesoft.com/api-functional-monitoring/bat-schedule-for-particular-location).

## Additional Options and Reporting

Additionally you can:

- [Download monitors](https://docs.mulesoft.com/api-functional-monitoring/afm-download-test) from Functional Monitoring to use them with BAT CLI or to
  modify them to create more complex test cases.

- [Upload monitors](https://docs.mulesoft.com/api-functional-monitoring/afm-upload-monitor) you have manually written or modified to use them in
  Functional Monitoring.

- [Use BAT CLI to configure monitoring reports](https://docs.mulesoft.com/api-functional-monitoring/bat-reporting-task) in one of the supported
  reporting systems.

- [Write and run BAT tests in IntelliJ IDEA](https://docs.mulesoft.com/api-functional-monitoring/bat-intellij-idea).

## See Also

- [API Functional Monitoring Overview](https://docs.mulesoft.com/api-functional-monitoring/)

- [Managing Permissions in Access Management](https://docs.mulesoft.com/access-management/managing-permissions)