RUAL Documentation

Blueprints APIs

List of all cluster API endpoints within the Blueprints category. Each endpoint provides specific functionality for integrating with cluster services.

/blueprints/search GET Search blueprints (GET) with Elasticsearch query parameters /blueprints/search POST Search blueprints with advanced filtering and permission-based access /blueprints/{guid} GET Get blueprint by GUID or short_id with Redis caching and permission checks /blueprints/{guid} DELETE Delete a blueprint and log the change /blueprints POST Create a new blueprint with auto-generated short_id and change tracking /blueprints/tests/{guid} GET Get test results for a blueprint /blueprints/restore POST Restore a previously deleted blueprint /blueprints/deploys GET Get deployment status and information /blueprints/production POST Deploy a blueprint to production environment /blueprints/simulating POST Start simulating a blueprint for testing /blueprints/apply/{guid} PUT Apply changes to a blueprint /blueprints/deploy GET Get current deployment status /blueprints/deploy-selected POST Deploy selected blueprints /blueprints/deploy/{guid}/actions GET Get actions for blueprint deployment /blueprints/deploy/{guid}/actions/guids GET Get action GUIDs for deployment /blueprints/update/set/active/{guid} PUT Set blueprint as active /blueprints/update/set/inactive/{guid} PUT Set blueprint as inactive /blueprints/simulating/data POST Cache data for blueprint simulation /blueprints/simulating/data/{session} DELETE Delete a blueprint simulation session /blueprints/simulating/data/{session}/{key} GET Get data from blueprint simulation /blueprints/simulating/html/{key} GET Get HTML rendering of simulation data /blueprints/simulating/json POST Get JSON data from simulation /blueprints/simulating/json/{session}/{key} GET Get JSON data from simulation session
Back to API Categories Return to the main API categories page to browse other endpoints