---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Preview Ignition injections

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/device/preview-ignition": {
      "post": {
        "operationId": "post_preview_effective_ignition_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PreviewEffectiveIgnition"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PreviewEffectiveIgnitionResponse"
                }
              }
            }
          },
          "400": {
            "description": "Error"
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          },
          "422": {
            "description": "Error"
          }
        },
        "summary": "Preview Ignition injections",
        "tags": [
          "Device"
        ]
      }
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Access to your Bare-Metal or Virtual Devices",
      "name": "Device"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "Modification": {
        "properties": {
          "contents": {
            "type": "object"
          },
          "path": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "PreviewEffectiveIgnition": {
        "properties": {
          "bonded": {
            "default": false,
            "example": false,
            "type": "boolean"
          },
          "hostname": {
            "type": "string"
          },
          "ignition": {
            "type": "object"
          },
          "password": {
            "type": "string"
          },
          "primaryInterface": {
            "$ref": "#/components/schemas/PrimaryInterface"
          },
          "publicKeys": {
            "default": [],
            "example": [],
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "ignition"
        ],
        "type": "object"
      },
      "PreviewEffectiveIgnitionResponse": {
        "properties": {
          "modifications": {
            "items": {
              "$ref": "#/components/schemas/Modification"
            },
            "type": "array"
          },
          "original": {
            "type": "object"
          },
          "result": {
            "type": "object"
          }
        },
        "type": "object"
      },
      "PrimaryInterface": {
        "properties": {
          "dnsServers": {
            "example": [],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "gateway": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "subnet": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```