---
title: Package Registry
description: Package Registry protocol schemas
---

{/* ⚠️  AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}

<Callout type="info">
**Source:** `packages/spec/src/api/package-registry.zod.ts`
</Callout>

## TypeScript Usage

```typescript
import { DisablePackageRequest, EnablePackageRequest, GetPackageRequest, ListPackagesRequest, UninstallPackageRequest, UninstallPackageResponse } from '@objectstack/spec/api';
import type { DisablePackageRequest, EnablePackageRequest, GetPackageRequest, ListPackagesRequest, UninstallPackageRequest, UninstallPackageResponse } from '@objectstack/spec/api';

// Validate data
const result = DisablePackageRequest.parse(data);
```

---

## DisablePackageRequest

Disable package request

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Package ID to disable |


---

## EnablePackageRequest

Enable package request

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Package ID to enable |


---

## GetPackageRequest

Get package request

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Package identifier |


---

## ListPackagesRequest

List packages request

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **status** | `Enum<'installed' \| 'disabled' \| 'installing' \| 'upgrading' \| 'uninstalling' \| 'error'>` | optional | Filter by package status |
| **type** | `Enum<'plugin' \| 'ui' \| 'driver' \| 'server' \| 'app' \| 'theme' \| 'agent' \| 'objectql' \| 'module' \| 'gateway' \| 'adapter'>` | optional | Filter by package type |
| **enabled** | `boolean` | optional | Filter by enabled state |


---

## UninstallPackageRequest

Uninstall package request

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Package ID to uninstall |


---

## UninstallPackageResponse

Uninstall package response

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Uninstalled package ID |
| **success** | `boolean` | ✅ | Whether uninstall succeeded |
| **message** | `string` | optional | Uninstall status message |


---

