---
id: application-read
title: "Read an application"
description: "Provides information about the application."
sidebar_label: "Read an application"
hide_title: true
hide_table_of_contents: true
api: eJzdWVtv27gS/isEX9oCsuP4kouBPnjT7jaLbk6QJtgF0sCgybHFjUSqJJXUNfzfD4aUbMlW4jh7Tg9w8uDYEjnzzX04XFABlhuZOakVHdJLox+kAEukmmqTMnxM2ETnjrgYCMuyRHL/tE0jqjMw/se5oENaeTk0wASNqGMzS4e3dLR+Re8imjHDUnBg8OWCKpYCHdIUHBPMsbFUPMkF0IhKxPQtBzOnEbU8hpTR4YK6eYYbrDNSzegy2hDiTKcpa1lANg4EyQwCdRIscTFzxMY6TwSZACk4CSKVl6+EQAzYTCsLbTJ6YDJhkwTIA0tysENyG4DYiKB4d6gI+M7SLPGYinde8mW0CCJkzMU0KgWVokkaqRzMwKA4Br7l0oCgQ2dy2BTvOgZy/oHoaZNJVkgOu73+8i6iFnhupJt7TU+AGTCj3MV0eHuHr0tBLSLpdjr4r85upIie/A3cEQOZAQvKSTXb5E0jyrVyoBxSqLw4+NsimcW2wIEqrYp7G3Tj9RRRm+Qz/OeYy23x2GaMw9ivMpBpK50283FuEvQWO0610mN8QSPKcqfHArJEz8dajbmBEqmDNEuY83TQHVf+geikaDDKpg1GxM6tg7T1KAWQXMlvuTfKVJvdVomoMmrbj5vsfHF1Qd5e5EmCeDEiyRVYnRsO5IKl8K5gncyJFGiY6TzYRtoqhNK9VZVQLMEww+N53YG1mTElf/h97w+HjHOdK/e+O1xp/31vWKH9vo8eGzx7W6KUff8Maob+dtRpErCKEonUwfwikwQFGl2eIxfvEPtyGZEV8pq1kNhOe9FJQNBimSzlXLngbjeph+pqc0hD+lHZLVPVuHd7/cFyFQANgoPKU4yaDJQIT4KX+695JsqvjDv5EBLq6uuUyQSEh5yAX3fXBD8w35VtSg7LrbB83lzdQaNX3Fx9LjmuyQWtxToRO9RGY+cyOzw4mEkX55M21+kBN/PM6ZZU/KBwabTqhnUr0FmWjX3WflGYTnUiwJDHGAxs6olISxLNfSWSyqIHMoJ5CrnVcGN4RhQ/sd6E5L/cSGtrOBOtE2BqG4/JgcgtcxEbM+MrYE2nj9LFRLsYDC62EZmyxEJ48ihtPR79u+XTmfX14NLcOizIgShqKk1BSOYwtbGpA0MmgJnA8wLxMpzVPL9vsJZ7SW5BEKcLzs97Xq8/OFpGq06mqdht81w1HYlm2Is8SFZvRjhzLNE+C9a4Leg9zOmQ+sYE/bdeyPzLl3jvPcxLqUue9XhCSsuo4PMikn7p80RXqJkQEreyZFwX4HnVjVbbqg1eA8s60aJBq9BnxrB5oxS/f/nXBSk2bFNelv3tFiXpIG2U4EUGernet5QZ/iLqpPOP/yjAnuk00wqbMywn4DD5NQKsJ5/txlpN5Sw3RUIp6DQWUfJnDIqUJcj79OXo+uxThLky0Y+WXP16Ro57p0fkrVfzH2BmQC6Z4/G7IbqkDbkJERWtN2EGM0QCPgFUlmjV2lzmOYM4WOULnUqHKdhvwxW+lzUPILZ9RMCU5Yl7hYY+hJ0lklrDNWVJYsmE8XtMJ4+oH0YmhikeE20IqAdptEpBOSKteuOIzYDLqQRB4DtqVrpkvg02UGhyj5dBLRBgc7K7HUqZVOhDFbCv51yV+GXsrWMzf+RDJ2fWgtvfRF9Ktw2PJ+iejYX7jSWTXCaCeEbBaazTptFjNL8HM/YOZf4BpgYNvLHkg6dOAvUCzjaG3Mj9bfFZFxX4KRU08d5Qxdo+BmbSOjNvF49868V4Ci2uTXZQa7fQhMBfoaxRyn5oRT6eXdUamSfwv8B4r1LcBvubq/MnjLc211pPeAwcHB2fnHYOu21xb9rATTu3LWDWtQ7bzEvIHq3X30aTyprPjnuhHV1d7IGWGTVkj3YI3AxXIIdVGYZr2ptGRjNzLWC8XvJPC09RiZFqVagszK62pPINuFT3vo1raAhClg1r653iSrlhFkaHNM/DgOJZtDfhgFmcyCWYpxDXWNd1fjzt8dPDDrRODnsnrb44GrRORee0NTk9Fien0y4fdE59Ma+hf+qAvCP74El4f4jhdNXiVdtsQ3pqMrCjREibJWweysL+0H6T7lM+2QYjuX5F8JxzdKK1NcvI2VtXRY/uvfTnelrJtY7qpAsA/S5v9Y/4aas/mRy32KAnWrxzMul0j08Oj6c9Wu8oK3FVFi36xPtiZ/+vv7aHimeJxKoPxmizGrZaInLA3kiqB5ZIPC5nucPeKJXWYp1eD47b/6mBY5hvnGk/b/Z4cEIB1rIZbA8HK6t3Hyg/XV9flvOT0iD1AWrpMYRX9fEW2rN2RPqdDn4c4kcPP/rvaubrdzpFbt19JhuRlPFYKmjhZN6PswMvj8sPVnBCMdNG/iiGBEXFxzFRbjbmchMmxqhEsP5EEdT2AhATI2EakThPmVojqawq/TeAQ3KlNr7SX5ggV4HpV4oPbhTLXewhi6/03cbocL2aLtcW3Q1yfawU4JhMbOX+w8Oq87n28xTPhzwyS1KWYAyDIF67yjGp/OQnuHTVg8vT2qApQr4E9W9GiFTC+7maEYaVzeIxO0x3R5fnBMdL/2ehYauKKJxhgKEx6HTxo1c3/OB/FxUorMExRlg0Dir7afFxXrAnhet8xDUhUvCJ5EBuFCuvs7YCpnH7fzV0RorkCr5nwPFgHkTSnOcGu3RymQCzQJyZEzZjUhGcxpn2esiRgos1XjzOwM9W/LSWHlT9fSHFEm+QvEThstHPpFcTYpbJdvWQjg03rV6bfcFIKQ7alcuzlSqQUHmb5zOjX0Sj4suvZTn//c9rXyfxXhW3I56gtcN2p92h6wpavSvFfkFblzIftcX14RUwgcFfv32rmWKxTgB7XukWYjn47g6ypDjtF3P8oOFbWmc8DJdosbYOXy4WE2bhxiTLJT4Ol7eoeCEt+p0oxrPPIP7597eNUofhasOtdDGPo95RHpiRoUHbS8a3V0WifUeevc9tRFaOG9W8iqZELAVd3i0jGgMTOIy4LefEI84hc5UtW6UBBVqF1W8fr8MtatXfN/zbU2+Es1iEFdf6HtRyuULn8DcCXC7/DXCpX+U=
sidebar_class_name: "get api-method"
info_path: docs/api/application
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 an application"}
>
</Heading>

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



