socket-dev/collections/socket-triage-api.opencollection.json at main · api-evangelist/socket-dev · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
{
  "opencollection": "1.0.0",
  "info": {
    "name": "Socket Triage API",
    "version": "0"
  },
  "items": [
    {
      "info": {
        "name": "triage",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Org Alert Triage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.socket.dev/v0/orgs/:org_slug/triage/alerts",
            "params": [
              {
                "name": "org_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the organization"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Field to sort by. One of: created_at, updated_at."
              },
              {
                "name": "direction",
                "value": "",
                "type": "query",
                "description": "Sort direction. One of: asc, desc."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page (1–100, default 30)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number (1-based)."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-list"
        },
        {
          "info": {
            "name": "Create/Update Org Alert Triage",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.socket.dev/v0/orgs/:org_slug/triage/alerts",
            "params": [
              {
                "name": "org_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the organization"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "Set to true to force broad triage updates, these are triages lacking a specific alertKey or granular artifact information which may have limited introspection to see what they apply to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-update"
        },
        {
          "info": {
            "name": "Delete Org Alert Triage",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.socket.dev/v0/orgs/:org_slug/triage/alerts/:uuid",
            "params": [
              {
                "name": "org_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the organization"
              },
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the alert triage entry to delete"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete a specific triage rule by UUID.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- triage:alerts-update"
        }
      ]
    }
  ],
  "bundled": true
}