Documentation menu
Agent Jobs

Run agent job now

POST /api/v1/projects/{projectId}/environments/{environmentId}/agent-jobs/{agentJobId}/runs

Trigger an immediate run of a schedule, independent of the cron cadence. The scheduled nextFireAt is preserved so the regular cadence is not disturbed. The standard Idempotency-Key header is required. Reuse the same key for a transport retry: a durable manual operation fire is replayed by its fire identity and status, including lease/approval waits; agent-target claims retain their in-flight retry behavior. A changed request is rejected with 409.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Run agent job now.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Run agent job now.
agentJobIdstringrequiredIdentifies the scheduled agent job. Applies to Run agent job now.

header

NameTypeRequiredDescription
Idempotency-Keystringrequired

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: one of 3 types (required)
202Response for status 202application/json — object — data: one of 3 types (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
402Payment required. The organization has exhausted its billing-period minute budget. Upgrade the plan or wait for the period to roll over.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)