F5 Application Services Templates API (1.4.0)

Download OpenAPI specification:Download

License: Apache 2.0

F5 Application Services Templates (FAST)

This is the documentation for the FAST templating extension. This document catalogs the API endpoints exposed by the extension. Note that the path for all endpoints must be preceded by /mgmt/shared/fast.

Application Management

These are endpoints related to managing the lifecycle of your applications. These endpoints help you create, edit, and query the applications managed by FAST.

Task Tracking

When an application is created, it may not happen instantly. A task is run to deploy the AS3 declaration. These endpoints are for retrieving information about currently running and previously run tasks. These endpoints will report the success or failure of a particular deployment action, such as creating or editing an application.

Package Management

This is the API for loading and unloading new template sets into the system.

Template Management

This is the API for Querying templates that are loaded into the system.

FAST Extension

These endpoints are related to management of the FAST Extension itself, for getting debug information or software version information.

Application Management

Fetch List of FAST Applications

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create one or more applications from templates

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.

Request Body schema: application/json

A task definition, including the name of the template to run and the parameters needed to render and post the output.

One of
name
required
string

must be valid template in the system

parameters
required
object

object must conform to specified template's schema

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "parameters": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete all FAST managed applications

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Fetch an individual application

Fetches the AS3 application class for the given FAST application

path Parameters
appName
required
string

The name of the app to retrieve

tenantName
required
string

The tenant the app belongs to

Responses

Response samples

Content type
application/json
{
  • "template": "string",
  • "parameters": { },
  • "lastModified": null,
  • "tenant": null,
  • "name": null,
  • "setHash": null
}

Update application parameters

Update an existing, deployed FAST application with the supplied parameters. Existing parameter values from the deployed application will be used as defaults for any missing parameter values.

path Parameters
appName
required
string

The name of the app to retrieve

tenantName
required
string

The tenant the app belongs to

Request Body schema: application/json
parameters
required
object

parameters used to update the application

Responses

Request samples

Content type
application/json
{
  • "parameters": { }
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete an individual application

path Parameters
appName
required
string

The name of the app to retrieve

tenantName
required
string

The tenant the app belongs to

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Task Tracking

List all running and completed tasks

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

path Parameters
taskId
required
string

The ID of the task to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]