> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/consume/activate/apis/overview/link-an-external-application.md). # Link an external application Use this option when the application is already hosted and running externally. Registering the URL creates a `link` Resource that associates the application with the Data Product in the catalog. Consumers can discover and open it from DataOS UI. ## Prerequisites * You have a Data Product that the application consumes. * You have `dataos-ctl` configured for the target Tenant. * **You have the `data-developer` tag assigned to your user account.** Run the following command to check your current tags: ```bash dataos-ctl user get ``` In the output, confirm that `roles:id:data-developer` appears in the **TAGS** column for your user. If the tag is missing, contact your operator to have it assigned before proceeding. * You have the URL of the hosted application. {% stepper %} {% step %} ### Prepare the manifest Copy the YAML below into a new file and replace all placeholders with your values. ### Manifest template {% code expandable="true" collapsedlinecount="12" %} ```yaml version: v1alpha type: link name: title: description: owner: tags: - app - hosted-app spec: link: domain: description: tags: - app - hosted-app owners: - products: - references: - title: Data Product url: title: Open application url: ``` {% endcode %} ### Example - Streamlit app (simple hosted link) {% code expandable="true" collapsedlinecount="12" %} ```yaml version: v1alpha type: link name: streamlit-link title: Greeting App description: Hosted Streamlit greeting demo. owner: kanakguptatmdcio tags: - streamlit - greeting - hosted-app spec: link: icon: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCI+PHJlY3QgeD0iMTAiIHk9IjMwIiB3aWR0aD0iMTAiIGhlaWdodD0iMjQiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCB4PSIyNiIgeT0iMjAiIHdpZHRoPSIxMCIgaGVpZ2h0PSIzNCIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IHg9IjQyIiB5PSIxMiIgd2lkdGg9IjEwIiBoZWlnaHQ9IjQyIiBmaWxsPSIjRkJCQzA1Ii8+PC9zdmc+" domain: platform description: Simple greeting demo on Streamlit Cloud. tags: - streamlit - greeting - hosted-app owners: - kanakguptatmdcio products: - platform-observability references: - title: Greeting App (Streamlit Cloud) url: https://app-cloud-app-idrapyca6q2nj3zhy22edw.streamlit.app/ title: Open Streamlit App url: https://app-cloud-app-idrapyca6q2nj3zhy22edw.streamlit.app/ ``` {% endcode %} ### Example - Streamlit app linked to a Data Product {% code expandable="true" collapsedlinecount="12" %} ```yaml version: v1alpha type: link name: order360-link title: Orders360 App description: Hosted Orders360 App. owner: kanakguptatmdcio tags: - streamlit - orders360 - hosted-app spec: link: icon: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCIgdmlld0JveD0iMCAwIDY0IDY0Ij48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImJnIiB4MT0iMCUiIHkxPSIwJSIgeDI9IjEwMCUiIHkyPSIxMDAlIj48c3RvcCBvZmZzZXQ9IjAlIiBzdG9wLWNvbG9yPSIjMGYxNzJhIi8+PHN0b3Agb2Zmc2V0PSI1NSUiIHN0b3AtY29sb3I9IiMxZTNhNWYiLz48c3RvcCBvZmZzZXQ9IjEwMCUiIHN0b3AtY29sb3I9IiMwZjc2NmUiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48cmVjdCB3aWR0aD0iNjQiIGhlaWdodD0iNjQiIHJ4PSIxNCIgZmlsbD0idXJsKCNiZykiLz48cmVjdCB4PSIxNCIgeT0iMzYiIHdpZHRoPSI4IiBoZWlnaHQ9IjE0IiByeD0iMiIgZmlsbD0iIzM4YmRmOCIgb3BhY2l0eT0iLjkiLz48cmVjdCB4PSIyOCIgeT0iMjgiIHdpZHRoPSI4IiBoZWlnaHQ9IjIyIiByeD0iMiIgZmlsbD0iIzM0ZDM5OSIvPjxyZWN0IHg9IjQyIiB5PSIxOCIgd2lkdGg9IjgiIGhlaWdodD0iMzIiIHJ4PSIyIiBmaWxsPSIjZmJiZjI0Ii8+PHBhdGggZD0iTTEyIDIyTDI4IDE2TDQ0IDI0TDUyIDIwIiBmaWxsPSJub25lIiBzdHJva2U9IiNlMmU4ZjAiIHN0cm9rZS13aWR0aD0iMi41IiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz48Y2lyY2xlIGN4PSI1MiIgY3k9IjIwIiByPSIzIiBmaWxsPSIjZjhmYWZjIi8+PHRleHQgeD0iMzIiIHk9IjE0IiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0ic3lzdGVtLXVpLHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iOSIgZm9udC13ZWlnaHQ9IjcwMCIgZmlsbD0iIzk0YTNiOCI+MzYwPC90ZXh0Pjwvc3ZnPg==" domain: platform description: Orders360 App for the Orders360 (VDE) data product via the Vulcan API. tags: - orders360 - hosted-app owners: - kanakguptatmdcio products: - platform-observability references: - title: Data Product url: https://pacific-051426.dataos.cloud/platform/data-product/product-sandbox/orders360-vdetrue?tab=overview title: Order360 App url: https://app-cloud-app-xvqqthmwjry6kruxfyytr2.streamlit.app/ ``` {% endcode %} #### Field reference
Field reference **Value** indicates what to do with each field: * **Keep as-is**: copy exactly as shown; the value does not change between applications. * **Replace**: substitute your own value; these appear as `` in the manifest. #### Metadata | Attribute | Required | Value | Purpose | | ------------- | -------- | ---------- | ------------------------------------------------------------------------------------ | | `version` | Yes | Keep as-is | Manifest schema version. Use `v1alpha`. | | `type` | Yes | Keep as-is | Declares the Resource kind. Use `link` to register an external application. | | `name` | Yes | Replace | Unique Resource name within the Tenant. Use lowercase letters, numbers, and hyphens. | | `title` | No | Replace | Human-friendly name shown in the UI. | | `description` | No | Replace | Short summary of what the application does. | | `owner` | Yes | Replace | Your username. | | `tags` | No | Replace | Labels used to organize and search for the application. | #### Link (`spec.link`) | Attribute | Required | Value | Purpose | | ------------------------------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | | `spec.link.url` | Yes | Replace | Hosted application URL that consumers open. | | `spec.link.title` | No | Replace | Label for the action that opens the application. | | `spec.link.domain` | Yes | Replace | Business domain the application belongs to. | | `spec.link.description` | No | Replace | Description shown on the application's catalog page. | | `spec.link.tags` | No | Replace | Catalog tags for the application. | | `spec.link.owners` | Yes | Replace | Usernames responsible for the application. | | `spec.link.products` | No | Replace | Data Products the application consumes. Creates the catalog relationship between the application and the Data Product. | | `spec.link.references[].title` | No | Replace | Label for a related link, such as the source Data Product. | | `spec.link.references[].url` | No | Replace | URL for the related link. | | `spec.link.icon` | No | Replace | Base64-encoded icon shown for the application in the UI. |
{% endstep %} {% step %} ### Apply the manifest ```bash dataos-ctl resource apply -f app-link.yaml ``` {% endstep %} {% step %} ### Open the application Once applied, the application appears in the catalog linked to its Data Product. Consumers can open it from the Data Product page or from the Apps section. {% endstep %} {% endstepper %} ## Validate the link
Validate the link | Check | Expected result | | ------------------------------------ | ---------------------------------------------------------------------------------- | | Link opens | The external application loads at the configured URL. | | Data Product relationship is visible | The application's catalog entry shows the correct Data Product under **Products**. |
## Troubleshooting
The link opens to an error or blank page The hosted application URL is wrong or the app is down. Confirm `spec.link.url` is correct and the hosted application is reachable from a browser.
The Data Product relationship is not shown in the catalog `spec.link.products` is missing or the product name is incorrect. Add the correct Data Product name under `spec.link.products` and re-apply the manifest.
--- # 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, and the optional `goal` query parameter: ``` GET https://v2.dataos.info/consume/activate/apis/overview/link-an-external-application.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.