Test Plans

Archive a test plan

Archives (soft-deletes) a test plan. The plan is hidden from plan lists and can no longer be updated or run, but its member cases, run history, and schedule are all kept, and the plan stays readable by id with archivedAt set. The schedule is left exactly as configured; the scheduler skips archived plans, so restoring one resumes its normal cadence. Idempotent: archiving an already-archived plan succeeds.

post/api/plans/{planId}/archive

Request

Base URL
https://aximo.autify.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/autify/apis/aximo-api/docs/api/plans/:planId/archive/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

planIdstring uuid required

Response

Plan archived.

archivedboolean required

Example response

{
  "archived": true
}

Changes

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