# Cybus::Link

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](https://docs.cybus.io/2-0-6/documentation/services/service-commissioning-files/resources/cybus-ingressroute). 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 %}