CorefinityCorefinityDocs
Open the Control PanelControl Panel
PHP settings · 1 of 6

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.

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

Path parameters

siteintegerRequired

The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.

Body

applystring

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. Defaults to now.

nowtonightwindow
custom_inistring or null

The whole custom php.ini, saved exactly as sent. An empty string removes it.

extensionsarray of strings

Every optional extension to load, by name. An empty list turns them all off.

fpmobject

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.

Fields
max_requestsinteger or null

100 to 100000.

pmstring or null
dynamicondemandstaticnull
pm.max_requestsinteger or null

The same as max_requests. 100 to 100000.

pm.process_idle_timeoutinteger or null

The same as process_idle_timeout. Seconds. Only with pm ondemand. 5 to 300.

process_idle_timeoutinteger or null

Seconds. Only with pm ondemand. 5 to 300.

settingsobject

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.

versionintegerRequired

The version of your last read. At least 0.

xdebugobject or any or null

Xdebug's set-up, or null to turn it off. Refused on production.

Returns

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

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

Fields of the 200 answer
adoptingbooleanRequired

True when the change also moves the site onto the runtime.

item_idinteger or null

The id of the pending change. Sent only with queued. At least 1.

operationobject or any or nullRequired

The operation that applies the change. Null when nothing differs and when the change was queued.

php_runtimeobjectRequired

A site's PHP configuration.

Fields
adoptedbooleanRequired

True when the site is on the runtime. Extensions, the full settings form, PHP-FPM, Xdebug and the php.ini need it.

adoptionobjectRequired

Whether a site is on the runtime, and whether it can move onto it.

Fields
adopt_now_refusalstring or nullRequired

Why the site cannot move at once, when it cannot.

adoptedbooleanRequired

True when the site is on the runtime.

can_adopt_nowbooleanRequired
can_adopt_tonightbooleanRequired
in_progressbooleanRequired
planned_forstring or nullRequired

The date Corefinity plans to move the site, if one is set.

queued_forstring or nullRequired

The date of the window the move is queued for, if it is queued.

revisionstring or nullRequired

The runtime revision the site is on, such as v1. Null until it is on the runtime.

applyobjectRequired

The PHP change still running, and the error of the last one that failed.

Fields
errorstring or nullRequired
operationobject or any or nullRequired

The PHP change still running, in short. Null when none is.

pending_tonightany

Always null at present.

custom_iniobjectRequired

The site's custom php.ini.

Fields
bannerarray of stringsRequired

The lines the Control Panel writes at the top of the file.

bytesintegerRequired

The size of the file as it is stored, the banner included.

contentstringRequired

The text, exactly as it was saved. Empty when there is none.

linesintegerRequired
max_bytesintegerRequired
overridesarray of objectsRequired

The settings form directives the php.ini sets, with the line that sets each.

Fields of each item
directivestringRequired
lineintegerRequired
extensionsarray of objectsRequired

Empty when the site's PHP version has no catalogue.

Fields of each item
availablebooleanRequired
conflictsarray of stringsRequired

Extensions that cannot be on at the same time.

descriptionstringRequired
docs_urlstring or null
enabledbooleanRequired
groupstringRequired
kindstringRequired

extension or zend_extension.

labelstringRequired
lockedbooleanRequired

True when the platform keeps it on or off for this site.

locked_reasonstring or nullRequired
namestringRequired

The name a change sends in extensions.

non_production_onlybooleanRequired
recommendedbooleanRequired
required_by_appbooleanRequired

True when the application's requirements name it.

sostring or null
versionstring or nullRequired
fpmobjectRequired

PHP-FPM as it applies to the site. A null value is inherited from the platform.

Fields
boundsobjectRequired

The values pm may take, and the range of max_requests and process_idle_timeout.

liveobject or null

The pool's figures when they were last read (active, idle, max_children_reached, read_at), or null.

max_childreninteger or nullRequired

Set by the site's size; it cannot be changed here.

max_requestsinteger or nullRequired
pmstring or nullRequired

dynamic, ondemand or static.

process_idle_timeoutinteger or nullRequired

Seconds. Applies only with pm ondemand.

sourceobjectRequired

Where each value comes from, such as platform, site or package.

imageobjectRequired

The PHP the site runs.

Fields
linestringRequired

new for the runtime's PHP, legacy for the earlier one.

minorstring or nullRequired

Such as 8.4.

patchstring or nullRequired

The full version, such as 8.4.9, when it is known.

last_applied_atstring or nullRequired

Format: date-time.

lockedobject or any or nullRequired

Set when Corefinity has locked the site's PHP configuration, with the reason. Null otherwise.

requirementsobject or nullRequired

What the application asks of PHP, as it was last stored. Null before the first read. GET …/php-runtime/requirements answers it with what is missing.

rolestringRequired

The environment's role, such as production or staging.

