Opt a module into background auto-updates

curl --request POST \
  --url http://localhost:9371/modules/{moduleId}/auto-update \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoUpdate": true,
  "constraint": "<string>"
}
'

import requests

url = "http://localhost:9371/modules/{moduleId}/auto-update"

payload = {
    "autoUpdate": True,
    "constraint": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({autoUpdate: true, constraint: '<string>'})
};

fetch('http://localhost:9371/modules/{moduleId}/auto-update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9371",
  CURLOPT_URL => "http://localhost:9371/modules/{moduleId}/auto-update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'autoUpdate' => true,
    'constraint' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:9371/modules/{moduleId}/auto-update"

	payload := strings.NewReader("{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

	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:9371/modules/{moduleId}/auto-update")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:9371/modules/{moduleId}/auto-update")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "autoUpdate": true,
  "constraint": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "rate_limit_exceeded",
  "message": "<string>",
  "retryAfter": 1
}

{
  "error": "<string>",
  "code": "<string>"
}

POST

modules

{moduleId}

auto-update

Opt a module into background auto-updates

curl --request POST \
  --url http://localhost:9371/modules/{moduleId}/auto-update \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoUpdate": true,
  "constraint": "<string>"
}
'

import requests

url = "http://localhost:9371/modules/{moduleId}/auto-update"

payload = {
    "autoUpdate": True,
    "constraint": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({autoUpdate: true, constraint: '<string>'})
};

fetch('http://localhost:9371/modules/{moduleId}/auto-update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9371",
  CURLOPT_URL => "http://localhost:9371/modules/{moduleId}/auto-update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'autoUpdate' => true,
    'constraint' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:9371/modules/{moduleId}/auto-update"

	payload := strings.NewReader("{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

	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:9371/modules/{moduleId}/auto-update")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:9371/modules/{moduleId}/auto-update")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoUpdate\": true,\n  \"constraint\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "autoUpdate": true,
  "constraint": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "rate_limit_exceeded",
  "message": "<string>",
  "retryAfter": 1
}

{
  "error": "<string>",
  "code": "<string>"
}

Path Parameters

moduleId

string

required

Module identifier.

Minimum string length: 1

Body

application/json

Request body used to opt a module into auto-updates.

autoUpdate

boolean

required

Whether the module opts into the background auto-update sweep.

constraint

string | null

Optional semver range pinning which registry version is selected. Omitted or null means latest. Invalid ranges are rejected with 400.

Response

The auto-update opt-in state.

Response returned by the module auto-update endpoint.

string

required

Identifier of the module whose auto-update flag was set.

Minimum string length: 1

autoUpdate

boolean

required

The stored auto-update opt-in state.

constraint

string | null

required

The normalized semver range stored for the sweep, or null for latest.

Last modified on August 25, 2026

Processes

Services

Tools

Modules

Registries

Environment

Logs

Opt a module into background auto-updates

Path Parameters

Body

Response