---
title: "Update a site's PHP configuration"
url: https://docs.corefinity.com/api/reference/runtime/update-php-runtime
type: endpoint
last_updated: 2026-11-13
feature: php-settings
related:
  - https://docs.corefinity.com/guides/sites/software-and-services/php-settings-and-php-ini.md
  - https://docs.corefinity.com/mcp/tools/corestack_php_extensions_update.md
---
# Update a site's PHP configuration

Changes the extensions, the settings, PHP-FPM, Xdebug or the custom php.ini. Send the `version` of your last
read and only the parts you change: a part you leave out stays as it is. `extensions`, `xdebug` and
`custom_ini` replace that part whole. `settings` and `fpm` are merged into what the site has: an entry you
leave out keeps its value, and null puts one back to its default. Answers `201` with the operation that applies
the change, or `200` when nothing differs. When the platform does not confirm the save, the `201` carries an
operation that is still `pending`: follow it, and do not send the change again meanwhile.

```http
PUT /api/corestack/sites/{site}/php-runtime
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Long-running: answers with an operation to poll
- 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

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

## Body

- `apply` (string): When a change that needs a maintenance window is applied. `now` applies it at once. `tonight` queues it for the site's next window. `window` means the same as `tonight`. An endpoint that takes `window` only while maintenance windows are on for your company says so, and refuses it `422` on `apply` otherwise. One of `now`, `tonight`, `window`. Defaults to `now`.
- `custom_ini` (string or null): The whole custom php.ini, saved exactly as sent. An empty string removes it.
- `extensions` (array of strings): Every optional extension to load, by name. An empty list turns them all off.
- `fpm` (object): PHP-FPM settings, merged into the ones the site has: a setting you leave out keeps its value, and null puts one back to the platform's value. Each setting has two spellings that mean the same.
  - `max_requests` (integer or null)
  - `pm` (string or null) One of `dynamic`, `ondemand`, `static`, `null`.
  - `pm.max_requests` (integer or null): The same as `max_requests`.
  - `pm.process_idle_timeout` (integer or null): The same as `process_idle_timeout`. Seconds. Only with `pm` `ondemand`.
  - `process_idle_timeout` (integer or null): Seconds. Only with `pm` `ondemand`.
- `settings` (object): Directives of the settings form and their values, merged into the settings the site has: a directive you leave out keeps its value. Sizes are whole numbers of bytes. Null puts a directive back to its default, except `memory_limit`, `upload_max_filesize` and `max_execution_time`, which always have a value: null for one of those is refused `422` with the code `required`.
- `version` (integer, required): The `version` of your last read.
- `xdebug` (object or any or null): Xdebug's set-up, or null to turn it off. Refused on production.

## Request

### curl

```bash
curl -X PUT https://manage.corefinity.com/api/corestack/sites/1042/php-runtime \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "extensions": [
      "imagick",
      "redis"
    ],
    "version": 12
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->put('https://manage.corefinity.com/api/corestack/sites/1042/php-runtime', [
        'extensions' => [
            'imagick',
            'redis',
        ],
        'version' => 12,
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/php-runtime', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    extensions: [
      'imagick',
      'redis',
    ],
    version: 12,
  }),
});

// 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.put(
    "https://manage.corefinity.com/api/corestack/sites/1042/php-runtime",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "extensions": [
            "imagick",
            "redis",
        ],
        "version": 12,
    },
)

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

## Responses

### 200 Nothing differs from what the site has. `operation` is null.

