---
title: Cloud Foundry API
description: Collects Cloud Foundry audit events.
breadcrumbs: Docs > Integrations > Cloud Foundry API
---

# Cloud Foundry API
Supported OS Integration version5.6.0
## Overview{% #overview %}

This check queries the [Cloud Foundry API](http://v3-apidocs.cloudfoundry.org) to collect audit events and send them to Datadog through the Agent.

**Minimum Agent version:** 7.23.0

## Setup{% #setup %}

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations) for guidance on applying these instructions.

### Installation{% #installation %}

The Cloud Foundry API check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package. No additional installation is needed on your server.

### Configuration{% #configuration %}

1. Edit the `cloud_foundry_api.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Cloud Foundry API data. See the [sample cloud_foundry_api.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/cloud_foundry_api/datadog_checks/cloud_foundry_api/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent).

### Validation{% #validation %}

[Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information) and look for `cloud_foundry_api` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **cloud\_foundry\_api.events.count**(count) | The count of events collected by this check*Shown as event* |

### Events{% #events %}

The Cloud Foundry API integration collects the configured audit events.

### Service Checks{% #service-checks %}

**cloud\_foundry\_api.api.can\_connect**

Returns `OK` if the check is able to connect to the API and collect audit events, `CRITICAL` otherwise.

*Statuses: ok, critical*

**cloud\_foundry\_api.uaa.can\_authenticate**

Returns `OK` if the check is able to authenticate with the UAA server and obtain an oauth token, `CRITICAL` otherwise.

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help).