@zlayer/api-client 0.10.86

package/docs/ProxyApi.md

@@ -0,0 +1,268 @@
+# ProxyApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listBackends**](ProxyApi.md#listbackends) | **GET** /api/v1/proxy/backends | List all load-balancer backend groups. |
+| [**listRoutes**](ProxyApi.md#listroutes) | **GET** /api/v1/proxy/routes | List all registered proxy routes. |
+| [**listStreams**](ProxyApi.md#liststreams) | **GET** /api/v1/proxy/streams | List L4 stream proxies. |
+| [**listTls**](ProxyApi.md#listtls) | **GET** /api/v1/proxy/tls | List loaded TLS certificates. |
+
+
+
+## listBackends
+
+> BackendsResponse listBackends()
+
+List all load-balancer backend groups.
+
+Returns each service\'s backend group with its strategy, health status, and active connection counts.  # Errors  Returns `ApiError::ServiceUnavailable` if the load balancer is not initialised.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProxyApi,
+} from '@zlayer/client';
+import type { ListBackendsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ProxyApi(config);
+
+  try {
+    const data = await api.listBackends();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BackendsResponse**](BackendsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Load-balancer backend groups |  -  |
+| **503** | Load balancer not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listRoutes
+
+> RoutesResponse listRoutes()
+
+List all registered proxy routes.
+
+Returns the full list of L7 routes with their host patterns, path prefixes, backends, and protocol information.  # Errors  Returns `ApiError::ServiceUnavailable` if the service registry is not initialised.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProxyApi,
+} from '@zlayer/client';
+import type { ListRoutesRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ProxyApi(config);
+
+  try {
+    const data = await api.listRoutes();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RoutesResponse**](RoutesResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of routes |  -  |
+| **503** | Service registry not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listStreams
+
+> StreamsResponse listStreams()
+
+List L4 stream proxies.
+
+Returns all TCP and UDP stream proxies with their listen ports, service names, and backends.  # Errors  Returns `ApiError::ServiceUnavailable` if the stream registry is not initialised.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProxyApi,
+} from '@zlayer/client';
+import type { ListStreamsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ProxyApi(config);
+
+  try {
+    const data = await api.listStreams();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**StreamsResponse**](StreamsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | L4 stream proxies |  -  |
+| **503** | Stream registry not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTls
+
+> TlsResponse listTls()
+
+List loaded TLS certificates.
+
+Returns cached certificate domains with metadata (expiry, fingerprint) when available.  # Errors  Returns `ApiError::ServiceUnavailable` if the certificate manager is not initialised.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProxyApi,
+} from '@zlayer/client';
+import type { ListTlsRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ProxyApi(config);
+
+  try {
+    const data = await api.listTls();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TlsResponse**](TlsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Loaded TLS certificates |  -  |
+| **503** | Certificate manager not available |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/PruneResultDto.md

@@ -0,0 +1,37 @@
+
+# PruneResultDto
+
+Serializable wrapper for [`PruneResult`].
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deleted` | Array<string>
+`spaceReclaimed` | number
+
+## Example
+
+```typescript
+import type { PruneResultDto } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deleted": null,
+  "spaceReclaimed": null,
+} satisfies PruneResultDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PruneResultDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PullImageRequest.md

@@ -0,0 +1,37 @@
+
+# PullImageRequest
+
+Request body for [`pull_image_handler`]. Blocking pull of an OCI image.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pullPolicy` | string
+`reference` | string
+
+## Example
+
+```typescript
+import type { PullImageRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pullPolicy": null,
+  "reference": null,
+} satisfies PullImageRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PullImageRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PullImageResponse.md

@@ -0,0 +1,39 @@
+
+# PullImageResponse
+
+Response body for [`pull_image_handler`]. Reports the pulled reference and, when the backend exposes it via `list_images`, the resolved digest and on-disk size.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`digest` | string
+`reference` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { PullImageResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "digest": null,
+  "reference": null,
+  "sizeBytes": null,
+} satisfies PullImageResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PullImageResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RegisteredServiceInfo.md

@@ -0,0 +1,45 @@
+
+# RegisteredServiceInfo
+
+Information about a registered service in a tunnel
+
+## Properties
+
+Name | Type
+------------ | -------------
+`localPort` | number
+`name` | string
+`protocol` | string
+`remotePort` | number
+`serviceId` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { RegisteredServiceInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "localPort": null,
+  "name": null,
+  "protocol": null,
+  "remotePort": null,
+  "serviceId": null,
+  "status": null,
+} satisfies RegisteredServiceInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RegisteredServiceInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RegistryAuthTypeSchema.md

@@ -0,0 +1,33 @@
+
+# RegistryAuthTypeSchema
+
+Authentication method for a registry credential (`OpenAPI` schema).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RegistryAuthTypeSchema } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RegistryAuthTypeSchema
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RegistryAuthTypeSchema
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RegistryCredentialResponse.md

@@ -0,0 +1,41 @@
+
+# RegistryCredentialResponse
+
+Registry credential metadata (returned by list/create; no password).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authType` | [RegistryAuthTypeSchema](RegistryAuthTypeSchema.md)
+`id` | string
+`registry` | string
+`username` | string
+
+## Example
+
+```typescript
+import type { RegistryCredentialResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authType": null,
+  "id": null,
+  "registry": null,
+  "username": null,
+} satisfies RegistryCredentialResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RegistryCredentialResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReplicationInfo.md

@@ -0,0 +1,41 @@
+
+# ReplicationInfo
+
+Replication detail within the storage status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`lastSync` | string
+`pendingChanges` | number
+`status` | string
+
+## Example
+
+```typescript
+import type { ReplicationInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "lastSync": null,
+  "pendingChanges": null,
+  "status": null,
+} satisfies ReplicationInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReplicationInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RestartContainerRequest.md

@@ -0,0 +1,35 @@
+
+# RestartContainerRequest
+
+Request body for restarting a container. Matches the Docker-compat `POST /containers/{id}/restart` shape.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timeout` | number
+
+## Example
+
+```typescript
+import type { RestartContainerRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timeout": null,
+} satisfies RestartContainerRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RestartContainerRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RouteInfo.md

@@ -0,0 +1,51 @@
+
+# RouteInfo
+
+Information about a single registered route.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`backends` | Array<string>
+`endpoint` | string
+`expose` | string
+`host` | string
+`pathPrefix` | string
+`protocol` | string
+`service` | string
+`stripPrefix` | boolean
+`targetPort` | number
+
+## Example
+
+```typescript
+import type { RouteInfo } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "backends": null,
+  "endpoint": null,
+  "expose": null,
+  "host": null,
+  "pathPrefix": null,
+  "protocol": null,
+  "service": null,
+  "stripPrefix": null,
+  "targetPort": null,
+} satisfies RouteInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RouteInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RoutesResponse.md

@@ -0,0 +1,37 @@
+
+# RoutesResponse
+
+Response for `GET /api/v1/proxy/routes`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`routes` | [Array<RouteInfo>](RouteInfo.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { RoutesResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "routes": null,
+  "total": null,
+} satisfies RoutesResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RoutesResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScaleRequest.md

@@ -0,0 +1,35 @@
+
+# ScaleRequest
+
+Scale request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`replicas` | number
+
+## Example
+
+```typescript
+import type { ScaleRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "replicas": null,
+} satisfies ScaleRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScaleRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+