List website setups

Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first.

List website setups

get

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.

Authorizations

AuthorizationstringRequired

API Token authentication

Query parameters

order_idinteger · nullableOptional

Order ID

Example: 123

subscription_idstring · max: 255 · nullableOptional

Filter by hosting order subscription ID

Example: sub_abc123

domainstring · max: 255 · nullableOptional

Filter by domain name (exact match)

Example: example.com

Responses

200

Success response

application/json

Array of Hosting.V1.Onboardings.OnboardingResource

domainstringRequired

Domain of the website being set up.

Example: example.com

usernamestringRequired

Hosting account username.

Example: u123456789

typestring · nullableOptional

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.

Example: wordpress

statusstring · enumRequired

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.

Example: runningPossible values:

created_atstring · date-timeRequired

When the setup was requested.

Example: 2024-01-15T10:30:00.000000Z

updated_atstring · date-timeRequired

When the setup last reported progress.

Example: 2024-01-15T10:32:00.000000Z

401

Unauthenticated response

application/json

422

Validation error response

application/json

500

Error response

application/json

get/api/hosting/v1/onboardings

GET /api/hosting/v1/onboardings HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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"
  }
]