F5 Application Services API

ApplicationManagement

createApplication

Create an application from a template

This is the main method to deploy a templated application. The parameters posted will be used to render a template, and that template will get posted to AS3. The call to AS3 may be async, so this endpoint must also be async. A task will be returned upon successful parameter submission that can track the progress of the deployment.


/applications

Usage and SDK Samples

curl -X POST "/mgmt/shared/fast/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationManagementApi;

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

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        Task body = ; // Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.

        try {
            TaskCreation result = apiInstance.createApplication(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#createApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationManagementApi;

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        Task body = ; // Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.

        try {
            TaskCreation result = apiInstance.createApplication(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#createApplication");
            e.printStackTrace();
        }
    }
}
Task *body = ; // A task definition, including the name of the template to run and the parameters needed
to render and post the output.


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

// Create an application from a template
[apiInstance createApplicationWith:body
              completionHandler: ^(TaskCreation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.ApplicationManagementApi()
var body = ; // {{Task}} A task definition, including the name of the template to run and the parameters needed
to render and post the output.


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

namespace Example
{
    public class createApplicationExample
    {
        public void main()
        {

            var apiInstance = new ApplicationManagementApi();
            var body = new Task(); // Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.


            try
            {
                // Create an application from a template
                TaskCreation result = apiInstance.createApplication(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationManagementApi.createApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationManagementApi();
$body = ; // Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.


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

my $api_instance = WWW::SwaggerClient::ApplicationManagementApi->new();
my $body = WWW::SwaggerClient::Object::Task->new(); # Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.


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

# create an instance of the API class
api_instance = swagger_client.ApplicationManagementApi()
body =  # Task | A task definition, including the name of the template to run and the parameters needed
to render and post the output.


try: 
    # Create an application from a template
    api_response = api_instance.create_application(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationManagementApi->createApplication: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Template Job Submitted Successfully, check the provided task id to get the status of the deployment

Status: default - unexpected error


getAllApplications

Fetch List of FAST Applications

Responds with a list of applications that are currently deployed in the system.


/applications

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationManagementApi;

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

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        try {
            apiInstance.getAllApplications();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#getAllApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationManagementApi;

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        try {
            apiInstance.getAllApplications();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#getAllApplications");
            e.printStackTrace();
        }
    }
}

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

// Fetch List of FAST Applications
[apiInstance getAllApplicationsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.ApplicationManagementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAllApplications(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllApplicationsExample
    {
        public void main()
        {

            var apiInstance = new ApplicationManagementApi();

            try
            {
                // Fetch List of FAST Applications
                apiInstance.getAllApplications();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationManagementApi.getAllApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationManagementApi();

try {
    $api_instance->getAllApplications();
} catch (Exception $e) {
    echo 'Exception when calling ApplicationManagementApi->getAllApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationManagementApi;

my $api_instance = WWW::SwaggerClient::ApplicationManagementApi->new();

eval { 
    $api_instance->getAllApplications();
};
if ($@) {
    warn "Exception when calling ApplicationManagementApi->getAllApplications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationManagementApi()

try: 
    # Fetch List of FAST Applications
    api_instance.get_all_applications()
except ApiException as e:
    print("Exception when calling ApplicationManagementApi->getAllApplications: %s\n" % e)

Parameters

Responses

Status: 200 - OK


getApplication

Fetch an individual application

Fetches the detail view of an individual mystique application


/applications/{appName}

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/applications/{appName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationManagementApi;

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

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        String appName = appName_example; // String | The name of the app to retrieve
        try {
            apiInstance.getApplication(appName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#getApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationManagementApi;

public class ApplicationManagementApiExample {

    public static void main(String[] args) {
        ApplicationManagementApi apiInstance = new ApplicationManagementApi();
        String appName = appName_example; // String | The name of the app to retrieve
        try {
            apiInstance.getApplication(appName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationManagementApi#getApplication");
            e.printStackTrace();
        }
    }
}
String *appName = appName_example; // The name of the app to retrieve

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

// Fetch an individual application
[apiInstance getApplicationWith:appName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.ApplicationManagementApi()
var appName = appName_example; // {{String}} The name of the app to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getApplication(appName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationExample
    {
        public void main()
        {

            var apiInstance = new ApplicationManagementApi();
            var appName = appName_example;  // String | The name of the app to retrieve

            try
            {
                // Fetch an individual application
                apiInstance.getApplication(appName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationManagementApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationManagementApi();
$appName = appName_example; // String | The name of the app to retrieve

try {
    $api_instance->getApplication($appName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationManagementApi->getApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationManagementApi;

my $api_instance = WWW::SwaggerClient::ApplicationManagementApi->new();
my $appName = appName_example; # String | The name of the app to retrieve

eval { 
    $api_instance->getApplication(appName => $appName);
};
if ($@) {
    warn "Exception when calling ApplicationManagementApi->getApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationManagementApi()
appName = appName_example # String | The name of the app to retrieve

try: 
    # Fetch an individual application
    api_instance.get_application(appName)
except ApiException as e:
    print("Exception when calling ApplicationManagementApi->getApplication: %s\n" % e)

Parameters

Path parameters
Name Description
appName*
String
The name of the app to retrieve
Required

Responses

Status: 200 - OK


FASTExtension

getInfo

Information about the FAST Extension

This endpoint returns data pertaining to the version of FAST currently in use, as well as loaded template sets and other information useful for debug. This endpoint is recommended for use when verifying that FAST is installed and ready to use.


/info

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/info"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FASTExtensionApi;

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

public class FASTExtensionApiExample {

    public static void main(String[] args) {
        
        FASTExtensionApi apiInstance = new FASTExtensionApi();
        try {
            apiInstance.getInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling FASTExtensionApi#getInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FASTExtensionApi;

public class FASTExtensionApiExample {

    public static void main(String[] args) {
        FASTExtensionApi apiInstance = new FASTExtensionApi();
        try {
            apiInstance.getInfo();
        } catch (ApiException e) {
            System.err.println("Exception when calling FASTExtensionApi#getInfo");
            e.printStackTrace();
        }
    }
}

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

// Information about the FAST Extension
[apiInstance getInfoWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.FASTExtensionApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInfoExample
    {
        public void main()
        {

            var apiInstance = new FASTExtensionApi();

            try
            {
                // Information about the FAST Extension
                apiInstance.getInfo();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FASTExtensionApi.getInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFASTExtensionApi();

try {
    $api_instance->getInfo();
} catch (Exception $e) {
    echo 'Exception when calling FASTExtensionApi->getInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FASTExtensionApi;

my $api_instance = WWW::SwaggerClient::FASTExtensionApi->new();

eval { 
    $api_instance->getInfo();
};
if ($@) {
    warn "Exception when calling FASTExtensionApi->getInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FASTExtensionApi()

try: 
    # Information about the FAST Extension
    api_instance.get_info()
except ApiException as e:
    print("Exception when calling FASTExtensionApi->getInfo: %s\n" % e)

Parameters

Responses

Status: 200 - OK


PackageManagement

getTemplateSet

Removes an installed package

DELETE /packages/{setName} will remove an installed package specified by its name.


/templatesets/{setName}

Usage and SDK Samples

curl -X DELETE "/mgmt/shared/fast/templatesets/{setName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageManagementApi;

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

public class PackageManagementApiExample {

    public static void main(String[] args) {
        
        PackageManagementApi apiInstance = new PackageManagementApi();
        String setName = setName_example; // String | The name of the package to remove
        try {
            apiInstance.getTemplateSet(setName);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#getTemplateSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageManagementApi;

public class PackageManagementApiExample {

    public static void main(String[] args) {
        PackageManagementApi apiInstance = new PackageManagementApi();
        String setName = setName_example; // String | The name of the package to remove
        try {
            apiInstance.getTemplateSet(setName);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#getTemplateSet");
            e.printStackTrace();
        }
    }
}
String *setName = setName_example; // The name of the package to remove

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

// Removes an installed package
[apiInstance getTemplateSetWith:setName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.PackageManagementApi()
var setName = setName_example; // {{String}} The name of the package to remove

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTemplateSet(setName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTemplateSetExample
    {
        public void main()
        {

            var apiInstance = new PackageManagementApi();
            var setName = setName_example;  // String | The name of the package to remove

            try
            {
                // Removes an installed package
                apiInstance.getTemplateSet(setName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageManagementApi.getTemplateSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPackageManagementApi();
$setName = setName_example; // String | The name of the package to remove

try {
    $api_instance->getTemplateSet($setName);
} catch (Exception $e) {
    echo 'Exception when calling PackageManagementApi->getTemplateSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PackageManagementApi;

my $api_instance = WWW::SwaggerClient::PackageManagementApi->new();
my $setName = setName_example; # String | The name of the package to remove

eval { 
    $api_instance->getTemplateSet(setName => $setName);
};
if ($@) {
    warn "Exception when calling PackageManagementApi->getTemplateSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PackageManagementApi()
setName = setName_example # String | The name of the package to remove

try: 
    # Removes an installed package
    api_instance.get_template_set(setName)
except ApiException as e:
    print("Exception when calling PackageManagementApi->getTemplateSet: %s\n" % e)

Parameters

Path parameters
Name Description
setName*
String
The name of the package to remove
Required

Responses

Status: 200 - package removed successfully


listAllTemplateSets

Info about installed packages

GET /packages will retrieve the list of template packages currently installed in the system


/templatesets

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/templatesets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageManagementApi;

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

public class PackageManagementApiExample {

    public static void main(String[] args) {
        
        PackageManagementApi apiInstance = new PackageManagementApi();
        try {
            PackageList result = apiInstance.listAllTemplateSets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#listAllTemplateSets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageManagementApi;

public class PackageManagementApiExample {

    public static void main(String[] args) {
        PackageManagementApi apiInstance = new PackageManagementApi();
        try {
            PackageList result = apiInstance.listAllTemplateSets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#listAllTemplateSets");
            e.printStackTrace();
        }
    }
}

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

// Info about installed packages
[apiInstance listAllTemplateSetsWithCompletionHandler: 
              ^(PackageList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.PackageManagementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllTemplateSets(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllTemplateSetsExample
    {
        public void main()
        {

            var apiInstance = new PackageManagementApi();

            try
            {
                // Info about installed packages
                PackageList result = apiInstance.listAllTemplateSets();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageManagementApi.listAllTemplateSets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPackageManagementApi();

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

my $api_instance = WWW::SwaggerClient::PackageManagementApi->new();

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

# create an instance of the API class
api_instance = swagger_client.PackageManagementApi()

try: 
    # Info about installed packages
    api_response = api_instance.list_all_template_sets()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PackageManagementApi->listAllTemplateSets: %s\n" % e)

Parameters

Responses

Status: 200 - a list of installed packages, versions, installation dates, etc


uploadTemplates

Upload a new package


/templatesets

Usage and SDK Samples

curl -X POST "/mgmt/shared/fast/templatesets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PackageManagementApi;

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

public class PackageManagementApiExample {

    public static void main(String[] args) {
        
        PackageManagementApi apiInstance = new PackageManagementApi();
        TemplateSchema body = ; // TemplateSchema | A template spec or zip containing template specs
        try {
            apiInstance.uploadTemplates(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#uploadTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PackageManagementApi;

public class PackageManagementApiExample {

    public static void main(String[] args) {
        PackageManagementApi apiInstance = new PackageManagementApi();
        TemplateSchema body = ; // TemplateSchema | A template spec or zip containing template specs
        try {
            apiInstance.uploadTemplates(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PackageManagementApi#uploadTemplates");
            e.printStackTrace();
        }
    }
}
TemplateSchema *body = ; // A template spec or zip containing template specs

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

// Upload a new package
[apiInstance uploadTemplatesWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.PackageManagementApi()
var body = ; // {{TemplateSchema}} A template spec or zip containing template specs

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadTemplates(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadTemplatesExample
    {
        public void main()
        {

            var apiInstance = new PackageManagementApi();
            var body = new TemplateSchema(); // TemplateSchema | A template spec or zip containing template specs

            try
            {
                // Upload a new package
                apiInstance.uploadTemplates(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PackageManagementApi.uploadTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPackageManagementApi();
$body = ; // TemplateSchema | A template spec or zip containing template specs

try {
    $api_instance->uploadTemplates($body);
} catch (Exception $e) {
    echo 'Exception when calling PackageManagementApi->uploadTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PackageManagementApi;

my $api_instance = WWW::SwaggerClient::PackageManagementApi->new();
my $body = WWW::SwaggerClient::Object::TemplateSchema->new(); # TemplateSchema | A template spec or zip containing template specs

eval { 
    $api_instance->uploadTemplates(body => $body);
};
if ($@) {
    warn "Exception when calling PackageManagementApi->uploadTemplates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PackageManagementApi()
body =  # TemplateSchema | A template spec or zip containing template specs

try: 
    # Upload a new package
    api_instance.upload_templates(body)
except ApiException as e:
    print("Exception when calling PackageManagementApi->uploadTemplates: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - upload a new package, either a zipfile or a single template specifiation


TaskTracking

getTask

Get information about a specific task

Get detailed information about a specific task. Tasks are tracked on a best effort basis, an interupption in service to the iControl LX platform may result in lost results.


/tasks/{taskId}

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/tasks/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskTrackingApi;

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

public class TaskTrackingApiExample {

    public static void main(String[] args) {
        
        TaskTrackingApi apiInstance = new TaskTrackingApi();
        String taskId = taskId_example; // String | The id of the task to retrieve
        try {
            TaskList result = apiInstance.getTask(taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskTrackingApi#getTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskTrackingApi;

public class TaskTrackingApiExample {

    public static void main(String[] args) {
        TaskTrackingApi apiInstance = new TaskTrackingApi();
        String taskId = taskId_example; // String | The id of the task to retrieve
        try {
            TaskList result = apiInstance.getTask(taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskTrackingApi#getTask");
            e.printStackTrace();
        }
    }
}
String *taskId = taskId_example; // The id of the task to retrieve

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

// Get information about a specific task
[apiInstance getTaskWith:taskId
              completionHandler: ^(TaskList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.TaskTrackingApi()
var taskId = taskId_example; // {{String}} The id of the task to retrieve

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

namespace Example
{
    public class getTaskExample
    {
        public void main()
        {

            var apiInstance = new TaskTrackingApi();
            var taskId = taskId_example;  // String | The id of the task to retrieve

            try
            {
                // Get information about a specific task
                TaskList result = apiInstance.getTask(taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskTrackingApi.getTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTaskTrackingApi();
$taskId = taskId_example; // String | The id of the task to retrieve

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

my $api_instance = WWW::SwaggerClient::TaskTrackingApi->new();
my $taskId = taskId_example; # String | The id of the task to retrieve

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

# create an instance of the API class
api_instance = swagger_client.TaskTrackingApi()
taskId = taskId_example # String | The id of the task to retrieve

try: 
    # Get information about a specific task
    api_response = api_instance.get_task(taskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskTrackingApi->getTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
String
The id of the task to retrieve
Required

Responses

Status: 200 - An array of tasks and their status

Status: default - unexpected error


listAllTasks

List all running and completed tasks


/tasks

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/tasks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskTrackingApi;

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

public class TaskTrackingApiExample {

    public static void main(String[] args) {
        
        TaskTrackingApi apiInstance = new TaskTrackingApi();
        try {
            TaskList result = apiInstance.listAllTasks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskTrackingApi#listAllTasks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskTrackingApi;

public class TaskTrackingApiExample {

    public static void main(String[] args) {
        TaskTrackingApi apiInstance = new TaskTrackingApi();
        try {
            TaskList result = apiInstance.listAllTasks();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskTrackingApi#listAllTasks");
            e.printStackTrace();
        }
    }
}

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

// List all running and completed tasks
[apiInstance listAllTasksWithCompletionHandler: 
              ^(TaskList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.TaskTrackingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllTasks(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllTasksExample
    {
        public void main()
        {

            var apiInstance = new TaskTrackingApi();

            try
            {
                // List all running and completed tasks
                TaskList result = apiInstance.listAllTasks();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskTrackingApi.listAllTasks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTaskTrackingApi();

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

my $api_instance = WWW::SwaggerClient::TaskTrackingApi->new();

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

# create an instance of the API class
api_instance = swagger_client.TaskTrackingApi()

try: 
    # List all running and completed tasks
    api_response = api_instance.list_all_tasks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TaskTrackingApi->listAllTasks: %s\n" % e)

Parameters

Responses

Status: 200 - An array of tasks and their status

Status: default - unexpected error


TemplateManagement

getTemplate

get the specified template


/templates/{templateName}

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/templates/{templateName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateManagementApi;

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

public class TemplateManagementApiExample {

    public static void main(String[] args) {
        
        TemplateManagementApi apiInstance = new TemplateManagementApi();
        String templateName = templateName_example; // String | The name of the template to retrieve
        try {
            TemplateSchema result = apiInstance.getTemplate(templateName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateManagementApi#getTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateManagementApi;

public class TemplateManagementApiExample {

    public static void main(String[] args) {
        TemplateManagementApi apiInstance = new TemplateManagementApi();
        String templateName = templateName_example; // String | The name of the template to retrieve
        try {
            TemplateSchema result = apiInstance.getTemplate(templateName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateManagementApi#getTemplate");
            e.printStackTrace();
        }
    }
}
String *templateName = templateName_example; // The name of the template to retrieve

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

// get the specified template
[apiInstance getTemplateWith:templateName
              completionHandler: ^(TemplateSchema output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.TemplateManagementApi()
var templateName = templateName_example; // {{String}} The name of the template to retrieve

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

namespace Example
{
    public class getTemplateExample
    {
        public void main()
        {

            var apiInstance = new TemplateManagementApi();
            var templateName = templateName_example;  // String | The name of the template to retrieve

            try
            {
                // get the specified template
                TemplateSchema result = apiInstance.getTemplate(templateName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateManagementApi.getTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTemplateManagementApi();
$templateName = templateName_example; // String | The name of the template to retrieve

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

my $api_instance = WWW::SwaggerClient::TemplateManagementApi->new();
my $templateName = templateName_example; # String | The name of the template to retrieve

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

# create an instance of the API class
api_instance = swagger_client.TemplateManagementApi()
templateName = templateName_example # String | The name of the template to retrieve

try: 
    # get the specified template
    api_response = api_instance.get_template(templateName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateManagementApi->getTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
templateName*
String
The name of the template to retrieve
Required

Responses

Status: 200 - A template object


listAllTemplates

List all templates


/templates

Usage and SDK Samples

curl -X GET "/mgmt/shared/fast/templates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateManagementApi;

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

public class TemplateManagementApiExample {

    public static void main(String[] args) {
        
        TemplateManagementApi apiInstance = new TemplateManagementApi();
        try {
            TemplateList result = apiInstance.listAllTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateManagementApi#listAllTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateManagementApi;

public class TemplateManagementApiExample {

    public static void main(String[] args) {
        TemplateManagementApi apiInstance = new TemplateManagementApi();
        try {
            TemplateList result = apiInstance.listAllTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateManagementApi#listAllTemplates");
            e.printStackTrace();
        }
    }
}

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

// List all templates
[apiInstance listAllTemplatesWithCompletionHandler: 
              ^(TemplateList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var F5ApplicationServicesApi = require('f5_application_services_api');

var api = new F5ApplicationServicesApi.TemplateManagementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllTemplates(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllTemplatesExample
    {
        public void main()
        {

            var apiInstance = new TemplateManagementApi();

            try
            {
                // List all templates
                TemplateList result = apiInstance.listAllTemplates();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateManagementApi.listAllTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTemplateManagementApi();

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

my $api_instance = WWW::SwaggerClient::TemplateManagementApi->new();

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

# create an instance of the API class
api_instance = swagger_client.TemplateManagementApi()

try: 
    # List all templates
    api_response = api_instance.list_all_templates()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateManagementApi->listAllTemplates: %s\n" % e)

Parameters

Responses

Status: 200 - An array of template names

Status: default - unexpected error