v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Connections

Create schema refresh schedule

post/api/v1/connections/{connectionId}/schedules

Path parameters

connectionIdstring uuid required

Connection ID

Example:550e8400-e29b-41d4-a716-446655440000

Connection ID

Request body

hardRefreshboolean

When true, the scheduled refresh performs a hard refresh that fully discards and rebuilds the schema model. When false (the default), it performs a soft refresh that merges newly generated views with the existing model.

schedulestring required

AWS EventBridge cron expression (6 fields: minute hour day-of-month month day-of-week year). See https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html

timezonestring required

IANA timezone for schedule execution

Example request

{
  "schedule": "0 2 * * ? *",
  "timezone": "America/New_York"
}

Response

Schema refresh schedule created successfully

connectionIdstring uuid required

Connection ID this schedule belongs to

createdAtstring required

Schedule creation timestamp (ISO 8601)

descriptionstring required

Human-readable schedule description

disabledAtstring nullable required

Timestamp when schedule was disabled (ISO 8601)

hardRefreshboolean required

When true, the scheduled refresh performs a hard refresh that fully discards and rebuilds the schema model. When false, it performs a soft refresh that merges newly generated views with the existing model.

schedulestring required

AWS EventBridge cron expression (6 fields: minute hour day-of-month month day-of-week year). See https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html

scheduleIdstring uuid required

Unique schedule identifier

timezonestring required

IANA timezone for schedule execution

updatedAtstring required

Schedule last update timestamp (ISO 8601)

Example response

{
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "description": "Runs daily at 2:00 AM EST",
  "schedule": "0 2 * * ? *",
  "scheduleId": "550e8400-e29b-41d4-a716-446655440001",
  "timezone": "America/New_York",
  "updatedAt": "2024-01-15T10:30:00Z"
}