API Reference

Onyx Core API

Resources & Endpoints

Update site

Updates a site with new properties.

PATCH
https://portal.onyx.io/api/v2/sites/{site}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

site Required

Site Lookup None

name Required

The name for the new site

 String None

subdomain

The subdomain for the new site

 String None

debug_mode

WordPress debug mode

 Boolean None

php_version

The PHP version for the new site

 SitePHPVersionEnum None

Potential Errors

The following errors may occur during this request.

Details HTTP status

site_not_found

No site was found matching any of the criteria provided in the arguments

 404 Not Found

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    site: Site {
        id: Integer
        name: String
        subdomain: String
        parent_id: Integer?
        created_at: Unix Timestamp
        ssh_enabled: Boolean
        cdn_enabled: Boolean
        cdn_active_domain: String?
        onyx_domain: String
        version: String?
        php_version: SitePHPVersionEnum
        debug_mode: Boolean
        provision_status: SiteProvisioningStatusEnum
    }
}