Update a repository custom pattern

PATCH

/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}

Updates a secret scanning custom pattern for a repository.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

pattern_id

required

integer

The ID of the custom pattern.

Request Body^required

application/json

Any of:

Secret Scanning Custom Pattern To Update

Fields to update on a custom pattern. At least one updatable field (pattern, start_delimiter, end_delimiter, must_match, or must_not_match) must also be provided. Only provided fields will be updated.

object

pattern

required

The updated regular expression of the custom pattern.

string

start_delimiter

The updated start delimiter regex for the custom pattern.

string

end_delimiter

The updated end delimiter regex for the custom pattern.

string

must_match

Updated list of regexes that the secret must match.

Array<string>

must_not_match

Updated list of regexes that the secret must not match.

Array<string>

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

Secret Scanning Custom Pattern To Update

object

pattern

The updated regular expression of the custom pattern.

string

start_delimiter

required

The updated start delimiter regex for the custom pattern.

string

end_delimiter

The updated end delimiter regex for the custom pattern.

string

must_match

Updated list of regexes that the secret must match.

Array<string>

must_not_match

Updated list of regexes that the secret must not match.

Array<string>

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

Secret Scanning Custom Pattern To Update

object

pattern

The updated regular expression of the custom pattern.

string

start_delimiter

The updated start delimiter regex for the custom pattern.

string

end_delimiter

required

The updated end delimiter regex for the custom pattern.

string

must_match

Updated list of regexes that the secret must match.

Array<string>

must_not_match

Updated list of regexes that the secret must not match.

Array<string>

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

Secret Scanning Custom Pattern To Update

object

pattern

The updated regular expression of the custom pattern.

string

start_delimiter

The updated start delimiter regex for the custom pattern.

string

end_delimiter

The updated end delimiter regex for the custom pattern.

string

must_match

required

Updated list of regexes that the secret must match.

Array<string>

must_not_match

Updated list of regexes that the secret must not match.

Array<string>

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

Secret Scanning Custom Pattern To Update

object

pattern

The updated regular expression of the custom pattern.

string

start_delimiter

The updated start delimiter regex for the custom pattern.

string

end_delimiter

The updated end delimiter regex for the custom pattern.

string

must_match

Updated list of regexes that the secret must match.

Array<string>

must_not_match

required

Updated list of regexes that the secret must not match.

Array<string>

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

Examples

default

{
  "pattern": "updated_secret_[0-9A-Z]{16}",
  "start_delimiter": "[^0-9A-Za-z]",
  "end_delimiter": "[^0-9A-Za-z]",
  "must_match": [
    "updated_secret_[0-9]{2}*"
  ],
  "must_not_match": [
    "updated_secret_1234567890ABCDEF"
  ],
  "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K"
}

Responses

200

Pattern updated successfully.

application/json

Secret Scanning Custom Pattern

A custom pattern for secret scanning.

object

required

The ID of the custom pattern.

integer

name

required

The name of the custom pattern.

string

pattern

required

The regular expression of the custom pattern.

string

slug

required

A URL-friendly identifier for the custom pattern, derived from its name.

string

state

required

The state of the custom pattern.

string

Allowed values: published unpublished

push_protection_enabled

required

Whether push protection is enabled for this custom pattern.

boolean

start_delimiter

The start delimiter regex for the custom pattern.

string

nullable

end_delimiter

The end delimiter regex for the custom pattern.

string

nullable

must_match

List of regexes that the secret must match.

Array<string>

nullable

must_not_match

List of regexes that the secret must not match.

Array<string>

nullable

custom_pattern_version

The version of the entity. This is used to confirm you’re updating the current version of the entity and mitigate unintentionally overriding someone else’s update.

string

nullable

created_at

The date and time the custom pattern was created in ISO 8601 format.

string format: date-time

updated_at

The date and time the custom pattern was last updated in ISO 8601 format.

string format: date-time

Examples

default

{
  "id": 1,
  "name": "Example Custom Pattern",
  "pattern": "updated_secret_[0-9A-Z]{16}",
  "slug": "example_custom_pattern",
  "state": "published",
  "push_protection_enabled": true,
  "start_delimiter": "[^0-9A-Za-z]",
  "end_delimiter": "[^0-9A-Za-z]",
  "must_match": [
    "updated_secret_[0-9]{2}*"
  ],
  "must_not_match": [
    "updated_secret_1234567890ABCDEF"
  ],
  "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

400

Bad Request

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Scim Error

Scim Error

object

message

string

nullable

documentation_url

string

nullable

detail

string

nullable

status

integer

scimType

string

nullable

schemas

Array<string>

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "detail": "example",
  "status": 1,
  "scimType": "example",
  "schemas": [
    "example"
  ]
}

403

Forbidden

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

412

Precondition Failed

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Validation failed, or the endpoint has been spammed.

application/json

Validation Error

Validation Error

object

message

required

string

documentation_url

required

string

errors

Array<object>

object

resource

string

field

string

message

string

code

required

string

index

integer

value

One of:

string

nullable

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}

Update a repository custom pattern

Parameters

Path Parameters

Request Body required

Examples

Responses

200

Examples

400

Example generated

Example generated

403

Example generated

404

Example generated

412

Example generated

422

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated