---
title: "Installed modules"
description: "The server modules this deployment has installed: each one's name, permissions and meters."
source: "https://www.cloudpdf.com/docs/api-reference/deployment/modules"
---

# Installed modules

`GET /v1/deployment/modules` · v3.3.0

The server modules this deployment has installed: each one's name, permissions and meters.

What each module declares, for a dashboard or a script that lists modules, offers their permissions in its dialogs and shows their meters. Which tenants may use one is in their \`features\` (\`tenants.get\`); what it costs, if anything, is the operator's.

## Authentication

- **apiToken** — The deployment's static root credential (CLOUDPDF\_API\_AUTH\_TOKENS), valid on every surface.

## SDK examples

**TypeScript**

```typescript
import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  token: "<token>",
});

await client.deployment.modules();
```

**Python**

```python
from cloudpdf import CloudPDFClient

client = CloudPDFClient(
    token="<token>",
)

client.deployment.modules()
```

**PHP**

```php
use CloudPDF\CloudPDFClient;

$client = new CloudPDFClient(
    token: '<token>',
);

$client->deployment->modules();
```

**.NET**

```csharp
using CloudPDF;

var client = new CloudPDFClient(
    "<token>"
);

await client.Deployment.ModulesAsync();
```

**Go**

```go
import (
    "context"

    client "github.com/embedpdf/cloudpdf-sdk-go/v3/client"
    option "github.com/embedpdf/cloudpdf-sdk-go/v3/option"
)

client := client.NewClient(
    option.WithToken("<token>"),
)

client.Deployment.Modules(
    context.TODO(),
)
```

**Java**

```java
import com.cloudpdf.api.CloudPDFClient;

CloudPDFClient client = CloudPDFClient
    .builder()
    .token("<token>")
    .build();

client.deployment().modules();
```

**Ruby**

```ruby
require "cloudpdf"

client = CloudPDF::Client.new(
  token: "<token>"
)

client.deployment.modules
```

## Responses

### 200 — OK

`application/json` — DeploymentModulesResponse

- `modules` ModuleManifest\[] — required
  - `id` string — required
  - `name` string — required
  - `description` string
  - `permissions` ModulePermission\[] — required
    - `name` string — required
    - `level` "document" | "tenant" — required
    - `label` string — required
    - `description` string
    - `replaces` string
    - `bypassedBy` string\[]
  - `meters` ModuleMeter\[] — required
    - `name` string — required
    - `label` string — required
    - `unit` string — required
    - `description` string
  - `requires` object — required
    - `document` string\[] — required

### default — Error

`application/json` — ErrorResponse

- `error` EngineError — required
  - `code` "Unknown" | "InvalidArg" | "DocNotOpen" | "DocOpenFailed" | "DocPasswordRequired" | "DocPasswordIncorrect" | "GrantPassphraseRequired" | "Aborted" | "Network" | "Unauthenticated" | "Forbidden" | "NotFound" | "WireFormat" | "RuntimeUnavailable" | "LayerVersionConflict" | "NotImplemented" | "MalformedPdf" | "SigningPending" | "SigningExpired" | "SigningVersionMismatch" | "SignatureRefused" | "ProtectedDocument" | "PayloadTooLarge" | "ObjectNumberUnavailable" | "LayerFull" | "ChangeConflict" | "UndoUnavailable" | "IdempotencyKeyReused" | "LayerDeleted" | "VisitorIdentityRequired" | "Conflict" | "EngineBusy" | "EngineRestarting" | "DocumentQuarantined" | "ThumbnailNotReady" | "TooManyRequests" | "GrantExpired" | "OriginRequired" | "OriginNotAllowed" | "FeatureNotEnabled" | "FeatureStopped" | "LicenseInvalid" | "LicenseUsageLimit" | "UpstreamError" — required — Why the request failed. A newer server can add codes: read one your client doesn't know as \`Unknown\`.
  - `message` string — required
  - `details` object — What a code carries besides its message, as each code says.
