Sign in
Hosting: Websites

List website setups

Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the order_id, subscription_id or domain filters.

Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is running endpoints that operate on that website may respond with 404 or 409. Poll this endpoint with the domain filter every 10 to 15 seconds and wait for status: completed before uploading files, deploying or creating databases. failed means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed.

type is the website type the setup was started with (wordpress, headless_wordpress, headless_ecommerce, headless_pocketbase), or null for an empty website.

get/api/hosting/v1/onboardings

Query parameters

order_idinteger nullable
Example:123

Order ID

subscription_idstring nullable
Example:sub_abc123

Filter by hosting order subscription ID

domainstring nullable
Example:example.com

Filter by domain name (exact match)

Response

Success response

domainstring required

Domain of the website being set up.

usernamestring required

Hosting account username.

typestring nullable

Website type requested for the setup: wordpress, headless_wordpress, headless_ecommerce or headless_pocketbase. null for an empty website. Setups started outside this API may report other legacy types.

status'running' | 'completed' | 'failed' required

running while the website is still being set up, completed once the setup has finished, failed when it stopped before finishing or has not reported progress for over an hour.

created_atstring date-time required

When the setup was requested.

updated_atstring date-time required

When the setup last reported progress.

Example response

[
  {
    "domain": "example.com",
    "username": "u123456789",
    "type": "wordpress",
    "status": "running",
    "created_at": "2024-01-15T10:30:00.000000Z",
    "updated_at": "2024-01-15T10:32:00.000000Z"
  }
]

Changes

Changed in 2 of the 117 revisions of this API.4

  • f086c8278a093See the full diff
    • ○

      added the new optional query request parameter order_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter subscription_id

      new-optional-request-parameter

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 80eb9c2270331See the full diff
    • ○

      endpoint added

      endpoint-added