stable · api · 0.1.0

Cancel an invocation schedule

DELETE /api/v1/invocation-schedules/{scheduleId}

Capability Domain: Jobs Scheduling

Authentication

projectCredential (schedules:write)

Scope: schedules:write

Parameters and request body

X-Correlation-ID — header, optional
X-Correlation-ID schema
```
{
    "type": "string",
    "format": "uuid"
}
```

scheduleId — path, required

scheduleId schema

{
    "type": "string",
    "format": "uuid"
}

Responses and errors

Status	Description
`200`	Cancelled schedule
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`422`	Request violates the public contract

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "required": [
                "id",
                "status",
                "recurring",
                "quota",
                "invocations"
            ],
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "status": {
                    "type": "string",
                    "enum": [
                        "active",
                        "quota_paused",
                        "cancelled"
                    ]
                },
                "recurring": {
                    "type": "boolean"
                },
                "quota": {
                    "oneOf": [
                        {
                            "type": "null"
                        },
                        {
                            "type": "object",
                            "required": [
                                "resource",
                                "used",
                                "limit",
                                "retry_at"
                            ],
                            "properties": {
                                "resource": {
                                    "type": "string"
                                },
                                "used": {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                "limit": {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                "retry_at": {
                                    "type": "string"
                                }
                            }
                        }
                    ]
                },
                "invocations": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "required": [
                            "id",
                            "status",
                            "attempts",
                            "last_error_code"
                        ],
                        "properties": {
                            "id": {
                                "type": "string",
                                "format": "uuid"
                            },
                            "scheduled_for": {
                                "type": "string"
                            },
                            "status": {
                                "type": "string",
                                "enum": [
                                    "pending",
                                    "processing",
                                    "retry",
                                    "succeeded",
                                    "dead_letter",
                                    "cancelled"
                                ]
                            },
                            "attempts": {
                                "type": "integer",
                                "minimum": 0
                            },
                            "last_error_code": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}

401 schema

401 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example

{
    "data": {
        "id": "87000000-0000-4000-8000-000000000001",
        "status": "cancelled",
        "recurring": true,
        "quota": null,
        "invocations": [
            {
                "id": "88000000-0000-4000-8000-000000000001",
                "scheduled_for": "2026-08-01 01:00:00",
                "status": "cancelled",
                "attempts": 0,
                "last_error_code": "schedule_cancelled"
            }
        ]
    }
}

Idempotency

Cancellation is idempotent; repeated requests return the cancelled schedule.