Update a performance audit
Changes the fields sent, as the audit's edit form does in the Control Panel, including the shared report's sections, username and password; the saved results stay until the audit runs again. Changing the protection, the username or the password signs out everyone who unlocked the link before. Only the shared report's settings can be changed while a run is queued or running.
Path parameters
The id of an audit. Digits only. At least 1.
Body
The environments to test, replacing the whole list. A domain that leaves out http_username or http_password keeps the one saved for the environment of that name; send an empty string to remove it. Up to 10 items.
Fields of each item
A name for the environment, unique in the audit, such as Current host. No control characters. Up to 100 characters.
The HTTP authentication password. No control characters. Never answered. Up to 255 characters.
The HTTP authentication username that opens a protected site for the runs. No control characters. Never answered. Up to 255 characters.
The address it is served on, a full http or https URL. No control characters. Up to 255 characters.
Up to 255 characters.
1 to 20.
The pages to test, replacing the whole list. Up to 20 items.
Fields of each item
Also test the page cached.
The path of the page, such as /shop/. No control characters. Up to 255 characters.
A name for the page, unique in the audit. No control characters. Up to 100 characters.
10 to 72 characters and at most 72 bytes, no NUL character, not only spaces. Never answered; leave it out to keep the one set.
Whether the shared link asks for a username and password first. Turning it on needs both, sent now or set before.
The shared report's sections in order. The headline always stays first and the contact block last; a section left out keeps its place and whether it shows. Up to 19 items.
Fields of each item
heroat_a_glanceresponse_timesgapimprovementabsolute_timeswaterfallfilmstripfull_tablegoogle_scoresdefinitionsmethodtiming_breakdownsamplesstatus_codesresponse_headersraw_lighthouse_jsonall_metricsctaThe username the shared link asks for. No control characters. Up to 64 characters.
The id of the server location to test from, as an audit answers it in server_location.id.
The user agent the requests carry. No control characters. Up to 255 characters.
Returns
200 The audit, without its results.
Fields of the 200 answer
At least 1.
Format: date-time.
Fields of each item
Whether an HTTP authentication username or password is set.
At least 1.
Fields of each item
The shared report's state. It never holds the link itself or the password.
Fields
When the figures the link shows were built. Format: date-time.
Whether a link made before the report existed still shows its response times and statuses.
Format: date-time.
Fields of each item
heroat_a_glanceresponse_timesgapimprovementabsolute_timeswaterfallfilmstripfull_tablegoogle_scoresdefinitionsmethodtiming_breakdownsamplesstatus_codesresponse_headersraw_lighthouse_jsonall_metricsctasimpletechnicalbothWhether the report link works.
Format: date-time.
The username the link asks for. Null while it is not protected.
The last run started through the API or MCP.
Fields
Why a failed run failed.
Format: date-time.
Format: date-time.
Format: date-time.
Null for an audit never run through the API.
queuedrunningcompletedfailednullWhere the runs are made from. Null when the location no longer exists.
Format: date-time.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
409 | run_in_progress | The audit is running. Wait for it to finish. |
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 PATCH https://manage.corefinity.com/api/performance-audits/5210 \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"report_password": "made-up-report-password",
"report_password_protected": true,
"report_sections": [
{
"enabled": false,
"key": "definitions"
}
],
"report_username": "client"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->patch('https://manage.corefinity.com/api/performance-audits/5210', [
'report_password' => 'made-up-report-password',
'report_password_protected' => true,
'report_sections' => [
[
'enabled' => false,
'key' => 'definitions',
],
],
'report_username' => 'client',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/performance-audits/5210', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
report_password: 'made-up-report-password',
report_password_protected: true,
report_sections: [
{
enabled: false,
key: 'definitions',
},
],
report_username: 'client',
}),
});
// 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.patch(
"https://manage.corefinity.com/api/performance-audits/5210",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"report_password": "made-up-report-password",
"report_password_protected": True,
"report_sections": [
{
"enabled": False,
"key": "definitions",
},
],
"report_username": "client",
},
)
data = res.json() if res.content else None{
"company_id": 1204,
"created_at": "2026-11-01T09:00:00+00:00",
"domains": [
{
"environment": "Current host",
"http_auth": false,
"url": "https://old.harbourandfinch.example.org"
},
{
"environment": "Corefinity",
"http_auth": true,
"url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
}
],
"id": 5210,
"name": "Before and after the move",
"number_of_requests": 10,
"page_types": [
{
"check_cache": true,
"path": "/",
"title": "Home"
},
{
"check_cache": false,
"path": "/shop/",
"title": "Category"
}
],
"report": {
"frozen_at": null,
"legacy_link_live": false,
"password_protected": false,
"revoked_at": null,
"sections": [
{
"enabled": true,
"key": "hero",
"label": "Headline",
"tab": "simple"
},
{
"enabled": true,
"key": "at_a_glance",
"label": "At a glance",
"tab": "simple"
},
{
"enabled": true,
"key": "response_times",
"label": "Response times",
"tab": "simple"
},
{
"enabled": true,
"key": "gap",
"label": "The gap, measurement by measurement",
"tab": "simple"
},
{
"enabled": true,
"key": "improvement",
"label": "Improvement per measurement",
"tab": "simple"
},
{
"enabled": true,
"key": "absolute_times",
"label": "Absolute times, side by side",
"tab": "simple"
},
{
"enabled": true,
"key": "waterfall",
"label": "Where the time actually goes",
"tab": "simple"
},
{
"enabled": true,
"key": "filmstrip",
"label": "Loading filmstrip",
"tab": "simple"
},
{
"enabled": true,
"key": "full_table",
"label": "The full table",
"tab": "simple"
},
{
"enabled": true,
"key": "google_scores",
"label": "Google scores",
"tab": "simple"
},
{
"enabled": true,
"key": "definitions",
"label": "Definitions",
"tab": "simple"
},
{
"enabled": true,
"key": "method",
"label": "Method",
"tab": "technical"
},
{
"enabled": true,
"key": "timing_breakdown",
"label": "Timing breakdown",
"tab": "technical"
},
{
"enabled": true,
"key": "samples",
"label": "Individual samples",
"tab": "technical"
},
{
"enabled": true,
"key": "status_codes",
"label": "Status codes and redirect chains",
"tab": "technical"
},
{
"enabled": true,
"key": "response_headers",
"label": "Response headers",
"tab": "technical"
},
{
"enabled": true,
"key": "raw_lighthouse_json",
"label": "Raw Lighthouse response",
"tab": "technical"
},
{
"enabled": true,
"key": "all_metrics",
"label": "Every available metric",
"tab": "technical"
},
{
"enabled": true,
"key": "cta",
"label": "Contact Corefinity",
"tab": "both"
}
],
"shared": false,
"shared_at": null,
"username": null
},
"run": {
"error": null,
"finished_at": "2026-11-03T12:35:00+00:00",
"requested_at": "2026-11-03T12:30:00+00:00",
"started_at": "2026-11-03T12:30:00+00:00",
"status": "completed"
},
"server_location": {
"id": 12,
"name": "London"
},
"updated_at": "2026-11-03T12:35:00+00:00",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"message": "Not found."
}{
"code": "run_in_progress",
"message": "This audit is running. Wait for it to finish, then change or delete it.",
"reason": "run_in_progress"
}{
"code": "invalid",
"errors": {
"report_username": [
"Give the shared report a username to protect it with."
]
},
"field": "report_username",
"message": "Give the shared report a username to protect it with.",
"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 has not been cleared for the console. Copy the request and run it yourself when you are sure.