```json
{
  "adopting": false,
  "operation": null,
  "php_runtime": {
    "adopted": true,
    "adoption": {
      "adopt_now_refusal": null,
      "adopted": true,
      "can_adopt_now": false,
      "can_adopt_tonight": false,
      "in_progress": false,
      "planned_for": null,
      "queued_for": null,
      "revision": "v1"
    },
    "apply": {
      "error": null,
      "operation": null,
      "pending_tonight": null
    },
    "custom_ini": {
      "banner": [
        "; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com",
        "; Managed by the control panel. Edits made here are overwritten."
      ],
      "bytes": 145,
      "content": "realpath_cache_size = 8M\n",
      "lines": 1,
      "max_bytes": 32768,
      "overrides": [
        {
          "directive": "realpath_cache_size",
          "line": 1
        }
      ]
    },
    "extensions": [
      {
        "available": true,
        "conflicts": [],
        "description": "A client for Redis and Valkey, for caches, sessions and queues.",
        "enabled": false,
        "group": "caching",
        "kind": "extension",
        "label": "Redis",
        "locked": false,
        "locked_reason": null,
        "name": "redis",
        "non_production_only": false,
        "recommended": true,
        "required_by_app": false,
        "version": "6.3.0"
      }
    ],
    "fpm": {
      "bounds": {
        "max_requests": {
          "max": 100000,
          "min": 100
        },
        "pm": [
          "dynamic",
          "ondemand",
          "static"
        ],
        "process_idle_timeout": {
          "max": 300,
          "min": 5
        }
      },
      "live": null,
      "max_children": null,
      "max_requests": 500,
      "pm": "dynamic",
      "process_idle_timeout": null,
      "source": {
        "max_children": "package",
        "max_requests": "platform",
        "pm": "platform",
        "process_idle_timeout": "platform"
      }
    },
    "image": {
      "line": "new",
      "minor": "8.4",
      "patch": "8.4.9"
    },
    "last_applied_at": null,
    "locked": null,
    "requirements": {
      "application": {
        "name": "WordPress",
        "version": "6.8.3"
      },
      "ext": {
        "by": {
          "imagick": [
            "wordpress"
          ]
        },
        "required": [
          "ext-json",
          "ext-mysqli",
          "ext-imagick"
        ]
      },
      "php": {
        "constraint": ">=7.4",
        "packages": []
      },
      "read_at": "2026-11-08T09:16:40Z",
      "source": "probe"
    },
    "role": "production",
    "settings": {
      "fields": [
        {
          "bounds": {
            "max": 200000,
            "min": 1000,
            "type": "int"
          },
          "effective": 20000,
          "locked": false,
          "locked_reason": null,
          "name": "max_input_vars",
          "source": "site",
          "value": 20000
        }
      ],
      "legacy": {
        "apply": {
          "applied_at": null,
          "error": null,
          "operation": null,
          "state": "applied",
          "state_label": "Applied"
        },
        "bounds": {
          "container_memory_limit_bytes": 2617245696,
          "max_execution_time": {
            "options": [
              60,
              120,
              300
            ]
          },
          "memory_headroom_bytes": 268435456,
          "memory_limit": {
            "max": 2147483648,
            "min": 134217728,
            "step": 67108864
          },
          "platform": "wordpress",
          "post_max_size": {
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576
          },
          "tier": "M",
          "upload_max_filesize": {
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576
          }
        },
        "container_memory_limit_bytes": 2617245696,
        "notes": [],
        "php_version": "8.4",
        "platform": "wordpress",
        "settings": {
          "max_execution_time": {
            "default": 300,
            "max": 300,
            "min": 60,
            "options": [
              60,
              120,
              300
            ],
            "step": 60,
            "unit": "seconds",
            "value": 300
          },
          "memory_limit": {
            "default": 536870912,
            "max": 2147483648,
            "min": 134217728,
            "step": 67108864,
            "unit": "bytes",
            "value": 536870912
          },
          "post_max_size": {
            "default": 268435456,
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576,
            "unit": "bytes",
            "value": 268435456
          },
          "upload_max_filesize": {
            "default": 268435456,
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576,
            "unit": "bytes",
            "value": 268435456
          }
        },
        "tier": "M",
        "version": 12
      },
      "shm": {
        "cap_mb": 998,
        "percent": 40
      }
    },
    "tools": [
      {
        "label": "7-Zip",
        "name": "7z",
        "path": "/usr/bin/7z",
        "purpose": "Packs and unpacks 7z and other archives.",
        "version": "25.01"
      }
    ],
    "version": 12,
    "versions": [
      {
        "ack_detail": [],
        "allowed": false,
        "changes": [],
        "current": true,
        "eol_date": "2028-12-31",
        "label": "PHP 8.4",
        "reason": "This is the current version",
        "requires_ack": [],
        "status": "supported",
        "version": "8.4"
      }
    ],
    "warnings": [],
    "xdebug": null
  },
  "warnings": []
}
```

