---
id: release-create
title: "Create a release"
description: "Create a new release within an existing application."
sidebar_label: "Create a release"
hide_title: true
hide_table_of_contents: true
api: eJzdWG1v2zYQ/ivEfWoB+S0v3eZvaddhGQYsSJyuWBIEZ/FssZVIlaTseIb++3CkZMtx2qRFt3X7YFkij7yHd/cceVyDJJdaVXplNIzhlSX0JFBoWgpLOaEjsVQ+U1qgFnSnnFd6LrAsc5Uij+pDAqYkGz5OJYyhGTdOw2SQgMe5g/EVnMcOuEnA0oeKnH9p5ArGa0iN9qQ9v3amHrxzjGoNLs2oQH7zq5JgDGb6jlIPcR5lSfL0jooFWUhgWqlc3ioJCTiPvnKQdKflnpsESsuwvSIXVETBrQrnrdJzSO5ZaJKRiLLCzITPqDUT24F0VTASTL1a8MpL0rKdpbSUoidGNUOVh5dKO4/TPJiE7rAoc1a9Ge6VDw2NitsGZN1Z4haw0p7mYf37iE9/bNGGgcIbscxUmgmfKbdx9JRyo+curKQFMzo4POJfvWfCz9XcGf4Z+o8OD0b8q5PWv4+66EQsyDpWoyRpr2aKrJiZPDdLjt0LKlB7lYo3UYrbnl1Q8Ybsc5EaveAxRrv+NXSBwKg/7I96Nh11HNNAquttUxPkkUlQ13VAnlZW+RWMr9YwJbRkTyqfwfjqpg5kcKXRLgbiwXDIf/uW3JBMLNEJV6UpOTercjbXV+FPJMwOiU4/xaEE0DniWSLT5S3yR1XK9mOPZU8KmxPhVs5T0VsqSaLS6kMV4mhm7B7hWu989/0P33aEbA36xYydbpYudyly/KJO/msJLIbOUyJyG4hBNIHK5pBAQR4levzCIGMz7IdWQHU//32277bz7rqQc13Q0GY64c0DnowaHo/h2NGG8IrfN2sQPHhnbpAmfU+2pwqcE3uAzfgELZfnvwqfoRe5Ye87YaworVkoSU5gSEIcnA9bDzLvSzceDJqWfmqKQRBzg6PjFwxj48fHsdip8hbtSrB8AyKcRqRULIO5CInwzt93aDdBx8ird7LWA7pnxhbcA5zNel4V9KCvucN5LEqxzEgHnewOvwpZulGxa5OD4cFhbzTsDUeT0cH48Gh8/OKPDldk2Dd28ui3B6/e43az1R29fbu/fb3KFWkvyFpjxWa3E7IiDh2lF5grKZQuK8/hVSjn2K8lWizIk3VfbY+LCeiVkWyugCekEueYFB85FAbpx5n/82Ry1mbW1EjOq6Ulx+ZumOlKStVMpSLt2uMZ9ef9RBwNh/wY8eOQH0fPd3PDcMgxu4vlo6wtMM2Upp4llJyfG10BV2Azc3lurPqTXMRGdsGbIKq8svcyxxTlbXNg58CMZnsCiKlVNEtEVhWot0g6Um1+jOB4utYa1/ASpTiPSq+BGy41Vj4LkOU17BqnKx2TSvTo4yC3qUOSR5U7gVNT+S2sXT2TsF8GPYFBBebMRJIiWFd7VJrkJqS7EVzXkSHHDzHkIpr/PkOUliHOOclpoZyrSJhI45OzU+GUpP8ZNVzXEE0wHDM1jocH/Djcdfzxv8cKXqzVmN9Godtosn+MH6eNetGEzmuWiUzhFpWSuNS4QJXzrHuEeXD430qdEy0qTXclpZ5ksySTppW1JPviLJaA3q4EzlFpkaMn27ImnhMyw9cLpXEcuiVyAQWDdvvh0z+vxIUiKxxuNqcPLFVfV3le5uiZrnwMAa682sLsghkSA7tbnm1MwBOxhiDGGTEI8eE0vPzUbsa//D4JeyMz73x7xfG6NcL2nmF7Rt6W8m2tvV9qt1XwtsTpFBt1AkrPDM/elDVN9xD2ylIWZgMWGDKDxrCczbXP1pg7vu5c0HzpFVFjSD6cDcocle4cQaMrrzYniZsEMnby+ArW6yk6urR5XXPzh4osV9E3CSzQqlB5cBGdQEYo2S5Xa3hPK8YZEfcmsWhYYF6F09/9/Fgn7YiTNKXSf1L2phOHZ79dTNh9zRVWEXIQWFxyXsUljCHcjIVKkQVC2xpy1PMqEAzinBwvuBtu98IrrKrpQr3qIFyvo8TEvCdd15A0S/H8DfVNXdd/AfES0DU=
sidebar_class_name: "post 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={"Create a release"}
>
</Heading>

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



Create a new release within an existing application.

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

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["semver","build_id","status","application_id"],"properties":{"status":{"type":"string","description":"The status of the release.","enum":["active","pending","deprecated","failed","unstable"],"example":"active","title":"release_status"},"build_id":{"type":"integer","description":"The ID of the build to which this release belongs.","example":12341234},"application_id":{"type":"integer","description":"The ID of the application to which this release belongs.","example":43214321},"semver":{"type":"string","description":"A version identifier following Semantic Versioning (SemVer) conventions.\"","example":"1.0.1-rc1","title":"semver"}},"title":"ReleaseCreate"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","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>