---
title: "Reveal the preview login"
url: https://docs.corefinity.com/api/reference/access/reveal-site-preview-login
type: endpoint
last_updated: 2026-11-13
feature: http-auth
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md
  - https://docs.corefinity.com/mcp/tools/corestack_site_preview_credentials_get.md
---
# Reveal the preview login

Answers the HTTP login of the environment's platform address, read when you ask and recorded in the site's
activity. It needs a person who may reveal the site's credentials; anyone else gets the `404` of a site that does
not exist.

```http
POST /api/corestack/sites/{site}/credentials/preview
```

- 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.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/credentials/preview \
  -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/credentials/preview');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/credentials/preview', {
  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/credentials/preview",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The login.

```json
{
  "password": "Example-preview-password-1",
  "revealed_at": "2026-11-10T00:59:43Z",
  "url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
  "username": "preview"
}
```

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

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

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

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

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 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
}
```

### 502 The login could not be read at the moment (`upstream_unavailable`). Try again in a minute.

```json
{
  "code": "upstream_unavailable",
  "message": "The cluster could not be reached. Try again in a minute.",
  "reason": "upstream_unavailable"
}
```

## 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 |  | Check the id. You see only what your account can reach. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 502 | `upstream_unavailable` | A service the action depends on did not answer. Try again later. |

## The same task elsewhere

- Guide: [Password protection](https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md)
- MCP tool: [`corestack_site_preview_credentials_get`](https://docs.corefinity.com/mcp/tools/corestack_site_preview_credentials_get.md)
