Refresh cached response

Unified endpoint to refresh a response by its identifier, invalidating the cached entry so that the next media request triggers a fresh scrape.

POST /v1/refresh/{id}

Refresh cached response

JavaScript

const options = {method: 'POST'};

fetch('http://localhost:{port}/v1/refresh/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url http://localhost:{port}/v1/refresh/{id}

import requests

url = "http://localhost:{port}/v1/refresh/{id}"

response = requests.post(url)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "http://localhost:{port}/v1/refresh/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$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 := "http://localhost:{port}/v1/refresh/{id}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:{port}/v1/refresh/{id}")
  .asString();

200

{
  "status": "OK"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

This endpoint has been sunset. It will be removed in the next major version of the spec.

Path Parameters

id · string · required

Response identifier used by the refresh endpoint. Alphanumeric with hyphens/underscores, max 128 characters.

Maximum string length: 128

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

200

application/json

Refresh request accepted and cache invalidated.

Response object for the refresh endpoint.

status · enum<string> · required

Refresh status string; MUST be "OK" on success.

Available options: OK