F5 BIG-IP Application Services Templates (FAST)

openapi: "3.0.0"
info:
  version: 1.26.0
  title: F5 BIG-IP Application Services Templates API
  license:
    name: Apache 2.0
  description: |
    # F5 BIG-IP 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.
servers:
  - url: http://localhost:8100/mgmt/shared/fast
tags:
  - name: Application Management
  - name: Task Tracking
  - name: Template Management
  - name: FAST Extension
paths:
  /applications:
    get:
      tags:
        - Application Management
      summary: Fetch List of FAST Applications
      description: Responds with a list of Applications that are currently deployed in the system.
      operationId: getFASTApplications
      responses:
        '200':
          description: List of FAST Applications.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationList"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    post:
      tags:
        - Application Management
      summary: Create one or more Applications from Templates
      description: 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.
      operationId: postFASTApplications
      requestBody:
        description: An application definition, including the name of the template to run and the parameters needed to render and post the output.
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FastApplicationRequest"
      responses:
        '202':
          description: Template Job Submitted Successfully, check the provided Task ID to get the status of the deployment.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationResponse"
        '400':
          description: AS3 errors (e.g., invalid schema) are forwarded as 400-level errors. See AS3 documentation for details.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    put:
      tags:
        - Application Management
      summary: Create or update Applications from Templates.
      description: This is method to deploy a templated Application. This 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.
      operationId: putFASTApplications
      requestBody:
        description: An application definition, including the name of the template to run and the parameters needed to render and post the output.
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FastApplicationRequest"
      responses:
        '202':
          description: Template Job Submitted Successfully, check the provided Task ID to get the status of the deployment.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationResponse"
        '400':
          description: AS3 errors (e.g., invalid schema) are forwarded as 400-level errors. See AS3 documentation for details.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    delete:
      tags:
        - Application Management
      summary: Delete FAST Applications
      description: Delete multiple FAST managed Applications (all if no body is provided).
      operationId: deleteFASTApplications
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                description: Application paths (e.g., 'tenant/app')
              example:
                - tenant/app
      responses:
        '202':
          description: Delete job submitted successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationDeleteResponse"
        '404':
          description: Tenant or Application not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /applications/{tenantName}/{appName}:
    parameters:
      - name: appName
        in: path
        required: true
        description: The name of the app to retrieve.
        schema:
          type: string
          pattern: '.*'
      - name: tenantName
        in: path
        required: true
        description: The tenant the app belongs to.
        schema:
          type: string
          pattern: '.*'
    get:
      summary: Fetch an individual Application
      description: Fetches the AS3 Application class for the given FAST Application.
      operationId: getFASTApplication
      tags:
        - Application Management
      responses:
        '200':
          description: The specified Application.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastAs3App"
        '404':
          description: Application or Tenant was not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    patch:
      summary: Update Application parameters
      description: 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.
      operationId: updateFASTApplication
      tags:
        - Application Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                parameters:
                  $ref: "#/components/schemas/ParametersDefinition"
              required:
                - parameters
            example: { "virtualAddresses": [ "10.0.0.1" ] }
      responses:
        '202':
          description: Template Job Submitted Successfully, check the provided Task ID to get the status of the deployment.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationResponse"
        '400':
          description: AS3 errors (e.g., invalid schema) are forwarded as 400-level errors. See AS3 documentation for details.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    delete:
      tags:
        - Application Management
      summary: Delete Application
      description: Delete an individual Application.
      operationId: deleteFASTApplication
      responses:
        '202':
          description: The Application was deleted successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastApplicationDeleteResponse"
        '404':
          description: Tenant or Application not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /templates:
    get:
      summary: List all Templates
      description: List all installed Templates.
      operationId: getFASTTemplates
      tags:
        - Template Management
      responses:
        '200':
          description: An array of Template names.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TemplateNameList"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /templates/{setName}/{templateName}:
    parameters:
      - name: templateName
        in: path
        required: true
        description: The name of the Template to retrieve.
        schema:
          type: string
          pattern: '.*'
      - name: setName
        in: path
        required: true
        description: The name of Template Set the Template belongs to.
        schema:
          type: string
          pattern: '.*'
    get:
      summary: Get specified Template
      description: Get the Template by Template name and Template Set name.
      operationId: getFASTTemplateBySetAndTemplateName
      tags:
        - Template Management
      responses:
        '200':
          description: A Template object.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Template"
        '404':
          description: Set or Template was not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /tasks:
    get:
      summary: Get Tasks
      description: List all running and completed Tasks.
      operationId: getFASTTasks
      tags:
        - Task Tracking
      responses:
        '200':
          description: An array of Tasks and their status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TaskList"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /tasks/{taskId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The ID of the Task to retrieve.
        schema:
          $ref: '#/components/schemas/uuid'
        example: 86657e15-439d-4cef-97bc-58a6c119976b
    get:
      summary: Get information about a specific Task
      description: Get detailed information about a specific Task. Tasks are tracked on a best effort basis, an interruption in service to the iControl LX platform may result in lost results.
      operationId: getFASTTaskById
      tags:
        - Task Tracking
      responses:
        '200':
          description: The specified Task and its status.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        '404':
          description: The Task ID was not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /templatesets:
    get:
      parameters:
        - name: showDisabled
          in: query
          required: false
          description: Whether to show only disabled Template Sets.
          schema:
            type: boolean
      summary: Get Template Sets
      description: List all installed Template Sets.
      operationId: getFASTTemplateSets
      tags:
        - Template Management
      responses:
        '200':
          description: A list of installed Template Sets
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TemplateSetList"
        '400':
          description: Invalid Template Set request.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '404':
          description: Template Set not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    post:
      summary: Install Template Set
      description: Installs a new template set from a variety of sources
      operationId: postFASTTemplateSets
      tags:
        - Template Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: File Upload
                  description: Install a previously uploaded zip archive as a template set
                  required:
                    - name
                  properties:
                    name:
                      title: Template Set name
                      description: The name of the Template Set to install (excluding the .zip extension).
                      type: string
                      example: new_template_set
                - title: GitHub Repository
                  description: Install a GitHub repository (or sub-directory in a repository) as a template set
                  required:
                    - gitHubRepo
                  properties:
                    gitHubRepo:
                      title: GitHub Repository
                      description: A GitHub repository to use as a template set
                      type: string
                      example: org/templateset
                    gitToken:
                      title: GitHub API token
                      description: An API token used to access private repositories
                      type: string
                      default: null
                    gitSubDir:
                      title: Git sub-directory
                      description: The sub-directory in the git repo to install as a template set
                      default: null
                      nullable: true
                      example: org-templates
                      oneOf:
                        - type: string
                    gitRef:
                      title: Git ref
                      description: The Git ref to use when fetching the repository
                      default: master
                      type: string
                      example: master
                    name:
                      title: Template set name
                      description: Template set name to use (defaults gitSubDir if available or the repo name)
                      type: string
                      example: newTemplateSet
                - title: GitLab Repository
                  description: Install a GitLab repository (or sub-directory in a repository) as a template set
                  required:
                   - gitLabRepo
                  properties:
                    gitLabRepo:
                      title: GitLab Repository
                      description: A GitLab repository to use as a template set
                      type: string
                      example: org/templateset
                    gitLabUrl:
                      title: GitLab URL
                      description: URL to the GitLab instance
                      type: string
                      default: https://gitlab.com
                    gitToken:
                      title: GitLab API token
                      description: An API token used to access private repositories
                      type: string
                      default: null
                    gitSubDir:
                      title: Git sub-directory
                      description: The sub-directory in the git repo to install as a template set
                      default: null
                      nullable: true
                      example: org-templates
                      oneOf:
                        - type: string
                    gitRef:
                      title: Git ref
                      description: The Git ref to use when fetching the repository
                      default: master
                      type: string
                      example: master
                    name:
                      title: Template set name
                      description: Template set name to use (defaults gitSubDir if available or the repo name)
                      type: string
                      example: newTemplateSet
      responses:
        '200':
          description: The Template Set installed successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '400':
          description: The supplied Template Set name is invalid or missing.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '404':
          description: The supplied Template name was not found in /var/config/rest/downloads.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    put:
      summary: Install Template Set
      description: Installs a new template set or updates existent templateset from a variety of sources
      operationId: putFASTTemplateSets
      tags:
        - Template Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: File Upload
                  description: Install a previously uploaded zip archive as a template set
                  required:
                    - name
                  properties:
                    name:
                      title: Template Set name
                      description: The name of the Template Set to install (excluding the .zip extension).
                      type: string
                      example: new_template_set
                - title: GitHub Repository
                  description: Install a GitHub repository (or sub-directory in a repository) as a template set
                  required:
                    - gitHubRepo
                  properties:
                    gitHubRepo:
                      title: GitHub Repository
                      description: A GitHub repository to use as a template set
                      type: string
                      example: org/templateset
                    gitToken:
                      title: GitHub API token
                      description: An API token used to access private repositories
                      type: string
                      default: null
                    gitSubDir:
                      title: Git sub-directory
                      description: The sub-directory in the git repo to install as a template set
                      default: null
                      nullable: true
                      example: org-templates
                      oneOf:
                        - type: string
                    gitRef:
                      title: Git ref
                      description: The Git ref to use when fetching the repository
                      default: master
                      type: string
                      example: master
                    name:
                      title: Template set name
                      description: Template set name to use (defaults gitSubDir if available or the repo name)
                      type: string
                      example: newTemplateSet
                - title: GitLab Repository
                  description: Install a GitLab repository (or sub-directory in a repository) as a template set
                  required:
                    - gitLabRepo
                  properties:
                    gitLabRepo:
                      title: GitLab Repository
                      description: A GitLab repository to use as a template set
                      type: string
                      example: org/templateset
                    gitLabUrl:
                      title: GitLab URL
                      description: URL to the GitLab instance
                      type: string
                      default: https://gitlab.com
                    gitToken:
                      title: GitLab API token
                      description: An API token used to access private repositories
                      type: string
                      default: null
                    gitSubDir:
                      title: Git sub-directory
                      description: The sub-directory in the git repo to install as a template set
                      default: null
                      nullable: true
                      example: org-templates
                      oneOf:
                        - type: string
                    gitRef:
                      title: Git ref
                      description: The Git ref to use when fetching the repository
                      default: master
                      type: string
                      example: master
                    name:
                      title: Template set name
                      description: Template set name to use (defaults gitSubDir if available or the repo name)
                      type: string
                      example: newTemplateSet
      responses:
        '200':
          description: The Template Set installed successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '400':
          description: The supplied Template Set name is invalid or missing.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '404':
          description: The supplied Template name was not found in /var/config/rest/downloads.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    delete:
      tags:
        - Template Management
      summary: Delete Template Sets
      description: Delete all installed Template Sets.
      operationId: deleteFASTTemplateSets
      responses:
        '200':
          description: All Template Sets were deleted successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /templatesets/{setName}:
    parameters:
      - name: setName
        in: path
        required: true
        description: The name of the Template Set.
        schema:
          type: string
          pattern: '.*'
    get:
      tags:
        - Template Management
      summary: Get Template information
      description: Get information of Template Set with {setName}.
      operationId: getFASTTemplateSetsByName
      responses:
        '200':
          description: A Template Set object.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TemplateSet"
        '400':
          description: Template Set in use.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '404':
          description: Template Set not found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    delete:
      tags:
        - Template Management
      summary: Delete specified Template Set
      description: Deletes an installed Template Set specified by its name.
      operationId: deleteFASTTemplateSetByName
      responses:
        '200':
          description: The specified Template Set was deleted successfully.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '400':
          description: Cannot delete Template Set, it is being used
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse400"
        '404':
          description: The Set name was not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse404"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /settings:
    get:
      tags:
        - FAST Extension
      summary: Get FAST Settings
      description: Get an object that represents the current FAST configuration.
      operationId: getFASTSettings
      responses:
        '200':
          description: The FAST Settings configuration.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Settings"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    delete:
      tags:
        - FAST Extension
      summary: Delete/Reset FAST Settings
      description: Reset FAST configuration to defaults.
      operationId: deleteFASTSettings
      responses:
        '200':
          description: Delete/Reset the FAST Settings configuration.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    post:
      tags:
        - FAST Extension
      summary: Replace FAST settings (Full overwrite)
      description: Replace the full FAST configuration with supplied body.
      operationId: postFASTSettings
      responses:
        '200':
          description: Replace the FAST Settings configuration.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '422':
          description: supplied configuration was invalid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse422"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    put:
      tags:
        - FAST Extension
      summary: Replace FAST settings (Full overwrite)
      description: Replace the full FAST configuration with supplied body.
      operationId: putFASTSettings
      responses:
        '200':
          description: Replace the FAST Settings configuration.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '422':
          description: supplied configuration was invalid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse422"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
    patch:
      tags:
        - FAST Extension
      summary: Update existing FAST Settings
      description: Update existing FAST configuration with the supplied body. Allows updates of individual properties.
      operationId: patchFASTSettings
      responses:
        '200':
          description: Update the FAST Settings configuration.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse200"
        '422':
          description: supplied configuration was invalid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse422"
        '500':
          description: Internal error. A bug report should be filed.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FastResponse500"
  /settings-schema:
    get:
      tags:
        - FAST Extension
      summary: Get settings schema
      description: Get JSON schema for the /settings endpoint.
      operationId: getFastSettingsSchema
      responses:
        '200':
          description: The FAST Settings schema.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SettingsSchema"
 

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/openapi/f5-big-ip-fast-openapi.yml