Skip to content

Latest commit

 

History

History
433 lines (304 loc) · 11 KB

IPBlocksApi.md

File metadata and controls

433 lines (304 loc) · 11 KB
Raw

IpApi::IPBlocksApi

All URIs are relative to https://api.phoenixnap.com/ips/v1

Method HTTP request Description
ip_blocks_get GET /ip-blocks List IP Blocks.
ip_blocks_ip_block_id_delete DELETE /ip-blocks/{ipBlockId} Delete IP Block.
ip_blocks_ip_block_id_get GET /ip-blocks/{ipBlockId} Get IP Block.
ip_blocks_ip_block_id_patch PATCH /ip-blocks/{ipBlockId} Update IP block.
ip_blocks_ip_block_id_tags_put PUT /ip-blocks/{ipBlockId}/tags Overwrite tags assigned for IP Block.
ip_blocks_post POST /ip-blocks Create an IP Block.

ip_blocks_get

<Array> ip_blocks_get(opts)

List IP Blocks.

List all IP Blocks.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
opts = {
  tag: ['inner_example'] # Array<String> | List of tags, in the form tagName.tagValue, to filter by.
}

begin
  # List IP Blocks.
  result = api_instance.ip_blocks_get(opts)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_get: #{e}"
end

Using the ip_blocks_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> ip_blocks_get_with_http_info(opts)

begin
  # List IP Blocks.
  data, status_code, headers = api_instance.ip_blocks_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<IpBlock>>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
tag Array<String> List of tags, in the form tagName.tagValue, to filter by. [optional]

Return type

Array<IpBlock>

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ip_blocks_ip_block_id_delete

ip_blocks_ip_block_id_delete(ip_block_id)

Delete IP Block.

Delete an IP Block. An IP Block can only be deleted if not assigned to any resource.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.

begin
  # Delete IP Block.
  result = api_instance.ip_blocks_ip_block_id_delete(ip_block_id)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_delete: #{e}"
end

Using the ip_blocks_ip_block_id_delete_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ip_blocks_ip_block_id_delete_with_http_info(ip_block_id)

begin
  # Delete IP Block.
  data, status_code, headers = api_instance.ip_blocks_ip_block_id_delete_with_http_info(ip_block_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteIpBlockResult>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_delete_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ip_block_id String The IP Block identifier.

Return type

DeleteIpBlockResult

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ip_blocks_ip_block_id_get

ip_blocks_ip_block_id_get(ip_block_id)

Get IP Block.

Get IP Block.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.

begin
  # Get IP Block.
  result = api_instance.ip_blocks_ip_block_id_get(ip_block_id)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_get: #{e}"
end

Using the ip_blocks_ip_block_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ip_blocks_ip_block_id_get_with_http_info(ip_block_id)

begin
  # Get IP Block.
  data, status_code, headers = api_instance.ip_blocks_ip_block_id_get_with_http_info(ip_block_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IpBlock>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ip_block_id String The IP Block identifier.

Return type

IpBlock

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ip_blocks_ip_block_id_patch

ip_blocks_ip_block_id_patch(ip_block_id, ip_block_patch)

Update IP block.

Update IP Block's details.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
ip_block_patch = IpApi::IpBlockPatch.new # IpBlockPatch | 

begin
  # Update IP block.
  result = api_instance.ip_blocks_ip_block_id_patch(ip_block_id, ip_block_patch)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_patch: #{e}"
end

Using the ip_blocks_ip_block_id_patch_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, ip_block_patch)

begin
  # Update IP block.
  data, status_code, headers = api_instance.ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, ip_block_patch)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IpBlock>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_patch_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ip_block_id String The IP Block identifier.
ip_block_patch IpBlockPatch

Return type

IpBlock

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ip_blocks_ip_block_id_tags_put

ip_blocks_ip_block_id_tags_put(ip_block_id, tag_assignment_request)

Overwrite tags assigned for IP Block.

Overwrites tags assigned for IP Block and unassigns any tags not part of the request.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
tag_assignment_request = [IpApi::TagAssignmentRequest.new({name: 'Environment'})] # Array<TagAssignmentRequest> | 

begin
  # Overwrite tags assigned for IP Block.
  result = api_instance.ip_blocks_ip_block_id_tags_put(ip_block_id, tag_assignment_request)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_tags_put: #{e}"
end

Using the ip_blocks_ip_block_id_tags_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ip_blocks_ip_block_id_tags_put_with_http_info(ip_block_id, tag_assignment_request)

begin
  # Overwrite tags assigned for IP Block.
  data, status_code, headers = api_instance.ip_blocks_ip_block_id_tags_put_with_http_info(ip_block_id, tag_assignment_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IpBlock>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_tags_put_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ip_block_id String The IP Block identifier.
tag_assignment_request Array<TagAssignmentRequest>

Return type

IpBlock

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

ip_blocks_post

ip_blocks_post(ip_block_create)

Create an IP Block.

Request an IP Block. An IP Block is a set of contiguous IPs that can be assigned to other resources such as servers.

Examples

require 'time'
require 'pnap_ip_api'
# setup authorization
IpApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = IpApi::IPBlocksApi.new
ip_block_create = IpApi::IpBlockCreate.new({location: 'PHX', cidr_block_size: '/30'}) # IpBlockCreate | 

begin
  # Create an IP Block.
  result = api_instance.ip_blocks_post(ip_block_create)
  p result
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_post: #{e}"
end

Using the ip_blocks_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ip_blocks_post_with_http_info(ip_block_create)

begin
  # Create an IP Block.
  data, status_code, headers = api_instance.ip_blocks_post_with_http_info(ip_block_create)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IpBlock>
rescue IpApi::ApiError => e
  puts "Error when calling IPBlocksApi->ip_blocks_post_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ip_block_create IpBlockCreate

Return type

IpBlock

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json