Sign in
Secret Validation Rules

Update Secret Validation Rule

patch/api/v1/projects/{projectId}/secret-validation-rules/{ruleId}

Path parameters

projectIdstring required

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

ruleIdstring uuid required

The ID of the secret validation rule to update.

Request body

namestring

The name of the secret validation rule.

descriptionstring nullable

An optional description of the secret validation rule.

environmentSlugstring nullable

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.

secretPathstring

The secret path this rule is scoped to.

isActiveboolean

Whether the secret validation rule is active.

Example request

{
  "rule": {
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ]
  }
}

Response

Default Response

Example response

{
  "rule": {
    "constraints": [
      {
        "type": "min-length",
        "appliesTo": "value",
        "value": "8"
      }
    ]
  }
}

Changes

Changed in 2 of the 19 revisions of this API.710

  • e15904efcbcd55See the full diff
    • ●

      added the new ldap-password enum value to the rule/allOf[subschema #2]/anyOf[subschema #3]/providers/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new mssql-credentials enum value to the rule/allOf[subschema #2]/anyOf[subschema #3]/providers/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new mysql-credentials enum value to the rule/allOf[subschema #2]/anyOf[subschema #3]/providers/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new oracledb-credentials enum value to the rule/allOf[subschema #2]/anyOf[subschema #3]/providers/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new unix-linux-local-account enum value to the rule/allOf[subschema #2]/anyOf[subschema #3]/providers/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new ldap-password enum value to the request property rule/anyOf[subschema #3]/providers/items/

      request-property-enum-value-added

    • ○

      added the new mssql-credentials enum value to the request property rule/anyOf[subschema #3]/providers/items/

      request-property-enum-value-added

    • ○

      added the new mysql-credentials enum value to the request property rule/anyOf[subschema #3]/providers/items/

      request-property-enum-value-added

    • ○

      added the new oracledb-credentials enum value to the request property rule/anyOf[subschema #3]/providers/items/

      request-property-enum-value-added

    • ○

      added the new unix-linux-local-account enum value to the request property rule/anyOf[subschema #3]/providers/items/

      request-property-enum-value-added

  • e2a4b9a0525125See the full diff
    • ●

      removed the request property inputs

      request-property-removed

    • ●

      removed the request property type

      request-property-removed

    • ○

      api operation id updateSecretValidationRule was added

      api-operation-id-added

    • ○

      api tag Secret Validation Rules added

      api-tag-added

    • ○

      added the new optional request property rule

      new-optional-request-property

    • ○

      added subschema #1 subschema #2 subschema #3 to the rule/allOf[subschema #2]/ response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #2 subschema #3 from the rule/allOf[subschema #2]/ response property anyOf list for the response status 200

      response-property-any-of-removed