---
title: "Deployment Package"
description: "Discover how our Deployment Package enhances your platform, complete with methods, properties, and language drivers for developers. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/deployment-package"
---

# <a id="top"></a>Deployment Package

An Object

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Deployment Package](/documentation/gitana/4.0/reference/types/deployment-package.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Deployment Package is contained within a [Platform](/documentation/gitana/4.0/reference/types/platform.md).

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |

## <a id="methods"></a>Methods

The following methods are available:

- [Lists Deployment Package](#get-deployment-packages "Lists Deployment Package")
- [Queries for Deployment Package](#post-deployment-packages-query "Queries for Deployment Package")
- [Read Deployment Package](#get-deployment-packages-deploymentpackageid "Read Deployment Package")

### <a id="get-deployment-packages"></a>Lists Deployment Package

Retrieves a list of Deployment Package instances

GET /deployment/packages

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment-package"
      }
    }
  }
}
```

### <a id="post-deployment-packages-query"></a>Queries for Deployment Package

Queries for instances of type Deployment Package

POST /deployment/packages/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment-package"
      }
    }
  }
}
```

### <a id="get-deployment-packages-deploymentpackageid"></a>Read Deployment Package

Reads an instance of a Deployment Package

GET /deployment/packages/{deploymentPackageId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| deploymentPackageId | true | string |  |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Deployment Package",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  }
}
```

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "document",
  "description": "Deployment Package",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "deployment-package"
}
```