Provides information about the application.

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

<ParamsDetails
  parameters={[{"name":"metadata_include","in":"query","schema":{"type":"string"},"description":"Comma-separated properties that should be included in the metadata response. Available values: [schemas, tags].","example":"schemas,tags"},{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The ID of the application.","example":1234}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"An object representing the application","content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","status","namespace_id","repository_url","is_mono_repo","auto_deploy_on_creation","template_id"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the application.","example":1234},"nrn":{"type":"string","description":"The NRN (Nullplatform Resource Name) uniquely identifying this application in the nullplatform hierarchy.","example":"organization=1:account=2:namespace=3:application=4"},"name":{"type":"string","maxLength":60,"description":"The application name.","example":"Billing API"},"slug":{"type":"string","maxLength":60,"description":"A namespace-wide unique slug for the application.","example":"billing-api"},"namespace_id":{"type":"integer","description":"The ID of the namespace that owns this application.","example":2345},"status":{"type":"string","enum":["pending","creating","updating","active","inactive","failed","deleting"],"description":"The status of the application.","example":"active"},"repository_url":{"type":"string","maxLength":250,"description":"The URL of the repository that holds this application.","example":"https://github.com/crypto-inc/accounting-billing-api"},"repository_app_path":{"type":"string","description":"The folder where the application is located inside a monorepo.","example":null,"nullable":true},"is_mono_repo":{"type":"boolean","description":"True if the application shares the repository with other apps, false otherwise.","example":false},"auto_deploy_on_creation":{"type":"boolean","description":"True if the application must be deployed immediately after being created, false otherwise.","example":false},"template_id":{"type":"integer","description":"The ID of the template used to create this application.","example":3456},"metadata":{"type":"object","description":"The metadata loaded via the metadata catalog API.","example":{"key":"value"},"properties":{"key":{"type":"string","description":"The key of the metadata.","example":"key"},"value":{"type":"string","description":"The value of the metadata.","example":"value"},"additional_properties":{"type":"object","description":"Additional properties of the metadata.","properties":{"schemas":{"type":"array","description":"The JSON schemas of the metadata."},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"key"},"value":{"type":"string","example":"value"}}}}}}},"title":"MetadataComponent"},"settings":{"type":"object","nullable":true,"description":"Configuration settings for the application. When updating via PATCH, follows RFC 7396 (JSON Merge Patch): keys with null values are deleted, keys with non-null values are updated/created, omitted keys are preserved.","properties":{"defaults":{"type":"object","nullable":true,"description":"Default values nullplatform falls back to when a branch or environment isn't specified explicitly.","properties":{"branch":{"type":"string","nullable":true,"description":"Default branch name for the application.","example":"main"},"environment":{"type":"string","nullable":true,"description":"Default environment name for the application.","example":"staging"}}},"asset":{"type":"object","nullable":true,"description":"Settings describing where the application's build assets are stored.","properties":{"docker_server":{"type":"object","nullable":true,"description":"Settings for the application's Docker server assets.","properties":{"uri":{"type":"string","nullable":true,"description":"Location where the application's Docker server assets are stored.","example":"registry.example.com/acme-corp/billing-api"}}},"ecr":{"type":"object","nullable":true,"description":"Amazon ECR repository where the application's assets are stored.","properties":{"uri":{"type":"string","nullable":true,"description":"ECR repository URI for the application's assets.","example":"123456789012.dkr.ecr.us-east-1.amazonaws.com/billing-api"},"arn":{"type":"string","nullable":true,"description":"ECR repository ARN for the application's assets.","example":"arn:aws:ecr:us-east-1:123456789012:repository/billing-api"}}}}},"code_repository":{"type":"object","nullable":true,"description":"Configuration of the code repository provider the application is linked to.","properties":{"specification_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the code repository specification.","example":"7f3c910e-8138-4d65-9d09-b97d89f2c509"},"specification_slug":{"type":"string","nullable":true,"description":"Slug of the code repository specification.","example":"github-configuration"},"specification_name":{"type":"string","nullable":true,"description":"Display name of the code repository specification.","example":"GitHub"},"specification_icon":{"type":"string","nullable":true,"description":"Icon identifier for the code repository specification.","example":"github"},"provider_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier of the code repository provider.","example":"82eee42c-46c9-4bb7-a53d-c08b027817f3"}}}},"title":"applicationSettings"}},"title":"application"}}}},"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>