---
id: deployment-list
title: "List deployments"
description: "Lists all deployments that belong to an application or scope."
sidebar_label: "List deployments"
hide_title: true
hide_table_of_contents: true
api: eJzdWW1v2zgS/isEP7WA4tp5262Bfsg16V4Ou2mRurd7lwbGWBrb3FKkSlJpXMP//TCkJFOWmjq9dg+4L36RSM4z78OZNc/QpkYUTmjFx/xXYZ1lICXLsJB6laNylrklODZDqdWCOc1AMSgKKVKgXUwbZlNd4IAn3MHC8vENP29289uE6wKNX3uZ8THfnjyWwjqecItpaYRb8fHNms8QDJqz0i35+OZ2c5vwAgzk6NBYv0AQ0I8lmhVPuIIc+Zjr+dyiPypdYg58vOZuVdAboRwu0PCE50KJvMz5eJjwDOdQSsfHw02yI4LJEpl1YJxQC1ZooRyba8MKWAjlmRiw87DbkjCGTMyZ0o4VRt+JDDMSA95DXkj0x/cDliIXD+LtxZXDPbHAVJnP0DA9ZwZtjcSgK41iBXqw2MJx9EUgXnVTkfVhsc4ItSAoBj+WwmDGx3OQFnexvRKS1NMymtmqMgv2tiwKbZxlZUE4R0OW6jyHA4ukWYcZuwNZoh28VzFmfnL608/J6PDomH8JfGSGP4iFiELECDAr1EJiAL6L+/Snn597yBVKoVJZZjjN0VpYoOVJm5k2kLcFpmIu0LJPS3RLNEw4Vh1hWX0GE4q5JZL+C61sW9vOlNgji5nWEkHxDTlVvdHSgsPhkL66BkcOSmYWSyUHly7JOYh+zUOqlSNvH69jpTz709JR6y4WPfsTU3KArVpuuPexhX/orZpiR2EoejgRgFYrxuvWvsb7a69y2oHs7g6P+2JDl3O/tsfRutx3HK3G8/Ug9CPjTiWM/bjt8hmiCWbbeNIifzTcZXuz2eptSxSMAbIP4TC3ffpva0hkewIulfhYIrs890IiXWxNtIVstEm2MW6/sy/PSRB0pt9Ifmhwh0aVDm2b1uHRsZeCRLDfRLDaysBanQofGz8Jt3yIQYqSxKMDV9pu5Es4KrK3G54aBDKuKRRkMyDJbXefTTNUArPoFU/4JxB+0VybqVDWgUp9FDOlUmHFXCiQ4nPrTziF1koZXlR//Is5iPDDaP96OoP0Q/UXs/pfhhIrEP4nZuTVXQmmpTGklSCFWppfkFiDuxHbVKip13Wf/HrdtJeK15VQTDi7LYm2ZM9eTi7/eRGoUt5brPYjFxGoN7IZUpgobeX3lYqFEk54xc5kidOFQVQksC2G6HmEY5qB643ObTAvtZqLRRlqOUZ7eryvwTjoeLf9JFy6xGzqDMznIt3DPV5Wii3QpKgcLNCLPexnOiRBhZ/YHRpLqJ4MD0bD4dNuUM7QUr6YfgOICZgFuoZqhKVmP0LQdk6iDLkuldt6ztTpKbnUHpSvqywXBejmGDbDuTZICSBFzEQozgOae1IDFm0sm4QvEaRbriIv3l8FKXFBCKpDtkjawqbUA6XyMn4MnclOxt0yWh/XYSfostbklFjuqXd2CV2qjOqTqMLasWDRlFeQOnGHjeYDPZ+gl9BTdPkk6AMnZlNwfe491yanNzwDhwdO5NhffogcrYO8IIyqE2fAsopMO8QcDg+PDkbDg+FoMjocHx2PT07/TY5eFtlfgUmCdayitR+wpibulgxtAGdNLdqUwA8nSfYEB4tBwqRe2IShMdrYxF9WQ/QOMK2PFHtWJxLvUO6ZIvAO6UrL/J46VVTQa2iXV69eJ+z3s+ury6tfEnZxff36uh25OC2J5LQf8aoY36HaPvg8DthgSIi2TFO0dl5KuSKaqc72IHhW12K0nIkMlRPzVV0h095IaTsYLt78+vpfv11cTaZvJ2fXk4tzItuY2Z7V0zsl7vtssxY2GeYCFZqOVY5On5+OTk+Hz083m/ZNJGh6K/YYVacAucbCoPV3I2io7honRKaZkKiXjBxGL2zXJn0nRTgvo+2u+v5IMmpYuGmsMphKZClfVXGt4T49tNQQyenWZ9IGktMfUD3CRvz6rzkuJVUo3ZIsadtjcgbSDz70lqbQdifrcJilo8Oj+9VnEo8ye4CahOuzLk2KjK7q7MnV9dXTCqpcdWz5S+WkNgtQ4rNH+mI0htRnyheHYzrUFpDii+NxdCt+cTz21eGLE75rd1UTo2nJRFeJpsSPysfdCq6VfFpRP4q0PQoMEnvYsCMFhfBY2bWUvt6NdJqjA18cgsooFm1rxn7D5j5tdp9b6kZeV30KWrRJ+PEff3Q7FS+lIFg+xjcdEcsyb3BMqDuQImNCFaUjS8qFtd6Qmr7i4Ht1MIKKXpJbJdzjiTyy04+IVn891P19MnlTxwkfak2tndo+begcpSyN5VHlmuPhkD5G9HFEH8ftTHM8HD4i5OdAZRAeGIQMZhIrWh6X7xZTfbXQRnxGG7ChuUPD6NZXmp00MINsSkJE63xs82LbA8TMCJwnbFnmoLZIolV1AgzgfCqqpPGe/w0ydh2Ivuf04J2imOMhZ+/5ThqOVj8qG59lmaCfQA11B0JaBjNdui2sNp0Qkzwdn7dykFScYca8dJUDQT2Z2qRjC95sgoec9HnI2yD+XQ8RoRImAwLFhLUl1neqszeXzIoM/89cw8aCqIzhhFzjZHhIH0dPd+5v/zOvIGaNAjkNi6ZBZH+Zf1xW5FllOhe0JngKPREpFV5wB0LSqR2H6d3+Q13nTLFS4X2BKeWgwJJOfWMoG7A3oa/mzIrBAoRiEhya2ms8LrfUNJ5a+E5yATR/4s+iLEVzKuIlTKFKQzXX0rnCjp89g0IMVCllIcGRww5SnXNqs9ejrbfkI8G04wFXIwQ6qJ5f+JjoF1Ejx/94Vd/Q/vH7xBcNQs01ba+aDnzMR4PhYBjl1231Z0nuhbYuB++v1ViCsmvc2N/VwHrr9//9XDBw6fDePSskCN998iJcV6K+iQuC24QvtXX0dL2egcV3Rm429DjMG0gBmbBkeV+Y58Tgv0dnvZeBD7iKZ49+GMTH3M9+HgfvsYO9B+DUM5BvRPM9R3kPoIxq3O8LdP+B3QPoOnPFb8T47bO8B8D1jBO38G7pjxGEz4/PfcsvQ+NdJuw/S1MsYgvp5HQ6pYmHv1xMeMKhHa52wpM/vW7fqFV09nodVkzonrHZ8JqJcO/Y3G42m/8AdIBTQw==
sidebar_class_name: "get api-method"
info_path: docs/api/deployments
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List deployments"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/deployment"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Lists all deployments that belong to an application or scope.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"offset","schema":{"type":"integer","minimum":0,"default":0},"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"The maximum number of results to return per page.","example":30},{"in":"query","name":"scope_id","schema":{"type":"string"},"required":false,"description":"Filters deployments by scope. Supports up to 10 comma-separated values.\n","example":"5678,1234"},{"in":"query","name":"application_id","schema":{"type":"string"},"required":false,"description":"Filters deployments by application. Supports a single value.\n","example":"6789"},{"name":"include_messages","in":"query","description":"Specifies whether it includes messages in the response.","example":true,"schema":{"type":"boolean"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The list of deployments matching the query","content":{"application/json":{"schema":{"type":"object","required":["paging","results"],"properties":{"paging":{"required":["offset","limit","total"],"properties":{"total":{"type":"integer","description":"The total number of results matching the query.","example":30},"offset":{"type":"integer","minimum":0,"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},"limit":{"type":"integer","description":"The number of results returned per page. Defaults to 30.","example":30}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID for the deployment.","example":1},"scope_id":{"type":"integer","description":"The ID of the scope where the deployment belongs.","example":1234},"release_id":{"type":"integer","description":"The ID of the release associated with the deployment.","example":5678},"status":{"type":"string","enum":["creating_approval","creating_approval_denied","creating","waiting_for_instances","running","finalizing","finalized","cancelling","cancelled","failed","rolling_back","rolled_back","deleting","deleted"],"description":"The current status of the deployment.","example":"running"},"status_in_scope":{"type":"string","description":"The status of the deployment within its scope.","example":"ACTIVE"},"strategy":{"type":"string","description":"The deployment strategy being used.","enum":["initial","blue_green"],"example":"blue_green"},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the deployment was created.","example":"2023-10-01T12:34:56Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the deployment was last updated.","example":"2023-10-01T12:34:56Z"},"messages":{"type":"array","description":"A list of messages associated with the deployment (e.g., logs, errors, or status updates).","items":{"type":"object","properties":{"level":{"type":"string","description":"The severity level of the message (e.g., INFO, WARNING, ERROR).","example":"INFO"},"message":{"type":"string","description":"The content of the message.","example":"Deployment started successfully"},"code":{"type":"string","description":"A unique code identifying the type of message.","example":"DEPLOYMENT_STARTED"},"timestamp":{"type":"integer","description":"The Unix timestamp when the message was generated.","example":1696166096}},"required":["level","message","timestamp"],"description":"Represents a message associated with a deployment, such as logs or status updates.","title":"deployment_message"},"example":[{"level":"INFO","message":"Deployment started successfully","code":"DEPLOYMENT_STARTED","timestamp":1696166096}]},"deployment_token":{"type":"string","description":"A unique token associated with the deployment for authentication or tracking purposes.","example":"abc123xyz"},"nrn":{"type":"string","description":"The resource name (NRN) uniquely identifying the deployment.","example":"organization=1:account=2:namespace=4:application=4:scope=5"}},"required":["id","scope_id","release_id","status","strategy","strategy_data","created_at","updated_at","messages","deployment_token","nrn"],"description":"Represents a deployment object with all its associated metadata and configuration.","title":"deployment"}}},"title":"deploymentsListResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>