---
id: release-read
title: "Read a release"
description: "Read a specific release by ID."
sidebar_label: "Read a release"
hide_title: true
hide_table_of_contents: true
api: eJzNV9ty2zYQ/RXMPiUztC6+pC3f3CRt3elDxpbTTG2PZ0WsRCQkwACgbFXDf+8sQErUxeO0k7Z5oURwsZezexbYFUhymVWVV0ZDCpeEUqBwFWVqpjJhqSB0JKZLcfFmAAmYiiyy8IWEFNrPqSWUkIDHuYP0Bi7jMtwl4CirrfJLSG9WMCW0ZM9rn0N6c9fcJVChxZI8WRcEFPtQoc8hAY0lQQqKFbsspxIhXYFfVmFVe5qThSYBS59rZUlC6m1NyU5Ak5zExRthZsLn1IXDgdAjllVBkI6PT07ZFUuuMtqRYzPHoxH/bOs618JMP1LmhaXKkiPtlZ7vKs6M9qQ9b8eqKlQW4Bp+dKxjtR9KVAn9QG7aqKlckIUEprUq5EVY8uhrB0lf9X0QRueItWSW0JO8R36pK9m9MNiWs+dVDFHJA3juwncu3NJ5Ko8elCRRa/W5DnjOjH0S0O++/6FZO78x4bxVen7AwoKsU0YLJRnQmSIrZqYozAODe0Ulaq8y8T5K8dqLKyrfk30pMqMXvMdoN7iFvg8wHowG4yObjbkslQ9rrUvNBtDnAdiun7BPeCOm69DlVuynZ6+adZaejZ2VR9lDBarrkksBM68WBAlUpGWnpbKUcWYhgRmqIvyptfM4LQLtNkCst3cotCbuWyebrnS+pCI3hRhEE6htAQmU5FGix39YZAzDfmkFr3aZ+rdzt9G7ncJcuWhBTKkweu6ENwcyGS08X8PxQ1fCy64tRAu8eUs3SJN9InukSpwTZ4Bh/AIr15e/CZ+jF4Xh7DthrKisWShJTmCWkeMwnkAPcu8rlw6H7cogM+UwiLnh6dkrdmOdx+d9sVPlLdqlYPnWCY4apVQsg4UIjfDR7ya0aTa1GCuv2epaB2zPjC35C3A3O/KqpIO55g/OY1mJh5x0sMnp8EvxgE60JrYxOR4dnxyNR0ej8WR8nJ6cpmev/uhxhe2F/Gz66LfnXrPHbWgaXj398GH/EHtdKNJekLXGivWZJ2RNXDpKL7BQUihd1Z7Lq1TOcV43B/VXO+NiA3ptJMMV/AmtxDkmxV4n6Uk/z/xfJpN3XWfNjKT9A3t9w8n6eLygwXyQiNPRiB9jfpzw4/Tldm8Yjbhmt315krUlZrnSdMSXJO7Pra3gV2Azc3lurPqTXPSN7IIPQVRFbXc6xxTlPYNILvAmwvYFTkytolki8rpEvfGkJ9X1x+gcq+vQuIUfUYrLaPQWeOFaY+3z4LK8hW1w+tKxqcSMPu/kpnVI8qgKJ3Bqar9xa9vOJJyXwU5gUIkFM5GkCOhqj0qTXJd0v4KbJjLk7BBDriL8uwxRWoY65yanhXKuJmEijc/fXQin5Ne7/n0b1HB9INpiOGNqnI2O+XGynfiz/48VHKzVWNxHofsI2X/Gj4vWvGhL5y3LRKbwispIXGtcoCpY6x5hDm7/V6lzrkWt6bGizJNsQzJZVltLciDexZnP26XAOSotCvRkO9bEe0JueP6bh5EjDGwpDNvTZ7hSsgnjC0cTB7twwVnfQLBSA10XRVWgZ8ryVQSa3rR4xSyJxd2fGdcwsKJuLAxdMQjxBTX8+ak7kH/9fRLOR6Vnhre3o0Y7H4x6R2k3sjYJVMb5EgNb2xm0nYq703UH/dWG88/Pz20AfDEaVgUq3bv+RRxvYGMnVZLpnhvn+cNqNUVH17ZoGl7+XJPlwfougQVaFe7+DLZUjv9LSGdYuN2RuO/ui8u26bwUTw7KBz1uF1EvgY0XNb9BAp9oGWf25q5JICeUPAPerNoP51lGle9t2WuRXAXr8vr57YQn2+3c7+Q6aD/ozmoVJSbmE+mmWXvn+Z0dbJq/AH5qzXw=
sidebar_class_name: "get api-method"
info_path: docs/api/release
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 release"}
>
</Heading>

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



Read a specific release by ID.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The ID of the release.","example":1234}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"An object representing the release.","content":{"application/json":{"schema":{"type":"object","required":["id","semver","buildId","status","application_id","asset","created_at","updated_at"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the release.","example":789},"semver":{"type":"string","description":"A version identifier following Semantic Versioning (SemVer) conventions.\"","example":"1.0.1-rc1","title":"semver"},"buildId":{"type":"integer","description":"The ID of the build to be released.","example":456},"status":{"type":"string","description":"The status of the release.","enum":["active","pending","deprecated","failed","unstable"],"example":"active","title":"release_status"},"asset":{"type":"object","required":["id","buildId","type","url","metadata"],"properties":{"id":{"type":"integer","description":"The unique ID for the asset.","example":123},"buildId":{"type":"integer","description":"The unique ID of the build this asset belongs to.","example":456},"type":{"type":"string","description":"A string identifying the asset type.","example":"docker-image"},"url":{"type":"string","description":"A URL that locates or provides access to the asset.","example":"https://example.com/assets/456"},"metadata":{"type":"string","description":"Arbitrary data providing additional context for the asset."}},"title":"asset"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the entity was created.","example":"2023-10-01T12:34:56Z","title":"date"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the entity was created.","example":"2023-10-01T12:34:56Z","title":"date"}},"title":"release"}}}},"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>