> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/1-7-2/documentation/resources/endpoints.md).

# Endpoints

Endpoints describes the address of a single data endpoint within the language of a specific protocol.

See also: [Cybus::Endpoint resource](/1-7-2/documentation/services/structure-of-commissioning-files/resources/cybus-endpoint.md)

## Overview

<figure><img src="https://4142639966-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7fj06nwrOaOPonB577Xs%2Fuploads%2Fgit-blob-9edb9655e53edf05944d2f89e4bd398fd4ea5667%2Fendpoints_overview.png?alt=media" alt=""><figcaption><p>Endpoints Overview</p></figcaption></figure>

By clicking on one of the listed endpoint you get redirected to the [Details View](#details-view) of the selected endpoint.

## Details View

<figure><img src="https://4142639966-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7fj06nwrOaOPonB577Xs%2Fuploads%2Fgit-blob-02ae366118c0698a8d9dab230e6a7a6167074ba0%2Fendpoints_details.png?alt=media" alt=""><figcaption><p>Endpoint Details View</p></figcaption></figure>

The endpoint has resources itself. In this case there are the following resources:

> * [Address](#address)
> * [RuleEngine](#ruleengine)

<figure><img src="https://4142639966-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7fj06nwrOaOPonB577Xs%2Fuploads%2Fgit-blob-fe3d73fb3258072e23206308648b15ef78320b8c%2Fendpoints_details_open.png?alt=media" alt=""><figcaption></figcaption></figure>

### Address

Address lists the address property specified for the endpoint in the commissioning file.

### RuleEngine

RuleEngine list associated Rules to the endpoint.

{% hint style="danger" %}
This is not yet fully implemented
{% 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 by asking a question.

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

```
GET https://docs.cybus.io/1-7-2/documentation/resources/endpoints.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.
