Enable, repoint, or disable a suite's schedule

A schedule fires exactly ONE run per interval, so an environment-based suite must pin exactly one of its attached environments. Omitting environmentId on a single-environment suite means that environment; omitting it on a multi-environment suite is a VALIDATION_ERROR. Disabling preserves the existing pin. Responds with the full updated suite.

PATCH /projects/{projectId}/eval-suites/{suiteId}/schedule

Enable, repoint, or disable a suite's schedule

cURL

curl --request PATCH \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/eval-suites/{suiteId}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "declaredSuiteId": "<string>",
  "intervalMinutes": 5042,
  "environmentId": "<string>"
}
'

200

Example

{ "id": "<string>", "environment": { "servers": [ "<string>" ], "computerEnvironment": { "id": "<string>", "name": "<string>" } }, "hosts": [ { "id": "<string>", "name": "<string>", "servers": [ "<string>" ] } ], "settings": { "minimumAccuracy": 123, "minimumIterations": 123, "matchOptions": {}, "checks": [ {} ], "judge": { "enabled": true, "model": "<string>", "autoRun": true, "threshold": 123, "severity": "warn", "groundedness": { "role": "advisory", "model": "<string>", "threshold": 123, "severity": "warn" }, "rubric": { "criteria": [ { "id": "<string>", "label": "<string>", "description": "<string>", "required": true } ] } }, "verdictPolicyVersion": 2, "verdictPolicyDefaults": { "repetitions": 2, "passThreshold": 0.5, "validity": { "minEligibleTrials": 2, "minCompletionRate": 0.5, "maxEvaluatorErrorRate": 0.5 } }, "policy": "legacy" }, "schedule": { "enabled": true, "intervalMinutes": 5042, "environmentId": "<string>", "state": "active", "createdBy": "<string>", "nextDueAt": 123, "consecutiveFailures": 123 }, "declaredId": "<string>", "managedBy": "ci", "name": "<string>", "description": "<string>", "projectId": "<string>", "executionConfig": { "model": "<string>", "systemPrompt": "<string>", "temperature": 123 }, "environmentIds": [ "<string>" ], "revisionNumber": 123, "createdAt": 123, "updatedAt": 123 }

Authorizations

Authorization · string · header · required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Path Parameters

projectId · string · required

ID of the hosted project that contains the server.

suiteId · string · required

Eval suite ID, as returned by POST /eval-runs.

Query Parameters

declaredSuiteId · string

The suite file's own suite.id, when this request is that file syncing itself. A CI-owned suite (see EvalSuiteDetail.managedBy) refuses configuration writes with 409 and details.reason: "CI_OWNED_SUITE_READ_ONLY"; naming the suite's own declared id is how the file writing itself is allowed through. Naming any other id refuses exactly as loudly as naming none, so it is not a capability — omit it for an ordinary edit.

A QUERY PARAMETER on every route that takes it, never a body field. These request bodies are strict, here and on every Inspector that predates the CI-owned lock, so a body field is a 400 against an older deployment — which would break mcpjam cloud eval run --file for anyone whose CLI is newer than their Inspector. A query parameter is read by the deployments that know it and ignored by those that do not, which is the right degradation: an Inspector with no lock has no exception to make.

Maximum string length: 128

Body

application/json

Enable, repoint, or disable a suite's recurring runs. Disabling PRESERVES the existing environment pin — send enabled: true with a new environmentId to repoint it.

enabled · boolean · required

declaredSuiteId · string

The suite file's own suite.id, when THIS request is a suite-file sync.

A CI-owned suite (see EvalSuiteDetail.managedBy) refuses configuration writes with 409 and details.reason: "CI_OWNED_SUITE_READ_ONLY". Naming the suite's own declared id is how the file writing itself is allowed through — the platform permits the write only when the id matches, so naming any other id refuses exactly as loudly as naming none. Omit it for ordinary edits.

PREFER THE declaredSuiteId QUERY PARAMETER on this route. This body field still works here, but these request bodies are strict on every Inspector that predates the CI-owned lock, so a body field is a 400 against an older deployment while an unknown query parameter is simply ignored. The MCPJam SDK and CLI send the query parameter.

Maximum string length: 128

intervalMinutes · integer

Required range: 5 <= x <= 10080

environmentId · string

Which attached environment scheduled runs use. Only meaningful when enabling. Omitted on a single-environment suite means that environment; omitted on a multi-environment suite is a VALIDATION_ERROR.

Minimum string length: 1

Response

200

application/json

The updated suite.

One eval suite's full configuration. Distinct from the EvalSuite summary returned by the list route, which carries run rollups instead of settings.

id · string · required

environment · object · required

LEGACY server bag, kept as rollback data, plus the suite's sandbox-image pin. Unrelated to environmentIds.

Show child attributes

hosts · object[] · required

Show child attributes

settings · object · required

Show child attributes

schedule · object · required

Recurring-run schedule. A schedule fires exactly ONE run, so an environment-based suite pins the environment it runs against.

Show child attributes

declaredId · string

The suite's declared file identity (suite.id in a suite file). Present on file-owned suites; absent on UI-authored suites, which have no declared id and cannot be claimed by eval run --file.

managedBy · enum<string>

Where this suite's configuration lives. ci means it is owned by a committed suite file or by MCPJam SDK ingest, and the platform REFUSES configuration writes to it — name, settings, environments, schedule, models, skills, execution config and cases — from this API and from the app alike, with 409 CONFLICT and details.reason: "CI_OWNED_SUITE_READ_ONLY".

Running, replaying and comparing are unaffected. To change a CI-owned suite, either edit its file and send that file's suite.id as declaredSuiteId on the write, or duplicate the suite for an editable copy.

declaredId alone is not this answer: a suite created by SDK ingest is CI-owned and has no declared id.

Available options: ci, app

name · string | null

description · string | null

projectId · string | null

executionConfig · object | null

Show child attributes

environmentIds · string[]

Attached project environments, in attach order.

revisionNumber · integer | null

How many committed edits this suite has had, or null on a deployment that does not record revisions. Send it back as expectedRevisionNumber on a PATCH to make that edit a compare-and-set.

createdAt · number | null

Epoch milliseconds.

updatedAt · number | null