---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Return a list with all client deployments

This method returns an array of all deployments on a client account including the name, order number, price, deployment ID, deployment configuration and provisioning status.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/deploy/": {
      "get": {
        "operationId": "get_deployment_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Deployments found successfully",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Deployment"
                  },
                  "type": "array"
                }
              }
            }
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          }
        },
        "summary": "Return a list with all client deployments",
        "tags": [
          "Deployment"
        ]
      }
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Endpoints to handle your servers provisioning",
      "name": "Deployment"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "Deployment": {
        "properties": {
          "deploymentConfiguration": {
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "deploymentId": {
            "type": "integer"
          },
          "deploymentName": {
            "type": "string"
          },
          "empty": {
            "type": "boolean"
          },
          "orderNumber": {
            "example": "",
            "type": "string"
          },
          "price": {
            "type": "number"
          },
          "startedProvisioning": {
            "type": "boolean"
          }
        },
        "type": "object"
      }
    }
  }
}
```