Class: NgrokAPI::Services::IPPoliciesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/ip_policies_client.rb

Overview

IP Policies are reusable groups of CIDR ranges with an allow or deny action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.

ngrok.com/docs/api#api-ip-policies

Constant Summary collapse

PATH =

The API path for the requests

'/ip_policies'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'ip_policies'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ IPPoliciesClient

Returns a new instance of IPPoliciesClient.



20
21
22
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 20

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



18
19
20
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 18

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", action:) ⇒ NgrokAPI::Models::IPPolicy

Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

ngrok.com/docs/api#api-ip-policies-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of the source IPs of this IP policy. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

  • action (string) —

    the IP policy action. Supported values are allow or deny

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 34

def create(
  description: "",
  metadata: "",
  action:
)
  path = '/ip_policies'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:action] = action if action
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.

ngrok.com/docs/api#api-ip-policies-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



59
60
61
62
63
64
65
66
67
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 59

def delete(
  id: ""
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules. Throws an exception if API error.

ngrok.com/docs/api#api-ip-policies-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



79
80
81
82
83
84
85
86
87
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 79

def delete!(
  id: ""
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::IPPolicy

Get detailed information about an IP policy by ID.

ngrok.com/docs/api#api-ip-policies-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 96

def get(
  id: ""
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::IPPolicy

Get detailed information about an IP policy by ID. Throws an exception if API error.

ngrok.com/docs/api#api-ip-policies-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 116

def get!(
  id: ""
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all IP policies on this account

ngrok.com/docs/api#api-ip-policies-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 137

def list(
  before_id: nil,
  limit: nil,
  url: nil
)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::IPPolicy
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all IP policies on this account Throws an exception if API error.

ngrok.com/docs/api#api-ip-policies-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 167

def list!(
  before_id: nil,
  limit: nil,
  url: nil
)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::IPPolicy,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy

Update attributes of an IP policy by ID

ngrok.com/docs/api#api-ip-policies-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of the source IPs of this IP policy. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 198

def update(
  id: "",
  description: nil,
  metadata: nil
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
end

#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy

Update attributes of an IP policy by ID Throws an exception if API error.

ngrok.com/docs/api#api-ip-policies-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of the source IPs of this IP policy. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 224

def update!(
  id: "",
  description: nil,
  metadata: nil
)
  path = '/ip_policies/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
end