Sign in
Hosting: NodeJS

List NodeJS builds

Retrieve a paginated list of Node.js build processes for a specific website.

Each build represents a single run of the Node.js build pipeline. Use the states query parameter to filter results by build state (pending, running, completed, failed). Use the uuid from a build to poll its output via the Get Node.js Build Logs endpoint.

get/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds

Path parameters

usernamestring required
Example:u123456789
domainstring required
Example:mydomain.tld

Domain name

Query parameters

pageinteger
Example:1

Page number

per_pageinteger
Example:25

Number of items per page

statesstring[]

Build states to filter by

Response

Success response

Example response

{
  "data": [
    {
      "uuid": "69f07fe2-197a-4fb3-9dae-606f965ad13d",
      "state": "pending",
      "options": {
        "node_version": 24,
        "app_type": "vite",
        "root_directory": "src",
        "output_directory": "dist",
        "build_script": "build",
        "entry_file": "server.js",
        "package_manager": "npm",
        "source_type": "archive",
        "source_options": {
          "archive_path": "archive.zip"
        }
      },
      "created_at": "2024-05-29T05:49:49.067239Z",
      "updated_at": "2024-05-29T05:49:49.067239Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

Changes

Changed in 1 of the 88 revisions of this API.13

  • 0692bdc8e67513See the full diff
    • ●

      added the new astro enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new express enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new fastify enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gatsby enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hono enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nest enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new next enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nitro enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nuxt enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new other enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new react-router enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new svelte enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new svelte-kit enum value to the data/items/options/oneOf[Hosting.V1.NodeJs.BuildOptionsResource]/app_type response property for the response status 200

      response-property-enum-value-added