Update a ruleset.

curl --request PUT \
  --url https://{tenant}/api/rulesets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": "<string>",
  "ruleset_id": "<string>",
  "description": "<string>",
  "active": true,
  "categories": [
    "payments",
    "internal"
  ]
}
'

import requests

url = "https://{tenant}/api/rulesets/{id}"

payload = {
    "name": "<string>",
    "definition": "<string>",
    "ruleset_id": "<string>",
    "description": "<string>",
    "active": True,
    "categories": ["payments", "internal"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    definition: '<string>',
    ruleset_id: '<string>',
    description: '<string>',
    active: true,
    categories: ['payments', 'internal']
  })
};

fetch('https://{tenant}/api/rulesets/{id}', 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://{tenant}/api/rulesets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'definition' => '<string>',
    'ruleset_id' => '<string>',
    'description' => '<string>',
    'active' => true,
    'categories' => [
        'payments',
        'internal'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://{tenant}/api/rulesets/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://{tenant}/api/rulesets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/rulesets/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}"

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

{
  "_id": "<string>",
  "ruleset_id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "active": true,
  "resource_type": "<string>",
  "action": "<string>",
  "categories": [
    "<string>"
  ],
  "owner": "<string>",
  "definition": "<string>",
  "is_template": true,
  "date_created": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z"
}

PUT

api

rulesets

{id}

Update a ruleset.

curl --request PUT \
  --url https://{tenant}/api/rulesets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": "<string>",
  "ruleset_id": "<string>",
  "description": "<string>",
  "active": true,
  "categories": [
    "payments",
    "internal"
  ]
}
'

import requests

url = "https://{tenant}/api/rulesets/{id}"

payload = {
    "name": "<string>",
    "definition": "<string>",
    "ruleset_id": "<string>",
    "description": "<string>",
    "active": True,
    "categories": ["payments", "internal"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    definition: '<string>',
    ruleset_id: '<string>',
    description: '<string>',
    active: true,
    categories: ['payments', 'internal']
  })
};

fetch('https://{tenant}/api/rulesets/{id}', 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://{tenant}/api/rulesets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'definition' => '<string>',
    'ruleset_id' => '<string>',
    'description' => '<string>',
    'active' => true,
    'categories' => [
        'payments',
        'internal'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://{tenant}/api/rulesets/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://{tenant}/api/rulesets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/rulesets/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"definition\": \"<string>\",\n  \"ruleset_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"active\": true,\n  \"categories\": [\n    \"payments\",\n    \"internal\"\n  ]\n}"

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

{
  "_id": "<string>",
  "ruleset_id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "active": true,
  "resource_type": "<string>",
  "action": "<string>",
  "categories": [
    "<string>"
  ],
  "owner": "<string>",
  "definition": "<string>",
  "is_template": true,
  "date_created": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Path Parameters

string

required

ObjectId hex or custom ruleset_id.

Body

name

string

required

definition

string

required

Full Spectral ruleset definition stored as a JSON string.

ruleset_id

string

Optional stable identifier. If not provided, defaults to the record's internal ID hex. Must be unique within the org. Never changed after creation.

description

string

active

boolean

resource_type

enum<string>

Available options:

oas-api,

mcp-api

action

enum<string>

Available options:

none,

warn

Response

Ruleset updated.

_id

string

ruleset_id

string

Stable migration identifier. Same value across environments.

org_id

string

name

string

description

string

active

boolean

resource_type

string

action

string

Overview

API Governance

Dashboard Analytics

User Management

Tyk Identity Broker (TIB)

Guides

Reference

Update a ruleset.

Authorizations

Path Parameters

Body

Response