---
id: deployment-read
title: "Read a deployment"
description: "Read a specific deployment"
sidebar_label: "Read a deployment"
hide_title: true
hide_table_of_contents: true
api: eJzdWVtv2zgW/isEn1pASezcdsdAHrxpZjaLnbRw3Z1LGgjH4rHFKU2qJOXENfTfF4e6WLLV1OliZ4F9cWyJ5Pn4nfvJhgt0iZWZl0bzEZ8gCAbMZZjIuUyYwEyZ9RK15xE3GVqghbeCj/j21cgiCB5xDwvHR/f8zXbTQ8QzsLBEj5bebbiGJfIRl7RBksgMfMqjHRzTFNntG2bmzKfYQsG8YSTtmEfc4udcWhR85G2OEXdJikvgow3364xkOG+lXvAi4vgEy0zRsyEvoi0InahcYLxE52CBrob0OUe73sP0viQFHXtM0adomfSsOsKx+gwmdcBs0WVGOySkjfivAJ0ZoxA0L4qHiDtMciv9OrA1Q7Box7lP+ej+gV7X5zrafzoY0J8uzrFmZvYHJp5ZzCw61F7qxQ6RBCsx2pOSRhsOWaZkEpR78oejYzb7MMtTecQzS6bgZQlCitYaqT0u0PYqNNfycx70Oje2B09D07AgkkyG8cFnb40lbCQVWdw1nhkqoxeuK+v07LwgWhWC+y6B1VYGzplEgkfBHqVPn7vgxeVf/kp39OBzt2+xEUedL8mVEotA2oshy6xZgSK17T6LBWqJovWKR/wRZFg0NzaW2nnQSTBwm2tdrphLDUp+6fwoT6G1SpUvqh/hxRxk+cWa8DqeQfKp+omi/iVQYQUifEVBYWCfwSS3lrRSsrDv6x3GGtwNbbHUcdB1H3/70r4mJehKaia9K02nK3Z8Pb39100p1YLHxfowcS0B9UY2Q/LD3GEIX7WKpZZeBsXOVI7xwiJqImyLofW8hSMW4Hu9swvm2ui5XORl4Ga0p8f7GozHe97tHqVPUhSxtzCfy+QA97iuFJuhTVB7WGCgvdzPTBkfNT6yFVpHqF4NjoaDwesO82eDIpxLET7+DhBTsAv0jdQWlvr6LQRd5yTJsDS59lvPib2JyaUOkDyp8hLT+XKGlu7eHMNmODcWWWZNgihCXDYVmidSA2ZdLEXEUwTl03XLiw9XQUK3IATVIVskXbKLiCvIdeD4JXKmxoPqvWh93N51Sl3Wmozpyj2pcFfQrRaUn1rJd8eCZZN5IfFyhY3mS3nEdJZCTz4uiqIKnChi8H3uPTd2SW+4AI9HXi6x1+fphfOwzAij3osz4FglphtiTgenZ0fDwdFgOB2ejs7ORxeXv5Oj55n4MzApcJ5Vsg4D1pRLW1hgLexXTGOmpAvm11RHzydJ9gqPF8cRU2bhIobWGusiZmwdvUuYLkQK6XHpvl2dKFyhOjBF4Aqp8mJhT50qKug1tNu7H99G7Jfx5O727qeI3UwmbyfdyMVpSYunw4RXxdiO1O7Bb9oBGyyR6PIkQefmuVJrkpkYcYDAcV2L0XImBZWI83VdJdLeltJ2MNy8++fb336+uZvG76fjyfTmDYltzOzA6umDlk99tlmTTYa5QE39xo5VDi9/uBxeXg5+uCyKdg9wX2l6S3sb1V4BMqlLY8egkbprnNAyzYioThk5jFm4fZs8DvJ84Gi7q24tOk3IfWOVpam0LOWbKq413KeHjhpaPD2ETNpA8uYT6hfYSFj/LcelpAq5T8mSyj6CKPIWkk8h9OY2M24n63CYJcPTs6f1F6JH2wNATcvOyuQ2QUZdHHt1N7l7XUFV6z1b/lo5aewCtPwSkF4NR5CETHl1OqJDXQYJXp2PWl3R1fkoVIdXF3zX7kIr27QrnVaiKfFb5eNuBddJPp2o34q0PQosGXvesFsKqlrC0q6VCvVuS6dL9BCKQ9CCYtG2Zuw3bF6EvHn+66/7Dei1kiQxhO+mD3ZMBFtiUq9AScGkznJPRrKUzgUbaQYF/1Fz2lZNyf41eUzEA56Wsz3slbrb1d+OYn+fTt/VISBE0b1muxmiJG0+qjRyPhjQx5A+zujjvJtEzgeDF0TzJVCFg0c0GoGZwkpWwOVT8IxKp4Wx8gu6EhvaFVpGDV1udyL8DERMJKLzIWwF2g4AMbMS5xFL8yXoLZLWqjq3leBClqnY+Mj/BoJNSqEfOT34oCmcBMjiI9/JsK3VL0q0YyEkfQXFBHqQyjGYmdxvYXXllOEmyAkpaQmK6i4ULLCrPUiNojHptgUXRekhF30e8r6kf9dDZFnkkgGBZtK5HOt2afzuljkp8P/MNVybiMoYLsg1Lgan9HH2eqc1+595BV3WalBxuSguKfvT/OO2Es8q07mhNaWn0BOZUE0FK5CKTt1zmN7t/1XXGWuWa3zKMKH0Ul7JJGHmI47Zu3Jk5u2awQKkZgo82tprAi6fGhozLzDU9DQkHvGTbQI62UhRUDINFypny7mlmir1PnOjkxPI5LHOlcoUePLa48QseXvC+p4cpbTv9py1YYIO4tW4NgTGsIgGNeHLj3UH9o9fpqEokHpuaHs1VKBp8/HgeNDKn9vqzhH5mXF+CcFpq4l0NX/vjN07ethsvf/5YX11B49P/iRTIMPsKBC0qdi8550NIxnmdKlxnt5tNjNw+MGqoqDH5UicSBbSkYkJPpqDcvgMvu8fmPeC/4Tr/pn9ClROy4NyV2Al4Xsh1lf11OY1O+R/D70A615Yr9ugGuCCh0o8RRBoA7zyxThJMPOtLXtBne7VOMRPN1Meceia6o5phtN74Ww25Yop1ZBF0aAra8rioSiKfwMA5xHT
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={"Read a deployment"}
>
</Heading>

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



Read a specific deployment

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

<ParamsDetails
  parameters={[{"name":"id","in":"path","description":"The ID of the deployment to read.","required":true,"schema":{"type":"string"},"example":"1"},{"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":"An object representing the deployment.","content":{"application/json":{"schema":{"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"}}}},"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>