HttpService Interface: Methods for HTTP Requests

--- title: "Interface: HttpService" description: Docker extension API reference keywords: Docker, extensions, sdk, API, reference aliases: - /desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/ - /extensions/extensions-sdk/dev/api/reference/interfaces/HttpService/ --- **`Since`** 0.2.0 ## Methods ### get ▸ **get**(`url`): `Promise`<`unknown`\> Performs an HTTP GET request to a backend service. ```typescript ddClient.extension.vm.service .get("/some/service") .then((value: any) => console.log(value) ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | #### Returns `Promise`<`unknown`\> ___ ### post ▸ **post**(`url`, `data`): `Promise`<`unknown`\> Performs an HTTP POST request to a backend service. ```typescript ddClient.extension.vm.service .post("/some/service", { ... }) .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | | `data` | `any` | The body of the request. | #### Returns `Promise`<`unknown`\> ___ ### put ▸ **put**(`url`, `data`): `Promise`<`unknown`\> Performs an HTTP PUT request to a backend service. ```typescript ddClient.extension.vm.service .put("/some/service", { ... }) .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | | `data` | `any` | The body of the request. | #### Returns `Promise`<`unknown`\> ___ ### patch ▸ **patch**(`url`, `data`): `Promise`<`unknown`\> Performs an HTTP PATCH request to a backend service. ```typescript ddClient.extension.vm.service .patch("/some/service", { ... }) .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | | `data` | `any` | The body of the request. | #### Returns `Promise`<`unknown`\> ___ ### delete ▸ **delete**(`url`): `Promise`<`unknown`\> Performs an HTTP DELETE request to a backend service. ```typescript ddClient.extension.vm.service .delete("/some/service") .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | #### Returns `Promise`<`unknown`\> ___ ### head ▸ **head**(`url`): `Promise`<`unknown`\> Performs an HTTP HEAD request to a backend service. ```typescript ddClient.extension.vm.service .head("/some/service") .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `url` | `string` | The URL of the backend service. | #### Returns `Promise`<`unknown`\> ___ ### request ▸ **request**(`config`): `Promise`<`unknown`\> Performs an HTTP request to a backend service. ```typescript ddClient.extension.vm.service .request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }}) .then((value: any) => console.log(value)); ``` #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `config` | [`RequestConfig`](RequestConfig.md) | The URL of the backend service. | #### Returns `Promise`<`unknown`\>

This section defines the `HttpService` interface, outlining methods for performing various HTTP requests (GET, POST, PUT, PATCH, DELETE, HEAD, and general REQUEST) to a backend service. Each method takes a URL and optional data, returning a Promise. Example code snippets are provided for each method.