Documentation

features

Blueprints

Reusable service templates for one-click deployment of common stacks.

Blueprints#

Blueprints are reusable templates that let you deploy common service configurations in one click. Instead of setting up a Node.js API with PostgreSQL from scratch, you can use a blueprint that configures everything for you.

How blueprints work#

  • A blueprint captures: the repository URL, branch, service type, instance type, and default environment variables
  • When you deploy from a blueprint, Runix creates a new deployment with all the settings pre-configured
  • You can customize any setting before deploying — blueprints are starting points, not locked configurations

Using a blueprint#

1

Browse blueprints

Open the dashboard and click "New Deployment" then "From Blueprint". Browse the available templates.

2

Select and customize

Pick a blueprint and review the pre-filled settings. Change the service name, environment variables, or instance type as needed.

3

Deploy

Click deploy. Runix clones the repo, builds the image, and starts the container just like a normal deployment.

Creating a blueprint from a deployment#

You can turn any running deployment into a blueprint. This is useful if you have a service configured exactly the way you like and want to replicate it.

Create a blueprint from an existing deployment

bash
# Via the API
curl -X POST https://api.runix.dev/blueprints \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "My Node API", "deployment_id": "a1b2c3d4-..." }'

Blueprint API#

GET/blueprints

List all available blueprints.

🔒 Auth: Bearer token required


POST/blueprints

Create a new blueprint.

🔒 Auth: Bearer token required

Parameters
namestringrequiredBlueprint name
deployment_iduuidoptionalSource deployment to copy settings from

GET/blueprints/{id}

Get blueprint details.

🔒 Auth: Bearer token required

Parameters
iduuidrequiredBlueprint ID

PUT/blueprints/{id}

Update a blueprint.

🔒 Auth: Bearer token required

Parameters
iduuidrequiredBlueprint ID
namestringoptionalNew name