Update

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "environmentSlug": "<string>",
  "secretPath": "<string>",
  "rule": {
    "type": "static-secrets",
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ]
  },
  "isActive": true
}
'

import requests

url = "https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "environmentSlug": "<string>",
    "secretPath": "<string>",
    "rule": {
        "type": "static-secrets",
        "constraints": [
            {
                "type": "min-length",
                "appliesTo": "value",
                "value": "8"
            }
        ]
    },
    "isActive": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    environmentSlug: '<string>',
    secretPath: '<string>',
    rule: {
      type: 'static-secrets',
      constraints: [{type: 'min-length', appliesTo: 'value', value: '8'}]
    },
    isActive: true
  })
};

fetch('https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}', 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://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'environmentSlug' => '<string>',
    'secretPath' => '<string>',
    'rule' => [
        'type' => 'static-secrets',
        'constraints' => [
                [
                                'type' => 'min-length',
                                'appliesTo' => 'value',
                                'value' => '8'
                ]
        ]
    ],
    'isActive' => true
  ]),
  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 := "https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}"

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

{
  "rule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "projectId": "<string>",
    "secretPath": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "type": "static-secrets",
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ],
    "description": "<string>",
    "envId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isActive": true
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

PATCH

api

projects

{projectId}

secret-validation-rules

{ruleId}

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "environmentSlug": "<string>",
  "secretPath": "<string>",
  "rule": {
    "type": "static-secrets",
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ]
  },
  "isActive": true
}
'

import requests

url = "https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "environmentSlug": "<string>",
    "secretPath": "<string>",
    "rule": {
        "type": "static-secrets",
        "constraints": [
            {
                "type": "min-length",
                "appliesTo": "value",
                "value": "8"
            }
        ]
    },
    "isActive": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    environmentSlug: '<string>',
    secretPath: '<string>',
    rule: {
      type: 'static-secrets',
      constraints: [{type: 'min-length', appliesTo: 'value', value: '8'}]
    },
    isActive: true
  })
};

fetch('https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}', 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://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'environmentSlug' => '<string>',
    'secretPath' => '<string>',
    'rule' => [
        'type' => 'static-secrets',
        'constraints' => [
                [
                                'type' => 'min-length',
                                'appliesTo' => 'value',
                                'value' => '8'
                ]
        ]
    ],
    'isActive' => true
  ]),
  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 := "https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"environmentSlug\": \"<string>\",\n  \"secretPath\": \"<string>\",\n  \"rule\": {\n    \"type\": \"static-secrets\",\n    \"constraints\": [\n      {\n        \"type\": \"min-length\",\n        \"appliesTo\": \"value\",\n        \"value\": \"8\"\n      }\n    ]\n  },\n  \"isActive\": true\n}"

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

{
  "rule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "projectId": "<string>",
    "secretPath": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "type": "static-secrets",
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ],
    "description": "<string>",
    "envId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isActive": true
  }
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Path Parameters

projectId

string

required

The ID of the project the secret validation rule belongs to.

ruleId

string<uuid>

required

The ID of the secret validation rule to update.

Body

application/json

name

string

The name of the secret validation rule.

Required string length: 1 - 100

description

string | null

An optional description of the secret validation rule.

Maximum string length: 500

environmentSlug

string | null

The slug of the environment this rule is scoped to. Omit to leave the current scope unchanged; pass null to make the rule apply to every environment in the project.

Minimum string length: 1

secretPath

string

The secret path this rule is scoped to.

Minimum string length: 1

rule

object

The rule configuration: which secret type it targets and the constraints to enforce. Replaces the existing configuration as a whole, or omits to leave it untouched.

Option 1
Option 2
Option 3

Show child attributes

isActive

boolean

Whether the secret validation rule is active.

Response

Default Response

rule

object

required

Option 1
Option 2
Option 3

Show child attributes

⌘I

Overview

Organization

Project

Shared

Identity auth

Secrets management

Certificate management

Secret scanning

Secret sharing

Infisical KMS

KMIP servers

Gateways

External migrations

Other

Path Parameters

Body

Response