---
title: "Deployment"
description: "Explore the Deployment API, offering methods to analyze, query, and manage deployment instances within the platform framework. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/deployment"
---

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

An Object

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Deployment](/documentation/gitana/4.0/reference/types/deployment.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 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:

- [Analyze Deployment](#post-deployments-deploymentid-analyze "Analyze Deployment")
- [Handlers Deployment](#get-deployment-handlers "Handlers Deployment")
- [Lists Deployment](#get-deployments "Lists Deployment")
- [Queries for Deployment](#post-deployments-query "Queries for Deployment")
- [Read Deployment](#get-deployments-deploymentid "Read Deployment")
- [Read Handler](#get-deployment-handlers-type "Read Handler")
- [Retry Deployment](#post-deployments-deploymentid-retry "Retry Deployment")

### <a id="post-deployments-deploymentid-analyze"></a>Analyze Deployment

POST /deployments/{deploymentId}/analyze

#### Parameters

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

### <a id="get-deployment-handlers"></a>Handlers Deployment

GET /deployment/handlers

#### Parameters

This function has no parameters.

### <a id="get-deployments"></a>Lists Deployment

Retrieves a list of Deployment instances

GET /deployments

#### 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"
      }
    }
  }
}
```

### <a id="post-deployments-query"></a>Queries for Deployment

Queries for instances of type Deployment

POST /deployments/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"
      }
    }
  }
}
```

### <a id="get-deployments-deploymentid"></a>Read Deployment

Reads an instance of a Deployment

GET /deployments/{deploymentId}

#### Parameters

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

#### Response

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

### <a id="get-deployment-handlers-type"></a>Read Handler

GET /deployment/handlers/{type}

#### Parameters

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

### <a id="post-deployments-deploymentid-retry"></a>Retry Deployment

POST /deployments/{deploymentId}/retry

#### Parameters

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

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

```json

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