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

Lists secret scanning custom patterns for a repository.

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

Fine-grained access tokens require the administration:write repository permission.

Servers

Path parameters

Name Type Required Description
repo String Yes

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

owner String Yes

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

Query parameters

Name Type Required Description
direction String No

The direction to sort the results by.

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

sort String No

The property to sort the results by.

Valid values:

  • "updated"
  • "created"
  • "name"

Default value: "created"

after String No

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

push_protection String No

Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.

Valid values:

  • "disabled"
  • "enabled"
state String No

Filter custom patterns by state. When absent, returns patterns in all states.

Valid values:

  • "unpublished"
  • "published"
before String No

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.