---
id: parameter-create
title: "Create a parameter"
description: "Create an application parameter."
sidebar_label: "Create a parameter"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zgS/isDfmoD2XFeujhorwt4cz1cDosmaBzsYpPApqWxzV2JVEnKrmvovx+GlCwqVrNpb/deFgUSxxHJmYfz8syQ2rEUTaJFYYWSLGYXGrlF4BJ4UWQi4fQcCq55jhb1kEVMFajd48uUxWw/FCduKYuY5UvD4jt23Qyxh4hpfF+isd+rdMviHUuUtCgtfQ0UHf9iCMWOmWSFOadvdlsgi5ma/4KJZdEjuONP4GReodCYEhLJcwImtSR4JDFiKBOVCrlkETOYaLRuDU+nSmZbFrE1z0o0BL3QtGUr0BAgJ6sFZqz2QrrAJisEmglqAXaFXQviB54XGa2+ViqDG/ERWeXhPUvw23dvG7nh7jcrkay62mCOmZJLA1Z1FSu95FJ8dAtfn8Q8SVQp7evTmECbgif4+iwOhL8+J4Qe2i6Qg3IttJI5+bIPKq3otcHjXaIsc3JVVyAsRIbkAyus07eXMXUCqsCPHVxFxoW0+KEfVbPmABk4rz+FLxQMc27wm/N+fHtc1T7AWufOlcqQywNwlzIlg6OBzQrtCrWD50CBMMDBSxrCzOoSZyAWIGw4EsFswTODM1C0fCOM202NnhZFbvyhCqP93wZGogYk6hDZfuhzoK25FnyefUGiBfEDjZQhvKvJgNBLmJHIGYGbBdNnQ3JVisYK6WJ+WnC7eh6CRZllLlaB1jyhj+aQoipIxoZTAjaoyeBL0nQfut1MatOkE8Ktodn11dUP05vLn9+0jBg7h3QixT2p+gLe8/+0JnpWVZWP/FILu2Xx3Y7NkWvU45KsevdQuapgCiWNZ9bT0Yj+HFp3X3Fgww2YMknQmEWZUfh8cSEJ64NIyeJfXiQitkZtKGREelgxRBroJ8svXYF6VMnAbI3FfLARKUIpxfsS4fJvsFD6iQJycnp2XkVfa9LXmvTZNelPT7Ffy+7nl92WxX5HxoJa7AFz1exVk2irkWvNiV2Fxdz0l4RH2WFqreSSgH2UBpOoAk2QPU8UAMf8voylU27/ICbfp/MBi//Pc21gm2cBvby5Gvzlm9EJ3E4uwIocjeV5Qdhd0vbQnKvwtRpCvFA6J20s5RYHJKKzjdPR6clgdDIYnU5Go9j9/MyakOrDKMss86znIr8Hs4dxUB7+Otff0e+9/A6Ojt4qi/HREVwuYGZWajP1NDD1weh4yKAFq+q8jLp5e3REmQlrYcQ8Q5pWGtQGNsJ6BzaxCQXqXBjKnqOjIdwgwt3YtT9UKbzSOgMeXhynKjHHe8jm2I8PnBqRCbt96YIwVxohRctFZob38pFBR2S/THm3P5OaW1Ye+5ChXbktkj4aNt8CmT7gIBhnRvmHNMljNZ0opUHXKFvUkmd9XdzT/rxy04B6RC4kmczVr1oeJSWXKaBcCrl3uU9PID8Hju7bV2tpMFaRt4SErSo1qI2EF42alyDkQnNjdZnYUqM3+QH7eBSf4pyefiHYRQd6X6PQ9kb1qqlIpyenZ75ZcYr7lfSbppsEY+tGc0UlPvL2ma2SYrrmZWZ9MpRFoTTl9L18Et9+GXPHh1TkKCn6TZ/zD/G28w9sEhy3wn4uZimuMVNF3d05HtRbFrPbG4/hsI3y7NI/+K4+0dTnn/Offjq07EUmqHdCrZWG/REI0tJRgZBrngkKpqK0VMIcAchlEG+/28HHWG5Lc6FSR6uEh0UsR2P4sicUg9m/XQb/MZlcg18BiUqJ0wqNBqVt8tAUmIiFSCAJ7fECh8thBOejEX2c0McZfZy/7HjxfDSigtTF8gmOGkPOk5WQOKCuyCWx1+Vw2RW3QE3WUmnxEY3HhnqNGhZcZJSynRid87Q95TZmewaIuRa4iGBV5ly2SIJZ+wbbgXPHlNoa9+x7nrqWF429Z/TgVvLSrhzk9J51jRPOJoiNR38bZJoK+sqzpkAAn6vStrC6eiZ1rUJjXeXOeUYVG1Nw1nW063jRh3QYwVXlM+RVX4bcePM/zhDh22EKIC5BGEOV2vcR4+tLMCLFP1lqmNAQdTC8otR4NTqlj7Ou41/997KCNusqi5809Sb7j+XHZa0e6tB5Q3N8ptATkSDcSr7mwrULBwnTu/wPTZ2xhFLihwITi2m9JZUkpdaYDuE6Q24QrN4CX3IhIePukqJq0iZHu1LuBYwyFLr+IM2Ow1cg3hPG3b2VOqPyam1h4uNjXoghtU5Fxi0l7DBROaMLuea+7oZyxId2eGu3NwIJIg1uGnGim8Si+svfm7b9nz9O3GUn5d679hXQm//ru08hF4qg1+daFrOT4Wg4Ym07sH/1ZSiGyEU5l8Fum9dsnTdWnXgKXpE956VcvW/a2bHbI+l1Pt/VoXHX9ihEXysKm/iO7XZ0YXSrs6qix+9LpObn7iE0zx3dDayQp6hdLP2K1B9deHyDib8qrY9ch4xbRc0KOrkU9sm5D0FkX1/dTCii6leGuWM1pvmGmJpvWMzc20jbtIfu2Y5lXC5Ll7LMy6T4493wfRSublfN5YPcBgh3Oz9jon5FWVUsqrdi6X9WPVRV9S9ZHCqL
sidebar_class_name: "post api-method"
info_path: docs/api/parameters
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 parameter"}
>
</Heading>

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



