Plan Schema

Return the live JSON schema for Plan.

The agent calls this via ./converge plan-schema when it needs field-level detail. Sourced from converge_api.plan.schema.Plan, the shape submit-plan validates against, so the fields cannot drift. The submit-only checks of SubmittedPlan are stated in field descriptions.

post/agent/cli/plan_schema

Request

  • Base URL
    https://app.runconverge.com/api
  • URL
    https://app.runconverge.com/api/agent/cli/plan_schema
  • Auth
    HTTP bearer

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 29 revisions of this API.