NetFoundry Public REST API

AzureSubscriptions

createAzureSubscription

store Azure subscription details

Store an Azure subscriptionID, tenant ID (AD), and Application ID and key for use with Azure Virtual WAN. The application must have permission to create a Virtual WAN (branch) site in your subscription.


/azureSubscriptions

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        AzureSubscriptions1310085210 azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
}; // AzureSubscriptions1310085210 | 
        try {
            azureSubscriptions1018328653 result = apiInstance.createAzureSubscription(azureSubscriptions1310085210);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#createAzureSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        AzureSubscriptions1310085210 azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
}; // AzureSubscriptions1310085210 | 
        try {
            azureSubscriptions1018328653 result = apiInstance.createAzureSubscription(azureSubscriptions1310085210);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#createAzureSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

AzureSubscriptions1310085210 *azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
}; //  (optional)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// store Azure subscription details
[apiInstance createAzureSubscriptionWith:azureSubscriptions1310085210
              completionHandler: ^(azureSubscriptions1018328653 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var opts = {
  'azureSubscriptions1310085210': {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
} // {AzureSubscriptions1310085210} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAzureSubscription(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createAzureSubscriptionExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptions1310085210 = new AzureSubscriptions1310085210(); // AzureSubscriptions1310085210 |  (optional) 

            try
            {
                // store Azure subscription details
                azureSubscriptions1018328653 result = apiInstance.createAzureSubscription(azureSubscriptions1310085210);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.createAzureSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
}; // AzureSubscriptions1310085210 | 

try {
    $result = $api_instance->createAzureSubscription($azureSubscriptions1310085210);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->createAzureSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptions1310085210 = WWW::OPenAPIClient::Object::AzureSubscriptions1310085210->new(); # AzureSubscriptions1310085210 | 

eval { 
    my $result = $api_instance->createAzureSubscription(azureSubscriptions1310085210 => $azureSubscriptions1310085210);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->createAzureSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
} # AzureSubscriptions1310085210 |  (optional)

try: 
    # store Azure subscription details
    api_response = api_instance.create_azure_subscription(azureSubscriptions1310085210=azureSubscriptions1310085210)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->createAzureSubscription: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptions1310085210 = {
  "name" : "Test AZ Subscription 02",
  "subscriptionId" : "1f0604c4-b0a6-450a-a488-20016a21bce6",
  "tenantId" : "7f6ef333-82e0-472e-992a-df3f93583a7f",
  "applicationId" : "689e077d-4836-40b7-8d30-5ec69c3599ae",
  "applicationKey" : "0ac594ee-be47-4bad-8295-77d642d0169a"
}; // AzureSubscriptions1310085210

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.createAzureSubscription(azureSubscriptions1310085210, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
azureSubscriptions1310085210

Responses


createAzureVirtualWanSite

describe a vWAN branch site

Define an Azure Virtual WAN branch site. A "site" here is a special type of NetFoundry endpoint with metadata describing the IP routes to be attached to your Azure Virtual WAN.


/azureSubscriptions/{azureSubscriptionId}/virtualWanSites

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}/virtualWanSites"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
}; // AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 | 
        try {
            azureSubscriptions-azureSubscriptionId-virtualWanSites1859069655 result = apiInstance.createAzureVirtualWanSite(azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#createAzureVirtualWanSite");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
}; // AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 | 
        try {
            azureSubscriptions-azureSubscriptionId-virtualWanSites1859069655 result = apiInstance.createAzureVirtualWanSite(azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#createAzureVirtualWanSite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)
AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 *azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
}; //  (optional)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// describe a vWAN branch site
[apiInstance createAzureVirtualWanSiteWith:azureSubscriptionId
    azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693:azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693
              completionHandler: ^(azureSubscriptions-azureSubscriptionId-virtualWanSites1859069655 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription
var opts = {
  'azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693': {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
} // {AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAzureVirtualWanSite(azureSubscriptionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createAzureVirtualWanSiteExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)
            var azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = new AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693(); // AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 |  (optional) 

            try
            {
                // describe a vWAN branch site
                azureSubscriptions-azureSubscriptionId-virtualWanSites1859069655 result = apiInstance.createAzureVirtualWanSite(azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.createAzureVirtualWanSite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
$azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
}; // AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 | 

try {
    $result = $api_instance->createAzureVirtualWanSite($azureSubscriptionId, $azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->createAzureVirtualWanSite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription
my $azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = WWW::OPenAPIClient::Object::AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693->new(); # AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 | 

eval { 
    my $result = $api_instance->createAzureVirtualWanSite(azureSubscriptionId => $azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 => $azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->createAzureVirtualWanSite: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)
azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
} # AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 |  (optional)

try: 
    # describe a vWAN branch site
    api_response = api_instance.create_azure_virtual_wan_site(azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693=azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->createAzureVirtualWanSite: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String
    let azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693 = {
  "name" : "azsite01",
  "endpointId" : "01f34efd-6a69-4aa9-9836-810cfa2f8079",
  "dataCenterId" : "d7ddedf5-09e7-4cb7-995f-2d8fde65786c",
  "azureSubscriptionId" : null,
  "azureResourceGroupName" : "resourceGroup01",
  "azureVirtualWanId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
  "publicIpAddress" : "8.8.8.8",
  "bgp" : {
    "localPeeringAddress" : {
      "ipAddress" : "192.168.0.1",
      "asn" : 64515
    },
    "bgpPeerWeight" : null,
    "deviceLinkSpeed" : null,
    "deviceVendor" : null,
    "deviceModel" : null,
    "neighborPeers" : [ {
      "ipAddress" : "192.168.0.2",
      "asn" : 64513
    }, {
      "ipAddress" : "192.168.0.3",
      "asn" : 64514
    } ],
    "advertiseLocal" : true,
    "advertisedPrefixes" : [ "10.0.0.0/24" ]
  }
}; // AzureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.createAzureVirtualWanSite(azureSubscriptionId, azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required
Body parameters
Name Description
azureSubscriptionsAzureSubscriptionIdVirtualWanSites1393634693

Responses


deleteAzureSubscription

delete stored Azure subscription details

delete stored Azure subscription details


/azureSubscriptions/{azureSubscriptionId}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            apiInstance.deleteAzureSubscription(azureSubscriptionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#deleteAzureSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            apiInstance.deleteAzureSubscription(azureSubscriptionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#deleteAzureSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// delete stored Azure subscription details
[apiInstance deleteAzureSubscriptionWith:azureSubscriptionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAzureSubscription(azureSubscriptionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAzureSubscriptionExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)

            try
            {
                // delete stored Azure subscription details
                apiInstance.deleteAzureSubscription(azureSubscriptionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.deleteAzureSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription

try {
    $api_instance->deleteAzureSubscription($azureSubscriptionId);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->deleteAzureSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription

eval { 
    $api_instance->deleteAzureSubscription(azureSubscriptionId => $azureSubscriptionId);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->deleteAzureSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)

try: 
    # delete stored Azure subscription details
    api_instance.delete_azure_subscription(azureSubscriptionId)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->deleteAzureSubscription: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.deleteAzureSubscription(azureSubscriptionId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required

Responses


deleteAzureVirtualWanSite

delete Azure vWAN site

delete Azure vWAN site


/azureSubscriptions/{azureSubscriptionId}/virtualWanSites/{siteId}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}/virtualWanSites/{siteId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        String siteId = siteId_example; // String | the id of the Azure vWAN VPN site
        try {
            apiInstance.deleteAzureVirtualWanSite(azureSubscriptionId, siteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#deleteAzureVirtualWanSite");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        String siteId = siteId_example; // String | the id of the Azure vWAN VPN site
        try {
            apiInstance.deleteAzureVirtualWanSite(azureSubscriptionId, siteId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#deleteAzureVirtualWanSite");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)
String *siteId = siteId_example; // the id of the Azure vWAN VPN site (default to null)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// delete Azure vWAN site
[apiInstance deleteAzureVirtualWanSiteWith:azureSubscriptionId
    siteId:siteId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription
var siteId = siteId_example; // {String} the id of the Azure vWAN VPN site

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAzureVirtualWanSite(azureSubscriptionId, siteId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAzureVirtualWanSiteExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)
            var siteId = siteId_example;  // String | the id of the Azure vWAN VPN site (default to null)

            try
            {
                // delete Azure vWAN site
                apiInstance.deleteAzureVirtualWanSite(azureSubscriptionId, siteId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.deleteAzureVirtualWanSite: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
$siteId = siteId_example; // String | the id of the Azure vWAN VPN site

try {
    $api_instance->deleteAzureVirtualWanSite($azureSubscriptionId, $siteId);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->deleteAzureVirtualWanSite: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription
my $siteId = siteId_example; # String | the id of the Azure vWAN VPN site

eval { 
    $api_instance->deleteAzureVirtualWanSite(azureSubscriptionId => $azureSubscriptionId, siteId => $siteId);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->deleteAzureVirtualWanSite: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)
siteId = siteId_example # String | the id of the Azure vWAN VPN site (default to null)

try: 
    # delete Azure vWAN site
    api_instance.delete_azure_virtual_wan_site(azureSubscriptionId, siteId)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->deleteAzureVirtualWanSite: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String
    let siteId = siteId_example; // String

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.deleteAzureVirtualWanSite(azureSubscriptionId, siteId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required
siteId*
String
the id of the Azure vWAN VPN site
Required

Responses


getAllAzureSubscriptions

list Azure subscriptions

Returns a list of stored Azure subscriptions in your account.


/azureSubscriptions

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        try {
            azureSubscriptions1321751198 result = apiInstance.getAllAzureSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAllAzureSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        try {
            azureSubscriptions1321751198 result = apiInstance.getAllAzureSubscriptions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAllAzureSubscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// list Azure subscriptions
[apiInstance getAllAzureSubscriptionsWithCompletionHandler: 
              ^(azureSubscriptions1321751198 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAzureSubscriptions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllAzureSubscriptionsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();

            try
            {
                // list Azure subscriptions
                azureSubscriptions1321751198 result = apiInstance.getAllAzureSubscriptions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.getAllAzureSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();

try {
    $result = $api_instance->getAllAzureSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->getAllAzureSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();

eval { 
    my $result = $api_instance->getAllAzureSubscriptions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->getAllAzureSubscriptions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()

try: 
    # list Azure subscriptions
    api_response = api_instance.get_all_azure_subscriptions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->getAllAzureSubscriptions: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.getAllAzureSubscriptions(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


getAllVirtualWanSitesForSubscription

list Azure vWAN sites for subscription

Returns a list of Azure Virtual WAN sites that were created by a stored suscription credential set.


/azureSubscriptions/{azureSubscriptionId}/virtualWanSites

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}/virtualWanSites"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            azureSubscriptions-azureSubscriptionId-virtualWanSites-670838162 result = apiInstance.getAllVirtualWanSitesForSubscription(azureSubscriptionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAllVirtualWanSitesForSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            azureSubscriptions-azureSubscriptionId-virtualWanSites-670838162 result = apiInstance.getAllVirtualWanSitesForSubscription(azureSubscriptionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAllVirtualWanSitesForSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// list Azure vWAN sites for subscription
[apiInstance getAllVirtualWanSitesForSubscriptionWith:azureSubscriptionId
              completionHandler: ^(azureSubscriptions-azureSubscriptionId-virtualWanSites-670838162 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllVirtualWanSitesForSubscription(azureSubscriptionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllVirtualWanSitesForSubscriptionExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)

            try
            {
                // list Azure vWAN sites for subscription
                azureSubscriptions-azureSubscriptionId-virtualWanSites-670838162 result = apiInstance.getAllVirtualWanSitesForSubscription(azureSubscriptionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.getAllVirtualWanSitesForSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription

try {
    $result = $api_instance->getAllVirtualWanSitesForSubscription($azureSubscriptionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->getAllVirtualWanSitesForSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription

eval { 
    my $result = $api_instance->getAllVirtualWanSitesForSubscription(azureSubscriptionId => $azureSubscriptionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->getAllVirtualWanSitesForSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)

try: 
    # list Azure vWAN sites for subscription
    api_response = api_instance.get_all_virtual_wan_sites_for_subscription(azureSubscriptionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->getAllVirtualWanSitesForSubscription: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.getAllVirtualWanSitesForSubscription(azureSubscriptionId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required

Responses


getAzureSubscription

fetch the attributes of a subscription

Returns the object describing one stored Azure subscription i.e. subscription ID, tenant ID, and application client ID (not the key).


/azureSubscriptions/{azureSubscriptionId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            azureSubscriptions1018328653 result = apiInstance.getAzureSubscription(azureSubscriptionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAzureSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        try {
            azureSubscriptions1018328653 result = apiInstance.getAzureSubscription(azureSubscriptionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#getAzureSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// fetch the attributes of a subscription
[apiInstance getAzureSubscriptionWith:azureSubscriptionId
              completionHandler: ^(azureSubscriptions1018328653 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAzureSubscription(azureSubscriptionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAzureSubscriptionExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)

            try
            {
                // fetch the attributes of a subscription
                azureSubscriptions1018328653 result = apiInstance.getAzureSubscription(azureSubscriptionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.getAzureSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription

try {
    $result = $api_instance->getAzureSubscription($azureSubscriptionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->getAzureSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription

eval { 
    my $result = $api_instance->getAzureSubscription(azureSubscriptionId => $azureSubscriptionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->getAzureSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)

try: 
    # fetch the attributes of a subscription
    api_response = api_instance.get_azure_subscription(azureSubscriptionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->getAzureSubscription: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.getAzureSubscription(azureSubscriptionId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required

Responses


updateAzureSubscription

redefine an Azure subscription

Accepts the same parameters as the operation that stored the subscription. Send all attributes, not only those that have changed.


/azureSubscriptions/{azureSubscriptionId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/azureSubscriptions/{azureSubscriptionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AzureSubscriptionsApi;

import java.io.File;
import java.util.*;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        Object body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
}; // Object | 
        try {
            azureSubscriptions1018328653 result = apiInstance.updateAzureSubscription(azureSubscriptionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#updateAzureSubscription");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AzureSubscriptionsApi;

public class AzureSubscriptionsApiExample {

    public static void main(String[] args) {
        AzureSubscriptionsApi apiInstance = new AzureSubscriptionsApi();
        String azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
        Object body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
}; // Object | 
        try {
            azureSubscriptions1018328653 result = apiInstance.updateAzureSubscription(azureSubscriptionId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AzureSubscriptionsApi#updateAzureSubscription");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *azureSubscriptionId = azureSubscriptionId_example; // the id of the subscription (default to null)
Object *body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
}; //  (optional)

AzureSubscriptionsApi *apiInstance = [[AzureSubscriptionsApi alloc] init];

// redefine an Azure subscription
[apiInstance updateAzureSubscriptionWith:azureSubscriptionId
    body:body
              completionHandler: ^(azureSubscriptions1018328653 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.AzureSubscriptionsApi()
var azureSubscriptionId = azureSubscriptionId_example; // {String} the id of the subscription
var opts = {
  'body': {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
} // {Object} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAzureSubscription(azureSubscriptionId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateAzureSubscriptionExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AzureSubscriptionsApi();
            var azureSubscriptionId = azureSubscriptionId_example;  // String | the id of the subscription (default to null)
            var body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
};  // Object |  (optional) 

            try
            {
                // redefine an Azure subscription
                azureSubscriptions1018328653 result = apiInstance.updateAzureSubscription(azureSubscriptionId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AzureSubscriptionsApi.updateAzureSubscription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\AzureSubscriptionsApi();
$azureSubscriptionId = azureSubscriptionId_example; // String | the id of the subscription
$body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
}; // Object | 

try {
    $result = $api_instance->updateAzureSubscription($azureSubscriptionId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AzureSubscriptionsApi->updateAzureSubscription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AzureSubscriptionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::AzureSubscriptionsApi->new();
my $azureSubscriptionId = azureSubscriptionId_example; # String | the id of the subscription
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval { 
    my $result = $api_instance->updateAzureSubscription(azureSubscriptionId => $azureSubscriptionId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AzureSubscriptionsApi->updateAzureSubscription: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.AzureSubscriptionsApi()
azureSubscriptionId = azureSubscriptionId_example # String | the id of the subscription (default to null)
body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
} # Object |  (optional)

try: 
    # redefine an Azure subscription
    api_response = api_instance.update_azure_subscription(azureSubscriptionId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AzureSubscriptionsApi->updateAzureSubscription: %s\n" % e)
extern crate AzureSubscriptionsApi;

pub fn main() {
    let azureSubscriptionId = azureSubscriptionId_example; // String
    let body = {
  "name" : "Test AZ Subscription 01",
  "subscriptionId" : "a4224de5-b845-49cb-9e01-a68e0b791da3",
  "tenantId" : "7bbaa1a3-cfcf-46e9-be9b-7826693a1820",
  "applicationId" : "b6e595e9-73d7-4277-aca0-d9fe443dc7b7",
  "applicationKey" : "1db1788d-9a5a-4b27-a0a5-d9057fa28767",
  "organizationId" : null,
  "ownerIdentityId" : null,
  "createdAt" : null,
  "updatedAt" : null,
  "id" : null
}; // Object

    let mut context = AzureSubscriptionsApi::Context::default();
    let result = client.updateAzureSubscription(azureSubscriptionId, body, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
azureSubscriptionId*
String
the id of the subscription
Required
Body parameters
Name Description
body

Responses


DataCenters

getDataCenterById

fetch a data center by ID

Fetch the attributes of a single data center by ID.


/dataCenters/{dataCenterId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/dataCenters/{dataCenterId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataCentersApi;

import java.io.File;
import java.util.*;

public class DataCentersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        DataCentersApi apiInstance = new DataCentersApi();
        String dataCenterId = dataCenterId_example; // String | the id of the data center
        try {
            dataCenters-dataCenterId-1060459100 result = apiInstance.getDataCenterById(dataCenterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCentersApi#getDataCenterById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DataCentersApi;

public class DataCentersApiExample {

    public static void main(String[] args) {
        DataCentersApi apiInstance = new DataCentersApi();
        String dataCenterId = dataCenterId_example; // String | the id of the data center
        try {
            dataCenters-dataCenterId-1060459100 result = apiInstance.getDataCenterById(dataCenterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCentersApi#getDataCenterById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *dataCenterId = dataCenterId_example; // the id of the data center (default to null)

DataCentersApi *apiInstance = [[DataCentersApi alloc] init];

// fetch a data center by ID
[apiInstance getDataCenterByIdWith:dataCenterId
              completionHandler: ^(dataCenters-dataCenterId-1060459100 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.DataCentersApi()
var dataCenterId = dataCenterId_example; // {String} the id of the data center

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataCenterById(dataCenterId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDataCenterByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DataCentersApi();
            var dataCenterId = dataCenterId_example;  // String | the id of the data center (default to null)

            try
            {
                // fetch a data center by ID
                dataCenters-dataCenterId-1060459100 result = apiInstance.getDataCenterById(dataCenterId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCentersApi.getDataCenterById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\DataCentersApi();
$dataCenterId = dataCenterId_example; // String | the id of the data center

try {
    $result = $api_instance->getDataCenterById($dataCenterId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataCentersApi->getDataCenterById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataCentersApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::DataCentersApi->new();
my $dataCenterId = dataCenterId_example; # String | the id of the data center

eval { 
    my $result = $api_instance->getDataCenterById(dataCenterId => $dataCenterId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataCentersApi->getDataCenterById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.DataCentersApi()
dataCenterId = dataCenterId_example # String | the id of the data center (default to null)

try: 
    # fetch a data center by ID
    api_response = api_instance.get_data_center_by_id(dataCenterId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataCentersApi->getDataCenterById: %s\n" % e)
extern crate DataCentersApi;

pub fn main() {
    let dataCenterId = dataCenterId_example; // String

    let mut context = DataCentersApi::Context::default();
    let result = client.getDataCenterById(dataCenterId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
dataCenterId*
String
the id of the data center
Required

Responses


getDataCenterByLocationCode

fetch data center(s)

Returns a list of all data centers or the attributes of one datacenter matching query `?locationCode={locationCode}`. A data center is a compute location and is associated with one or more geographic regions in /rest/v1/geoRegions.


/dataCenters

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/dataCenters?locationCode="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataCentersApi;

import java.io.File;
import java.util.*;

public class DataCentersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        DataCentersApi apiInstance = new DataCentersApi();
        String locationCode = locationCode_example; // String | the locationCode by which to filter data centers
        try {
            dataCenters2066924366 result = apiInstance.getDataCenterByLocationCode(locationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCentersApi#getDataCenterByLocationCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DataCentersApi;

public class DataCentersApiExample {

    public static void main(String[] args) {
        DataCentersApi apiInstance = new DataCentersApi();
        String locationCode = locationCode_example; // String | the locationCode by which to filter data centers
        try {
            dataCenters2066924366 result = apiInstance.getDataCenterByLocationCode(locationCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataCentersApi#getDataCenterByLocationCode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *locationCode = locationCode_example; // the locationCode by which to filter data centers (default to null)

DataCentersApi *apiInstance = [[DataCentersApi alloc] init];

// fetch data center(s)
[apiInstance getDataCenterByLocationCodeWith:locationCode
              completionHandler: ^(dataCenters2066924366 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.DataCentersApi()
var locationCode = locationCode_example; // {String} the locationCode by which to filter data centers

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataCenterByLocationCode(locationCode, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDataCenterByLocationCodeExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DataCentersApi();
            var locationCode = locationCode_example;  // String | the locationCode by which to filter data centers (default to null)

            try
            {
                // fetch data center(s)
                dataCenters2066924366 result = apiInstance.getDataCenterByLocationCode(locationCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataCentersApi.getDataCenterByLocationCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\DataCentersApi();
$locationCode = locationCode_example; // String | the locationCode by which to filter data centers

try {
    $result = $api_instance->getDataCenterByLocationCode($locationCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataCentersApi->getDataCenterByLocationCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataCentersApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::DataCentersApi->new();
my $locationCode = locationCode_example; # String | the locationCode by which to filter data centers

eval { 
    my $result = $api_instance->getDataCenterByLocationCode(locationCode => $locationCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataCentersApi->getDataCenterByLocationCode: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.DataCentersApi()
locationCode = locationCode_example # String | the locationCode by which to filter data centers (default to null)

try: 
    # fetch data center(s)
    api_response = api_instance.get_data_center_by_location_code(locationCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataCentersApi->getDataCenterByLocationCode: %s\n" % e)
extern crate DataCentersApi;

pub fn main() {
    let locationCode = locationCode_example; // String

    let mut context = DataCentersApi::Context::default();
    let result = client.getDataCenterByLocationCode(locationCode, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
locationCode*
String
the locationCode by which to filter data centers
Required

Responses


Elastic


GeoRegions

getGeoRegionById

fetch a georegion

Fetch the attributes of a geographic region by ID


/geoRegions/{geoRegionId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/geoRegions/{geoRegionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoRegionsApi;

import java.io.File;
import java.util.*;

public class GeoRegionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GeoRegionsApi apiInstance = new GeoRegionsApi();
        String geoRegionId = geoRegionId_example; // String | the id of the geographic region
        try {
            geoRegions-geoRegionId-1492212157 result = apiInstance.getGeoRegionById(geoRegionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoRegionsApi#getGeoRegionById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoRegionsApi;

public class GeoRegionsApiExample {

    public static void main(String[] args) {
        GeoRegionsApi apiInstance = new GeoRegionsApi();
        String geoRegionId = geoRegionId_example; // String | the id of the geographic region
        try {
            geoRegions-geoRegionId-1492212157 result = apiInstance.getGeoRegionById(geoRegionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoRegionsApi#getGeoRegionById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *geoRegionId = geoRegionId_example; // the id of the geographic region (default to null)

GeoRegionsApi *apiInstance = [[GeoRegionsApi alloc] init];

// fetch a georegion
[apiInstance getGeoRegionByIdWith:geoRegionId
              completionHandler: ^(geoRegions-geoRegionId-1492212157 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.GeoRegionsApi()
var geoRegionId = geoRegionId_example; // {String} the id of the geographic region

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGeoRegionById(geoRegionId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGeoRegionByIdExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GeoRegionsApi();
            var geoRegionId = geoRegionId_example;  // String | the id of the geographic region (default to null)

            try
            {
                // fetch a georegion
                geoRegions-geoRegionId-1492212157 result = apiInstance.getGeoRegionById(geoRegionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoRegionsApi.getGeoRegionById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\GeoRegionsApi();
$geoRegionId = geoRegionId_example; // String | the id of the geographic region

try {
    $result = $api_instance->getGeoRegionById($geoRegionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoRegionsApi->getGeoRegionById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GeoRegionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::GeoRegionsApi->new();
my $geoRegionId = geoRegionId_example; # String | the id of the geographic region

eval { 
    my $result = $api_instance->getGeoRegionById(geoRegionId => $geoRegionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoRegionsApi->getGeoRegionById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.GeoRegionsApi()
geoRegionId = geoRegionId_example # String | the id of the geographic region (default to null)

try: 
    # fetch a georegion
    api_response = api_instance.get_geo_region_by_id(geoRegionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoRegionsApi->getGeoRegionById: %s\n" % e)
extern crate GeoRegionsApi;

pub fn main() {
    let geoRegionId = geoRegionId_example; // String

    let mut context = GeoRegionsApi::Context::default();
    let result = client.getGeoRegionById(geoRegionId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
geoRegionId*
String
the id of the geographic region
Required

Responses


getGeoRegions

list all georegions

Returns a list of geographic regions. These are longitudinal regions comprising provider-specific datacenters.


/geoRegions

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/geoRegions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoRegionsApi;

import java.io.File;
import java.util.*;

public class GeoRegionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        GeoRegionsApi apiInstance = new GeoRegionsApi();
        try {
            geoRegions-446812573 result = apiInstance.getGeoRegions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoRegionsApi#getGeoRegions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoRegionsApi;

public class GeoRegionsApiExample {

    public static void main(String[] args) {
        GeoRegionsApi apiInstance = new GeoRegionsApi();
        try {
            geoRegions-446812573 result = apiInstance.getGeoRegions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoRegionsApi#getGeoRegions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


GeoRegionsApi *apiInstance = [[GeoRegionsApi alloc] init];

// list all georegions
[apiInstance getGeoRegionsWithCompletionHandler: 
              ^(geoRegions-446812573 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.GeoRegionsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGeoRegions(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getGeoRegionsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new GeoRegionsApi();

            try
            {
                // list all georegions
                geoRegions-446812573 result = apiInstance.getGeoRegions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoRegionsApi.getGeoRegions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\GeoRegionsApi();

try {
    $result = $api_instance->getGeoRegions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoRegionsApi->getGeoRegions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GeoRegionsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::GeoRegionsApi->new();

eval { 
    my $result = $api_instance->getGeoRegions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoRegionsApi->getGeoRegions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.GeoRegionsApi()

try: 
    # list all georegions
    api_response = api_instance.get_geo_regions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoRegionsApi->getGeoRegions: %s\n" % e)
extern crate GeoRegionsApi;

pub fn main() {

    let mut context = GeoRegionsApi::Context::default();
    let result = client.getGeoRegions(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


Hosts

getHost

fetch a host

Fetch the attributes of a host by ID.


/hosts/{hostId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/hosts/{hostId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HostsApi;

import java.io.File;
import java.util.*;

public class HostsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HostsApi apiInstance = new HostsApi();
        String hostId = hostId_example; // String | 
        try {
            hosts-hostId-1233713338 result = apiInstance.getHost(hostId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String hostId = hostId_example; // String | 
        try {
            hosts-hostId-1233713338 result = apiInstance.getHost(hostId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *hostId = hostId_example; //  (default to null)

HostsApi *apiInstance = [[HostsApi alloc] init];

// fetch a host
[apiInstance getHostWith:hostId
              completionHandler: ^(hosts-hostId-1233713338 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.HostsApi()
var hostId = hostId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHost(hostId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getHostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HostsApi();
            var hostId = hostId_example;  // String |  (default to null)

            try
            {
                // fetch a host
                hosts-hostId-1233713338 result = apiInstance.getHost(hostId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.getHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HostsApi();
$hostId = hostId_example; // String | 

try {
    $result = $api_instance->getHost($hostId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostsApi->getHost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HostsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HostsApi->new();
my $hostId = hostId_example; # String | 

eval { 
    my $result = $api_instance->getHost(hostId => $hostId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostsApi->getHost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HostsApi()
hostId = hostId_example # String |  (default to null)

try: 
    # fetch a host
    api_response = api_instance.get_host(hostId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostsApi->getHost: %s\n" % e)
extern crate HostsApi;

pub fn main() {
    let hostId = hostId_example; // String

    let mut context = HostsApi::Context::default();
    let result = client.getHost(hostId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
hostId*
String
Required

Responses


getHostsForNetwork

list hosts for network

Returns a list of hosts for a network.


/hosts

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/hosts"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HostsApi;

import java.io.File;
import java.util.*;

public class HostsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        HostsApi apiInstance = new HostsApi();
        try {
            hosts-1480010628 result = apiInstance.getHostsForNetwork();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHostsForNetwork");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        try {
            hosts-1480010628 result = apiInstance.getHostsForNetwork();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHostsForNetwork");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


HostsApi *apiInstance = [[HostsApi alloc] init];

// list hosts for network
[apiInstance getHostsForNetworkWithCompletionHandler: 
              ^(hosts-1480010628 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.HostsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHostsForNetwork(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getHostsForNetworkExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new HostsApi();

            try
            {
                // list hosts for network
                hosts-1480010628 result = apiInstance.getHostsForNetwork();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.getHostsForNetwork: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\HostsApi();

try {
    $result = $api_instance->getHostsForNetwork();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostsApi->getHostsForNetwork: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HostsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::HostsApi->new();

eval { 
    my $result = $api_instance->getHostsForNetwork();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostsApi->getHostsForNetwork: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.HostsApi()

try: 
    # list hosts for network
    api_response = api_instance.get_hosts_for_network()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostsApi->getHostsForNetwork: %s\n" % e)
extern crate HostsApi;

pub fn main() {

    let mut context = HostsApi::Context::default();
    let result = client.getHostsForNetwork(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


NetworkConfigMetadata

createNetworkConfigMetadata

add a network configuration

Store a new network configuration template.


/networkConfigMetadata

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkConfigMetadata"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkConfigMetadataApi;

import java.io.File;
import java.util.*;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        NetworkConfigMetadata1781842714 networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 
        try {
            networkConfigMetadata-299031831 result = apiInstance.createNetworkConfigMetadata(networkConfigMetadata1781842714);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#createNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkConfigMetadataApi;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        NetworkConfigMetadata1781842714 networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 
        try {
            networkConfigMetadata-299031831 result = apiInstance.createNetworkConfigMetadata(networkConfigMetadata1781842714);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#createNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

NetworkConfigMetadata1781842714 *networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; //  (optional)

NetworkConfigMetadataApi *apiInstance = [[NetworkConfigMetadataApi alloc] init];

// add a network configuration
[apiInstance createNetworkConfigMetadataWith:networkConfigMetadata1781842714
              completionHandler: ^(networkConfigMetadata-299031831 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkConfigMetadataApi()
var opts = {
  'networkConfigMetadata1781842714': {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
} // {NetworkConfigMetadata1781842714} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNetworkConfigMetadata(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createNetworkConfigMetadataExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkConfigMetadataApi();
            var networkConfigMetadata1781842714 = new NetworkConfigMetadata1781842714(); // NetworkConfigMetadata1781842714 |  (optional) 

            try
            {
                // add a network configuration
                networkConfigMetadata-299031831 result = apiInstance.createNetworkConfigMetadata(networkConfigMetadata1781842714);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkConfigMetadataApi.createNetworkConfigMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkConfigMetadataApi();
$networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 

try {
    $result = $api_instance->createNetworkConfigMetadata($networkConfigMetadata1781842714);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkConfigMetadataApi->createNetworkConfigMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkConfigMetadataApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkConfigMetadataApi->new();
my $networkConfigMetadata1781842714 = WWW::OPenAPIClient::Object::NetworkConfigMetadata1781842714->new(); # NetworkConfigMetadata1781842714 | 

eval { 
    my $result = $api_instance->createNetworkConfigMetadata(networkConfigMetadata1781842714 => $networkConfigMetadata1781842714);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkConfigMetadataApi->createNetworkConfigMetadata: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkConfigMetadataApi()
networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
} # NetworkConfigMetadata1781842714 |  (optional)

try: 
    # add a network configuration
    api_response = api_instance.create_network_config_metadata(networkConfigMetadata1781842714=networkConfigMetadata1781842714)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkConfigMetadataApi->createNetworkConfigMetadata: %s\n" % e)
extern crate NetworkConfigMetadataApi;

pub fn main() {
    let networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714

    let mut context = NetworkConfigMetadataApi::Context::default();
    let result = client.createNetworkConfigMetadata(networkConfigMetadata1781842714, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Body parameters
Name Description
networkConfigMetadata1781842714

Responses


deleteNetworkConfigMetadata

delete a network configuration

Remove a network configuration template.


/networkConfigMetadata/{networkConfigMetadataId}

Usage and SDK Samples

curl -X DELETE -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkConfigMetadata/{networkConfigMetadataId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkConfigMetadataApi;

import java.io.File;
import java.util.*;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration
        try {
            apiInstance.deleteNetworkConfigMetadata(networkConfigMetadataId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#deleteNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkConfigMetadataApi;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration
        try {
            apiInstance.deleteNetworkConfigMetadata(networkConfigMetadataId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#deleteNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkConfigMetadataId = networkConfigMetadataId_example; // the id of the configuration (default to null)

NetworkConfigMetadataApi *apiInstance = [[NetworkConfigMetadataApi alloc] init];

// delete a network configuration
[apiInstance deleteNetworkConfigMetadataWith:networkConfigMetadataId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkConfigMetadataApi()
var networkConfigMetadataId = networkConfigMetadataId_example; // {String} the id of the configuration

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteNetworkConfigMetadata(networkConfigMetadataId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteNetworkConfigMetadataExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkConfigMetadataApi();
            var networkConfigMetadataId = networkConfigMetadataId_example;  // String | the id of the configuration (default to null)

            try
            {
                // delete a network configuration
                apiInstance.deleteNetworkConfigMetadata(networkConfigMetadataId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkConfigMetadataApi.deleteNetworkConfigMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkConfigMetadataApi();
$networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration

try {
    $api_instance->deleteNetworkConfigMetadata($networkConfigMetadataId);
} catch (Exception $e) {
    echo 'Exception when calling NetworkConfigMetadataApi->deleteNetworkConfigMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkConfigMetadataApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkConfigMetadataApi->new();
my $networkConfigMetadataId = networkConfigMetadataId_example; # String | the id of the configuration

eval { 
    $api_instance->deleteNetworkConfigMetadata(networkConfigMetadataId => $networkConfigMetadataId);
};
if ($@) {
    warn "Exception when calling NetworkConfigMetadataApi->deleteNetworkConfigMetadata: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkConfigMetadataApi()
networkConfigMetadataId = networkConfigMetadataId_example # String | the id of the configuration (default to null)

try: 
    # delete a network configuration
    api_instance.delete_network_config_metadata(networkConfigMetadataId)
except ApiException as e:
    print("Exception when calling NetworkConfigMetadataApi->deleteNetworkConfigMetadata: %s\n" % e)
extern crate NetworkConfigMetadataApi;

pub fn main() {
    let networkConfigMetadataId = networkConfigMetadataId_example; // String

    let mut context = NetworkConfigMetadataApi::Context::default();
    let result = client.deleteNetworkConfigMetadata(networkConfigMetadataId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkConfigMetadataId*
String
the id of the configuration
Required

Responses


findNetworkConfigMetadata

list network configurations

Returns a list of network configuration templates.


/networkConfigMetadata

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkConfigMetadata"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkConfigMetadataApi;

import java.io.File;
import java.util.*;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        try {
            networkConfigMetadata-1344539778 result = apiInstance.findNetworkConfigMetadata();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#findNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkConfigMetadataApi;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        try {
            networkConfigMetadata-1344539778 result = apiInstance.findNetworkConfigMetadata();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#findNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


NetworkConfigMetadataApi *apiInstance = [[NetworkConfigMetadataApi alloc] init];

// list network configurations
[apiInstance findNetworkConfigMetadataWithCompletionHandler: 
              ^(networkConfigMetadata-1344539778 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkConfigMetadataApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNetworkConfigMetadata(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class findNetworkConfigMetadataExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkConfigMetadataApi();

            try
            {
                // list network configurations
                networkConfigMetadata-1344539778 result = apiInstance.findNetworkConfigMetadata();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkConfigMetadataApi.findNetworkConfigMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkConfigMetadataApi();

try {
    $result = $api_instance->findNetworkConfigMetadata();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkConfigMetadataApi->findNetworkConfigMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkConfigMetadataApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkConfigMetadataApi->new();

eval { 
    my $result = $api_instance->findNetworkConfigMetadata();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkConfigMetadataApi->findNetworkConfigMetadata: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkConfigMetadataApi()

try: 
    # list network configurations
    api_response = api_instance.find_network_config_metadata()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkConfigMetadataApi->findNetworkConfigMetadata: %s\n" % e)
extern crate NetworkConfigMetadataApi;

pub fn main() {

    let mut context = NetworkConfigMetadataApi::Context::default();
    let result = client.findNetworkConfigMetadata(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


getNetworkConfigMetadata

fetch a network configuration

Fetch the attributes of a network configuration template by ID.


/networkConfigMetadata/{networkConfigMetadataId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkConfigMetadata/{networkConfigMetadataId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkConfigMetadataApi;

import java.io.File;
import java.util.*;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration
        try {
            networkConfigMetadata-299031831 result = apiInstance.getNetworkConfigMetadata(networkConfigMetadataId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#getNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkConfigMetadataApi;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration
        try {
            networkConfigMetadata-299031831 result = apiInstance.getNetworkConfigMetadata(networkConfigMetadataId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#getNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkConfigMetadataId = networkConfigMetadataId_example; // the id of the configuration (default to null)

NetworkConfigMetadataApi *apiInstance = [[NetworkConfigMetadataApi alloc] init];

// fetch a network configuration
[apiInstance getNetworkConfigMetadataWith:networkConfigMetadataId
              completionHandler: ^(networkConfigMetadata-299031831 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkConfigMetadataApi()
var networkConfigMetadataId = networkConfigMetadataId_example; // {String} the id of the configuration

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkConfigMetadata(networkConfigMetadataId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getNetworkConfigMetadataExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkConfigMetadataApi();
            var networkConfigMetadataId = networkConfigMetadataId_example;  // String | the id of the configuration (default to null)

            try
            {
                // fetch a network configuration
                networkConfigMetadata-299031831 result = apiInstance.getNetworkConfigMetadata(networkConfigMetadataId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkConfigMetadataApi.getNetworkConfigMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkConfigMetadataApi();
$networkConfigMetadataId = networkConfigMetadataId_example; // String | the id of the configuration

try {
    $result = $api_instance->getNetworkConfigMetadata($networkConfigMetadataId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkConfigMetadataApi->getNetworkConfigMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkConfigMetadataApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkConfigMetadataApi->new();
my $networkConfigMetadataId = networkConfigMetadataId_example; # String | the id of the configuration

eval { 
    my $result = $api_instance->getNetworkConfigMetadata(networkConfigMetadataId => $networkConfigMetadataId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkConfigMetadataApi->getNetworkConfigMetadata: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkConfigMetadataApi()
networkConfigMetadataId = networkConfigMetadataId_example # String | the id of the configuration (default to null)

try: 
    # fetch a network configuration
    api_response = api_instance.get_network_config_metadata(networkConfigMetadataId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkConfigMetadataApi->getNetworkConfigMetadata: %s\n" % e)
extern crate NetworkConfigMetadataApi;

pub fn main() {
    let networkConfigMetadataId = networkConfigMetadataId_example; // String

    let mut context = NetworkConfigMetadataApi::Context::default();
    let result = client.getNetworkConfigMetadata(networkConfigMetadataId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkConfigMetadataId*
String
the id of the configuration
Required

Responses


updateNetworkConfigMetadata

redefine a network configuration

Redefine an existing network configuration template.


/networkConfigMetadata/{networkConfigMetadataId}

Usage and SDK Samples

curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkConfigMetadata/{networkConfigMetadataId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkConfigMetadataApi;

import java.io.File;
import java.util.*;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | 
        NetworkConfigMetadata1781842714 networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 
        try {
            networkConfigMetadata-299031831 result = apiInstance.updateNetworkConfigMetadata(networkConfigMetadataId, networkConfigMetadata1781842714);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#updateNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkConfigMetadataApi;

public class NetworkConfigMetadataApiExample {

    public static void main(String[] args) {
        NetworkConfigMetadataApi apiInstance = new NetworkConfigMetadataApi();
        String networkConfigMetadataId = networkConfigMetadataId_example; // String | 
        NetworkConfigMetadata1781842714 networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 
        try {
            networkConfigMetadata-299031831 result = apiInstance.updateNetworkConfigMetadata(networkConfigMetadataId, networkConfigMetadata1781842714);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkConfigMetadataApi#updateNetworkConfigMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkConfigMetadataId = networkConfigMetadataId_example; //  (default to null)
NetworkConfigMetadata1781842714 *networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; //  (optional)

NetworkConfigMetadataApi *apiInstance = [[NetworkConfigMetadataApi alloc] init];

// redefine a network configuration
[apiInstance updateNetworkConfigMetadataWith:networkConfigMetadataId
    networkConfigMetadata1781842714:networkConfigMetadata1781842714
              completionHandler: ^(networkConfigMetadata-299031831 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkConfigMetadataApi()
var networkConfigMetadataId = networkConfigMetadataId_example; // {String} 
var opts = {
  'networkConfigMetadata1781842714': {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
} // {NetworkConfigMetadata1781842714} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateNetworkConfigMetadata(networkConfigMetadataId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateNetworkConfigMetadataExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkConfigMetadataApi();
            var networkConfigMetadataId = networkConfigMetadataId_example;  // String |  (default to null)
            var networkConfigMetadata1781842714 = new NetworkConfigMetadata1781842714(); // NetworkConfigMetadata1781842714 |  (optional) 

            try
            {
                // redefine a network configuration
                networkConfigMetadata-299031831 result = apiInstance.updateNetworkConfigMetadata(networkConfigMetadataId, networkConfigMetadata1781842714);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkConfigMetadataApi.updateNetworkConfigMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkConfigMetadataApi();
$networkConfigMetadataId = networkConfigMetadataId_example; // String | 
$networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714 | 

try {
    $result = $api_instance->updateNetworkConfigMetadata($networkConfigMetadataId, $networkConfigMetadata1781842714);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkConfigMetadataApi->updateNetworkConfigMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkConfigMetadataApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkConfigMetadataApi->new();
my $networkConfigMetadataId = networkConfigMetadataId_example; # String | 
my $networkConfigMetadata1781842714 = WWW::OPenAPIClient::Object::NetworkConfigMetadata1781842714->new(); # NetworkConfigMetadata1781842714 | 

eval { 
    my $result = $api_instance->updateNetworkConfigMetadata(networkConfigMetadataId => $networkConfigMetadataId, networkConfigMetadata1781842714 => $networkConfigMetadata1781842714);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkConfigMetadataApi->updateNetworkConfigMetadata: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkConfigMetadataApi()
networkConfigMetadataId = networkConfigMetadataId_example # String |  (default to null)
networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
} # NetworkConfigMetadata1781842714 |  (optional)

try: 
    # redefine a network configuration
    api_response = api_instance.update_network_config_metadata(networkConfigMetadataId, networkConfigMetadata1781842714=networkConfigMetadata1781842714)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkConfigMetadataApi->updateNetworkConfigMetadata: %s\n" % e)
extern crate NetworkConfigMetadataApi;

pub fn main() {
    let networkConfigMetadataId = networkConfigMetadataId_example; // String
    let networkConfigMetadata1781842714 = {
  "name" : "small",
  "awsNetworkControllerSize" : "T2Medium",
  "awsGatewaySize" : "T2Large",
  "awsTransferNodeSize" : "T2Large",
  "azureTransferNodeSize" : "T2Large",
  "alicloudTransferNodeSize" : "T2Large",
  "gcpTransferNodeSize" : "T2Large",
  "networkControllerVolumeSize" : 20,
  "transferNodeVolumeSize" : 10,
  "gatewayVolumeSize" : 10
}; // NetworkConfigMetadata1781842714

    let mut context = NetworkConfigMetadataApi::Context::default();
    let result = client.updateNetworkConfigMetadata(networkConfigMetadataId, networkConfigMetadata1781842714, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkConfigMetadataId*
String
Required
Body parameters
Name Description
networkConfigMetadata1781842714

Responses


NetworkProcesses

findNetworkProcesses

list processes for network

List running processes for a network.


/network-processes

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/network-processes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkProcessesApi;

import java.io.File;
import java.util.*;

public class NetworkProcessesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkProcessesApi apiInstance = new NetworkProcessesApi();
        try {
            array[Object] result = apiInstance.findNetworkProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkProcessesApi#findNetworkProcesses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkProcessesApi;

public class NetworkProcessesApiExample {

    public static void main(String[] args) {
        NetworkProcessesApi apiInstance = new NetworkProcessesApi();
        try {
            array[Object] result = apiInstance.findNetworkProcesses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkProcessesApi#findNetworkProcesses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


NetworkProcessesApi *apiInstance = [[NetworkProcessesApi alloc] init];

// list processes for network
[apiInstance findNetworkProcessesWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkProcessesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findNetworkProcesses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class findNetworkProcessesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkProcessesApi();

            try
            {
                // list processes for network
                array[Object] result = apiInstance.findNetworkProcesses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkProcessesApi.findNetworkProcesses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkProcessesApi();

try {
    $result = $api_instance->findNetworkProcesses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkProcessesApi->findNetworkProcesses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkProcessesApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkProcessesApi->new();

eval { 
    my $result = $api_instance->findNetworkProcesses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkProcessesApi->findNetworkProcesses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkProcessesApi()

try: 
    # list processes for network
    api_response = api_instance.find_network_processes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkProcessesApi->findNetworkProcesses: %s\n" % e)
extern crate NetworkProcessesApi;

pub fn main() {

    let mut context = NetworkProcessesApi::Context::default();
    let result = client.findNetworkProcesses(&context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Responses


getNetworkProcesses

fetch network processes by key

Fetch network process statuses for a business key.


/network-processes/{businessKey}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/network-processes/{businessKey}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkProcessesApi;

import java.io.File;
import java.util.*;

public class NetworkProcessesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkProcessesApi apiInstance = new NetworkProcessesApi();
        String businessKey = businessKey_example; // String | the business key to filter
        try {
            array[Object] result = apiInstance.getNetworkProcesses(businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkProcessesApi#getNetworkProcesses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkProcessesApi;

public class NetworkProcessesApiExample {

    public static void main(String[] args) {
        NetworkProcessesApi apiInstance = new NetworkProcessesApi();
        String businessKey = businessKey_example; // String | the business key to filter
        try {
            array[Object] result = apiInstance.getNetworkProcesses(businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkProcessesApi#getNetworkProcesses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *businessKey = businessKey_example; // the business key to filter (default to null)

NetworkProcessesApi *apiInstance = [[NetworkProcessesApi alloc] init];

// fetch network processes by key
[apiInstance getNetworkProcessesWith:businessKey
              completionHandler: ^(array[Object] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkProcessesApi()
var businessKey = businessKey_example; // {String} the business key to filter

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetworkProcesses(businessKey, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getNetworkProcessesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkProcessesApi();
            var businessKey = businessKey_example;  // String | the business key to filter (default to null)

            try
            {
                // fetch network processes by key
                array[Object] result = apiInstance.getNetworkProcesses(businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkProcessesApi.getNetworkProcesses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkProcessesApi();
$businessKey = businessKey_example; // String | the business key to filter

try {
    $result = $api_instance->getNetworkProcesses($businessKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkProcessesApi->getNetworkProcesses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkProcessesApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkProcessesApi->new();
my $businessKey = businessKey_example; # String | the business key to filter

eval { 
    my $result = $api_instance->getNetworkProcesses(businessKey => $businessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkProcessesApi->getNetworkProcesses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkProcessesApi()
businessKey = businessKey_example # String | the business key to filter (default to null)

try: 
    # fetch network processes by key
    api_response = api_instance.get_network_processes(businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkProcessesApi->getNetworkProcesses: %s\n" % e)
extern crate NetworkProcessesApi;

pub fn main() {
    let businessKey = businessKey_example; // String

    let mut context = NetworkProcessesApi::Context::default();
    let result = client.getNetworkProcesses(businessKey, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
businessKey*
String
the business key to filter
Required

Responses


Networkgroups

getAllEndpointsForNetworkGroup

List all endpoints for network group.

List all endpoints for network group.


/networkgroups/{networkGroupId}/endpoints

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkgroups/{networkGroupId}/endpoints"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkgroupsApi;

import java.io.File;
import java.util.*;

public class NetworkgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkgroupsApi apiInstance = new NetworkgroupsApi();
        String networkGroupId = networkGroupId_example; // String | the ID of the network group for which to get endpoints
        try {
            networkgroups-networkGroupId-endpoints-592200708 result = apiInstance.getAllEndpointsForNetworkGroup(networkGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkgroupsApi#getAllEndpointsForNetworkGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkgroupsApi;

public class NetworkgroupsApiExample {

    public static void main(String[] args) {
        NetworkgroupsApi apiInstance = new NetworkgroupsApi();
        String networkGroupId = networkGroupId_example; // String | the ID of the network group for which to get endpoints
        try {
            networkgroups-networkGroupId-endpoints-592200708 result = apiInstance.getAllEndpointsForNetworkGroup(networkGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkgroupsApi#getAllEndpointsForNetworkGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkGroupId = networkGroupId_example; // the ID of the network group for which to get endpoints (default to null)

NetworkgroupsApi *apiInstance = [[NetworkgroupsApi alloc] init];

// List all endpoints for network group.
[apiInstance getAllEndpointsForNetworkGroupWith:networkGroupId
              completionHandler: ^(networkgroups-networkGroupId-endpoints-592200708 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkgroupsApi()
var networkGroupId = networkGroupId_example; // {String} the ID of the network group for which to get endpoints

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllEndpointsForNetworkGroup(networkGroupId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllEndpointsForNetworkGroupExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkgroupsApi();
            var networkGroupId = networkGroupId_example;  // String | the ID of the network group for which to get endpoints (default to null)

            try
            {
                // List all endpoints for network group.
                networkgroups-networkGroupId-endpoints-592200708 result = apiInstance.getAllEndpointsForNetworkGroup(networkGroupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkgroupsApi.getAllEndpointsForNetworkGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkgroupsApi();
$networkGroupId = networkGroupId_example; // String | the ID of the network group for which to get endpoints

try {
    $result = $api_instance->getAllEndpointsForNetworkGroup($networkGroupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkgroupsApi->getAllEndpointsForNetworkGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkgroupsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkgroupsApi->new();
my $networkGroupId = networkGroupId_example; # String | the ID of the network group for which to get endpoints

eval { 
    my $result = $api_instance->getAllEndpointsForNetworkGroup(networkGroupId => $networkGroupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkgroupsApi->getAllEndpointsForNetworkGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkgroupsApi()
networkGroupId = networkGroupId_example # String | the ID of the network group for which to get endpoints (default to null)

try: 
    # List all endpoints for network group.
    api_response = api_instance.get_all_endpoints_for_network_group(networkGroupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkgroupsApi->getAllEndpointsForNetworkGroup: %s\n" % e)
extern crate NetworkgroupsApi;

pub fn main() {
    let networkGroupId = networkGroupId_example; // String

    let mut context = NetworkgroupsApi::Context::default();
    let result = client.getAllEndpointsForNetworkGroup(networkGroupId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkGroupId*
String
the ID of the network group for which to get endpoints
Required

Responses


getAllServicesForNetworkGroup

list services for network group

Returns a list of all of the services in networks that are in a network group.


/networkgroups/{networkGroupId}/services

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networkgroups/{networkGroupId}/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworkgroupsApi;

import java.io.File;
import java.util.*;

public class NetworkgroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworkgroupsApi apiInstance = new NetworkgroupsApi();
        String networkGroupId = networkGroupId_example; // String | the id of the network group
        try {
            networkgroups-networkGroupId-services-1977395650 result = apiInstance.getAllServicesForNetworkGroup(networkGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkgroupsApi#getAllServicesForNetworkGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworkgroupsApi;

public class NetworkgroupsApiExample {

    public static void main(String[] args) {
        NetworkgroupsApi apiInstance = new NetworkgroupsApi();
        String networkGroupId = networkGroupId_example; // String | the id of the network group
        try {
            networkgroups-networkGroupId-services-1977395650 result = apiInstance.getAllServicesForNetworkGroup(networkGroupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkgroupsApi#getAllServicesForNetworkGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkGroupId = networkGroupId_example; // the id of the network group (default to null)

NetworkgroupsApi *apiInstance = [[NetworkgroupsApi alloc] init];

// list services for network group
[apiInstance getAllServicesForNetworkGroupWith:networkGroupId
              completionHandler: ^(networkgroups-networkGroupId-services-1977395650 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworkgroupsApi()
var networkGroupId = networkGroupId_example; // {String} the id of the network group

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllServicesForNetworkGroup(networkGroupId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAllServicesForNetworkGroupExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworkgroupsApi();
            var networkGroupId = networkGroupId_example;  // String | the id of the network group (default to null)

            try
            {
                // list services for network group
                networkgroups-networkGroupId-services-1977395650 result = apiInstance.getAllServicesForNetworkGroup(networkGroupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkgroupsApi.getAllServicesForNetworkGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworkgroupsApi();
$networkGroupId = networkGroupId_example; // String | the id of the network group

try {
    $result = $api_instance->getAllServicesForNetworkGroup($networkGroupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkgroupsApi->getAllServicesForNetworkGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworkgroupsApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworkgroupsApi->new();
my $networkGroupId = networkGroupId_example; # String | the id of the network group

eval { 
    my $result = $api_instance->getAllServicesForNetworkGroup(networkGroupId => $networkGroupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkgroupsApi->getAllServicesForNetworkGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworkgroupsApi()
networkGroupId = networkGroupId_example # String | the id of the network group (default to null)

try: 
    # list services for network group
    api_response = api_instance.get_all_services_for_network_group(networkGroupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkgroupsApi->getAllServicesForNetworkGroup: %s\n" % e)
extern crate NetworkgroupsApi;

pub fn main() {
    let networkGroupId = networkGroupId_example; // String

    let mut context = NetworkgroupsApi::Context::default();
    let result = client.getAllServicesForNetworkGroup(networkGroupId, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkGroupId*
String
the id of the network group
Required

Responses


Networks

addEndpointGroupToAppWan

Authorize an endpoint group

Authorize a group of endpoints to initiate connections to all services in an AppWAN.


/networks/{networkId}/appWans/{appWanId}/endpointGroups

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/appWans/{appWanId}/endpointGroups"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointGroupToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointGroupToAppWan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointGroupToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointGroupToAppWan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
String *appWanId = appWanId_example; // the id of the AppWAN (default to null)
NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 *networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// Authorize an endpoint group
[apiInstance addEndpointGroupToAppWanWith:networkId
    appWanId:appWanId
    networksNetworkIdAppWansAppWanIdEndpointGroups210048416:networksNetworkIdAppWansAppWanIdEndpointGroups210048416
              completionHandler: ^(networks-networkId-appWans-appWanId-services484785527 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var appWanId = appWanId_example; // {String} the id of the AppWAN
var opts = {
  'networksNetworkIdAppWansAppWanIdEndpointGroups210048416': {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
} // {NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addEndpointGroupToAppWan(networkId, appWanId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addEndpointGroupToAppWanExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var appWanId = appWanId_example;  // String | the id of the AppWAN (default to null)
            var networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = new NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416(); // NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 |  (optional) 

            try
            {
                // Authorize an endpoint group
                networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointGroupToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.addEndpointGroupToAppWan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$appWanId = appWanId_example; // String | the id of the AppWAN
$networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 | 

try {
    $result = $api_instance->addEndpointGroupToAppWan($networkId, $appWanId, $networksNetworkIdAppWansAppWanIdEndpointGroups210048416);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->addEndpointGroupToAppWan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $appWanId = appWanId_example; # String | the id of the AppWAN
my $networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = WWW::OPenAPIClient::Object::NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416->new(); # NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 | 

eval { 
    my $result = $api_instance->addEndpointGroupToAppWan(networkId => $networkId, appWanId => $appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416 => $networksNetworkIdAppWansAppWanIdEndpointGroups210048416);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->addEndpointGroupToAppWan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
appWanId = appWanId_example # String | the id of the AppWAN (default to null)
networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
} # NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416 |  (optional)

try: 
    # Authorize an endpoint group
    api_response = api_instance.add_endpoint_group_to_app_wan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416=networksNetworkIdAppWansAppWanIdEndpointGroups210048416)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->addEndpointGroupToAppWan: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let appWanId = appWanId_example; // String
    let networksNetworkIdAppWansAppWanIdEndpointGroups210048416 = {
  "ids" : [ "d47fc529-9338-4360-818d-dd1a388bc425", "71cbdf9a-55af-406e-bd01-0f554c40a91f" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpointGroups210048416

    let mut context = NetworksApi::Context::default();
    let result = client.addEndpointGroupToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpointGroups210048416, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
appWanId*
String
the id of the AppWAN
Required
Body parameters
Name Description
networksNetworkIdAppWansAppWanIdEndpointGroups210048416

Responses


addEndpointsToAppWan

Authorize one or more endpoints

Authorize one or more endpoints, which are "clients" or "gateways", to initiate connections to any service in an AppWAN.


/networks/{networkId}/appWans/{appWanId}/endpoints

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/appWans/{appWanId}/endpoints"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdEndpoints802034737 networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpoints802034737 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointsToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointsToAppWan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdEndpoints802034737 networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpoints802034737 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointsToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointsToAppWan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
String *appWanId = appWanId_example; // the id of the AppWAN (default to null)
NetworksNetworkIdAppWansAppWanIdEndpoints802034737 *networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// Authorize one or more endpoints
[apiInstance addEndpointsToAppWanWith:networkId
    appWanId:appWanId
    networksNetworkIdAppWansAppWanIdEndpoints802034737:networksNetworkIdAppWansAppWanIdEndpoints802034737
              completionHandler: ^(networks-networkId-appWans-appWanId-services484785527 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var appWanId = appWanId_example; // {String} the id of the AppWAN
var opts = {
  'networksNetworkIdAppWansAppWanIdEndpoints802034737': {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
} // {NetworksNetworkIdAppWansAppWanIdEndpoints802034737} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addEndpointsToAppWan(networkId, appWanId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addEndpointsToAppWanExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var appWanId = appWanId_example;  // String | the id of the AppWAN (default to null)
            var networksNetworkIdAppWansAppWanIdEndpoints802034737 = new NetworksNetworkIdAppWansAppWanIdEndpoints802034737(); // NetworksNetworkIdAppWansAppWanIdEndpoints802034737 |  (optional) 

            try
            {
                // Authorize one or more endpoints
                networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addEndpointsToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.addEndpointsToAppWan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$appWanId = appWanId_example; // String | the id of the AppWAN
$networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpoints802034737 | 

try {
    $result = $api_instance->addEndpointsToAppWan($networkId, $appWanId, $networksNetworkIdAppWansAppWanIdEndpoints802034737);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->addEndpointsToAppWan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $appWanId = appWanId_example; # String | the id of the AppWAN
my $networksNetworkIdAppWansAppWanIdEndpoints802034737 = WWW::OPenAPIClient::Object::NetworksNetworkIdAppWansAppWanIdEndpoints802034737->new(); # NetworksNetworkIdAppWansAppWanIdEndpoints802034737 | 

eval { 
    my $result = $api_instance->addEndpointsToAppWan(networkId => $networkId, appWanId => $appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737 => $networksNetworkIdAppWansAppWanIdEndpoints802034737);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->addEndpointsToAppWan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
appWanId = appWanId_example # String | the id of the AppWAN (default to null)
networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
} # NetworksNetworkIdAppWansAppWanIdEndpoints802034737 |  (optional)

try: 
    # Authorize one or more endpoints
    api_response = api_instance.add_endpoints_to_app_wan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737=networksNetworkIdAppWansAppWanIdEndpoints802034737)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->addEndpointsToAppWan: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let appWanId = appWanId_example; // String
    let networksNetworkIdAppWansAppWanIdEndpoints802034737 = {
  "ids" : [ "f61c495a-c065-4d4e-8b7d-33d29b5f77e0", "72f4fc69-1f5c-4a30-b8ac-8904c8e7281e" ]
}; // NetworksNetworkIdAppWansAppWanIdEndpoints802034737

    let mut context = NetworksApi::Context::default();
    let result = client.addEndpointsToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdEndpoints802034737, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
appWanId*
String
the id of the AppWAN
Required
Body parameters
Name Description
networksNetworkIdAppWansAppWanIdEndpoints802034737

Responses


addEndpointsToEndpointGroup

add endpoints to group

Add client or gateway endpoints to a group. Groups may be added to an AppWAN.


/networks/{networkId}/endpointGroups/{endpointGroupId}/endpoints

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/endpointGroups/{endpointGroupId}/endpoints"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String endpointGroupId = endpointGroupId_example; // String | the id of the endpoint group
        Object body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
}; // Object | 
        try {
            networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.addEndpointsToEndpointGroup(networkId, endpointGroupId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointsToEndpointGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String endpointGroupId = endpointGroupId_example; // String | the id of the endpoint group
        Object body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
}; // Object | 
        try {
            networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.addEndpointsToEndpointGroup(networkId, endpointGroupId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addEndpointsToEndpointGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
String *endpointGroupId = endpointGroupId_example; // the id of the endpoint group (default to null)
Object *body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// add endpoints to group
[apiInstance addEndpointsToEndpointGroupWith:networkId
    endpointGroupId:endpointGroupId
    body:body
              completionHandler: ^(networks-networkId-endpointGroups-endpointGroupId-110776441 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var endpointGroupId = endpointGroupId_example; // {String} the id of the endpoint group
var opts = {
  'body': {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
} // {Object} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addEndpointsToEndpointGroup(networkId, endpointGroupId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addEndpointsToEndpointGroupExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var endpointGroupId = endpointGroupId_example;  // String | the id of the endpoint group (default to null)
            var body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
};  // Object |  (optional) 

            try
            {
                // add endpoints to group
                networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.addEndpointsToEndpointGroup(networkId, endpointGroupId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.addEndpointsToEndpointGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$endpointGroupId = endpointGroupId_example; // String | the id of the endpoint group
$body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
}; // Object | 

try {
    $result = $api_instance->addEndpointsToEndpointGroup($networkId, $endpointGroupId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->addEndpointsToEndpointGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $endpointGroupId = endpointGroupId_example; # String | the id of the endpoint group
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval { 
    my $result = $api_instance->addEndpointsToEndpointGroup(networkId => $networkId, endpointGroupId => $endpointGroupId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->addEndpointsToEndpointGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
endpointGroupId = endpointGroupId_example # String | the id of the endpoint group (default to null)
body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
} # Object |  (optional)

try: 
    # add endpoints to group
    api_response = api_instance.add_endpoints_to_endpoint_group(networkId, endpointGroupId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->addEndpointsToEndpointGroup: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let endpointGroupId = endpointGroupId_example; // String
    let body = {
  "ids" : [ "e4dcb0c0-5226-4e4b-8091-59e92a6253eb", "6184cfd9-3c84-455b-b170-2d8908aa024e" ]
}; // Object

    let mut context = NetworksApi::Context::default();
    let result = client.addEndpointsToEndpointGroup(networkId, endpointGroupId, body, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
endpointGroupId*
String
the id of the endpoint group
Required
Body parameters
Name Description
body

Responses


addServicesToAppWan

Authorize one or more services

Authorize all endpoints in an AppWAN to initiate connections to one or more services additional services.


/networks/{networkId}/appWans/{appWanId}/services

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/appWans/{appWanId}/services"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdServices555046397 networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
}; // NetworksNetworkIdAppWansAppWanIdServices555046397 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addServicesToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdServices555046397);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addServicesToAppWan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        String appWanId = appWanId_example; // String | the id of the AppWAN
        NetworksNetworkIdAppWansAppWanIdServices555046397 networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
}; // NetworksNetworkIdAppWansAppWanIdServices555046397 | 
        try {
            networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addServicesToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdServices555046397);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#addServicesToAppWan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
String *appWanId = appWanId_example; // the id of the AppWAN (default to null)
NetworksNetworkIdAppWansAppWanIdServices555046397 *networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// Authorize one or more services
[apiInstance addServicesToAppWanWith:networkId
    appWanId:appWanId
    networksNetworkIdAppWansAppWanIdServices555046397:networksNetworkIdAppWansAppWanIdServices555046397
              completionHandler: ^(networks-networkId-appWans-appWanId-services484785527 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var appWanId = appWanId_example; // {String} the id of the AppWAN
var opts = {
  'networksNetworkIdAppWansAppWanIdServices555046397': {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
} // {NetworksNetworkIdAppWansAppWanIdServices555046397} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addServicesToAppWan(networkId, appWanId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class addServicesToAppWanExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var appWanId = appWanId_example;  // String | the id of the AppWAN (default to null)
            var networksNetworkIdAppWansAppWanIdServices555046397 = new NetworksNetworkIdAppWansAppWanIdServices555046397(); // NetworksNetworkIdAppWansAppWanIdServices555046397 |  (optional) 

            try
            {
                // Authorize one or more services
                networks-networkId-appWans-appWanId-services484785527 result = apiInstance.addServicesToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdServices555046397);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.addServicesToAppWan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$appWanId = appWanId_example; // String | the id of the AppWAN
$networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
}; // NetworksNetworkIdAppWansAppWanIdServices555046397 | 

try {
    $result = $api_instance->addServicesToAppWan($networkId, $appWanId, $networksNetworkIdAppWansAppWanIdServices555046397);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->addServicesToAppWan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $appWanId = appWanId_example; # String | the id of the AppWAN
my $networksNetworkIdAppWansAppWanIdServices555046397 = WWW::OPenAPIClient::Object::NetworksNetworkIdAppWansAppWanIdServices555046397->new(); # NetworksNetworkIdAppWansAppWanIdServices555046397 | 

eval { 
    my $result = $api_instance->addServicesToAppWan(networkId => $networkId, appWanId => $appWanId, networksNetworkIdAppWansAppWanIdServices555046397 => $networksNetworkIdAppWansAppWanIdServices555046397);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->addServicesToAppWan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
appWanId = appWanId_example # String | the id of the AppWAN (default to null)
networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
} # NetworksNetworkIdAppWansAppWanIdServices555046397 |  (optional)

try: 
    # Authorize one or more services
    api_response = api_instance.add_services_to_app_wan(networkId, appWanId, networksNetworkIdAppWansAppWanIdServices555046397=networksNetworkIdAppWansAppWanIdServices555046397)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->addServicesToAppWan: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let appWanId = appWanId_example; // String
    let networksNetworkIdAppWansAppWanIdServices555046397 = {
  "ids" : [ "bc8e5980-6d23-4216-a596-8444387d2e4d", "a38f8324-c4e8-46fb-a5eb-e59ab8427aa3" ]
}; // NetworksNetworkIdAppWansAppWanIdServices555046397

    let mut context = NetworksApi::Context::default();
    let result = client.addServicesToAppWan(networkId, appWanId, networksNetworkIdAppWansAppWanIdServices555046397, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
appWanId*
String
the id of the AppWAN
Required
Body parameters
Name Description
networksNetworkIdAppWansAppWanIdServices555046397

Responses


createAppWan

Initialize an empty AppWAN

Initialize an empty AppWAN for authorizations that will be added later.


/networks/{networkId}/appWans

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/appWans"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdAppWans751732740 networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
}; // NetworksNetworkIdAppWans751732740 | 
        try {
            networks-networkId-appWans-2073924989 result = apiInstance.createAppWan(networkId, networksNetworkIdAppWans751732740);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createAppWan");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdAppWans751732740 networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
}; // NetworksNetworkIdAppWans751732740 | 
        try {
            networks-networkId-appWans-2073924989 result = apiInstance.createAppWan(networkId, networksNetworkIdAppWans751732740);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createAppWan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
NetworksNetworkIdAppWans751732740 *networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// Initialize an empty AppWAN
[apiInstance createAppWanWith:networkId
    networksNetworkIdAppWans751732740:networksNetworkIdAppWans751732740
              completionHandler: ^(networks-networkId-appWans-2073924989 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var opts = {
  'networksNetworkIdAppWans751732740': {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
} // {NetworksNetworkIdAppWans751732740} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAppWan(networkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createAppWanExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var networksNetworkIdAppWans751732740 = new NetworksNetworkIdAppWans751732740(); // NetworksNetworkIdAppWans751732740 |  (optional) 

            try
            {
                // Initialize an empty AppWAN
                networks-networkId-appWans-2073924989 result = apiInstance.createAppWan(networkId, networksNetworkIdAppWans751732740);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.createAppWan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
}; // NetworksNetworkIdAppWans751732740 | 

try {
    $result = $api_instance->createAppWan($networkId, $networksNetworkIdAppWans751732740);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->createAppWan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $networksNetworkIdAppWans751732740 = WWW::OPenAPIClient::Object::NetworksNetworkIdAppWans751732740->new(); # NetworksNetworkIdAppWans751732740 | 

eval { 
    my $result = $api_instance->createAppWan(networkId => $networkId, networksNetworkIdAppWans751732740 => $networksNetworkIdAppWans751732740);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->createAppWan: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
} # NetworksNetworkIdAppWans751732740 |  (optional)

try: 
    # Initialize an empty AppWAN
    api_response = api_instance.create_app_wan(networkId, networksNetworkIdAppWans751732740=networksNetworkIdAppWans751732740)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->createAppWan: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let networksNetworkIdAppWans751732740 = {
  "name" : "Test AppWan Create",
  "subscriptionId" : "49822a5e-6888-4e9b-aab9-753517086783"
}; // NetworksNetworkIdAppWans751732740

    let mut context = NetworksApi::Context::default();
    let result = client.createAppWan(networkId, networksNetworkIdAppWans751732740, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
Body parameters
Name Description
networksNetworkIdAppWans751732740

Responses


createCertificateAuthority

create a CA

Create a certificate authority for this network.


/networks/{networkId}/cas

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/cas"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdCas844953516 networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
}; // NetworksNetworkIdCas844953516 | 
        try {
            networks-networkId-cas-caId749087399 result = apiInstance.createCertificateAuthority(networkId, networksNetworkIdCas844953516);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createCertificateAuthority");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdCas844953516 networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
}; // NetworksNetworkIdCas844953516 | 
        try {
            networks-networkId-cas-caId749087399 result = apiInstance.createCertificateAuthority(networkId, networksNetworkIdCas844953516);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createCertificateAuthority");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
NetworksNetworkIdCas844953516 *networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// create a CA
[apiInstance createCertificateAuthorityWith:networkId
    networksNetworkIdCas844953516:networksNetworkIdCas844953516
              completionHandler: ^(networks-networkId-cas-caId749087399 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var opts = {
  'networksNetworkIdCas844953516': {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
} // {NetworksNetworkIdCas844953516} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCertificateAuthority(networkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCertificateAuthorityExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var networksNetworkIdCas844953516 = new NetworksNetworkIdCas844953516(); // NetworksNetworkIdCas844953516 |  (optional) 

            try
            {
                // create a CA
                networks-networkId-cas-caId749087399 result = apiInstance.createCertificateAuthority(networkId, networksNetworkIdCas844953516);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.createCertificateAuthority: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
}; // NetworksNetworkIdCas844953516 | 

try {
    $result = $api_instance->createCertificateAuthority($networkId, $networksNetworkIdCas844953516);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->createCertificateAuthority: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $networksNetworkIdCas844953516 = WWW::OPenAPIClient::Object::NetworksNetworkIdCas844953516->new(); # NetworksNetworkIdCas844953516 | 

eval { 
    my $result = $api_instance->createCertificateAuthority(networkId => $networkId, networksNetworkIdCas844953516 => $networksNetworkIdCas844953516);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->createCertificateAuthority: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
} # NetworksNetworkIdCas844953516 |  (optional)

try: 
    # create a CA
    api_response = api_instance.create_certificate_authority(networkId, networksNetworkIdCas844953516=networksNetworkIdCas844953516)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->createCertificateAuthority: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let networksNetworkIdCas844953516 = {
  "name" : "Test CertificateAuthorityResponse 01",
  "certPem" : "Cert PEM",
  "isAutoCaEnrollmentEnabled" : true,
  "isAuthEnabled" : true,
  "isOttCaEnrollmentEnabled" : false
}; // NetworksNetworkIdCas844953516

    let mut context = NetworksApi::Context::default();
    let result = client.createCertificateAuthority(networkId, networksNetworkIdCas844953516, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
Body parameters
Name Description
networksNetworkIdCas844953516

Responses


createEndpointGroup

create an endpoint group

Create a group of endpoints. This allows some endpoints to be added together to an AppWAN.


/networks/{networkId}/endpointGroups

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/endpointGroups"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
}; // NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 | 
        try {
            networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.createEndpointGroup(networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createEndpointGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the id of the network
        NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
}; // NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 | 
        try {
            networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.createEndpointGroup(networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createEndpointGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the id of the network (default to null)
NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 *networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// create an endpoint group
[apiInstance createEndpointGroupWith:networkId
    networksNetworkIdEndpointGroupsEndpointGroupId453849676:networksNetworkIdEndpointGroupsEndpointGroupId453849676
              completionHandler: ^(networks-networkId-endpointGroups-endpointGroupId-110776441 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the id of the network
var opts = {
  'networksNetworkIdEndpointGroupsEndpointGroupId453849676': {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
} // {NetworksNetworkIdEndpointGroupsEndpointGroupId453849676} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEndpointGroup(networkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createEndpointGroupExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the id of the network (default to null)
            var networksNetworkIdEndpointGroupsEndpointGroupId453849676 = new NetworksNetworkIdEndpointGroupsEndpointGroupId453849676(); // NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 |  (optional) 

            try
            {
                // create an endpoint group
                networks-networkId-endpointGroups-endpointGroupId-110776441 result = apiInstance.createEndpointGroup(networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.createEndpointGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the id of the network
$networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
}; // NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 | 

try {
    $result = $api_instance->createEndpointGroup($networkId, $networksNetworkIdEndpointGroupsEndpointGroupId453849676);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworksApi->createEndpointGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NetworksApi;

# Configure HTTP basic authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::username = 'YOUR_USERNAME';
$WWW::OPenAPIClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::OPenAPIClient::NetworksApi->new();
my $networkId = networkId_example; # String | the id of the network
my $networksNetworkIdEndpointGroupsEndpointGroupId453849676 = WWW::OPenAPIClient::Object::NetworksNetworkIdEndpointGroupsEndpointGroupId453849676->new(); # NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 | 

eval { 
    my $result = $api_instance->createEndpointGroup(networkId => $networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676 => $networksNetworkIdEndpointGroupsEndpointGroupId453849676);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworksApi->createEndpointGroup: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: bearerAuth
openapi_client.configuration.username = 'YOUR_USERNAME'
openapi_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = openapi_client.NetworksApi()
networkId = networkId_example # String | the id of the network (default to null)
networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
} # NetworksNetworkIdEndpointGroupsEndpointGroupId453849676 |  (optional)

try: 
    # create an endpoint group
    api_response = api_instance.create_endpoint_group(networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676=networksNetworkIdEndpointGroupsEndpointGroupId453849676)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworksApi->createEndpointGroup: %s\n" % e)
extern crate NetworksApi;

pub fn main() {
    let networkId = networkId_example; // String
    let networksNetworkIdEndpointGroupsEndpointGroupId453849676 = {
  "name" : "Test Endpoint Group 01",
  "source" : null,
  "syncId" : null
}; // NetworksNetworkIdEndpointGroupsEndpointGroupId453849676

    let mut context = NetworksApi::Context::default();
    let result = client.createEndpointGroup(networkId, networksNetworkIdEndpointGroupsEndpointGroupId453849676, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
networkId*
String
the id of the network
Required
Body parameters
Name Description
networksNetworkIdEndpointGroupsEndpointGroupId453849676

Responses


createEndpointsFromCsv

Create a node(s) on the edge of your network.

An endpoint is a node on the edge of your network. Protected network traffic flows to, from, and through endpoints. Clients and gateways are initiating endpoints from which traffic flows toward services. Services are terminated by an endpoint to which traffic flows from clients and gateways. An endpoint in an AppWAN may represent an app, a device, or some IP addresses. For example, * An app that is built with a Ziti Endpoint SDK is an embedded endpoint, and * a device where Tunneler is running is a client endpoint, and * a router where Tunneler is running is a gateway endpoint forwarding for some IP addresses. See the schema here for possible values for the fields. The most commonly-used fields are name, endpointType, geoRegionId. It is also possible to upload a CSV file to this endpoint. Headings are: * NAME: a required, meaningful string that is unique within this network * ENDPOINTTYPE: required all-caps string without whitespace e.g. "VCPEGW". All possible values described in the schema for create-endpoint * GEOREGION: optional but preferred location field. The display name of the geographic region i.e. attribute *name* from /rest/v1/geoRegions. * DATACENTER: This optional and alterative to the preferred location field: GEOREGION. The display name of the specific datacenter in a georegion i.e. attribute *locationName* from /rest/v1/dataCenters. * PROVIDER: optional value specifying dataCenter cloud provider from /rest/v1/dataCenters attribute *provider*.


/networks/{networkId}/endpoints

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://gateway.production.netfoundry.io/rest/v1/networks/{networkId}/endpoints"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NetworksApi;

import java.io.File;
import java.util.*;

public class NetworksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBasicAuth bearerAuth = (HttpBasicAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setUsername("YOUR USERNAME");
        bearerAuth.setPassword("YOUR PASSWORD");
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the ID of the network
        NetworksNetworkIdEndpoints928479263 networksNetworkIdEndpoints928479263 = {
  "name" : "Test Endpoint 01",
  "endpointType" : "GW",
  "geoRegionId" : "15095af7-689e-46c5-95bf-2772116a65c0",
  "dataCenterId" : null,
  "haEndpointType" : "HAGW",
  "o365BreakoutNextHopIp" : null,
  "source" : null,
  "syncId" : null,
  "clientMfaEnable" : "NO",
  "subscriptionId" : null,
  "countryId" : null,
  "sessionIdentityId" : null
}; // NetworksNetworkIdEndpoints928479263 | 
        try {
            networks-networkId-endpoints327607540 result = apiInstance.createEndpointsFromCsv(networkId, networksNetworkIdEndpoints928479263);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createEndpointsFromCsv");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NetworksApi;

public class NetworksApiExample {

    public static void main(String[] args) {
        NetworksApi apiInstance = new NetworksApi();
        String networkId = networkId_example; // String | the ID of the network
        NetworksNetworkIdEndpoints928479263 networksNetworkIdEndpoints928479263 = {
  "name" : "Test Endpoint 01",
  "endpointType" : "GW",
  "geoRegionId" : "15095af7-689e-46c5-95bf-2772116a65c0",
  "dataCenterId" : null,
  "haEndpointType" : "HAGW",
  "o365BreakoutNextHopIp" : null,
  "source" : null,
  "syncId" : null,
  "clientMfaEnable" : "NO",
  "subscriptionId" : null,
  "countryId" : null,
  "sessionIdentityId" : null
}; // NetworksNetworkIdEndpoints928479263 | 
        try {
            networks-networkId-endpoints327607540 result = apiInstance.createEndpointsFromCsv(networkId, networksNetworkIdEndpoints928479263);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworksApi#createEndpointsFromCsv");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: bearerAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *networkId = networkId_example; // the ID of the network (default to null)
NetworksNetworkIdEndpoints928479263 *networksNetworkIdEndpoints928479263 = {
  "name" : "Test Endpoint 01",
  "endpointType" : "GW",
  "geoRegionId" : "15095af7-689e-46c5-95bf-2772116a65c0",
  "dataCenterId" : null,
  "haEndpointType" : "HAGW",
  "o365BreakoutNextHopIp" : null,
  "source" : null,
  "syncId" : null,
  "clientMfaEnable" : "NO",
  "subscriptionId" : null,
  "countryId" : null,
  "sessionIdentityId" : null
}; //  (optional)

NetworksApi *apiInstance = [[NetworksApi alloc] init];

// Create a node(s) on the edge of your network.
[apiInstance createEndpointsFromCsvWith:networkId
    networksNetworkIdEndpoints928479263:networksNetworkIdEndpoints928479263
              completionHandler: ^(networks-networkId-endpoints327607540 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NetFoundryPublicRestApi = require('net_foundry_public_rest_api');
var defaultClient = NetFoundryPublicRestApi.ApiClient.instance;

// Configure HTTP basic authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.username = 'YOUR USERNAME'
bearerAuth.password = 'YOUR PASSWORD'

var api = new NetFoundryPublicRestApi.NetworksApi()
var networkId = networkId_example; // {String} the ID of the network
var opts = {
  'networksNetworkIdEndpoints928479263': {
  "name" : "Test Endpoint 01",
  "endpointType" : "GW",
  "geoRegionId" : "15095af7-689e-46c5-95bf-2772116a65c0",
  "dataCenterId" : null,
  "haEndpointType" : "HAGW",
  "o365BreakoutNextHopIp" : null,
  "source" : null,
  "syncId" : null,
  "clientMfaEnable" : "NO",
  "subscriptionId" : null,
  "countryId" : null,
  "sessionIdentityId" : null
} // {NetworksNetworkIdEndpoints928479263} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEndpointsFromCsv(networkId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createEndpointsFromCsvExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NetworksApi();
            var networkId = networkId_example;  // String | the ID of the network (default to null)
            var networksNetworkIdEndpoints928479263 = new NetworksNetworkIdEndpoints928479263(); // NetworksNetworkIdEndpoints928479263 |  (optional) 

            try
            {
                // Create a node(s) on the edge of your network.
                networks-networkId-endpoints327607540 result = apiInstance.createEndpointsFromCsv(networkId, networksNetworkIdEndpoints928479263);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworksApi.createEndpointsFromCsv: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new OpenAPITools\Client\Api\NetworksApi();
$networkId = networkId_example; // String | the ID of the network
$networksNetworkIdEndpoints928479263 = {
  "name" : "Test Endpoint 01",
  "endpointType" : "GW",
  "geoRegionId" : "15095af7-689e-46c5-95bf-2772116a65c0",
  "dataCenterId" : null,
  "haEndpointType" : "HAGW",
  "o365BreakoutNextHopIp" :