API Reference
  1. API Endpoints
  2. alert-policies

Update Org Alert Policy

put
https://api.socket.dev/v0/orgs//alert-policies/

Update an alert policy. Only the provided fields change; repository_ids replaces the full set of repositories the policy scopes to. The default policy cannot be renamed and its scope is implicit. Requires a token with org-wide repository access; repo-restricted tokens receive 403.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • alert-policy:update
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

string
required

The ID of the alert policy: a UUID, or default for the default policy

Body Params
string

The policy name (1-120 characters). The default policy cannot be renamed.

string | null

Operator-provided description (up to 256 characters).

repository_ids
array of strings | null

Full replacement set of repositories the policy scopes to. The default policy scope is implicit and cannot be set.

repository_ids
string | null

Baseline rule bundle the policy starts from. One of: essential, balanced, comprehensive. Null to remove the baseline.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?