> For the complete documentation index, see [llms.txt](https://docs.octoxlabs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.octoxlabs.com/adapters/adapters/upkeep.md).

# Upkeep

## Connection Requirements

{% stepper %}
{% step %}

### Domain

Enter the domain of your UpKeep instance. This is the URL where the service is hosted. (default: **api.onupkeep.com**)
{% endstep %}

{% step %}

### User Email

Email that has read API access to UpKeep instance.
{% endstep %}

{% step %}

### Password

Password for the email that has been used.
{% endstep %}

{% step %}

### Proxy

Proxy url. (optional)
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
It is important to run a connection test to confirm that a valid connection can be made to the UpKeep host. Once the discovery process is complete, you will see the connection details on the Assets page.
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.octoxlabs.com/adapters/adapters/upkeep.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.