> 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/2-6-1/data-flows/service-commissioning-files/resources/cybus-link.md).

# Cybus::Link

Providing quick access to external or internal web resources.

The **Cybus::Link** resource defines a direct hyperlink to a web resource. This can be an external resource (e.g., <https://github.com>) or an internal resource served from within a container (for example, when the container hosts its own web server).

Links are typically displayed as buttons in the Connectware interface, giving users quick access to related content such as dashboards, documentation, or service-specific tools.

## Link Properties

| Property                      | Type     | Required     | Default |
| ----------------------------- | -------- | ------------ | ------- |
| [name](#name)                 | `string` | **Required** |         |
| [href](#href)                 | `string` | **Required** |         |
| [ingressRoute](#ingressroute) | `string` | Optional     |         |

### name

Name of the link (label on the button).

* Type: `string`
  * Maximum length: 20 characters

### href

Href of the button link.

* Type: `string`

{% hint style="warning" %}
If the internal HTTP server of a service container requires a trailing slash or a specific path in the URL, make sure to include this in the `href` property of the link.
{% endhint %}

### ingressRoute

Reference to an already declared [Cybus::IngressRoute](/2-6-1/data-flows/service-commissioning-files/resources/cybus-ingressroute.md). Use `!ref <logicalId>`.

If this property is used, the `href` property must be defined relative to the ingress route, i.e., only the path of the inner HTTP server must be defined.

* Type: `string`

## Example

{% code lineNumbers="true" %}

```yaml
myDashboardLink:
  type: Cybus::Link
  properties:
    ingressRoute: !ref dashboardRoute
    href: ui/
    name: Dashboard

myExternalLink:
  type: Cybus::Link
  properties:
    href: https://github.com
    name: Github
```

{% endcode %}


---

# 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/2-6-1/data-flows/service-commissioning-files/resources/cybus-link.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.