sdp-api-specification/ringfence_rule.yml at main · appgate/sdp-api-specification · 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
ringfence-rules:
  get:
    summary: List all Ringfence Rules.
    description: List all Ringfence Rules visible to current user.
    tags:
      - Ringfence Rules
    parameters:
      - $ref: './common.yml#/parameters/authorization'
      - $ref: './common.yml#/parameters/query'
      - $ref: './common.yml#/parameters/range'
      - $ref: './common.yml#/parameters/orderBy'
      - $ref: './common.yml#/parameters/descending'
      - $ref: './common.yml#/parameters/filterBy'
    responses:
      '200':
        description: List of Ringfence Rules.
        content:
          application/json:
            schema:
              $ref: '#/definitions/RingfenceRuleList'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
  post:
    summary: Create a new Ringfence Rule.
    description: Create a new Ringfence Rule.
    tags:
      - Ringfence Rules
    parameters:
      - $ref: './common.yml#/parameters/authorization'
    responses:
      '200':
        description: Created Ringfence Rule.
        content:
          application/json:
            schema:
              $ref: '#/definitions/RingfenceRule'
      '400':
        $ref: './common.yml#/responses/JsonError'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '409':
        $ref: './common.yml#/responses/ConflictError'
      '422':
        $ref: './common.yml#/responses/ValidationError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
    requestBody:
      $ref: '#/requestBodies/RingfenceRule'
ringfence-rules-id:
  get:
    summary: Get a specific Ringfence Rule.
    description: Get a specific Ringfence Rule.
    tags:
      - Ringfence Rules
    parameters:
      - $ref: './common.yml#/parameters/authorization'
      - $ref: './common.yml#/parameters/id'
    responses:
      '200':
        description: Single Ringfence Rule object.
        content:
          application/json:
            schema:
              $ref: '#/definitions/RingfenceRule'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '404':
        $ref: './common.yml#/responses/NotFoundError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
  put:
    summary: Update an existing Ringfence Rule.
    description: Update an existing Ringfence Rule.
    tags:
      - Ringfence Rules
    parameters:
      - $ref: './common.yml#/parameters/authorization'
      - $ref: './common.yml#/parameters/id'
    responses:
      '200':
        description: Updated Ringfence Rule.
        content:
          application/json:
            schema:
              $ref: '#/definitions/RingfenceRule'
      '400':
        $ref: './common.yml#/responses/JsonError'
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '404':
        $ref: './common.yml#/responses/NotFoundError'
      '422':
        $ref: './common.yml#/responses/ValidationError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'
    requestBody:
      $ref: '#/requestBodies/RingfenceRule'
  delete:
    summary: Delete a specific Ringfence Rule.
    description: Delete a specific Ringfence Rule.
    tags:
      - Ringfence Rules
    parameters:
      - $ref: './common.yml#/parameters/authorization'
      - $ref: './common.yml#/parameters/id'
    responses:
      '204':
        description: Ringfence Rule was deleted successfully.
      '401':
        $ref: './common.yml#/responses/TokenError'
      '403':
        $ref: './common.yml#/responses/PermissionError'
      '404':
        $ref: './common.yml#/responses/NotFoundError'
      '500':
        $ref: './common.yml#/responses/UnexpectedError'

requestBodies:
  RingfenceRule:
    content:
      application/json:
        schema:
          $ref: '#/definitions/RingfenceRule'
    description: Ringfence Rule object.
    required: true

definitions:
  RingfenceRuleList:
    allOf:
      - $ref: './common.yml#/definitions/ResultList'
      - type: object
        description: Represents a list of Ringfence Rules.
        properties:
          data:
            type: array
            description: List of Ringfence Rules.
            items:
              $ref: '#/definitions/RingfenceRule'
  RingfenceRule:
    allOf:
      - $ref: './common.yml#/definitions/BaseEntity'
      - type: object
        description: Represents an Ringfence Rule.
        required:
          - actions
        properties:
          actions:
            type: array
            description: List of all ringfence actions in this Ringfence Rule.
            items:
              type: object
              required:
                - protocol
                - direction
                - action
                - hosts
              properties:
                protocol:
                  type: string
                  description: Protocol of the ringfence action.
                  enum:
                    - icmp
                    - icmpv6
                    - udp
                    - tcp
                direction:
                  type: string
                  description: The direction of the action
                  enum:
                    - up
                    - down
                    - out
                    - in
                action:
                  type: string
                  description: Applied action to the traffic.
                  enum:
                    - allow
                    - block
                hosts:
                  type: array
                  description: Destination address. IP address or hostname.
                  items:
                    type: string
                    example: 10.0.2.0/24
                ports:
                  type: array
                  description: >-
                    Destination port.
                    Multiple ports can be entered comma separated.
                    Port ranges can be entered dash separated.
                    Only valid for tcp and udp subtypes.
                  items:
                    type: string
                  example:
                    - 80
                    - 443
                    - 1024-2048
                types:
                  type: array
                  description: ICMP type. Only valid for icmp protocol.
                  items:
                    type: string
                    example: 0-255