---
title: "Reveal a deployment variable's value"
url: https://docs.corefinity.com/api/reference/deployments/reveal-site-deployment-variable
type: endpoint
last_updated: 2026-11-13
feature: deployment-variables
related:
  - https://docs.corefinity.com/guides/sites/code-and-deployments/variables-and-secrets.md
  - https://docs.corefinity.com/mcp/tools/corestack_deployments_variable_reveal.md
---
# Reveal a deployment variable's value

Answers the variable's stored value, the only endpoint that does. It needs a token with the `exec` scope and a
person who may change the site, and the reveal is recorded in the site's activity by the variable's name.

```http
POST /api/corestack/sites/{site}/deployments/variables/{name}/reveal
```

- Scope: `exec`
- Two-factor: required on your account (all)
- Rate limit: 10 a minute
- Try it in the console: off. It reveals a secret. Copy the request and run it yourself when you are sure.

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.
- `name` (string, required): The variable's name, without the `CF_` prefix builds see it with: letters, digits and underscores, starting with a letter or underscore, at most 64 characters. Any other name is refused `422` `invalid` on `name`.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/deployments/variables/API_TOKEN/reveal \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/deployments/variables/API_TOKEN/reveal');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/deployments/variables/API_TOKEN/reveal', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.post(
    "https://manage.corefinity.com/api/corestack/sites/1042/deployments/variables/API_TOKEN/reveal",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The variable's name and its value.

```json
{
  "name": "API_TOKEN",
  "value": "example-value-not-a-real-secret"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the `exec` scope (`scope_required`), or your company requires two-factor authentication and you have not set it up.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The stored value can no longer be read (`not_available`): save the variable again. Or the site is managed by another control panel (`managed_elsewhere`).

```json
{
  "code": "managed_elsewhere",
  "message": "This site is managed by another control panel",
  "reason": "managed_elsewhere"
}
```

### 422 A field or query parameter this endpoint does not take, or a name that is not in the expected format (`invalid`, with the `field`).

```json
{
  "code": "invalid",
  "errors": {
    "name": [
      "The name argument is not in the expected format."
    ]
  },
  "field": "name",
  "message": "Some arguments are not valid.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `not_available` | The tool does not apply to this object. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Variables](https://docs.corefinity.com/guides/sites/code-and-deployments/variables-and-secrets.md)
- MCP tool: [`corestack_deployments_variable_reveal`](https://docs.corefinity.com/mcp/tools/corestack_deployments_variable_reveal.md)
