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.

https://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.



22
23
24
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 22

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", action: nil) ⇒ 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.

https://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.

Returns:



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

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

#create!(description: "", metadata: "", action: nil) ⇒ 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. Throws an exception if API error.

https://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.

Returns:



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 56

def create!(description: "", metadata: "", action: nil)
  path = '/ip_policies'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::IPPolicy.new(client: self, attrs: 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.

https://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



76
77
78
79
80
81
82
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 76

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.

https://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



94
95
96
97
98
99
100
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 94

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.

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

Parameters:

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

    a resource identifier

Returns:



109
110
111
112
113
114
115
116
117
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 109

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

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

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

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

Parameters:

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

    a resource identifier

Returns:



127
128
129
130
131
132
133
134
135
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 127

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, attrs: result)
end

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

List all IP policies on this account

https://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:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 146

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,
    attrs: 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.

https://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:



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

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,
    attrs: 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

https://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:



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

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, attrs: 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.

https://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:



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 221

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, attrs: result)
end