API reference

Base URL: https://api.greatwait.dev. Requests authenticate with an Authorization: Bearer header carrying an API credential or an OAuth access token. A credential acts in exactly one project and environment — Concepts says what that means for what it can reach.

The machine-readable description of everything below is the OpenAPI document that @greatwait/contracts 0.1.0-alpha.4 publishes.

​

Conventions

• Every instant is RFC 3339, UTC, milliseconds, with a literal Z.
• Listings are cursor-paged, never offset-paged.
• Every refusal is a problem document with a stable code — see Problem codes.
• schedules.create accepts an Idempotency-Key header, so a create is safe to retry — see Idempotency.
• Reads return a strong ETag; send it back in If-Match to make a later write conditional.

​

Operations

​

exports

Operation	Request	Id
Create a data export	POST /v1/exports	exports.create
Read a data export	GET /v1/exports/{exportId}	exports.read
Download a data export part	GET /v1/exports/{exportId}/parts	exports.part
Cancel a data export	POST /v1/exports/{exportId}/cancel	exports.cancel

​

meta

Operation	Request	Id
Read the deployed version	GET /__greatwait/version	meta.version
Read the workspace scaffold	GET /_scaffold	meta.scaffold

​

endpoints

Operation	Request	Id
Create a callback endpoint	POST /v1/endpoints	endpoints.create
List callback endpoints	GET /v1/endpoints	endpoints.list
Read a callback endpoint	GET /v1/endpoints/{endpointId}	endpoints.read
Update a callback endpoint	PUT /v1/endpoints/{endpointId}	endpoints.update
Disable a callback endpoint	DELETE /v1/endpoints/{endpointId}	endpoints.disable
Rotate a callback endpoint signing key	POST /v1/endpoints/{endpointId}/signing-keys/rotate	endpoints.rotateSigningKey
Mark a signing-key server update done	POST /v1/endpoints/{endpointId}/signing-keys/acknowledge	endpoints.acknowledgeSigningKeyRotation
Reveal a callback endpoint signing secret	GET /v1/endpoints/{endpointId}/signing-secret	endpoints.revealSigningSecret
Enable a disabled callback endpoint	POST /v1/endpoints/{endpointId}/enable	endpoints.enable

​

testsinks

Operation	Request	Id
Create a test sink	POST /v1/test-sinks	testsinks.create
List test sinks	GET /v1/test-sinks	testsinks.list
Read a test sink	GET /v1/test-sinks/{sinkId}	testsinks.read
Delete a test sink	DELETE /v1/test-sinks/{sinkId}	testsinks.delete
Set a test sink behavior program	PUT /v1/test-sinks/{sinkId}/program	testsinks.configure

​

sinkdeliveries

Operation	Request	Id
List test sink deliveries	GET /v1/test-sinks/{sinkId}/deliveries	sinkdeliveries.list
Read a test sink delivery	GET /v1/test-sinks/{sinkId}/deliveries/{deliveryRecordId}	sinkdeliveries.read

​

context

Operation	Request	Id
Read this credential’s authority	GET /v1/context	context.read

​

credentials

Operation	Request	Id
Issue an API credential	POST /v1/credentials	credentials.create
List API credentials	GET /v1/credentials	credentials.list
Read a credential’s MCP connection	GET /v1/credentials/{credentialId}/connection	credentials.connection
Rotate an API credential	POST /v1/credentials/{credentialId}/rotate	credentials.rotate
Revoke an API credential	DELETE /v1/credentials/{credentialId}	credentials.revoke

​

projects

Operation	Request	Id
List the member’s projects	GET /v1/projects	projects.list
Create a project	POST /v1/projects	projects.create
Rename a project	PATCH /v1/projects/{projectId}	projects.rename
Delete an archived project	DELETE /v1/projects/{projectId}	projects.delete
Archive or restore a project	POST /v1/projects/{projectId}/archive	projects.archive

​

grants

Operation	Request	Id
List the member’s connected applications	GET /v1/grants	grants.list
Disconnect an application	DELETE /v1/grants/{grantId}	grants.revoke

​

schedules

Operation	Request	Id
Create a schedule	POST /v1/schedules	schedules.create
List schedules	GET /v1/schedules	schedules.list
Read a schedule	GET /v1/schedules/{scheduleId}	schedules.read
Replace a schedule	PUT /v1/schedules/{scheduleId}	schedules.replace
Cancel a schedule	DELETE /v1/schedules/{scheduleId}	schedules.cancel
Pause a schedule	POST /v1/schedules/{scheduleId}/pause	schedules.pause
Resume a schedule	POST /v1/schedules/{scheduleId}/resume	schedules.resume
Archive a schedule	POST /v1/schedules/{scheduleId}/archive	schedules.archive

​

forecast

Operation	Request	Id
Forecast upcoming occurrences	GET /v1/forecast	forecast.read
Forecast in the transitional window shape	GET /v1/forecast/windows	forecast.windows

​

usage

Operation	Request	Id
Read terminal occurrence volume by day	GET /v1/usage	usage.read

​

timing

Operation	Request	Id
Read rolling delivery timing	GET /v1/timing/summary	timing.summary

​

occurrences

Operation	Request	Id
List retained occurrences	GET /v1/schedules/{scheduleId}/occurrences	occurrences.list
Read an occurrence	GET /v1/schedules/{scheduleId}/occurrences/{occurrenceId}	occurrences.read
Redeliver an occurrence	POST /v1/schedules/{scheduleId}/occurrences/{occurrenceId}/redeliver	occurrences.redeliver

​

executions

Operation	Request	Id
List project executions	GET /v1/occurrences	executions.list

​

attempts

Operation	Request	Id
List delivery attempts	GET /v1/schedules/{scheduleId}/occurrences/{occurrenceId}/attempts	attempts.list
Read a delivery attempt	GET /v1/schedules/{scheduleId}/occurrences/{occurrenceId}/attempts/{attemptId}	attempts.read