Purge a completed invocation

Deletes all state associated with a completed invocation, including its journal and metadata. This operation only applies to invocations that have already completed. For more information, see the purging documentation.

PATCH /invocations/{invocation_id}/purge

Purge a completed invocation

cURL

curl --request PATCH \
  --url https://api.example.com/invocations/{invocation_id}/purge

import requests

url = "https://api.example.com/invocations/{invocation_id}/purge"

response = requests.patch(url)

print(response.text)

const options = {method: 'PATCH'};

fetch('https://api.example.com/invocations/{invocation_id}/purge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/invocations/{invocation_id}/purge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/invocations/{invocation_id}/purge"

	req, _ := http.NewRequest("PATCH", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/invocations/{invocation_id}/purge")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/invocations/{invocation_id}/purge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body

400

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

{
  "message": "<string>",
  "restate_code": "<string>"
}

Path Parameters

invocation_id · string · required

Invocation identifier.

Response

200

Invocation purged successfully