Reveal a variable's value
Answers the variable's stored value, the only endpoint that does. It needs a token with the exec scope, and the answer is never cached.
Path parameters
The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.
The variable's name, without the CF_ prefix builds see it with. A new name is letters, digits and underscores, starting with a letter or underscore, at most 64 characters; a variable the environment already has is found by its stored name as it is, whatever the rules were when it was saved.
Returns
200 The variable's name and its value.
Fields of the 200 answer
The stored value. An empty string for a cleared variable.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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 | none | Check the id. You see only what your account can reach. |
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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/environments/1311/variables/API_TOKEN/reveal \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/environments/1311/variables/API_TOKEN/reveal');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/environments/1311/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);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/environments/1311/variables/API_TOKEN/reveal",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"name": "API_TOKEN",
"value": "example-value-not-a-real-secret"
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "not_available",
"errors": {
"name": [
"This value can no longer be read. Set it again."
]
},
"message": "This value can no longer be read. Set it again.",
"reason": "not_available"
}{
"code": "invalid",
"errors": {
"environment": [
"This is a CoreStack or CoreCluster environment: name it by its site_id."
]
},
"field": "environment",
"message": "This is a CoreStack or CoreCluster environment: name it by its site_id.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt reveals a secret. Copy the request and run it yourself when you are sure.