Skip to content

DedicatedIPAddressesApi.md

Latest commit

 

History

History
98 lines (66 loc) · 3.17 KB

DedicatedIPAddressesApi.md

File metadata and controls

98 lines (66 loc) · 3.17 KB

PSAdGuardDNS.PSAdGuardDNS\Api.DedicatedIPAddressesApi

All URIs are relative to https://api.adguard-dns.io

Method HTTP request Description
New-DedicatedIPv4Address POST /oapi/v1/dedicated_addresses/ipv4 Allocates new dedicated IPv4
Invoke-ListDedicatedIPv4Addresses GET /oapi/v1/dedicated_addresses/ipv4 Lists allocated dedicated IPv4 addresses

New-DedicatedIPv4Address

DedicatedIPv4Address New-DedicatedIPv4Address

Allocates new dedicated IPv4

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: ApiKey
$Configuration.ApiKey.Authorization = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.Authorization = "Bearer"



# Allocates new dedicated IPv4
try {
    $Result = New-DedicatedIPv4Address
} catch {
    Write-Host ("Exception occurred when calling New-DedicatedIPv4Address: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

DedicatedIPv4Address (PSCustomObject)

Authorization

ApiKey, AuthToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-ListDedicatedIPv4Addresses

DedicatedIPv4Address[] Invoke-ListDedicatedIPv4Addresses

Lists allocated dedicated IPv4 addresses

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: ApiKey
$Configuration.ApiKey.Authorization = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.Authorization = "Bearer"



# Lists allocated dedicated IPv4 addresses
try {
    $Result = Invoke-ListDedicatedIPv4Addresses
} catch {
    Write-Host ("Exception occurred when calling Invoke-ListDedicatedIPv4Addresses: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

This endpoint does not need any parameter.

Return type

DedicatedIPv4Address[] (PSCustomObject)

Authorization

ApiKey, AuthToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]