> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/develop/developer-tools-and-resources/automation-testing/how-to-perform-api-automation-testing.md).

# Performing API Automation Testing

The /e2e-tests folder comprises guardian Cypress test automation framework and automated UI and API tests

### Software Requirements

* Node.js 12 or 14 and above
* Follow steps from the [README](https://github.com/hashgraph/guardian/blob/main/README.md) to install and deploy Guardian application

### Installation

From /e2e-tests folder run the following command to install Cypress:

```
npm install cypress --save-dev
```

### Configuration

In cypress.env.json file update `authorization` key with `access_key` value which will be assigned to the RootAuthority after registration (bearerAuth)

### Usage

To run a specific test from UI you can open Cypress dashboard by running the following command:

```
npx cypress open
```

To run all tests sequentially use:

```
npx cypress run
```

For a single test use:

```
npx cypress run --spec path/to/file.cy.js
```

###


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://guardian.hedera.com/docs/develop/developer-tools-and-resources/automation-testing/how-to-perform-api-automation-testing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
