Formations

Plan a formation deployment

Computes a diff between the desired template and the current stack state without making any changes. Returns the list of planned actions.

post/v1/projects/{project_id}/formations/plan

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/formations/plan
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Request body

formation_idstring

Existing formation ID to compare against. Omit for new formation planning.

parametersobject nullable

Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in template.parameters. A parameter declared with use_previous_value: true may be omitted to reuse its stored value.

Example request

{
  "template": {
    "metadata": {
      "author": "John",
      "revision": 2
    }
  }
}

Response

Plan result

Example response

{
  "unauthorized_actions": [
    {
      "logical_id": "MyGuardrail",
      "resource_type": "guardrail",
      "action": "guardrails:CreateGuardrail"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.