EQTY LabDocs

Update validation rule

Admin only. Changes the supplied fields of a default or custom rule; disable a default rule by setting enabled to false.

patchhttps://<host>/api/v1/settings/validation-rules/{ruleKey}
bash
curl --request PATCH \
  --url 'https://<host>/api/v1/settings/validation-rules/{ruleKey}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"context_mode":"string","description":"string","enabled":true,"file_scope":"string","flags":"string","label":"string","message":"string","pattern":"string","severity":"string"}'
javascript
const response = await fetch("https://<host>/api/v1/settings/validation-rules/{ruleKey}", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "context_mode": "string",
    "description": "string",
    "enabled": true,
    "file_scope": "string",
    "flags": "string",
    "label": "string",
    "message": "string",
    "pattern": "string",
    "severity": "string"
  })
});

const data = await response.json();
typescript
interface ValidationRuleResponse {
  correlation_id?: string;
  item?: Record<string, unknown>;
}

const response = await fetch("https://<host>/api/v1/settings/validation-rules/{ruleKey}", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "context_mode": "string",
    "description": "string",
    "enabled": true,
    "file_scope": "string",
    "flags": "string",
    "label": "string",
    "message": "string",
    "pattern": "string",
    "severity": "string"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: ValidationRuleResponse = await response.json();
python
import requests

response = requests.patch(
    "https://<host>/api/v1/settings/validation-rules/{ruleKey}",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "context_mode": "string",
        "description": "string",
        "enabled": True,
        "file_scope": "string",
        "flags": "string",
        "label": "string",
        "message": "string",
        "pattern": "string",
        "severity": "string",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "context_mode": "string",
	  "description": "string",
	  "enabled": true,
	  "file_scope": "string",
	  "flags": "string",
	  "label": "string",
	  "message": "string",
	  "pattern": "string",
	  "severity": "string"
	}`)
	req, err := http.NewRequest(http.MethodPatch, "https://<host>/api/v1/settings/validation-rules/{ruleKey}", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://<host>/api/v1/settings/validation-rules/{ruleKey}"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {
                  "context_mode": "string",
                  "description": "string",
                  "enabled": true,
                  "file_scope": "string",
                  "flags": "string",
                  "label": "string",
                  "message": "string",
                  "pattern": "string",
                  "severity": "string"
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://<host>/api/v1/settings/validation-rules/{ruleKey}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "context_mode": "string",
      "description": "string",
      "enabled": true,
      "file_scope": "string",
      "flags": "string",
      "label": "string",
      "message": "string",
      "pattern": "string",
      "severity": "string"
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://<host>/api/v1/settings/validation-rules/{ruleKey}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "context_mode": "string",
      "description": "string",
      "enabled": true,
      "file_scope": "string",
      "flags": "string",
      "label": "string",
      "message": "string",
      "pattern": "string",
      "severity": "string"
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://<host>/api/v1/settings/validation-rules/{ruleKey}")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "context_mode": "string",
    "description": "string",
    "enabled": true,
    "file_scope": "string",
    "flags": "string",
    "label": "string",
    "message": "string",
    "pattern": "string",
    "severity": "string"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .patch("https://<host>/api/v1/settings/validation-rules/{ruleKey}")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "context_mode": "string",
            "description": "string",
            "enabled": true,
            "file_scope": "string",
            "flags": "string",
            "label": "string",
            "message": "string",
            "pattern": "string",
            "severity": "string"
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and a sign-in token: a Guardian Platform JWT, or an OIDC ID token in a standalone deployment.

Parameters

Path parameters

NameTypeDescription
ruleKey
required
string

Rule key

Request bodyrequired

Fields to change

application/json
  • context_modestring
  • descriptionstring
  • enabledboolean
  • file_scopestring
  • flagsstring
  • labelstring
  • messagestring
  • patternstring
  • severitystring
Examplejson
{
  "context_mode": "string",
  "description": "string",
  "enabled": true,
  "file_scope": "string",
  "flags": "string",
  "label": "string",
  "message": "string",
  "pattern": "string",
  "severity": "string"
}

Responses

200OK

application/json
  • correlation_idstring
  • itemgithub_com_eqtylab_gateway_control-plane_service_internal_discovery.ConfigValidationRule
    Show github_com_eqtylab_gateway_control-plane_service_internal_discovery.ConfigValidationRule
    • agent_typestring
    • categorystring
    • context_modestring
    • created_atstring
    • descriptionstring
    • enabledboolean
    • file_scopestring
    • flagsstring
    • is_defaultboolean
    • labelstring
    • messagestring
    • patternstring
    • rule_idinteger
    • rule_keystring
    • severitystring
    • updated_atstring
Examplejson
{
  "correlation_id": "string",
  "item": {
    "agent_type": "string",
    "category": "string",
    "context_mode": "string",
    "created_at": "string",
    "description": "string",
    "enabled": true,
    "file_scope": "string",
    "flags": "string",
    "is_default": true,
    "label": "string",
    "message": "string",
    "pattern": "string",
    "rule_id": 0,
    "rule_key": "string",
    "severity": "string",
    "updated_at": "string"
  }
}

400Bad Request

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

401Unauthorized

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

403Forbidden

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

404Not Found

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

500Internal Server Error

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}