API Reference

Onyx Core API

Resources & Endpoints

Create Site

Create a new site within a service.

POST
https://portal.onyx.io/api/v2/sites

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

name Required

The name for the new site

 String None

subdomain

The subdomain for the new site

 String None

php_version

The PHP version for the new site

 String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

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
    }
}