Create an application parameter.

<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","description":"An application parameter","required":["name","nrn","type","encoding","secret","read_only","values"],"properties":{"name":{"type":"string","description":"The name of the parameter.","example":"Pool Size"},"nrn":{"type":"string","description":"The NRN of the application which the parameter belongs to.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"example":"environment","description":"The type of the parameter.","type":"string","enum":["environment"," file"],"title":"parameter_type"},"encoding":{"example":"plaintext","description":"The encoding of the parameter value.","type":"string","enum":["plaintext"," base64"],"title":"parameter_encoding"},"secret":{"type":"boolean","description":"Indicates whether the value is a secret. `true` if it is a secret, `false` otherwise.","enum":[true,false]},"read_only":{"type":"boolean","description":"Indicates whether the value is read-only. `true` if it is read-only, `false` otherwise.","enum":[true,false]},"variable":{"type":"string","description":"The name of the environment variable. Required when `type` is `environment`."},"destination_path":{"type":"string","description":"The full file path. Required when `type` is `file`."}},"example":{"name":"Pool Size","nrn":"organization=1:account=2:namespace=3:application=4","type":"environment","encoding":"plaintext","variable":"POOL_SIZE","secret":false,"read_only":false},"title":"parameter_create_request"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","name","nrn","type","encoding","secret","read_only","values","version_id"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the parameter.","example":1234},"name":{"type":"string","description":"The name of the parameter.","example":"Pool Size"},"nrn":{"type":"string","description":"The NRN of the application which the parameter belongs to.","example":"organization=1:account=2:namespace=3:application=4"},"type":{"example":"environment","description":"The type of the parameter.","type":"string","enum":["environment"," file"],"title":"parameter_type"},"encoding":{"example":"plaintext","description":"The encoding of the parameter value.","type":"string","enum":["plaintext"," base64"],"title":"parameter_encoding"},"variable":{"type":"string","description":"The name of the environment variable. Required when `type` is `environment`."},"destination_path":{"type":"string","description":"The full file path. Required when `type` is `file`."},"secret":{"type":"boolean","description":"Indicates whether the value is a secret. `true` if it is a secret, `false` otherwise.","enum":[true,false]},"read_only":{"type":"boolean","description":"Indicates whether the value is read-only. `true` if it is read-only, `false` otherwise.","enum":[true,false]},"version_id":{"type":"integer","description":"A system-wide unique ID for the parameter version.","example":12341234},"values":{"type":"array","items":{"description":"The parameter values for this application or scopes.","type":"object","required":["id","nrn","created_at"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the value.","example":1234},"nrn":{"type":"string","description":"The NRN of the application which the parameter belongs to.","example":"organization=1:account=2:namespace=3:application=4"},"created_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the parameter value was created.","format":"date-time","example":"2021-01-02T00:00:00Z"},"value":{"type":"string","nullable":true,"description":"The value of the parameter.<br><br>\n> **Note:** If `show_secret_values` is set to `true`, the value is **only visible to users with the required permission**. See [Accessing secret values](/docs/parameters/secret-visibility) for more details.\n","example":"200"},"location":{"type":"string","description":"The file path. Applicable only for files; null otherwise. Also null for secrets.","example":null},"external":{"type":"object","nullable":true,"description":"Object containing the external ID and engine of the value. \n>  **Note:** Applicable only for parameters stored in your own (external) infrastructure.\n","required":["id","engine"],"properties":{"id":{"description":"The external ID of the value.","type":"string","example":"external_id_123"},"engine":{"description":"The engine of the value. \n\n> **Note:** At the moment, only `hcp_vault` is supported.\n","type":"string","example":"hcp_vault"}}},"dimensions":{"type":"object","description":"The dimensions of the value.","example":{"environment":"development","country":"US"}}},"title":"parameter_value"}}},"title":"parameterResponse"}}}},"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>