Docker Extension API: Host Interface

content/reference/api/extensions-sdk/Host.md

60dc0e654b7516e455db11dab1698d806f44d8b44c506b9200000003000004a5

---
title: "Interface: Host"
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
aliases: 
 - /desktop/extensions-sdk/dev/api/reference/interfaces/Host/
 - /extensions/extensions-sdk/dev/api/reference/interfaces/Host/
---

**`Since`**

0.2.0

## Methods

### openExternal

▸ **openExternal**(`url`): `void`

Opens an external URL with the system default browser.

**`Since`**

0.2.0

```typescript
ddClient.host.openExternal("https://docker.com");
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `url` | `string` | The URL the browser will open (must have the protocol `http` or `https`). |

#### Returns

`void`

## Properties

### platform

• **platform**: `string`

Returns a string identifying the operating system platform. See https://nodejs.org/api/os.html#osplatform

**`Since`**

0.2.2

___

### arch

• **arch**: `string`

Returns the operating system CPU architecture. See https://nodejs.org/api/os.html#osarch

**`Since`**

0.2.2

___

### hostname

• **hostname**: `string`

Returns the host name of the operating system. See https://nodejs.org/api/os.html#oshostname

**`Since`**

0.2.2

Chunks

3d33b4b6 (1st chunk of `content/reference/api/extensions-sdk/Host.md`)

Title: Docker Extension API: Host Interface

Summary

This document describes the 'Host' interface within the Docker Extension API, available since version 0.2.0. It details the 'openExternal' method, which opens a URL in the user's default browser, and properties such as 'platform', 'arch', and 'hostname', providing information about the host operating system. These properties were introduced in version 0.2.2.