Skip to main content

Delete an invocation

DELETE 
/invocations/:invocation_id

Delete the given invocation. By default, an invocation is terminated by gracefully cancelling it. This ensures virtual object state consistency. Alternatively, an invocation can be killed which does not guarantee consistency for virtual object instance state, in-flight invocations to other services, etc. A stored completed invocation can also be purged

Request​

Path Parameters

    invocation_id stringrequired

    Invocation identifier.

Query Parameters

    mode DeletionMode

    Possible values: [Cancel, Kill, Purge]

    If cancel, it will gracefully terminate the invocation. If kill, it will terminate the invocation with a hard stop. If purge, it will only cleanup the response for completed invocations, and leave unaffected an in-flight invocation.

Responses​

Accepted

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://restatedeployment.documentation-beg.pages.dev/invocations/:invocation_id");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Parameters
— pathrequired
— query