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

# Cybus::Link

Open the dashboards, manuals, and other web pages of a service directly from the Admin UI.

The **Cybus::Link** resource adds a link to a web resource to your service. The target can be an external website, for example `https://www.example.com`, or a web interface that a container of the service serves through a [Cybus::IngressRoute](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-ingressroute.md).

Use a link to give users of the service direct access to related content, such as a dashboard, documentation, or a tool of the service. The Admin UI shows each link as a button, in the [Service Overview](https://docs.cybus.io/data-flows/services/service-overview.md) and in the [Service Links View](https://docs.cybus.io/data-flows/services/service-resources-view/service-links-view.md).

## Link Properties

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

### name

The name of the link, which the Admin UI shows as the label of its button.

* **Required**
* Type: `string`
  * Minimum length: 2 characters
  * Maximum length: 20 characters

### href

The URL of the link. With [ingressRoute](#ingressroute), it is the path below the ingress route.

* **Required**
* Type: `string`

{% hint style="warning" %}
If the web server in your container expects a trailing slash or a specific path, include it in `href`, for example `ui/`.
{% endhint %}

### ingressRoute

A reference to a [Cybus::IngressRoute](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-ingressroute.md) that you declared in the same service. Use `!ref <resource ID>`, for example `!ref dashboardRoute`.

Connectware puts the path of the route, `/services/<serviceId>/<slug>`, in front of `href`. With `ingressRoute`, `href` must be relative to the ingress route. Set it to the path below the route, not to the full path on the web server of the container. For example, if the [target](https://docs.cybus.io/data-flows/service-commissioning-files/resources/cybus-ingressroute.md#target) of the route has the path `/app` and the web interface is at `/app/ui/`, set `href` to `ui/`.

* **Optional**
* Type: `string`

## Example

The first link opens the `ui/` path of a container through an ingress route. The second link opens an external website.

{% code lineNumbers="true" %}

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

manualLink:
  type: Cybus::Link
  properties:
    href: https://example.com/manual
    name: Manual
```

{% 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/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.
