Ctrlk
SupportSnyk LearnAPI referenceProduct updatesSign up for free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

SecretsRuleExtensions

Snyk API reference for the SecretsRuleExtensions endpoints, including request parameters and response schemas

This document uses the REST API. For more details, see the Authentication for API page.

Create a secrets rule extension

post

Secrets rule extensions adapt Snyk Secret analysis, making Snyk Secret Rules more suitable for your code. Only published secrets rule extensions with assignment would be applied to Snyk scans.

Required permissions

  • group.rule_extension.create
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Unique identifier for group in request path

Example: b667f176-df52-4b0a-9954-117af6b05ab7
Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
201

Secrets rule extension successfully created. Secrets rule extensions will only apply once published and assigned.

application/vnd.api+json
post/groups/{group_id}/secrets/rule_extensions
POST /rest/groups/{group_id}/secrets/rule_extensions?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 101

{
  "data": {
    "attributes": {
      "copy_from": "a6fd4971-1d47-4684-a45d-7d0a372912e0"
    },
    "type": "rule_extensions"
  }
}
{
  "data": {
    "attributes": {
      "configuration": {
        "type": "addition"
      },
      "created_at": "2026-04-09T10:00:00Z",
      "created_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "description": "Detect AWS access key IDs in source code.",
      "kind": "secrets_regex",
      "published_at": "2026-04-10T09:15:00Z",
      "published_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "signature": {
        "regex_pattern": "(?i)AKIA[0-9A-Z]{16}"
      },
      "status": "published",
      "updated_at": "2026-04-10T09:15:00Z",
      "updated_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a"
    },
    "id": "b7fe5082-2e58-5795-b56e-8e1b483023f1",
    "type": "rule_extensions"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/rest/groups/0188104e-7aea-4047-b383-74d8b42d7452/secrets/rule_extensions/b7fe5082-2e58-5795-b56e-8e1b483023f1"
  }
}

Get a list of all secrets rule extensions for the requested Group

get

Get a list of all secrets rule extensions for the requested Group ID and its child Org(s).

Required permissions

  • group.rule_extension.read
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Unique identifier for group in request path

Example: b667f176-df52-4b0a-9954-117af6b05ab7
Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
starting_afterstringOptional

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=
ending_beforestringOptional

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=
limitinteger · int32 · min: 1 · max: 100Optional

Number of results to return per page

Default: 10Example: 10
Responses
200

Returns a list of all secrets rule extensions for the requested Group ID.

application/vnd.api+json
get/groups/{group_id}/secrets/rule_extensions
GET /rest/groups/{group_id}/secrets/rule_extensions?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "attributes": {
        "configuration": {
          "type": "addition"
        },
        "created_at": "2026-01-01T00:00:00.000Z",
        "created_by": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "kind": "secrets_regex",
        "published_at": "2026-01-01T00:00:00.000Z",
        "published_by": "123e4567-e89b-12d3-a456-426614174000",
        "signature": {
          "regex_pattern": "text"
        },
        "status": "published",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "updated_by": "123e4567-e89b-12d3-a456-426614174000"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "rule_extensions"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

Update a secrets rule extension by rule extension ID

patch

Update the secrets rule extension for the requested rule extension ID.

Required permissions

  • group.rule_extension.edit
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Unique identifier for group in request path

Example: b667f176-df52-4b0a-9954-117af6b05ab7
rule_extension_idstring · uuidRequired

Unique identifier for a rule extension in request path

Example: 4a994d3b-d15e-45c3-bf24-6a26a02ed9ea
Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
Responses
200

Secrets rule extension updated successfully.

application/vnd.api+json
patch/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}
PATCH /rest/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 115

{
  "data": {
    "attributes": {
      "status": "published"
    },
    "id": "b7fe5082-2e58-5795-b56e-8e1b483023f1",
    "type": "rule_extensions"
  }
}
{
  "data": {
    "attributes": {
      "configuration": {
        "type": "addition"
      },
      "created_at": "2026-04-09T10:00:00Z",
      "created_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "description": "Detect AWS access key IDs in source code.",
      "kind": "secrets_regex",
      "published_at": "2026-04-10T09:15:00Z",
      "published_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "signature": {
        "regex_pattern": "(?i)AKIA[0-9A-Z]{16}"
      },
      "status": "published",
      "updated_at": "2026-04-10T09:15:00Z",
      "updated_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a"
    },
    "id": "b7fe5082-2e58-5795-b56e-8e1b483023f1",
    "type": "rule_extensions"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/rest/groups/0188104e-7aea-4047-b383-74d8b42d7452/secrets/rule_extensions/b7fe5082-2e58-5795-b56e-8e1b483023f1"
  }
}

Get a secrets rule extension by rule extension ID

get

Get the secrets rule extension for the requested rule extension ID.

Required permissions

  • group.rule_extension.read
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Unique identifier for group in request path

Example: b667f176-df52-4b0a-9954-117af6b05ab7
rule_extension_idstring · uuidRequired

Unique identifier for a rule extension in request path

Example: 4a994d3b-d15e-45c3-bf24-6a26a02ed9ea
Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
200

Secrets rule extension retrieved successfully.

application/vnd.api+json
get/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}
GET /rest/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "configuration": {
        "type": "addition"
      },
      "created_at": "2026-04-09T10:00:00Z",
      "created_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "description": "Detect AWS access key IDs in source code.",
      "kind": "secrets_regex",
      "published_at": "2026-04-10T09:15:00Z",
      "published_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a",
      "signature": {
        "regex_pattern": "(?i)AKIA[0-9A-Z]{16}"
      },
      "status": "published",
      "updated_at": "2026-04-10T09:15:00Z",
      "updated_by": "758769f2-5b3a-41eb-b7c2-20bd785be49a"
    },
    "id": "b7fe5082-2e58-5795-b56e-8e1b483023f1",
    "type": "rule_extensions"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/rest/groups/0188104e-7aea-4047-b383-74d8b42d7452/secrets/rule_extensions/b7fe5082-2e58-5795-b56e-8e1b483023f1"
  }
}

Delete a secrets rule extension by rule extension ID

delete

Delete the secrets rule extension for the requested rule extension ID. Draft rule extensions can be deleted unconditionally. Published rule extensions can only be deleted if they have no assignments.

Required permissions

  • group.rule_extension.delete
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
group_idstring · uuidRequired

Unique identifier for group in request path

Example: b667f176-df52-4b0a-9954-117af6b05ab7
rule_extension_idstring · uuidRequired

Unique identifier for a rule extension in request path

Example: 4a994d3b-d15e-45c3-bf24-6a26a02ed9ea
Query parameters
versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
204

Secrets rule extension deleted successfully.

delete/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}
DELETE /rest/groups/{group_id}/secrets/rule_extensions/{rule_extension_id}?version=2021-06-04 HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousSastSettings
NextSecretsSettings

Last updated

Was this helpful?