settingsobjectRequired
Fields
fieldsarray of objectsRequired

The settings form. A site that is not on the runtime has only memory limit, upload size and execution time.

Fields of each item
boundsobjectRequired

What the value may be. Memory, upload size and execution time carry default, min, max, unit (bytes or seconds), step and sometimes options. Every other directive carries type (size, int, enum, bool, expr, timezone or path) and what that type needs.

Fields
defaultany
maxinteger
mininteger
optionsarray
rootstring
stepinteger
typestring
unitstring
effectiveinteger or nullRequired

The value in effect.

lockedbooleanRequired
locked_reasonstring or nullRequired

Such as production or platform.

namestringRequired

The directive, as a change sends it in settings.

sourcestringRequired

Where the value in effect comes from: site (set for the site), ini (the custom php.ini), platform, image (PHP's own default) or locked (kept fixed by the platform).

valueinteger or nullRequired

The value set for the site. Null when none is set, so the default applies. Sizes are in bytes.

legacyobject or any or nullRequired

What GET /corestack/sites/{site}/php-settings answers. Null for a site with a custom size.

shmobject or nullRequired

The shared memory OPcache, its JIT and APCu may use together (cap_mb, and that as a percent of PHP's memory). Null for a site that is not on the runtime.

toolsarray of objectsRequired
Fields of each item
labelstring
namestringRequired
pathstring
purposestring
versionstring or nullRequired
versionintegerRequired

The write token. Send it back with every change; a change made since your read is refused stale.

versionsarray of objectsRequired
Fields of each item
ack_detailobjectRequired

A sentence for each entry of requires_ack, by its key. An empty list when nothing is asked.

allowedbooleanRequired

Whether the site may move to this version.

changesarray of stringsRequired

What moving to this version changes besides the version.

currentbooleanRequired
eol_datestring or nullRequired

The day the version stops getting security fixes.

labelstringRequired
reasonstring or nullRequired

Why it is not allowed, when it is not.

requires_ackarray of stringsRequired

What acknowledge must carry to move to this version, such as eol.

statusstringRequired

Such as supported, security or eol.

versionstringRequired

Major and minor, such as 8.4.

warningsarray of objectsRequired
Fields of each item
codestringRequired
messagestringRequired
xdebugobject or any or nullRequired

Null on production and on a site that is not on the runtime.

queuedboolean

Sent only when the change waits for the site's window.

warningsarray of objectsRequired
Fields of each item
codestringRequired
messagestringRequired
windowobject or any or null

The window the change waits for. Sent only with queued, while maintenance windows are on for your company.

window_datestring

The date of the window the change waits for. Sent only with queued.

Fields of the 201 answer
adoptingbooleanRequired

True when the change also moves the site onto the runtime.

item_idinteger or null

The id of the pending change. Sent only with queued. At least 1.

operationobject or any or nullRequired

The operation that applies the change. Null when nothing differs and when the change was queued.

php_runtimeobjectRequired

A site's PHP configuration.

Fields
adoptedbooleanRequired

True when the site is on the runtime. Extensions, the full settings form, PHP-FPM, Xdebug and the php.ini need it.

adoptionobjectRequired

Whether a site is on the runtime, and whether it can move onto it.

Fields
adopt_now_refusalstring or nullRequired

Why the site cannot move at once, when it cannot.

adoptedbooleanRequired

True when the site is on the runtime.

can_adopt_nowbooleanRequired
can_adopt_tonightbooleanRequired
in_progressbooleanRequired
planned_forstring or nullRequired

The date Corefinity plans to move the site, if one is set.

queued_forstring or nullRequired

The date of the window the move is queued for, if it is queued.

revisionstring or nullRequired

The runtime revision the site is on, such as v1. Null until it is on the runtime.

applyobjectRequired

The PHP change still running, and the error of the last one that failed.

Fields
errorstring or nullRequired
operationobject or any or nullRequired

The PHP change still running, in short. Null when none is.

pending_tonightany

Always null at present.

custom_iniobjectRequired

The site's custom php.ini.

Fields
bannerarray of stringsRequired

The lines the Control Panel writes at the top of the file.

bytesintegerRequired

The size of the file as it is stored, the banner included.

contentstringRequired

The text, exactly as it was saved. Empty when there is none.

linesintegerRequired
max_bytesintegerRequired
overridesarray of objectsRequired

The settings form directives the php.ini sets, with the line that sets each.

Fields of each item
directivestringRequired
lineintegerRequired
extensionsarray of objectsRequired

Empty when the site's PHP version has no catalogue.

Fields of each item
availablebooleanRequired
conflictsarray of stringsRequired

Extensions that cannot be on at the same time.

descriptionstringRequired
docs_urlstring or null
enabledbooleanRequired
groupstringRequired
kindstringRequired

extension or zend_extension.

labelstringRequired
lockedbooleanRequired

True when the platform keeps it on or off for this site.

locked_reasonstring or nullRequired
namestringRequired

The name a change sends in extensions.

non_production_onlybooleanRequired
recommendedbooleanRequired
required_by_appbooleanRequired

True when the application's requirements name it.

sostring or null
versionstring or nullRequired
fpmobjectRequired

PHP-FPM as it applies to the site. A null value is inherited from the platform.

Fields
boundsobjectRequired

The values pm may take, and the range of max_requests and process_idle_timeout.

liveobject or null

The pool's figures when they were last read (active, idle, max_children_reached, read_at), or null.

max_childreninteger or nullRequired

Set by the site's size; it cannot be changed here.

max_requestsinteger or nullRequired
pmstring or nullRequired

dynamic, ondemand or static.

process_idle_timeoutinteger or nullRequired

Seconds. Applies only with pm ondemand.

sourceobjectRequired

Where each value comes from, such as platform, site or package.

imageobjectRequired

The PHP the site runs.

Fields
linestringRequired

new for the runtime's PHP, legacy for the earlier one.

minorstring or nullRequired

Such as 8.4.

patchstring or nullRequired

The full version, such as 8.4.9, when it is known.

last_applied_atstring or nullRequired

Format: date-time.

lockedobject or any or nullRequired

Set when Corefinity has locked the site's PHP configuration, with the reason. Null otherwise.

requirementsobject or nullRequired

What the application asks of PHP, as it was last stored. Null before the first read. GET …/php-runtime/requirements answers it with what is missing.

rolestringRequired

The environment's role, such as production or staging.

settingsobjectRequired
Fields
fieldsarray of objectsRequired

The settings form. A site that is not on the runtime has only memory limit, upload size and execution time.

Fields of each item
boundsobjectRequired

What the value may be. Memory, upload size and execution time carry default, min, max, unit (bytes or seconds), step and sometimes options. Every other directive carries type (size, int, enum, bool, expr, timezone or path) and what that type needs.

Fields
defaultany
maxinteger
mininteger
optionsarray
rootstring
stepinteger
typestring
unitstring
effectiveinteger or nullRequired

The value in effect.

lockedbooleanRequired
locked_reasonstring or nullRequired

Such as production or platform.

namestringRequired

The directive, as a change sends it in settings.

sourcestringRequired

Where the value in effect comes from: site (set for the site), ini (the custom php.ini), platform, image (PHP's own default) or locked (kept fixed by the platform).

valueinteger or nullRequired

The value set for the site. Null when none is set, so the default applies. Sizes are in bytes.

legacyobject or any or nullRequired

What GET /corestack/sites/{site}/php-settings answers. Null for a site with a custom size.

shmobject or nullRequired

The shared memory OPcache, its JIT and APCu may use together (cap_mb, and that as a percent of PHP's memory). Null for a site that is not on the runtime.

toolsarray of objectsRequired
Fields of each item
labelstring
namestringRequired
pathstring
purposestring
versionstring or nullRequired
versionintegerRequired

The write token. Send it back with every change; a change made since your read is refused stale.

versionsarray of objectsRequired
Fields of each item
ack_detailobjectRequired

A sentence for each entry of requires_ack, by its key. An empty list when nothing is asked.

allowedbooleanRequired

Whether the site may move to this version.

changesarray of stringsRequired

What moving to this version changes besides the version.

currentbooleanRequired
eol_datestring or nullRequired

The day the version stops getting security fixes.

labelstringRequired
reasonstring or nullRequired

Why it is not allowed, when it is not.

requires_ackarray of stringsRequired

What acknowledge must carry to move to this version, such as eol.

statusstringRequired

Such as supported, security or eol.

versionstringRequired

Major and minor, such as 8.4.

warningsarray of objectsRequired
Fields of each item
codestringRequired
messagestringRequired
xdebugobject or any or nullRequired

Null on production and on a site that is not on the runtime.

queuedboolean

Sent only when the change waits for the site's window.

warningsarray of objectsRequired
Fields of each item
codestringRequired
messagestringRequired
windowobject or any or null

The window the change waits for. Sent only with queued, while maintenance windows are on for your company.

window_datestring

The date of the window the change waits for. Sent only with queued.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409busyAnother operation is running on the site. Wait for it to finish.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409runtime_lockedCorefinity has locked this environment's PHP configuration. Contact support to change it.
409staleWhat you read has changed since you read it. Read it again, then send the change with its new version or quote.
422ini_invalidopen_basedir: The platform sets the paths PHP serves.
422invalidFix the field named in field; errors says why.
422feature_offThis feature is not on for your organisation yet.
429rate_limitedWait for the seconds in Retry-After.
502noneRead the message; it says what happened.
503switched_offCorefinity has switched this action off for the moment. Try again later.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

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
  }'
{
  "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": []
}
Try it

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.

Was this helpful?
Open in ClaudeOpen in ChatGPT