---
id: parameter-read
title: "Read a parameter"
description: "Retrieve a parameter by ID."
sidebar_label: "Read a parameter"
hide_title: true
hide_table_of_contents: true
api: eJztWe9uG7kRf5UBP8XCWpYd51BsmgPc3LV1USSG/+AOtQ2JWo60vOySG5IrRxH2W7/3ddrX6Qv0FYohd7W70sbxtZdrcTjAUWyRnPlx/vw4HG6YQJsYWTipFYvZJTojcYXAoeCG5+jQwHwN59+MWcR0gYbTzHPBYradEBvkgkXtF5bFtxumeI4sZpKGpPILXMqiHY3XKcL5N6AX4FJslZI6g+9LaVCw2JkSI2aTFHPO4g1z64JEW2ekWrIqYviB50WGLD4+eV5FW9021Q9Ti4lBN13xrETbYHlfolnvgfkuRZeiAaeBlkJYCmEpSOUxGrSFVhbHv52br+nfnfoa/vnXf/zr73+D0eiNdhiPRnC+AIuOJM0I/SzaEfYgswzmCKPRSlo5zxC0ytY0v7RoaNyltbpgBSjQ5NJaqdVo9BI0AX2QFiOatd7KS6UQqMaE6QoRbs+SBK2VatnXf//sSOjEHrU+Owrjhx6OzKRbH8BCG8i1QRDouMzs+E6xAT/Mtc6QK2/OBS8zx2K24JnFnmsY2YF1vCNkjor28xmv/Fnm0ll4SGWS7liRGzLQCnmGAh5SVDDb9/kMpK29MIarAhO5WMNtq72xRfvNAXALic5zfmiRTORQwOwdrmMvcQYFl8aO4a13WYoNnJy7JCVbuxQtQiuwBupKowho7VtpINHKoXIvAVdo1sGrQRpYx9e28eejsXazjRhdupBH21ihiKL83DGcQhTAFfCiMHrFM3Apd5DoFUlqwg4t7bvdxfjnC6mB1GaoVtJolaNycWG0KBMfINV9xBxfEumwi0Y3u4+YxaQ00q09G82RGzRnpUtZfHtPa5o8tqT2ZDKh//a5act58MAt2NLvfVFmRFC182ghL4pMJn7i0Q+WVm/2N6XnP2Diesx2G/jRZ0TElCFj+NkRQ5VoQUbwOzEYFnIxJaJgEdsSGvlMajWVgnZdGILsZNiXFB39UjlcotlLsDOwa+swP3yQAqFU8n3pSZl8tcfKXao9rWroe44bonmaOUj0rYsvtM7gSn70zEHWeJLgN5dvGrkdP9SE0dMGc8y0Wlpwuq9YmyVX8qNf+Oo45kmiS+VencQE2hY8wVfP447wV6eEMEDbDMfoIFRaMWiD3V2iKnMKj75AWMgMyctOOq9vK2PqBVSdsOnhKjJO3v8wjKpZs4cspPZj+LqCYc4tfnU6jG+Lq6LQNZLPs/8gbjrmgEbKGC6bMzIcASQykH5n+mxMmgVaJ5V34dTXI09CsCizzJseaM0j+mhOUFSn7PAh2ZV/rgTFFJUETfXRHCgkktckO65PMJALkK47EsHMH7aztiYYtw7ypZMfv6+6/PFfAyNRhyRqH9l26MdA67DYT8hYUIvdY66avWoSbTVyYzixq3SY2+EjYSc7bK2VXNJhH23AJrpA28meRw4Az/yJQSo1ptx9ISbfpvMei//fc23HNk8Cen719vA3X02O4eb6NTiZo3U8Lwi7T9oBmvMnfK2GEC+0yUkbE9zhIYnobeNkcnJ8ODk+nJxcTyax//kLa0JqCKMqsyywXrjP7GMOMPaOh27x17thfKrY3bl59PJ2NPIXjebW8cQLx5cr/boGnZD9Mh3c/kRqbln5LITM9i5F+mjYvgQyfYeD4CyzOnxJkwJW24tSGvTVp0OjeDZUxT3uz7d+mi/wuVT1pQAaeZSUXAlAtZRq6/KQnkB+7jh6aF+tpcE6Td6SCta6NKAfFDxr1ByAVAvDrTNl4kqDweR77BNQfIpzBuqFzi560IcKhbY2qldNpZgenzwPxYpXPKxk2DT9JDgL951c0xEfBfvM0qSYrugeGpKhLAptKKfv1KP4tstYVVGp0F5PB5y/j7dz29u1yVbHplfPxUzgCjNd1NWd50GzZjG7uQoY9suowC7Dg5f1jYaGq4idfv/9vmVfZ5JqJzRGm20rw4IoPRVIteKZpGAqSkdHmCcAtezE20928bGOu9K+1sLTKuFhEcvRWr4cCMXO7M8fg3+8vr6AsAISLYjTCoMWlWvy0Po2gEwg6drjGY6X4whOJxP6OKaP5/RxetDz4ulkQgdSH8snOOoMck49ATykqsgncdDlcYVbN3e41EZ+xHD1tmhWaGDBZUYp24vRORfT+mru88eb7Qkg5kbiIoK0zLlqkXRmbQtsD85fU2pr3LHfceFLXrTujtEXN4qXLvWQxR3rG6c7myA2Hv08SCEk/cqz5oAAPm8aGh5WX89126XwJ3fOMzqxUYA2De16Xgwh3Y3gqgoZ8mIoQ66C+XczRIZymAKIK5DW0kkd6oizi3OwUuAvLDVs1xB1MLyg1HgxOaGP533Hv/jfZQVt1p8sYdI0mOxny4/zWj3UofMtzQmZQt/IBOFG8RWXvlzYS5jB5V80dc4UlAo/FJhQgy9sSSdJaQyKMVxkyC2CM2vgSy4VZNw3KaombXJ0qaYngKVvSoV7NGurv6ONFJVvW9F+wmtAaTI6Yp0rbHx0xAs5pvKpyLijpB0nOveNvKZnd0V5EsK727nbGoIENX1Dz4t+EovqX37flO5/+u6aEWSpFpqW19dBFrPj8WQ8Ye0petG+XlQRK7R1OfcpW3erL6mJ2nkW2XXCpk39zzyj1FugpsmRb5+QQm+fTW3LW9ZVE4fGXqqto6HNhtosNyarKvo69MzJxEJaii/BYn+pfgTfr+8cT7mZDPrpHa4/9bBUX/yYf+N4ujN+fd74xT9vPBJJvUewNoLuu03SH5Xbz5rm5AE88rY6iKhpgal1F0uDVApWUaMuRS7QeFRhgAxWuM6SvcKHtrM9NP7w7TWLGO/z+Q5/e+mDcDabMONav0NVVVt0jv4mgFX1b+8szvw=
sidebar_class_name: "get 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={"Read a parameter"}
>
</Heading>

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



Retrieve a parameter by ID.

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

<ParamsDetails
  parameters={[{"name":"id","in":"path","description":"The ID of the parameter.","required":true,"schema":{"type":"string"},"example":123},{"name":"show_secret_values","in":"query","description":"Whether to show secret values in the response.<br><br>\n> ℹ️ **Note:** If set to `true`, secret values will be **visible only to users with the required permission**; otherwise, they will be hidden.\n> See [Accessing secret values](/docs/parameters/secret-visibility) for more details.\n","schema":{"type":"boolean","default":"false"},"example":"true"},{"name":"dimensions","in":"query","description":"Limits which secret values are revealed when `show_secret_values` is `true`. Specify [dimensions](/docs/dimensions) as comma-separated `key:value` pairs. Only the values matching these dimensions are returned with their content; every other value stays hidden.<br><br>\n> ℹ️ **Note:** Users without the permission to read secret values need an approval that covers the requested dimensions. See [Accessing secret values](/docs/parameters/secret-visibility) for more details.\n","schema":{"type":"string"},"example":"environment:production"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</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>