A run is one piece of work Certyn did: one test, one retest, or one exploration. The REST API calls runs executions.
Reading needs execution:read. Stopping and retrying need platform:manage.
List runs
/api/projects/{projectId}/executionsBearer or API key · execution:readPaged. Optional query:
| Parameter | Notes |
|---|---|
status | One or more, comma-separated: draft, queued, dispatching, starting, running, completed, failed, aborted, blocked. An unknown value returns 400. |
environmentKey | |
agentId | |
page, pageSize |
Each item has id, status, effectiveTestOutcome (such as passed, failed, or blocked), startedAt, completedAt, duration, environmentKey, environmentVersion, summaryMarkdown, testCasesCount, and findingsCount.
Get a run
/api/projects/{projectId}/executions/{executionId}Bearer or API key · execution:readEvidence
/api/projects/{projectId}/executions/{executionId}/artifactsBearer or API key · execution:read/api/projects/{projectId}/executions/{executionId}/notesBearer or API key · execution:read/api/projects/{projectId}/executions/{executionId}/testcasesBearer or API key · execution:readEach returns a paged result. Artifacts have id, type, uri, description, and createdAt. The testcases list has the result of each test in the run.
Stop a run
/api/projects/{projectId}/executions/{executionId}/stopBearer or API key · platform:manageReturns 204. A run that is not running returns 400.
Retry a run
/api/projects/{projectId}/executions/{executionId}/retryBearer or API key · platform:manageStarts a new attempt and returns 201 with the new run. A run that cannot be retried returns 400. A retry that is already in progress returns 409.
Example
curl -sS -H "X-API-Key: $CERTYN_API_KEY" \
"https://api.certyn.io/api/projects/$PROJECT_ID/executions?status=failed,blocked&pageSize=10"