API Reference

Onyx Core API

Resources & Endpoints

Show Domain

Shows information about a domain.

GET
https://portal.onyx.io/api/v2/sites/{site}/domains/{domain}

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

domain Required

Site Domain Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

domain_not_found

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

 404 Not Found

site_not_found

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

 404 Not Found

Returned Object

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

{
    domain: Domain {
        id: Integer
        site_id: Integer
        name: String
        redirect: Boolean
        require_ssl: Boolean
        primary: Boolean
        created_at: Unix Timestamp
    }
}