---
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/isEP7WA4sjOy24F9EOuSfdy2E2L1L3duzQwaGksc0uRKkklcQ3/98OQkkxZaur02j3gvvhFIjnPvA9n1jQDk2peWq4kTeiv3FhDmBAkg1KoVQHSGmKXzJI5CCVzYhVhkrCyFDxluIsoTUyqShjRiFqWG5rc0PN2N72NqCpBu7WXGU3o9uREcGNpRA2kleZ2RZObNZ0D06DPKrukyc3t5jaiJdOsAAvauAUcgX6qQK9oRCUrgCZULRYG3FHpEgpGkzW1qxLfcGkhB00jWnDJi6qgSRzRDBasEpYm8SbaEcF0CcRYpi2XOSkVl5YslCYly7l0TIzIud9tUBgx4QsilSWlVnc8gwzFAA+sKAW444cBC17wR/EO4irYA7JAZFXMQRO1IBpMg0SDrbQkJTiw0MFx9EUgTnUzng1hMVZzmSMUDZ8qriGjyYIJA7vYXnOB6ukYzXxVmwV5V5Wl0taQqkSc45ikqijYgQHUrIWM3DFRgRl9kCFmenL608/ReHJ0TL8EPjDDH8RCQCFghBHDZS7AA9/FffrTzy8c5Boll6moMpgVYAzLwdCoy0wXyLsSUr7gYMj9EuwSNOGW1EcY0pxBuCR2Caj/UknT1bbVFQzIYq6UACbpBp2q2WhwwSSO8atvcOigaGahVApm0yU6B9JveEiVtOjtyTpUyuGfBo9a97Go+Z+QogNs1XJDnY/l7qGzaowdpcboYbkHWq9I1p19rfc3XmWVZaK/2z8eig19zt3aAUfrc99ztAbP14PQj4w7tTAGQfgwQpNJPAjjSWGGhDuYEOq+cWjCDZnEcQfYJI43m81Ww1t4TGuGlsQtFGbIUrq65Nmeiqwk/1QBuTx34kStbY25A228ibbRcL+zL89ROHim24geq2GHRp04TZfW5OjYSUEAM99EsN5KmDEq5S6K3nO7fIxBjKfIo2W2Mv0YGVGQaBQ3NNXA0AxnrETrYgIdfPfZLAPJIQte0YjeM+4WLZSecWksk6mLd7qS0q9YcMkE/9z540/BtUL4F/Uf92LBuP+hlXs9m7P0Y/0XsuZfBgJqEO4nZOj/fQmmldaoFS+FRppfkFiLuxXbjMuZ0/WQ/AYdepCK0xWXhFuzLZ62ZM9eTS//eeGpYobMV/uRCwg0G8kcMKBUpo4QtYq55JY7xc5FBbNcA0gU2BZD8DzAMcuYHYzjXTCvlFzwvPJVH8E9A97XYhz1vNvcc5suIZtZzRYLnu7hHq9qxZagU5CW5eDE7vcT5dOlhHtyB9ogqmfxwTiOn/fDdwYGM8vsG0BMmc7BtlQDLA37AYKucyJlVqhK2q3nzKyaoUvtQfm6zodB0G6PIXNYKA2YKlKAjPsy3qN5QDVA2cWyiegSmLDLVeDF+6sgRS4QQX3IFklX2JikWCWdjJ9CZ7qTm7eMNsf12PG6bDQ5Q5YHKqNdQpcyw0omqMV2LJi3hRhLLb+DVvOenkvlSzZQnrkk6AInZDNmh9x7oXSBb2jGLBxYXsBwocILMJYVJWKUvTjDDKnJdEPMJJ4cHYzjg3g8HU+So+Pk5PTf6OhVmf0VmAQzltS09gPWVs/9kqEL4KytWtti+fEkSZ7BKB9FRKjcRAS0VtpE7lrro7eHaVyk2LM6EXAHYs8UAXeAl1/i9jSpoobeQLu8ev0mIr+fXV9dXv0SkYvr6zfX3chFcUkgp/2I12X7DtXuwedhwGYahWiqNAVjFpUQK6SZqmwPgmdNLYbLCc9AWr5YNbU07g2UtoPh4u2vb/7128XVdPZuenY9vThHsq2Z7Vk9vZf8Ycg2G2GjYeYgQfescnz64nR8ehq/ON1suncWr+mt2ENUvQLkGkoNxt2iWEt11zhZYJoRinpJ0GFUbvo26Xou3DoZbXc1N02UUcvCTWuV3lQCS/mqihsND+mho4ZATrcuk7aQrPoI8gk24tZ/zXExqbLKLtGStt0oq1n60YXeSpfK7GQdyubpeHL0sPqM4pF6D1BTf9FWlU6B4KWePLu6vnpeQxWrni1/qZxUOmeSf3ZIX44TlrpM+XKS4KGmZCm8PE6C+/PL48RVhy9P6K7d1e2OtnkTXCXaEj8oH3cruE7y6UT9INIOKNBL7HHDDhTkw2Nt10K4ejfQaQGWueKQyQxj0bZmHDZs6tJm/7nBvuV13dHARZuIHv/xR7+n8UpwhOVifNs7MSRzBke4vGOCZ4TLsrJoSQU3xhlS24Ecfa9eh1fRK3SriDo8gUf2OhfB6q+Hur9Pp2+bOOFCrW6009in8T2mlKShPOpccxzH+DHGjyP8OO5mmuM4fkLILxiWQXCggWVsLqCm5XC5vjLWV7nS/DMYjw30HWiCt75K76SBOctmKEQw1sU2J7Y9QMw1h0VEllXB5BZJsKpJgB6cS0W1ND7Qv7GMXHuiHyg+eC8x5jjI2Qe6k4aD1U/KxmdZxvEnw9a7ZVwYwuaqsltYXTo+Jjk6Lm8VTGBxBhlx0pWWcQlZa9KhBW823kNOhjzknRf/rodwXwmjATFJuDEVNHeqs7eXxPAM/s9cw4SCqI3hBF3jJJ7gx9Hznfvb/8wrkFktmZj5RTMvsr/MPy5r8qQ2nQtc4z0Fn/AUCy92x7jAU3sOM7j9h7rOmSSVhIcSUsxBniWVusZQNiJvfV/N6hVhOeOSCGZBN17jcNmlwkFW7nrOJcNJFT0MshROtJAXP6+qNNZcS2tLkxwespKPZCVEKZhFhx2lqqDYkG+GYO/QR7xph6OwVgh4UDPpcDHRLcJGjvvxurmh/eP3qSsauFwo3F43HWhCx6N4FAf5dVv9GZR7qYwtmPPXeoCB2TUcAexqYL31+/9+gui5tPBgD0vBuOs+ORGua1HfhAXBbUSXylh8ul7PmYH3Wmw2+NhPJlABGTdoeV+Y/ITgv0cPfpCBj7AKp5SuPU4T6qZET4P31BHgI3Caack3ovmeQ79HUAY17vcFuv9o7xF0vQnkN2L89qnfI+AGBo9beLf4R3PE5wbtruWXgXYu4/efpSmUoYX0cjqe0sbDXy6mNKKsG652wpM7vWnfyFVw9nrtV0zxnrHZ0IYJf+/Y3G42m/8AB+JheA==
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","maximum":200,"description":"The maximum number of results to return per page. The maximum allowed value is 200.","example":200}}},"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>