---
title: "Update a performance audit"
url: https://docs.corefinity.com/api/reference/logs/update-performance-audit
type: endpoint
last_updated: 2026-11-13
feature: performance-audits
related:
  - https://docs.corefinity.com/guides/tools/performance-audits.md
---
# 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.

```http
PATCH /api/performance-audits/{audit}
```

- Scope: `write`
- Rate limit: 10 a minute
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `audit` (integer, required): The id of an audit. Digits only.

## Body

- `domains` (array of objects): 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.
  - `environment` (string, required): A name for the environment, unique in the audit, such as `Current host`. No control characters.
  - `http_password` (string or null): The HTTP authentication password. No control characters. Never answered.
  - `http_username` (string or null): The HTTP authentication username that opens a protected site for the runs. No control characters. Never answered.
  - `url` (string, required): The address it is served on, a full `http` or `https` URL. No control characters.
- `name` (string)
- `number_of_requests` (integer)
- `page_types` (array of objects): The pages to test, replacing the whole list.
  - `check_cache` (boolean): Also test the page cached.
  - `path` (string or null): The path of the page, such as `/shop/`. No control characters.
  - `title` (string, required): A name for the page, unique in the audit. No control characters.
- `report_password` (string or null): 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.
- `report_password_protected` (boolean): Whether the shared link asks for a username and password first. Turning it on needs both, sent now or set before.
- `report_sections` (array of objects): 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.
  - `enabled` (boolean, required)
  - `key` (string, required) One of `hero`, `at_a_glance`, `response_times`, `gap`, `improvement`, `absolute_times`, `waterfall`, `filmstrip`, `full_table`, `google_scores`, `definitions`, `method`, `timing_breakdown`, `samples`, `status_codes`, `response_headers`, `raw_lighthouse_json`, `all_metrics`, `cta`.
- `report_username` (string or null): The username the shared link asks for. No control characters.
- `server_location` (integer): The id of the server location to test from, as an audit answers it in `server_location.id`.
- `user_agent` (string): The user agent the requests carry. No control characters.

## Request

### curl

```bash
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"
  }'
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The audit, without its results.

```json
{
  "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"
}
```

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

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

### 403 The token lacks the `write` scope (`scope_required`).

```json
{
  "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"
}
```

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

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

### 409 A run is queued or running and the request changes something the run reads: `name`, `domains`, `page_types`, `number_of_requests`, `user_agent` or `server_location` (`run_in_progress`). Nothing was changed. A request that changes only the shared report's settings is not refused.

```json
{
  "code": "run_in_progress",
  "message": "This audit is running. Wait for it to finish, then change or delete it.",
  "reason": "run_in_progress"
}
```

### 422 A field is wrong, or the shared report would be protected without a username or a password. `field` names the first one.

```json
{
  "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"
}
```

### 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 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 |  | 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`. |

## The same task elsewhere

- Guide: [Performance audits](https://docs.corefinity.com/guides/tools/performance-audits.md)