### 201 The change started (`operation`), or was queued for the site's window (`queued`).

```json
{
  "adopting": false,
  "item_id": 5120,
  "operation": null,
  "php_runtime": {
    "adopted": true,
    "adoption": {
      "adopt_now_refusal": null,
      "adopted": true,
      "can_adopt_now": false,
      "can_adopt_tonight": false,
      "in_progress": false,
      "planned_for": null,
      "queued_for": null,
      "revision": "v1"
    },
    "apply": {
      "error": null,
      "operation": null,
      "pending_tonight": null
    },
    "custom_ini": {
      "banner": [
        "; cf-runtime v1 php-custom.ini site=rs-northwind-harbourandfinch-example-com",
        "; Managed by the control panel. Edits made here are overwritten."
      ],
      "bytes": 145,
      "content": "realpath_cache_size = 8M\n",
      "lines": 1,
      "max_bytes": 32768,
      "overrides": [
        {
          "directive": "realpath_cache_size",
          "line": 1
        }
      ]
    },
    "extensions": [
      {
        "available": true,
        "conflicts": [],
        "description": "A client for Redis and Valkey, for caches, sessions and queues.",
        "enabled": false,
        "group": "caching",
        "kind": "extension",
        "label": "Redis",
        "locked": false,
        "locked_reason": null,
        "name": "redis",
        "non_production_only": false,
        "recommended": true,
        "required_by_app": false,
        "version": "6.3.0"
      }
    ],
    "fpm": {
      "bounds": {
        "max_requests": {
          "max": 100000,
          "min": 100
        },
        "pm": [
          "dynamic",
          "ondemand",
          "static"
        ],
        "process_idle_timeout": {
          "max": 300,
          "min": 5
        }
      },
      "live": null,
      "max_children": null,
      "max_requests": 500,
      "pm": "dynamic",
      "process_idle_timeout": null,
      "source": {
        "max_children": "package",
        "max_requests": "platform",
        "pm": "platform",
        "process_idle_timeout": "platform"
      }
    },
    "image": {
      "line": "new",
      "minor": "8.4",
      "patch": "8.4.9"
    },
    "last_applied_at": null,
    "locked": null,
    "requirements": {
      "application": {
        "name": "WordPress",
        "version": "6.8.3"
      },
      "ext": {
        "by": {
          "imagick": [
            "wordpress"
          ]
        },
        "required": [
          "ext-json",
          "ext-mysqli",
          "ext-imagick"
        ]
      },
      "php": {
        "constraint": ">=7.4",
        "packages": []
      },
      "read_at": "2026-11-08T09:16:40Z",
      "source": "probe"
    },
    "role": "production",
    "settings": {
      "fields": [
        {
          "bounds": {
            "max": 200000,
            "min": 1000,
            "type": "int"
          },
          "effective": 20000,
          "locked": false,
          "locked_reason": null,
          "name": "max_input_vars",
          "source": "site",
          "value": 20000
        }
      ],
      "legacy": {
        "apply": {
          "applied_at": null,
          "error": null,
          "operation": null,
          "state": "applied",
          "state_label": "Applied"
        },
        "bounds": {
          "container_memory_limit_bytes": 2617245696,
          "max_execution_time": {
            "options": [
              60,
              120,
              300
            ]
          },
          "memory_headroom_bytes": 268435456,
          "memory_limit": {
            "max": 2147483648,
            "min": 134217728,
            "step": 67108864
          },
          "platform": "wordpress",
          "post_max_size": {
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576
          },
          "tier": "M",
          "upload_max_filesize": {
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576
          }
        },
        "container_memory_limit_bytes": 2617245696,
        "notes": [],
        "php_version": "8.4",
        "platform": "wordpress",
        "settings": {
          "max_execution_time": {
            "default": 300,
            "max": 300,
            "min": 60,
            "options": [
              60,
              120,
              300
            ],
            "step": 60,
            "unit": "seconds",
            "value": 300
          },
          "memory_limit": {
            "default": 536870912,
            "max": 2147483648,
            "min": 134217728,
            "step": 67108864,
            "unit": "bytes",
            "value": 536870912
          },
          "post_max_size": {
            "default": 268435456,
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576,
            "unit": "bytes",
            "value": 268435456
          },
          "upload_max_filesize": {
            "default": 268435456,
            "max": 1073741824,
            "min": 2097152,
            "step": 1048576,
            "unit": "bytes",
            "value": 268435456
          }
        },
        "tier": "M",
        "version": 12
      },
      "shm": {
        "cap_mb": 998,
        "percent": 40
      }
    },
    "tools": [
      {
        "label": "7-Zip",
        "name": "7z",
        "path": "/usr/bin/7z",
        "purpose": "Packs and unpacks 7z and other archives.",
        "version": "25.01"
      }
    ],
    "version": 12,
    "versions": [
      {
        "ack_detail": [],
        "allowed": false,
        "changes": [],
        "current": true,
        "eol_date": "2028-12-31",
        "label": "PHP 8.4",
        "reason": "This is the current version",
        "requires_ack": [],
        "status": "supported",
        "version": "8.4"
      }
    ],
    "warnings": [],
    "xdebug": null
  },
  "queued": true,
  "warnings": [],
  "window_date": "2026-11-09"
}
```

