APIReference
Job Specs API
Generated OpenAPI reference for the Job Specs API surface.
Overview
Job Specs endpoints are part of the public Everyn API. Reusable job specs and immutable job-spec versions.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
GET | /v1/job-specs | List Job Specs | None. | 200 application/json: Page_JobSpecResponse_ |
POST | /v1/job-specs | Create Job Spec | application/json: JobSpecRequestBody | 201 application/json: JobSpecResponse |
GET | /v1/job-specs/summaries | List Job Spec Summaries | None. | 200 application/json: CountedBidirectionalPage_JobSpecSummaryResponse_ |
GET | /v1/job-specs/toolsets | List Row Agent Toolsets | None. | 200 application/json: AgentToolsetListResponse |
GET | /v1/job-specs/{job_spec_id} | Get Job Spec | None. | 200 application/json: JobSpecDetailResponse |
PATCH | /v1/job-specs/{job_spec_id} | Update Job Spec | application/json: JobSpecUpdateRequestBody | 200 application/json: JobSpecResponse |
GET | /v1/job-specs/{job_spec_id}/runs | List Job Runs | None. | 200 application/json: BidirectionalPage_JobRunHistoryResponse_ |
GET | /v1/job-specs/{job_spec_id}/versions | List Job Spec Versions | None. | 200 application/json: BidirectionalPage_JobSpecVersionResponse_ |
GET | /v1/job-specs/{job_spec_id}/versions/{version_id} | Get Job Spec Version | None. | 200 application/json: JobSpecVersionResponse |
Loading API reference...