- name: CI Test Integration

API tests are useful to help you monitor your API endpoints and alert you when they are failing or too slow. These checks verify that your applications are responding to requests, as well as that they meet any conditions you define—such as response time, HTTP status code, and header or body contents. Use the [Datadog API][1] to see the full list.

API tests configuration depends on the type of API test you want to create. There are two API test types: [HTTP test](?tab=httptest) and [SSL test](?tab=ssltest).

Define the `HTTP` or `SSL` request you want to be executed by Datadog:

4. **Select your tags**: The tags attached to your browser test. Use the `<KEY>:<VALUE>` format to filter on a `<VALUE>` for a given `<KEY>` on the [Synthetic Monitoring page][1].

{{< /tabs >}}

{{< tabs >}}

{{% tab "HTTP Test" %}}

When you set the alert conditions to: `An alert is triggered if any assertion fails for X minutes from any n of N locations`, an alert is triggered if:

* At least one location was in failure (at least one assertion failed) during the last *X* minutes, **AND**

* At one moment during the last *X* minutes, at least *n* locations were in failure

The uptime bar is displayed differently on your test result: location uptime is displayed on a per-evaluation basis (whether the last test was up or down). Total uptime is displayed based on the configured alert conditions. Notifications sent are based on the total uptime bar.

**Note**: You can decide the number of retries needed to consider a location as *failed* before sending a notification alert. By default, Synthetic tests do not retry after a failed result for a given location.

{{% tab "SSL Test" %}}

If one of the assertions defined fails for a given location, an alert is triggered.

{{% /tab %}}

| Error | Description |

|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| `CONNRESET` | The connection was abruptly closed by the remote server. Possible causes include the webserver encountering an error or crashing while responding, loss of connectivity of the webserver, etc. |

| DNS | DNS entry not found for the check URL. Possible causes include misconfigured check URL, wrong configuration of your DNS entries, etc. |

| `INVALID_REQUEST` | The configuration of the check is invalid (e.g., typo in the URL). |

| `SSL` | The SSL connection couldn't be performed. [See the dedicated error page for more information][2]. |

| `TIMEOUT` | The request couldn't be completed in a reasonable time. Two types of `TIMEOUT` can happen. A `TIMEOUT: The request couldn’t be completed in a reasonable time.` indicates that the timeout happened at the TCP socket connection level. A `TIMEOUT: Retrieving the response couldn’t be completed in a reasonable time.` indicates that the timeout happened on the overall run (which includes TCP socket connection, data transfer, and assertions). |

If a test fails, the uptime directly considers the endpoint as `down`. It is not re-tested until the next test run.

title: Synthetic CI Test Integration

description: Run Synthetic tests on-demand in your CI.

<div class="alert alert-warning">

This feature is in private beta. To request access, contact <a href="/help/">Datadog Support</a>.

</div>

On top of executing your tests at predefined intervals, you can also execute Datadog Synthetic tests on-demand using the dedicated API endpoints. You can execute Datadog Synthetic tests in your continuous integration (CI) pipelines, enabling you to block the deployment of branches which would break your key features and endpoints.

On top of these API endpoints, Datadog provides and maintains a command line interface (CLI), allowing you to easily integrate Datadog Synthetic tests with your CI tooling.

The package is published privately under [@datadog/datadog-ci][1] in the NPM registry.

Until it is made public, an NPM token is needed to access it. If you do not have an NPM token to access the package, reach out to [Datadog support][2].