### 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), or your company requires two-factor authentication and you have not set it up. For routes outside Managed Clusters.

```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 change cannot be made now. `reason` says why: `stale` (the configuration changed since your read: read it again), `busy` (another change to the site is running), `change_pending` (a change already waits for the window), `runtime_locked` (Corefinity has locked the site's PHP configuration), `runtime_not_adopted` (the site is not on the runtime and cannot move onto it yet; the answer adds its `adoption` state), `batch_window` (the change can only be made in the site's window, or other maintenance is already queued for the site: send it again with `apply` `tonight`), `conflict` (other changes kept landing first: send it again), `restore_running`, `command_running` or `deployment_running` (a restore, a command or a deployment is running on the site), `cluster_paused` (the site's cluster is paused for planned maintenance), `deleted`, `provisioning`, `removed` or `managed_elsewhere`. A site that cannot be changed from the Control Panel at all answers a `message` with no `reason`.

```json
{
  "code": "busy",
  "message": "Another change to this site is in progress. Wait for it to finish.",
  "reason": "busy"
}
```

### 422 The change is not valid. `invalid` lists every refused field in `errors`, each with its own `code`, and the php.ini's findings in `diagnostics`. `ini_invalid` means only the php.ini is wrong: see `diagnostics`. `feature_off` refuses a custom php.ini while it is not on for your company, and `apply` `tonight` while queuing for the window is switched off.

```json
{
  "code": "ini_invalid",
  "diagnostics": [
    {
      "code": "locked",
      "column": 1,
      "end_column": 16,
      "line": 1,
      "message": "open_basedir: The platform sets the paths PHP serves.",
      "severity": "error"
    }
  ],
  "errors": [],
  "message": "open_basedir: The platform sets the paths PHP serves.",
  "reason": "ini_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
}
```

### 502 The platform did not save the change. Nothing was changed; the body carries a `message` and no `reason`.

```json
{
  "message": "The change could not be saved. Contact support."
}
```

### 503 Corefinity has paused PHP changes for the moment (`switched_off`). Try again later.

```json
{
  "code": "switched_off",
  "message": "PHP changes are paused while commands are switched off. Try again later.",
  "reason": "switched_off"
}
```

## 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 | `busy` | Another operation is running on the site. Wait for it to finish. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `runtime_locked` | Corefinity has locked this environment's PHP configuration. Contact support to change it. |
| 409 | `stale` | What you read has changed since you read it. Read it again, then send the change with its new version or quote. |
| 422 | `ini_invalid` | open_basedir: The platform sets the paths PHP serves. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 422 | `feature_off` | This feature is not on for your organisation yet. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 502 |  | Read the message; it says what happened. |
| 503 | `switched_off` | Corefinity has switched this action off for the moment. Try again later. |

## The same task elsewhere

- Guide: [PHP configuration](https://docs.corefinity.com/guides/sites/software-and-services/php-settings-and-php-ini.md)
- MCP tool: [`corestack_php_extensions_update`](https://docs.corefinity.com/mcp/tools/corestack_php_extensions_update.md)
