F5® BIG-IP® Next Central Manager API Specifications

Overview

This is the BIG-IP Next Central Manager API documentation.

F5® BIG-IP® Next Central Manager API
API docs by Redocly

F5® BIG-IP® Next Central Manager API

Download OpenAPI specification:Download

The F5® BIG-IP® Next Central Manager API is F5's single front-end API for all services and resources in BIG-IP Next. F5 has undertaken to design it to ensure the APIs are in duty, meaningful, and following the best industry practices. You can consider the object model discussed in this documentation as reflecting a consistent and logical view of how to see resources, manage configurations, and view the actual system state of your BIG-IP Next.

Alerts

Alerts APIs may operate on alert resources of the F5® BIG-IP® Next Central Manager.

Retrieve all alerts

Retrieves a list of all the alerts and notifications.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

expand
string
Examples:
  • expand=notification_configurations,name - array column names

The column names used for filtering array elements in the result query.Ignored if filer parameter is absent.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Save aggregated alerts

Request to save the aggregated alerts from aggregator services.

Request Body schema: application/json
required
required
Array of objects (CreateAlert)

alerts

Responses

Request samples

Content type
application/json
{
  • "alerts": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Retrieve alert

Retrieves a specific alert.

path Parameters
id
required
string <uuid>

uuid of alert

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
  • "notification_configurations": [
    ],
  • "name": "string",
  • "level": "INFO",
  • "status": "ACTIVE",
  • "source": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "summary": "string",
  • "description": "string",
  • "help_link": "string",
  • "object_name": "string",
  • "object_type": "string",
  • "additional_information": { },
  • "_links": {
    }
}

Inactivate multiple alerts

Inactivates multiple alerts.

Request Body schema: application/json
required
alerts
required
Array of strings <uuid> [ items <uuid > ]

alert ids

Responses

Request samples

Content type
application/json
{
  • "alerts": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Store alert types

Stores alert types.

Request Body schema: application/json
required
name
required
string non-empty

alert type name

source
required
string non-empty

feature name who is source of this type

level
required
string (AlertLevel)
Enum: "INFO" "WARNING" "SEVERE"

alert severity

help_link
string

help link

object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "source": "string",
  • "level": "INFO",
  • "help_link": "string",
  • "notifications": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Update alert type

Updates alert type by name and source.

Request Body schema: application/json
required
name
required
string non-empty

alert type name

source
required
string non-empty

feature name who is source of this type

level
string (AlertLevel)
Enum: "INFO" "WARNING" "SEVERE"

alert severity

help_link
string

help link

object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "source": "string",
  • "level": "INFO",
  • "help_link": "string",
  • "notifications": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Delete alert type Deprecated

Deletes alert type.

Request Body schema: application/json
required
name
required
string

alert type name

source
required
string

feature name who is source of this type

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Delete alert type

Deletes alert type.

Request Body schema: application/json
required
name
required
string

alert type name

source
required
string

feature name who is source of this type

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Retrieve all alert types

Retrieves a list of all the alert types.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Add alert types

Adds alert types.

Request Body schema: application/json
required
Array
name
required
string non-empty

alert type name

source
required
string non-empty

feature name who is source of this type

level
required
string (AlertLevel)
Enum: "INFO" "WARNING" "SEVERE"

alert severity

help_link
string

help link

object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/hal+json
[
  • {
    }
]

Update an alert types

Updates an alert type by name and source.

Request Body schema: application/json
required
Array
name
required
string non-empty

alert type name

source
required
string non-empty

feature name who is source of this type

level
string (AlertLevel)
Enum: "INFO" "WARNING" "SEVERE"

alert severity

help_link
string

help link

object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/hal+json
[
  • {
    }
]

Delete an alert types Deprecated

Deletes an alert type.

Request Body schema: application/json
required
Array
name
required
string

alert type name

source
required
string

feature name who is source of this type

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/hal+json
[
  • {
    }
]

Delete alert types

Deletes multiple alert types.

Request Body schema: application/json
required
Array
name
required
string

alert type name

source
required
string

feature name who is source of this type

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve an alert type

Retrieves a specific alert type.

path Parameters
id
required
string <uuid>

uuid of alert type

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "source": "string",
  • "level": "INFO",
  • "help_link": "string",
  • "notification_configurations": [
    ],
  • "_links": {
    }
}

Update an alert type

Updates a specific alert type identified by id.

path Parameters
id
required
string <uuid>

uuid of alert type

Request Body schema: application/json
required
level
string (AlertLevel)
Enum: "INFO" "WARNING" "SEVERE"

alert severity

help_link
string

help link

object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "level": "INFO",
  • "help_link": "string",
  • "notifications": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Deletes an alert type

Deletes an alert type specified by id.

path Parameters
id
required
string <uuid>

uuid of alert type

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Inactivate an alert

Inactivates a specific alert.

path Parameters
id
required
string <uuid>

uuid of alert

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Update multiple alerts to seen alert status

Updates the status of multiple alerts to seen alert status. Provide a list of alert IDs to specify which alerts will have their status changed to seen.

Request Body schema: application/json
required
alerts
required
Array of strings <uuid> [ items <uuid > ]

alert ids

Responses

Request samples

Content type
application/json
{
  • "alerts": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Update an alert to seen alert status

Updates a specific alert to seen alert status.

path Parameters
id
required
string <uuid>

uuid of alert

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Retrieve alert rules

Retrieves a list of all the alert rules.

Responses

Response samples

Content type
application/hal+json
{
  • "id": [
    ]
}

Notifications

Notifications APIs may operate on notification resources of the F5® BIG-IP® Next Central Manager.

Retrieve notifications

Retrieves a list of all the notifications.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Creates new notification configuration

Creates a new notification configuration from data.

Request Body schema: application/json
required
name
required
string non-empty
notification_type
required
string (NotificationType)
Enum: "SMTP" "UI"
periodicity
string non-empty
suppressed
boolean
location
string
to_emails
Array of strings[ items non-empty ]
server_config
string
object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notification_type": "SMTP",
  • "periodicity": "string",
  • "suppressed": true,
  • "location": "string",
  • "to_emails": [
    ],
  • "server_config": "string",
  • "alert_types": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Update notification configuration

Updates an existing notification configuration.

Request Body schema: application/json
required
id
required
string <uuid>
name
required
string
notification_type
required
string (NotificationType)
Enum: "SMTP" "UI"
periodicity
string
suppressed
boolean
location
string
to_emails
Array of strings[ items non-empty ]
server_config
string
object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "notification_type": "SMTP",
  • "periodicity": "string",
  • "suppressed": true,
  • "location": "string",
  • "to_emails": [
    ],
  • "server_config": "string",
  • "alert_types": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Delete notification configuration Deprecated

Deletes a notification configuration.

Request Body schema: application/json
required
name
required
string

notification configuration name

notification_type
required
string

notification configuration type

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Delete notification configuration

Deletes a notification configuration.

Request Body schema: application/json
required
name
required
string

notification configuration name

notification_type
required
string

notification configuration type

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Retrieve notification

Retrieves a specific notification

path Parameters
id
required
string <uuid>

uuid of notification

Responses

Response samples

Content type
application/hal+json
{
  • "data": "string"
}

Update notification

Update an specific notification by ID.

path Parameters
id
required
string <uuid>

uuid of notification

Request Body schema: application/json
required
name
required
string
notification_type
required
string (NotificationType)
Enum: "SMTP" "UI"
periodicity
string
suppressed
boolean
location
string
to_emails
Array of strings[ items non-empty ]
server_config
string
object (LinkOrRemovalList)

list of IDs to link and/or removal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "notification_type": "SMTP",
  • "periodicity": "string",
  • "suppressed": true,
  • "location": "string",
  • "to_emails": [
    ],
  • "server_config": "string",
  • "alert_types": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Delete notification

Deletes a notification identified by ID.

path Parameters
id
required
string <uuid>

uuid of notification

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Suppress Notifications

Suppresses notifications specified by a list of notification IDs.

Request Body schema: application/json
required
notifications
required
Array of strings <uuid> [ items <uuid > ]

notification ids

Responses

Request samples

Content type
application/json
{
  • "notifications": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Suppress single notification

Suppresses a single notification specified by the notification ID.

path Parameters
id
required
string <uuid>

uuid of notification

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Reactivate multiple notifications

Reactivate multiple suppressed notifications specified by a list of notification IDs.

Request Body schema: application/json
required
notifications
required
Array of strings <uuid> [ items <uuid > ]

notification ids

Responses

Request samples

Content type
application/json
{
  • "notifications": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Reactivate a single suppressed notification

Reactivates a suppressed notifications specified by a notification ID.

path Parameters
id
required
string <uuid>

uuid of notification

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "notifications": [
    ],
  • "alert_types": [
    ]
}

Analytics

Analytic APIs may operate on analytics resources of the F5® BIG-IP® Next Central Manager.

Retrieve request count

Retrieves the number of web application requests counted during a specified time interval.

Request Body schema: application/json
required
duration
string
Enum: "5m" "1h" "1d" "1w" "30d"

Defines the analytics timeframe

object (WafEventAnalyticsPeriod)
entity
string
Enum: "geolocation" "source_ip" "url"

Defines the analytics entity

filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • actionType - the WAF result after evaluating the request. Possible values: 'legal', 'alarmed', 'blocked'.
  • country - the origin country of the request. A list of countries can be found in /v1/geolocations.
  • url - the URL of the request. Example value '/login'.
  • sourceIP - the client IP address of the request.
  • policy - the name of the WAF policy that enforced the request.
  • application - the name of the application in the request.
  • rating - the violation rating of the request. Possible values: '0', '1', '2', '3', '4', '5'.
  • systemID - the managed device ID.

Supported properties per entity type:

  • geolocation: country, application, policy, actionType, rating, systemID
  • source_ip: sourceIP, application, policy, rating, actionType, systemID
  • url: url, actionType, application, country, policy, rating, systemID
  • none: actionType, application, policy, rating, systemID

Supported operators:

  • and
  • or
  • eq
  • neq

Responses

Request samples

Content type
application/json
Example
{
  • "filter": "actionType eq 'blocked' and country eq 'US' and policy eq 'Policy1'",
  • "entity": "geolocation",
  • "duration": "1h"
}

Response samples

Content type
application/hal+json
{
  • "count": 0.1,
  • "_links": {
    }
}

Retrieve trend of requests

Retrieves the trend of web application requests counted during a specified time interval.

Request Body schema: application/json
required
duration
string
Enum: "5m" "1h" "1d" "1w" "30d"

Defines the analytics timeframe

object (WafEventAnalyticsPeriod)
entity
string
Enum: "geolocation" "source_ip" "url"

Defines the analytics entity

filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • actionType - the WAF result after evaluating the request. Possible values: 'legal', 'alarmed', 'blocked'.
  • country - the origin country of the request. A list of countries can be found in /v1/geolocations.
  • url - the URL of the request. Example value '/login'.
  • sourceIP - the client IP address of the request.
  • policy - the name of the WAF policy that enforced the request.
  • application - the name of the application in the request.
  • rating - the violation rating of the request. Possible values: '0', '1', '2', '3', '4', '5'.
  • systemID - the managed device ID.

Supported properties per entity type:

  • geolocation: country, application, policy, actionType, rating, systemID
  • source_ip: sourceIP, application, policy, rating, actionType, systemID
  • url: url, actionType, application, country, policy, rating, systemID
  • none: actionType, application, policy, rating, systemID

Supported operators:

  • and
  • or
  • eq
  • neq

Responses

Request samples

Content type
application/json
Example
{
  • "filter": "actionType eq 'blocked' and country eq 'US' and policy eq 'Policy1'",
  • "entity": "geolocation",
  • "duration": "1h"
}

Response samples

Content type
application/hal+json
{
  • "percent": 0.1,
  • "_links": {
    }
}

Retrieve the trends of web application requests

Retrieves the trends of web application requests which were made during a particular time period.

Request Body schema: application/json
required
required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category of the request.
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "percent": 0.1,
  • "count": 0.1,
  • "trend": 0.1,
  • "_links": {
    }
}

Retrieve most frequent web application requests

Retrieves the 20 most abundant web application requests which were made during a time period.

Request Body schema: application/json
required
entity
required
string (WafEventAnalyticsEntityEnum)
Enum: "geo_location" "ip_address" "uri" "signatures" "threat_campaign" "violations" "bot_signature"

Defines the analytics data aggregation criteria.

required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category for the request
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "entity": "geo_location",
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "top": [
    ],
  • "_links": {
    }
}

Retrieve aggregated statistics for policy or application

Retrieves web application request aggregated statistics for policy or application during a particular time period.

Request Body schema: application/json
required
entity
required
string
Enum: "policy_name" "app_name" "vs_name"

Defines the analytics data aggregation criteria.

required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category for the request
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "entity": "policy_name",
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "entity": [
    ],
  • "_links": {
    }
}

Retrieve statistics for entity

Retrieve statistics for entity

Request Body schema: application/json
required
entity
required
string (WafEventAnalyticsEntityEnum)
Enum: "geo_location" "ip_address" "uri" "signatures" "threat_campaign" "violations" "bot_signature"

Defines the analytics data aggregation criteria.

required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category for the request
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "entity": "geo_location",
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "urls": 0.1,
  • "signatures": 0.1,
  • "rating": 0.1,
  • "ip_addresses": 0.1,
  • "_links": {
    }
}

Retrieve the time interval

Retrieves the time interval which was used to get the number of web application requests.

Request Body schema: application/json
required
required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category of the request.
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "alerted": [
    ],
  • "blocked": [
    ],
  • "_links": {
    }
}

Retrieve trends of web application requests

Retrieves the trends of web application requests which were made during a particular time period.

Request Body schema: application/json
required
entity
required
string (WafEventAnalyticsEntityEnum)
Enum: "geo_location" "ip_address" "uri" "signatures" "threat_campaign" "violations" "bot_signature"

Defines the analytics data aggregation criteria.

required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • request_status - the WAF result after evaluating the request; possible values: 'alerted', 'blocked'
  • geo_location - the country that originated the request; you can find a list of countries at: /v1/geolocations
  • uri - the URI of the request; for example: '/login'
  • policy_name - the name of the WAF policy that enforced the request
  • app_name - the name of the application in the request
  • violation_rating - the violation rating of the request; possible values: '0', '1', '2', '3', '4', '5'
  • ip_client - the client IP address of the request
  • ip_address_intelligence - IP intelligence address of the request
  • severity - the request severity category
  • stack_name - the stack name
  • bot_category - the bot category for the request
  • bot_signature_name - the name of the bot signature for the request
  • client_class - the name of the bot client class for the request
  • client_type - the name of the bot client type for the request
  • sig_ids - the attack signature ID for the request
  • violations - the violation name for the request
  • sub_violations - the sub violation name for the request
  • threat_campaign_names - the threat campaign name for the request

Supported operators:

  • and
  • or
  • eq
  • neq

Supported functions:

  • contains(...)
  • not(contains(...))

Responses

Request samples

Content type
application/json
{
  • "entity": "geo_location",
  • "period": {
    },
  • "filter": "string"
}

Response samples

Content type
application/hal+json
{
  • "alerted_percent": 0.1,
  • "alerted_count": 0,
  • "alerted_trend": 0.1,
  • "blocked_percent": 0.1,
  • "blocked_count": 0,
  • "blocked_trend": 0.1,
  • "urls": 0,
  • "rating": 0.1,
  • "ip_addresses": 0,
  • "_links": {
    }
}

Retrieve WAF security report configurations

Retrieves a list of the report configuration for all WAF security reports.

query Parameters
limit
integer
Examples:
  • limit=2 - return 2 pages

Limits the number of items to return per page.

page
integer
Examples:
  • page=3 - return page number 3

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column name to sort results. Prefix column name with minus sign to sort in descending order.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. Queries by equality, string, or numerical conditions are possible.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "count": 0,
  • "total": 0,
  • "_embedded": {
    }
}

Create a WAF security report

Creates a new WAF security report.

Request Body schema: application/json
required
id
string <uuid>

UUID of WAF security report.

name
required
string^[-a-zA-Z0-9._/:\s]+$

The name of the security report.

description
string <= 255 characters

Specifies the description of the security report.

required
object
time_frame_in_days
integer
Enum: 1 7 30 90

Specifies the report time period.

Array of objects

Specifies the scoped categories.

top_level
integer
Enum: 5 10 20

Specifies the number of the top level items of the report.

request_type
string
Enum: "illegal" "alerted" "blocked"

Specifies the type of the report requests.

user_defined
boolean

Specifies whether the report is user defined.

created_by
string

The creator of the security report.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "WAF security report description",
  • "scope": {
    },
  • "time_frame_in_days": 1,
  • "categories": [
    ],
  • "top_level": 5,
  • "request_type": "illegal",
  • "user_defined": true,
  • "created_by": "string"
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "WAF security report description",
  • "scope": {
    },
  • "time_frame_in_days": 1,
  • "categories": [
    ],
  • "top_level": 5,
  • "request_type": "illegal",
  • "user_defined": true,
  • "created_by": "string",
  • "_links": {
    }
}

Retrieve a WAF security report

Retrieves a specific WAF security report

path Parameters
report_id
required
string

Security report's report_id

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "WAF security report description",
  • "scope": {
    },
  • "time_frame_in_days": 1,
  • "categories": [
    ],
  • "top_level": 5,
  • "request_type": "illegal",
  • "user_defined": true,
  • "created_by": "string",
  • "_links": {
    }
}

Update a security report

Updates a specific security report identified by report_id

path Parameters
report_id
required
string

Security report's report_id

Request Body schema: application/json
required
id
string <uuid>

UUID of WAF security report.

name
required
string^[-a-zA-Z0-9._/:\s]+$

The name of the security report.

description
string <= 255 characters

Specifies the description of the security report.

required
object
time_frame_in_days
integer
Enum: 1 7 30 90

Specifies the report time period.

Array of objects

Specifies the scoped categories.

top_level
integer
Enum: 5 10 20

Specifies the number of the top level items of the report.

request_type
string
Enum: "illegal" "alerted" "blocked"

Specifies the type of the report requests.

user_defined
boolean

Specifies whether the report is user defined.

created_by
string

The creator of the security report.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "WAF security report description",
  • "scope": {
    },
  • "time_frame_in_days": 1,
  • "categories": [
    ],
  • "top_level": 5,
  • "request_type": "illegal",
  • "user_defined": true,
  • "created_by": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "WAF security report description",
  • "scope": {
    },
  • "time_frame_in_days": 1,
  • "categories": [
    ],
  • "top_level": 5,
  • "request_type": "illegal",
  • "user_defined": true,
  • "created_by": "string",
  • "_links": {
    }
}

Delete a WAF security report

Deletes a specific WAF security report.

path Parameters
report_id
required
string

Security report's report_id

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "bad request"
}

Retrieve most abundant bad actor detection requests for geolocation

Retrieves the 10 most abundant (by count) bad actor detection requests for geolocation during a specified time interval.

Request Body schema: application/json
required
object (WafEventAnalyticsPeriod)
filter
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • app_name - Successfully deployed application name. Example value 'test_app_name'. Supported operators:
  • or
example
any

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "filter": "string",
  • "example": null
}

Response samples

Content type
application/hal+json
{
  • "top": [
    ],
  • "_links": {
    }
}

Return a list of Application behavioral DOS statuses Deprecated

Retrieves a list of Application behavioral DOS statuses.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "count": 0,
  • "total": 0,
  • "_embedded": {
    }
}

Return a list of virtual server behavioral DOS statuses

Retrieves a list of virtual server behavioral DOS statuses.

query Parameters
limit
integer
Examples:
  • limit=2 - return 2 pages

Limits the number of items to return per page.

prev_vs_name
string

last VS name in previous response if any, used for pagination.

prev_instance_id
string <uuid>

last instance ID in previous response if any, used for pagination.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "count": 0,
  • "total": 0,
  • "_embedded": {
    }
}

Return the BADOS application statistics for the given time interval Deprecated

Return the BADOS application statistics for the given time interval.

Request Body schema: application/json
required
required
object (WafEventAnalyticsPeriod)
app_name
required
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • app_name - Successfully deployed application name. Example value 'test_app_name'.

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "app_name": "test_app_name"
}

Response samples

Content type
application/hal+json
{
  • "stress_level": [
    ],
  • "baseline_dps": [
    ],
  • "incoming_rps": [
    ],
  • "successful_tps": [
    ],
  • "unsuccessful_rps": [
    ],
  • "mitigated_bad_actor_rps": [
    ],
  • "mitigated_global_rps": [
    ],
  • "mitigated_signature_rps": [
    ],
  • "_links": {
    }
}

Return the BADOS virtual server statistics for the given time interval

Return the BADOS virtual server statistics for the given time interval.

Request Body schema: application/json
required
required
object (WafEventAnalyticsPeriod)
vs_name
required
string

Defines the analytics filtering criteria. The supported properties are as follows:

  • vs_name - Virtual server name.
instance_id
required
string <uuid>

Defines the analytics filtering criteria. The supported properties are as follows:

  • instance_id - Managed instance ID.

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "vs_name": "test_vs_name",
  • "instance_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/hal+json
{
  • "stress_level": [
    ],
  • "baseline_dps": [
    ],
  • "incoming_rps": [
    ],
  • "successful_tps": [
    ],
  • "unsuccessful_rps": [
    ],
  • "mitigated_bad_actor_rps": [
    ],
  • "mitigated_global_rps": [
    ],
  • "mitigated_signature_rps": [
    ],
  • "_links": {
    }
}

Retrieve time series instance metrics

Retrieves time series instance-related metrics for a specified time frame and resolution, optionally matching a provided filter.

query Parameters
names
required
string
Examples:
  • names=http.transactions - query a single metric
  • names=cpu.idle,cpu.system - query multiple metrics
  • names=SUM(http.transactions) - query aggregated value of a metric

Defines one or more metrics to be returned. When groupBy is used only one metric should be used. An aggregation function can be added such as SUM, AVG, COUNT, MIN, MAX, RATE.

filter
string
Examples:
  • filter=deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055' - filter using an equality expression
  • filter=transactionOutcome neq 'incomplete' - filter using an inequality expression
  • filter=port gte 80 - filter using a numerical condition
  • filter=(deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055') AND (cpu.core eq 'all') - multiple predicates

A logical expression for filtering query results. consists of one or more predicates in the form of .

start
string

The start of the time window to include metrics from (inclusive).

end
string

The end of the time window to include metrics from (non-inclusive) – default to “now”.

resolution
string

Defines the returned data granularity.

aggregate
boolean

Defines if result should be returned aggregated.

Responses

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve list of time series access metrics

Retrieve time series access-related metrics for a specified time frame and resolution, optionally matching a provided filter.

query Parameters
names
required
string
Examples:
  • names=global_access_stat.current_connectivity_sessions - query a single metric, supports only global_access_stat.current_connectivity_sessions

Defines one or more metrics to be returned. Supports global_access_stat.current_connectivity_sessions only. By default groups by DeviceId_CM

filter
string
Examples:
  • filter=deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055' - filter using an equality expression
  • filter=(deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055' or deviceId eq '78032542-C56B-EB96-6F19-E1BB685CF022') - multiple predicates

A logical expression for filtering query results. consists of one or more predicates in the form of .

start
string

The start of the time window to include metrics from (inclusive).

end
string

The end of the time window to include metrics from (non-inclusive) – default to “now”.

resolution
string

Defines the returned data granularity.

sort
boolean

when true. orders and assigns a rank to device by the avg(metric) over time window.

aggregate
boolean

Defines if result should be returned aggregated.

Responses

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve applications time series metrics

Retrieves applications-related time series metrics for a specified time frame and resolution, optionally matching a provided filter.

query Parameters
names
required
string
Examples:
  • names=http.transactions - query a single metric
  • names=cpu.idle,cpu.system - query multiple metrics
  • names=SUM(http.transactions) - query aggregated value of a metric

Defines one or more metrics to be returned. When groupBy is used only one metric should be used. An aggregation function can be added such as SUM, AVG, COUNT, MIN, MAX, RATE.

filter
string
Examples:
  • filter=deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055' - filter using an equality expression
  • filter=transactionOutcome neq 'incomplete' - filter using an inequality expression
  • filter=port gte 80 - filter using a numerical condition
  • filter=(deviceId eq '91032542-C56B-EB96-6F19-E1BB685CF055') AND (cpu.core eq 'all') - multiple predicates

A logical expression for filtering query results. consists of one or more predicates in the form of .

start
string

The start of the time window to include metrics from (inclusive).

end
string

The end of the time window to include metrics from (non-inclusive) – default to “now”.

resolution
string

Defines the returned data granularity.

aggregate
boolean

Defines if result should be returned aggregated.

Responses

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve applications health

Retrieve the health status of all existing application services that match an optionally provided filter. This API supports paging.

query Parameters
limit
integer
Default: 100
Examples:
  • limit=10 - returns upto 10 items per page

Limits the number of items to return per page.

page
integer
Examples:
  • page=5 - return page number 5

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=name - column ascending sort
  • sort=location - single column descending sort
  • sort=name,location - mixed ascending/descending sort

The column name to sort results. Prefix column name with minus sign to sort in descending order.

select
string
Examples:
  • select=name,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'Deployed' - query by equality
  • filter=name startswith 'app' - query by string

Filter conditions for result queries. Queries by equality, string, or numerical conditions are possible.

Responses

Response samples

Content type
application/hal+json
{
  • "bigIpId": "string",
  • "tenantName": "string",
  • "objectName": "string",
  • "parentObjectName": "string",
  • "objectType": "string",
  • "parentObjectType": "string",
  • "applicationName": "string",
  • "health": "string",
  • "sourceId": "string",
  • "description": "string",
  • "lastUpdated": "string",
  • "_links": {
    }
}

Retrieve application-services locations

Retrieve a list of application-services locations, for the application-service topology view.

path Parameters
app_service_name
required
string

application service name (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "instances": [
    ]
}

Returns a list of virtual servers

Returns a list of virtual servers for a given application service, with their health.

path Parameters
app_service_name
required
string

application service name (unique)

query Parameters
id
required
string <uuid>

ID of the application

instance_id
string <uuid>

UUID of instance (instance-id)

type
required
string
Enum: "AS3" "FAST"

type of application

Responses

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve pool properties

Retrieves pool properties for the specified pool.

path Parameters
app_service_name
required
string

application service name (unique)

virtual_server_name
required
string

virtual server name (unique for application)

pool_name
required
string

pool name (unique)

query Parameters
instance_id
string <uuid>

UUID of instance (device-id)

app_id
required
string <uuid>

application service id (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "throughput": 0.1,
  • "health": "string",
  • "num_active_alerts": 0,
  • "num_pool_members": 0,
  • "num_healthy_pool_members": 0,
  • "percent_healthy_pool_members": "string",
  • "num_unhealthy_pool_members": 0,
  • "percent_unhealthy_pool_members": "string",
  • "lb_method": "string",
  • "virtual_server": "string",
  • "monitor_type": [
    ],
  • "_links": {
    }
}

Retrieve application service properties

Retrieves application service properties for the specified application-service.

path Parameters
app_service_name
required
string

application name (unique)

query Parameters
instance_id
string <uuid>

UUID of instance (device-id)

app_id
required
string <uuid>

application service id (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "description": "string",
  • "last_update": "2019-08-24T14:15:22Z",
  • "health": "Critical",
  • "active_alerts": 0,
  • "virtual_servers": 0,
  • "source": "Template",
  • "template_name": "string",
  • "location": "string",
  • "pools": 0,
  • "pool_members": 0,
  • "security": [
    ],
  • "_links": {
    }
}

Retrieve summary of the WAF policies

Retrieves summary of the WAF policies attached to applications.

Responses

Response samples

Content type
application/hal+json
{
  • "total_applications": 0,
  • "applications_with_waf_policies": 0,
  • "blocking": 0,
  • "transparent": 0,
  • "mixed": 0,
  • "no_policy": 0,
  • "_links": {
    }
}

Retrieve summary of applications health

Retrieve a summary of the distribution of applications health to generate a pie chart.

Responses

Response samples

Content type
application/hal+json
{
  • "total_applications": 0,
  • "application_health_summary": [
    ],
  • "_links": {
    }
}

Retrieve summary information

Retrieves a summary of the distribution of applications health by a list of their instance IDs, to generate a pie chart.

Request Body schema: application/json
required
instances
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "instances": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "total_applications": 0,
  • "application_health_summary": [
    ],
  • "_links": {
    }
}

Retrieve summary of applications alerts

Retrieves a summary of the distribution of application alerts by level to generate a pie chart.

query Parameters
app_name
string

application name (unique)

instance_id
string <uuid>

UUID of instance (device-id)

Responses

Response samples

Content type
application/hal+json
{
  • "total_alerts": 0,
  • "application_alerts_summary": [
    ],
  • "_links": {
    }
}

Retrieve endpoints data

Retrieves endpoints data for a specified pool.

path Parameters
app_name
required
string

application name (unique)

virtual_name
required
string

virtual server name (unique)

pool_name
required
string

pool name (unique)

query Parameters
app_id
required
string <uuid>

id of application

instance_id
string <uuid>

UUID of instance (device-id)

Responses

Response samples

Content type
application/hal+json
[
  • {
    }
]

Retrieve application health status

Retrieves application health status for a specified application.

path Parameters
app_name
required
string

application name (unique)

query Parameters
instance_id
string <uuid>

UUID of instance (device-id)

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "health": "Good",
  • "_links": {
    }
}

Retrieve virtual server properties

Retrieves virtual server properties for a specified virtual server.

path Parameters
app_service_name
required
string

application service name (unique)

virtual_server_name
required
string

virtual server name (unique for application)

query Parameters
instance_id
string <uuid>

UUID of instance (device-id)

app_id
required
string <uuid>

application service id (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "pools": 0,
  • "virtual_address": "string",
  • "virtual_port": 0,
  • "https_certificate": "string",
  • "enabled_protocols_and_profiles": [
    ],
  • "enabled_security_policies": [
    ],
  • "irules": {
    },
  • "_links": {
    }
}

Returns endpoint properties

Returns endpoint properties for a specified endpoint.

path Parameters
app_service_name
required
string

application service name (unique)

virtual_server_name
required
string

virtual server name (unique for application)

pool_name
required
string

pool name (unique)

endpoint-name
required
string

endpoint-name (unique)

query Parameters
instance_id
required
string <uuid>

UUID of instance (device-id)

app_id
required
string <uuid>

application service id (unique)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "ip_address": "string",
  • "location": "string",
  • "health": "string"
}

Retrieve properties of a FQDN in the GSLB

Retrieves properties of a specific Fully Qualified Domain Name (FQDN) in the GSLB.

path Parameters
fqdn_name
required
string

Fully Qualified Domain Name (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "globalResiliencyClusterName": "GR_Cluster_01",
  • "dnsListenerName": "NS_Cluster_01",
  • "protocols": [
    ],
  • "port": 53,
  • "_links": {
    }
}

Retrieve instances details of FQDN in the GSLB

Retrieves instances details of a specific FQDN in the GSLB.

path Parameters
fqdn_name
required
string

Fully Qualified Domain Name (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "instances": [
    ],
  • "_links": {
    }
}

Retrieve FQDN status

Retrieve the FQDN status as reported by each of the existing DNS servers within that Global Resiliency Group.

path Parameters
fqdn_name
required
string

fqdn name (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "fqdn_Status": [
    ],
  • "_links": {
    }
}

Retrieve access sessions

Retrieves access sessions.

query Parameters
start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

instanceID
string

Instance ID of the instance to fetch the data from. If not used all the instances from CM is used.

filter
string
Examples:
  • filter=applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' - application name
  • filter=sessionState eq 'closed' [closed, pending, established] - session state
  • filter=policyState eq 'allow' [allow, error, denied] - policy state

Uses ODATA filter to filter the results based on various criteria. Filters can be combined together using 'and' operator. Filters are HTML encoded before sending. The supported filters currently are- applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' [name of application], sessionState eq 'closed' [closed, pending, established], policyState eq 'allow' [allow, error, denied]

limit
required
integer
Default: 100
Examples:
  • limit=10 - returns upto 10 items per page

Limits the number of items to return per page.

page
required
string
Examples:
  • page=5 - return next page from value "5"

The key in which to return the next page from. send "0" for the first page, send the received value to fetch the next batch, is no value is received in the response then no next batch is available.

Responses

Response samples

Content type
application/hal+json
{
  • "sessions": [
    ],
  • "count": 0,
  • "queryMetadata": {
    },
  • "page": "string",
  • "_links": {
    }
}

Retrieve access sessions metrics

Retrieves access sessions metrics.

query Parameters
resolution
required
string
Examples:
  • - 5 minutes is used to aggregate the number of sessions between 2 timestamps. For example, 2 timestamps are 5 minutes apart like 1702300086320 and 1702300386320 and the later datapoint shows all the sessions between these 2 timestamps

Provides the resolution being used to differentiate timestamps and show the aggregated results between 2 points.

start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

instanceID
string

Instance ID of the instance to fetch the data from. If not used all the instances from CM is used.

filter
string
Examples:
  • filter=applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' - application name
  • filter=sessionState eq 'closed' [closed, pending, established] - session state
  • filter=policyState eq 'allow' [allow, error, denied] - policy state

Uses ODATA filter to filter the results based on various criteria. Filters can be combined together using 'and' operator. Filters are HTML encoded before sending. The supported filters currently are- applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' [name of application], sessionState eq 'closed' [closed, pending, established], policyState eq 'allow' [allow, error, denied]

Responses

Response samples

Content type
application/hal+json
{
  • "metrics": [
    ],
  • "queryMetadata": {
    },
  • "_links": {
    }
}

Retrieve access sessions summary

Retrieves access sessions summary.

query Parameters
start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

instanceID
string

Instance ID of the instance to fetch the data from. If not used all the instances from CM is used.

filter
string
Examples:
  • filter=applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' - application name
  • filter=sessionState eq 'closed' [closed, pending, established] - session state
  • filter=policyState eq 'allow' [allow, error, denied] - policy state

Uses ODATA filter to filter the results based on various criteria. Filters can be combined together using 'and' operator. Filters are HTML encoded before sending. The supported filters currently are- applicationName eq 'tenantimY7t9084SQqati5c0zYwkA:app1' [name of application], sessionState eq 'closed' [closed, pending, established], policyState eq 'allow' [allow, error, denied]

Responses

Response samples

Content type
application/hal+json
{
  • "count": 0,
  • "policy_allow": 0,
  • "policy_error": 0,
  • "policy_denied": 0,
  • "_links": {
    }
}

Retrieve access sessions state summary

Retrieves access sessions state summary.

query Parameters
start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

instanceID
string

Instance ID of the instance to fetch the data from. If not used all the instances from CM is used.

Responses

Response samples

Content type
application/hal+json
{
  • "session_states": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Retrieve access sessions applications summary

Retrieves access sessions applications summary.

query Parameters
start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

instanceID
string

Instance ID of the instance to fetch the data from. If not used all the instances from CM is used.

Responses

Response samples

Content type
application/hal+json
{
  • "top_applications_summary": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Retrieve active sessions on all discovered instances

Retrieves the list of active sessions on all discovered instances.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "sessionId": "48acfb53",
  • "status": "established",
  • "user": "",
  • "clientIp": "172.18.1.96",
  • "startTime": "2022-06-09T17:45:38Z",
  • "expirationTime": "2022-06-09T18:00:55Z",
  • "policyName": "Start_Allow_Policy_bh_1",
  • "instanceId": "990cfa6e-e9cb-4e0d-bb1b-1dcd55f978d2",
  • "hostname": "big-ip-next.com"
}

Retrieve active sessions as json

Retrieves a list of active sessions in a json format.

path Parameters
instance-id
required
string <uuid>

Unique BIG-IP Next instance ID for the session in which it is generated.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "sessionId": "48acfb53",
  • "status": "established",
  • "user": "",
  • "clientIp": "172.18.1.96",
  • "startTime": "2022-06-09T17:45:38Z",
  • "expirationTime": "2022-06-09T18:00:55Z",
  • "policyName": "Start_Allow_Policy_bh_1",
  • "instanceId": "990cfa6e-e9cb-4e0d-bb1b-1dcd55f978d2",
  • "hostname": "big-ip-next.com"
}

Retrieve the active session

Retrieves the active session in a json format.

path Parameters
instance-id
required
string <uuid>

Unique BIG-IP Next instance ID for the session in which it is generated.

session-id
required
string

Unique session ID for the session on the BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "sessionId": "48acfb53",
  • "status": "established",
  • "user": "",
  • "clientIp": "172.18.1.96",
  • "startTime": "2022-06-09T17:45:38Z",
  • "expirationTime": "2022-06-09T18:00:55Z",
  • "policyName": "Start_Allow_Policy_bh_1",
  • "hostname": "big-ip-next.com"
}

End the active session

Ends the active session on the BIG-IP Next instance.

path Parameters
instance-id
required
string <uuid>

Unique BIG-IP Next instance ID for the session in which it is generated.

session-id
required
string

Unique session ID for the session on the BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "message": "Session <sessionId> successfully terminated on BIG-IP Next instance <instanceId>."
}

Retrieve active session variables as JSON

Retrieves the active session variables in a JSON format.

path Parameters
instance-id
required
string <uuid>

Unique BIG-IP Next instance ID for the session in which it is generated.

session-id
required
string

Unique session ID for the session on the BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "session.user.sessionid": "adbb118e",
  • "session.access.named_scope": "",
  • "session.access.profile": "297f395d-ebdf-548c-a7eb-38299270f1e9",
  • "session.access.profile_name": "my_access_policy",
  • "session.access.profileid": "297f395d-ebdf-548c-a7eb-38299270f1e9",
  • "session.access.profiletype": "2",
  • "session.access.scope": "2",
  • "session.client.activex": "0",
  • "session.client.browscap_info": "uimode=0&ctype=unknown&cversion=0&cjs=0&cactivex=0&cplugin=0&cplatform=unknown&cpu=unknown&ccustom_protocol=0",
  • "session.client.cpu": "unknown",
  • "session.client.custom_protocol": "0",
  • "session.client.js": "0",
  • "session.client.platform": "unknown",
  • "session.client.plugin": "0",
  • "session.client.type": "unknown",
  • "session.client.version": "0",
  • "session.createdfrom": "ACCESS",
  • "session.edgeclient.scripting.logoff.params": "",
  • "session.ha_unit": " 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000 0x00000000",
  • "session.inactivity_timeout": "900",
  • "session.keydb.current": "532a43389615110f459da9d2adbb118e",
  • "session.keydb.final": "fdcdb63fd9a1a6066d32624fadbb118e",
  • "session.logon.last.username": "joe",
  • "session.max_session_timeout": "604800",
  • "session.policy.result": "not_started",
  • "session.server.landinguri": "/",
  • "session.server.listener.name": "30d1132b-c203-5979-bb5b-00071d6551df",
  • "session.server.network.name": "10.0.66.159",
  • "session.server.network.port": "80",
  • "session.server.network.protocol": "http",
  • "session.snapshotid": "6d12e33910f_1ooooooooooooooooooo",
  • "session.state": "allow",
  • "session.stats.bytes.in": "0",
  • "session.stats.bytes.out": "0",
  • "session.stats.egress.compressed": "0",
  • "session.stats.egress.raw": "0",
  • "session.stats.ingress.compressed": "0",
  • "session.stats.ingress.raw": "0",
  • "session.stats.packets.in": "0",
  • "session.stats.packets.out": "0",
  • "session.timeout": "eval_timed_out",
  • "session.ui.lang": "en",
  • "session.ui.mode": "0",
  • "session.user.agent": "curl/7.68.0",
  • "session.user.clientip": "201.12.12.10",
  • "session.user.display_sessionid": "adbb118e",
  • "session.user.expirationtime": "1654568309",
  • "session.user.starttime": "1654562309"
}

API Gateway

The API Gateway provides a single endpoint for all interactions with the F5® BIG-IP® Next Central Manager. Its primary function is to handle authentication and route HTTP requests to internal services. It also provides a common endpoint that is the aggregation of all OpenAPI endpoints for each installed feature. The Gateway feature's API enables programmatic operations by the BIG-IP Next Central Manager.

User login

Login with user name and password. Validates the username and password and returns an authentication token and a refresh token. The authentication token has a short lifetime and should be included in subsequent API requests. The refresh token has a longer lifetime and can be used to get a new authentication token.

Request Body schema: application/json
required
username
required
string

User name

password
required
string

Password

provider_type
string
Default: "Local"
Enum: "Local" "LDAP" "RADIUS" "TACACS+"

Auth provider type

provider_name
string non-empty

Auth provider name

Responses

Request samples

Content type
application/json
{
  • "username": "user01",
  • "password": "PASSWORD",
  • "provider_type": "LDAP",
  • "provider_name": "dummy-ldap"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "user_id": "string",
  • "force_change_password": true
}

Generate authentication token

Use a user refresh token to generate an authentication token

Request Body schema: application/json
required
refresh_token
required
string

Refresh token

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "refresh test token"
}

Response samples

Content type
application/json
{
  • "access_token": "string"
}

User logout

Logs out the user by closing their session state.

Authorizations:
bearerAuth

Responses

Response samples

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

Retrieve system information

Retrieves system information.

Responses

Response samples

Content type
application/hal+json
{
  • "providers": [
    ],
  • "_links": {
    }
}

Replace temporary password with new password

Replaces a temporary password with a new password.

Request Body schema: application/json
required
username
required
string non-empty

User Name

temp_password
required
string non-empty

Temporary password

new_password
required
string non-empty

New password

Responses

Request samples

Content type
application/json
{
  • "username": "admin1",
  • "temp_password": "TEMP_PASSWORD",
  • "new_password": "NEW_PASSWORD"
}

Response samples

Content type
application/json
{
  • "message": "Password change was successful."
}

Application Services

Application Services APIs may operate on application services resources of the F5® BIG-IP® Next Central Manager.

Return all AS3 application services

Request all the AS3 application services, their deployments details, and last deployment records.

query Parameters
limit
integer >= 1
Examples:
  • limit=2 - Return up to 2 items per page

Limits the number of items to return per page.

page
integer >= 1
Examples:
  • page=2 - Return page number 2

The page number to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - Two column ascending sort
  • sort=-hostname - Single column descending sort
  • sort=address,-hostname - Mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending sorting order.

select
string
Examples:
  • select=name,state,status - selected column names

Provide the names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - Query by equality
  • filter=hostname starts with 'mbip' - Query by string
  • filter=port gte 80 - Query by numerical condition
  • filter=records/last_record/status eq 'completed'&expand=records - query by json array attributes
  • filter=records/total eq 2 - query by json
  • filter=completed eq true - query by boolean

Filter conditions for result queries. Query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 1
}

Save AS3 application service

Save an AS3 application service to BIG-IP Next Central Manager. This endpoint is for customers who wish to deploy application services one at a time. This API accepts application definitions at the application scope.

Request Body schema: application/json
required
object (ApplicationService)

AS3 Application Service definition

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Message": "Application service created successfully",
  • "_links": {
    },
  • "id": "dd9ab859-11ef-42d3-a107-ae37f557eb15\""
}

Returns an AS3 application service

Request a specific AS3 application service, its deployment details, and last deployment records.

path Parameters
document-id
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "app_data": {
    },
  • "created": "2024-06-05T22:41:28.590371Z",
  • "deployments": [
    ],
  • "deployments_count": {
    },
  • "id": "6230de41-37f5-46cd-84e9-3501a47dfd12",
  • "name": "app01",
  • "tenant_name": "default",
  • "type": "AS3"
}

Update AS3 application service

Updates an application service with new AS3 declaration and re-deploy changes to instances. This action deploys updates only to instances on which the AS3 declaration was previously deployed.

path Parameters
document-id
required
string <uuid>

Application ID

query Parameters
retry_failed
boolean

Use retry_failed=true to re-deploy to an instance after a failed deployment. retry_failed=true is not allowed on BIG-IP Next instances with unhealthy or unknown statuses and any attempt to redeploy to those instances fails with a validation error.

Request Body schema: application/json
required
object (ApplicationService)

AS3 Application Service definition

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "eea68104-f934-4090-8189-9acc990e076c",
  • "message": "Application service updated successfully"
}

Delete AS3 application service

Remove an AS3 application service from the deployed instance and also delete from BIG-IP Next Central Manager.

path Parameters
document-id
required
string <uuid>

Application ID

query Parameters
force
boolean

Use force=true as query parameter to remove deployments from all deployed instance (ignores remote removal failures) and delete the application service from BIG-IP Next Central Manager. This forces a deletion from unreachable instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "45231c07-5fe9-421d-87e8-fcfd73ac1158",
  • "message": "The application service was successfully deleted"
}

Deploy AS3 application service

Deploy an AS3 application service to a specified instance managed by BIG-IP Next Central Manager. If the deployment already exists on a different instance, the application service is removed from the existing instance before deploying to the new instance. This action will delete all verification results for all instances if the action is not set to 'dry-run'.

path Parameters
document-id
required
string

application ID

query Parameters
validation
string
Enum: "strict" "lazy"

Specify the declaration validation type.

updateMode
string
Enum: "complete" "selective"

Specify the update mode for configuration.

action
string
Value: "dry-run"

Specify the action to perform for the specified configuration.

show
string
Enum: "base" "full" "expanded"

Specify how the response document should be expanded.

Request Body schema: application/json
required
target
required
string [ 1 .. 64000 ] characters

The target deployment location of the BIG-IP Next instance.

Responses

Request samples

Content type
application/json
{
  • "target": "192.0.2.1"
}

Response samples

Content type
application/json
{
  • "Message": "Deployment task created successfully",
  • "_links": {
    },
  • "id": "2ceb048a-0ee6-4a2d-8952-cd15583bb5e8",
  • "task_id": "212ab859-11ef-42d3-a107-ae37f5asd15"
}

Return deployment records

Request all records for a specific deployment.

path Parameters
document-id
required
string

application ID

deployment-id
required
string

deployment ID

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "92d75b51-abb1-4460-b92f-fdc2553f99df",
  • "instance_id": "8aeb0515-7e76-4498-b392-a36f759f5959",
  • "last_app_modified": "2024-06-07T23:47:25.411127Z",
  • "last_successful_deploy_time": "2024-06-07T23:47:27.056544Z",
  • "records": [
    ],
  • "records_count": {
    },
  • "request": {
    },
  • "response": {
    },
  • "tenant_name": "default",
  • "type": "AS3"
}

Re-deploy AS3 declaration after failed deployment

Re-deploys an AS3 application service declaration to a BIG-IP Next instance if the deployment had previously failed.

path Parameters
document-id
required
string

application ID

deployment-id
required
string

deployment ID

query Parameters
validation
string
Enum: "strict" "lazy"

Specify the declaration validation type.

updateMode
string
Enum: "complete" "selective"

Specify the update mode for configuration.

show
string
Enum: "base" "full" "expanded"

Specify how the response document should be expanded.

Responses

Response samples

Content type
application/json
{
  • "Message": "Update deployment task created",
  • "_links": {
    },
  • "task_id": "212ab859-11ef-42d3-a107-ae37f5asd15",
  • "id": "0f41cedf-68c8-4e80-bd3a-584a2de1029d"
}

Delete application service deployment

Remove the specified application service deployment from BIG-IP Next Central Manager. An application service is first removed from its instance deployment(s) before it is deleted from BIG-IP Next Central Manager.

path Parameters
document-id
required
string

application ID

deployment-id
required
string

deployment ID

query Parameters
force
boolean
Default: false
Example: force=true

This flag determines whether the API deletes the data in BIG-IP Next Central Manager irrespective of whether the application was deleted from the instance.

local_delete
boolean
Default: false
Example: local_delete=true

This flag is used to delete only the data in BIG-IP Next Central Manager without attempting to delete the application from the instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "5faa962d-7192-4e86-ae81-30a7208e9f86",
  • "task_id": "d6270685-6e0c-4c28-962b-7cefbfe0f2da"
}

List AS3 declarative configuration

Lists AS3 declarative configuration, which behaves similarly to the BIG-IP AS3 API

query Parameters
target_address
string [ 1 .. 64000 ] characters

The target address to deploy to (preferred over payload option)

draft
boolean
Default: false

Whether only draft declarations should be retrieved

Responses

Response samples

Content type
application/json
{
  • "class": "ADC",
  • "tenant01": {
    }
}

Deploy AS3 declarative configuration

Deploys AS3 declarative configuration, which behaves similarly to the BIG-IP AS3 API. This endpoint provides backwards compatibility with AS3 running on BIG-IP instances prior to BIG-IP Next. This endpoint is meant for customers who have been using AS3 prior to BIG-IP Next and have existing declarations they wish to use on Next. The main difference between this and the standard documents API is that this API allows you to have multiple tenants and multiple applications per tenant in one declaration.

query Parameters
target_address
string [ 1 .. 64000 ] characters

The target address to deploy to (preferred over payload option)

Request Body schema: application/json
object (AppSvcsLegacyCreateRequest)

Responses

Request samples

Content type
application/json
{
  • "class": "ADC",
  • "target": {
    },
  • "tenant01": {
    }
}

Response samples

Content type
application/json
{
  • "declaration": {
    },
  • "results": [
    ]
}

Delete AS3 declarative configuration

Deletes AS3 declarative configuration, which behaves similarly to the BIG-IP AS3 API.

query Parameters
target_address
string [ 1 .. 64000 ] characters

The target address to delete configuration from

Responses

Response samples

Content type
application/json
{
  • "declaration": { },
  • "results": [
    ]
}

Delete AS3 declarative configuration for specific tenant

Deletes AS3 declarative configuration for specific tenant, which behaves similarly to the BIG-IP AS3 API.

path Parameters
tenant-name
required
string non-empty

tenant name

query Parameters
target_address
string [ 1 .. 64000 ] characters

The target address to delete tenant configuration from

Responses

Response samples

Content type
application/json
{
  • "declaration": { },
  • "results": [
    ]
}

Retrieve deployed applications

Retrieves a list of all deployed applications.

query Parameters
limit
integer >= 1
Examples:
  • limit=2 - Return up to 2 items per page

Limits the number of items to return per page.

page
integer >= 1
Examples:
  • page=2 - Return page number 2

The page number to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - Two column ascending sort
  • sort=-hostname - Single column descending sort
  • sort=address,-hostname - Mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending sorting order.

select
string
Examples:
  • select=name,state,status - selected column names

Provide the names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - Query by equality
  • filter=hostname starts with 'mbip' - Query by string
  • filter=port gte 80 - Query by numerical condition
  • filter=records/last_record/status eq 'completed'&expand=records - query by json array attributes
  • filter=records/total eq 2 - query by json
  • filter=completed eq true - query by boolean

Filter conditions for result queries. Query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve deployed applications for observability

Retrieves a list of all deployed applications for observability.

Responses

Response samples

Content type
application/hal+json
{
  • "values": {
    },
  • "_links": {
    }
}

Retrieve instances by applications names

Retrieves a list of instances by applications names filter for observability.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "instances": [
    ],
  • "_links": {
    }
}

Retrieve all applications

Retrieves a list of all applications.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

page
integer
Examples:
  • page=2 - return page number 2

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort the result. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition
  • filter=records/last_record/status eq 'completed'&expand=records - query by json array attributes
  • filter=records/total eq 2 - query by json
  • filter=completed eq true - query by boolean

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 1,
  • "total": 1
}

Create an application

Creates an AS3 application using the FAST template.

Request Body schema: application/json
required
object (CreateApplicationRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "App3",
  • "set_name": "Examples",
  • "template_name": "http",
  • "description": "App3-description",
  • "parameters": {
    }
}

Response samples

Content type
application/hal+json
{
  • "id": "da6a7197-c265-45af-a795-38e309f68078",
  • "message": "application created successfully",
  • "status": 200,
  • "_links": {
    }
}

Retrieve single application

Retrieves a specific application.

path Parameters
appsvc-id
required
string <uuid>

The UUID of the application.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "created": "2023-08-17T11:14:57.824038+05:30",
  • "deployments": [
    ],
  • "deployments_count": {
    },
  • "id": "fc839c4e-533b-429e-9eb0-9ab8ad147835",
  • "name": "App3",
  • "parameters": {
    },
  • "set_name": "Examples",
  • "template_name": "http",
  • "tenant_name": "tenantqKTq90T7JQj90Bk3xzrWCc0A",
  • "type": "FAST"
}

Update FAST application

Updates an existing FAST Application with the supplied values. This API can be used to add new deployments to an application, edit and delete existing deployments as well as attach new objects to the application.

path Parameters
appsvc-id
required
string <uuid>

The UUID of the application.

query Parameters
retry_failed
boolean
Default: false
Example: retry_failed=true

This flag determines whether the API will retry the earlier failed deployments. The flag is false by default.

dry_run
boolean
Default: false
Example: dry_run=true

This flag determines whether the API will dry run the deployment.

Request Body schema: application/json
required
object (UpdateApplicationRequest)

Update Application Request Body.

Responses

Request samples

Content type
application/json
{
  • "description": "test_desc",
  • "parameters": {
    },
  • "delete_deployments": [
    ],
  • "new_deployments": [
    ],
  • "existing_deployments": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "da6a7197-c265-45af-a795-38e309f68078"
}

Delete the FAST application

Deletes FAST application by deleting all the deployments attached to that application. The application will only be deleted if all the deployments attached to it are successfully deleted first.

path Parameters
appsvc-id
required
string <uuid>

The UUID of the application.

query Parameters
force
boolean
Default: false
Example: force=true

This flag determines whether the API will delete the data in the CM irrespective of whether the application was un-deployed from the instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "5e33337f-836d-4d91-800f-0a26d6b2421f"
}

Create a FAST application deployment

Creates a FAST application deployment

path Parameters
appsvc-id
required
string

ID of the application.

query Parameters
dry_run
boolean
Default: false
Example: dry_run=true

This flag determines whether the API will dry run the deployment.

Request Body schema: application/json
required
Array of objects (ApplicationDeploymentRequest)
generic_hosts
any (object)

Optional object to receive the generic hosts details for the deployment.

Responses

Request samples

Content type
application/json
{
  • "deployments": [
    ],
  • "generic_hosts": null
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "5e33337f-836d-4d91-800f-0a26d6b2421f"
}

Return single FAST application deployment records

Returns specific FAST application deployment records.

path Parameters
appsvc-id
required
string

ID of the application.

deployment-id
required
string

ID

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "application_id": "7f3feee7-da7a-46f8-bc8a-69988b1749f3",
  • "application_name": "multi-cert-app",
  • "description": "Fast application with multiple ports and certificates",
  • "dry_run": false,
  • "id": "9d0b8eeb-95b2-4f09-b5d8-601cf53d9f06",
  • "instance_id": "9baa8a9f-cde3-411b-bca0-c26ecef1bed0",
  • "last_successful_deploy_time": "2023-07-27T10:26:27.042858+05:30",
  • "modified": "2023-07-27T10:26:27.042858+05:30",
  • "parameters": {
    },
  • "records": [
    ],
  • "records_count": {
    },
  • "set_name": "Examples",
  • "template_name": "http",
  • "tenant_name": "Tenant1",
  • "type": "FAST"
}

Deletes the specified deployment

Deletes a specified deployment of a FAST application.

path Parameters
appsvc-id
required
string

ID of the application.

deployment-id
required
string

ID

query Parameters
force
boolean
Default: false
Example: force=true

This flag determines whether the API will delete the data in the CM irrespective of whether the application was un-deployed from the instance.

local_delete
boolean
Default: false
Example: local_delete=true

This flag will be used to delete only the data in the CM without attempting to un-deploy the application in the instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "5e33337f-836d-4d91-800f-0a26d6b2421f"
}

Deletes the deployments of multiple FAST applications to an instance

Deletes the deployments of multiple FAST applications to an instance.

path Parameters
id
required
string

ID of the instance.

query Parameters
force
boolean
Default: false
Example: force=true

This flag determines whether the API will delete the data in the CM irrespective of whether the application was un-deployed from the instance.

local_delete
boolean
Default: false
Example: local_delete=true

This flag will be used to delete only the data in the CM without attempting to un-deploy the application in the instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "deployments": [
    ],
  • "id": "5e33337f-836d-4d91-800f-0a26d6b2421f"
}

Application Templates

Application Templates APIs may operate on application template resources of the F5® BIG-IP® Next Central Manager.

Create a FAST template

Creates a new FAST template.

Request Body schema: application/json
required
name
required
string (Template name) non-empty ^[a-zA-Z0-9_-]+$
set_name
required
string (Template set name) non-empty ^[a-zA-Z0-9_-]+$
description
string (Template description)
body
required
string (Template body) non-empty
published
boolean
Default: false

The value true indicates that the template has been published, and this means the template is in use by an application or that it cannot be modified. When the template is published (value set to true), the template cannot be updated, deleted or moved from one template-set to another.

file_type
required
string
Enum: "YAML" "MST" "JSON"

Responses

Request samples

Content type
application/json
{
  • "name": "example-FAST-template",
  • "set_name": "fast",
  • "description": "optional template description",
  • "body": "template: |\n {\n \"class\": \"AS3\",\n \"action\": \"deploy\",\n \"persist\": true,\n \"declaration\": {\n \"class\": \"ADC\",\n \"schemaVersion\": \"3.0.0\",\n \"{{tenant_name}}\": {\n \"class\": \"Tenant\",\n \"{{application_name}}\": {\n \"class\": \"Application\",\n \"template\": \"http\",\n \"serviceMain\": {\n \"class\": \"Service_HTTP\",\n \"virtualPort\": {{virtual_port::integer}},\n \"virtualAddresses\": [\"{{virtual_address}}\"],\n \"pool\": \"{{application_name}}_web_pool\"\n },\n \"{{application_name}}_web_pool\": {\n \"class\": \"Pool\",\n \"monitors\": [\n \"http\"\n ],\n \"members\": [\n {\n \"servicePort\": {{service_port::integer}},\n \"serverAddresses\": {{server_addresses::array}}\n }\n ]\n }\n }\n }\n }\n }",
  • "file_type": "JSON"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/template-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Retrieve all TemplateSetName and TemplateName pairs

Retrieves a list of all the TemplateSetName and TemplateName pairs.

Responses

Response samples

Content type
application/json
[
  • "Examples/sslo-inbound-gateway-topology",
  • "Examples/http"
]

Retrieve a list of the template sets

Retrieves a list of the template sets, each containing a list of templates in that set.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

page
integer
Examples:
  • page=2 - return page number 2

The number of the page to return. Ignored if limit parameter is absent.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a list of all the templates

Retrieves a list of all of the templates.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

page
integer
Examples:
  • page=2 - return page number 2

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort the result. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition
  • filter=records/last_record/status eq 'completed'&expand=records - query by json array attributes
  • filter=records/total eq 2 - query by json
  • filter=completed eq true - query by boolean

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve a template

Retrieves the specified template.

path Parameters
set_name
required
string

Name of template set.

name
required
string

Name of the template.

Responses

Response samples

Content type
application/json
{
  • "id": "53b12b55-1ed4-4321-9196-388949623db8",
  • "name": "httpTemplate",
  • "set_name": "exampleTemplates",
  • "description": "http template example",
  • "body": "<full template here>",
  • "published": true,
  • "last_updated": "2022-01-31T15:18:46.098462-08:00",
  • "file_type": "MST",
  • "is_built_in": false
}

Delete a FAST template

Deletes an unpublished FAST template from BIG-IP Next Central Manager.

path Parameters
set_name
required
string

Name of template set.

name
required
string

Name of the template.

Responses

Response samples

Content type
application/json
{
  • "status": 401,
  • "message": "Incorrect credentials"
}

Replace FAST template

Replaces the entire FAST template object. Payload must contain all the required properties. The PUT operation enables updates to the name, set_name, file_type, description, published and body properties of the template.

path Parameters
set_name
required
string

Name of template set.

name
required
string

Name of the template.

Request Body schema: application/json
required
name
required
string (Template name) non-empty ^[a-zA-Z0-9_-]+$
set_name
required
string (Template set name) non-empty ^[a-zA-Z0-9_-]+$
description
string (Template description)
body
required
string (Template body) non-empty
published
boolean
Default: false

The value true indicates that the template has been published, and this means the template is in use by an application or that it cannot be modified. When the template is published (value set to true), the template cannot be updated, deleted or moved from one template-set to another.

file_type
required
string
Enum: "YAML" "MST" "JSON"

Responses

Request samples

Content type
application/json
{
  • "name": "example-FAST-template",
  • "set_name": "fast",
  • "description": "optional template description",
  • "body": "template: |\n {\n \"class\": \"AS3\",\n \"action\": \"deploy\",\n \"persist\": true,\n \"declaration\": {\n \"class\": \"ADC\",\n \"schemaVersion\": \"3.0.0\",\n \"{{tenant_name}}\": {\n \"class\": \"Tenant\",\n \"{{application_name}}\": {\n \"class\": \"Application\",\n \"template\": \"http\",\n \"serviceMain\": {\n \"class\": \"Service_HTTP\",\n \"virtualPort\": {{virtual_port::integer}},\n \"virtualAddresses\": [\"{{virtual_address}}\"],\n \"pool\": \"{{application_name}}_web_pool\"\n },\n \"{{application_name}}_web_pool\": {\n \"class\": \"Pool\",\n \"monitors\": [\n \"http\"\n ],\n \"members\": [\n {\n \"servicePort\": {{service_port::integer}},\n \"serverAddresses\": {{server_addresses::array}}\n }\n ]\n }\n }\n }\n }\n }",
  • "file_type": "JSON"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/template-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Update a FAST template's name and status

Partially updates the FAST template object. The PATCH operation enables updates to only the name, set_name, description, and published properties of the template.

path Parameters
set_name
required
string

Name of template set.

name
required
string

Name of the template.

Request Body schema: application/json
required
name
string (Template name) non-empty ^[a-zA-Z0-9_-]+$
set_name
string (Template set name) non-empty ^[a-zA-Z0-9_-]+$
description
string (Description of template)
published
boolean
Default: false

The value true indicates that the template has been published, and this means the template is in use by an application or that it cannot be modified. When the template is published (value set to true), the template cannot be updated, deleted or moved from one template-set to another.

Responses

Request samples

Content type
application/json
{
  • "name": "simple-https",
  • "set_name": "FAST",
  • "description": "A simple https application"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "error message"
}

Retrieve all template set names

Retrieves all template sets.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "templatesets": [
    ]
}

Data Groups

Data Groups APIs help to store and reference large data sets with frequent lookups and specific tasks.

Get all the data groups available in the CM

Get all the data groups available in the CM

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 2,
  • "total": 2
}

Create a new data group

Creates a new data group with the given values

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters

name of the data group

description
string

description of the data group

key_type
required
string
Enum: "STRING" "INTEGER" "ADDRESS"

key type of the data group

required
Array of objects (Key)

array of key-value pairs

Responses

Request samples

Content type
application/json
{
  • "name": "my_datagroup1",
  • "description": "data group description",
  • "key_type": "STRING",
  • "data": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Get details of a data group

Get all the details of the particular data group

path Parameters
id
required
string <uuid>

uuid of the data group

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "created": "2024-02-21T10:46:03.252002+05:30",
  • "created_by": "admin",
  • "data": [
    ],
  • "description": "data group with repeating key",
  • "id": "febd1636-cf7d-4092-add5-38b36eeae27f",
  • "key_type": "STRING",
  • "key_value_count": 5,
  • "name": "my_datagroup"
}

Partially modify data group

Partially modify some part of the data group including adding, updating or deleting a key

path Parameters
id
required
string <uuid>

uuid of the data group

Request Body schema: application/json
required
description
string

description of the data group

Array of objects (UpdateKey)

array of key-value pairs

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "description": "test desp"
}

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Completely replace data group

Completely replace the data group details with the new data

path Parameters
id
required
string <uuid>

uuid of the data group

Request Body schema: application/json
required
description
string

description of the data group

required
Array of objects (Key)

array of key-value pairs

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "data": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Deletes the data group

Deletes the particular data group

path Parameters
id
required
string <uuid>

uuid of the data group

Responses

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Deploy the data group

Deploy the data group to the BIG-IP

path Parameters
id
required
string <uuid>

uuid of the data group

Request Body schema: application/json
required
object (DeployRequest)

deployment or un-deployment request

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": [
    ]
}

Import a data-group file

Imports a file containing key value pairs and creates a new Data Group with the values.

Request Body schema: multipart/form-data
name
required
string [ 1 .. 255 ] characters

name of the data group

description
string

description of the data group

key_type
required
string
Enum: "STRING" "INTEGER" "ADDRESS"

key type of the data group

separator
string
Default: ":="
content
required
string <binary>

Responses

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Import a data-group file and completely override the existing data.

Imports a file containing key value pairs and completely overrides the existing the Data Group data.

path Parameters
id
required
string <uuid>

uuid of the data group

Request Body schema: multipart/form-data
separator
string
Default: ":="
content
required
string <binary>

Responses

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Import a data-group file and append the existing data.

Imports a file containing key value pairs and appends or updates the existing data.

path Parameters
id
required
string <uuid>

uuid of the data group

Request Body schema: multipart/form-data
separator
string
Default: ":="
content
required
string <binary>

Responses

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"
}

Export the data group

Send data group content in response

path Parameters
id
required
string <uuid>

uuid of the data group

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "code": "DG-0001",
  • "details": "",
  • "help": "Check and correct the input.",
  • "message": "DG-0001: DataGroupBadRequestError: Invalid request query parameters provided."
}

Global Resiliency Group

Global Resiliency Group APIs may operate on DNS resources of the F5® BIG-IP® Next Central Manager.

Create Global Resiliency Group (GR group)

Creates a Global Resiliency Group (GR group)

Request Body schema: application/json
required
name
required
string

Name of the Global Resiliency group.

dns_listener_name
required
string

Name of the DNS listener

dns_listener_port
required
integer

port on which the DNS instance is listening for DNS requests.

protocols
required
Array of strings non-empty
Items Enum: "tcp" "udp"

Protocols that are supported

required
Array of objects non-empty

instances that are going to be part of the Global Resiliency group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dns_listener_name": "string",
  • "dns_listener_port": 0,
  • "protocols": [
    ],
  • "instances": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "path": "/v1/gslb/gr-groups/4f8cbe8e-6a9b-4a43-a9b7-cf8f7a7b63f9"
}

Retrieve list of Global Resiliency Groups

Retrieves a list of all Global Resiliency Groups.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=name - single column ascending sort
  • sort=-health - single column descending sort
  • sort=name,-status - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,health,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'DRAFT' - query by equality
  • filter=name startswith 'dns' - query by string
  • filter=dns_listener_port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    },
  • "count": 0,
  • "total": 0
}

Retrieve Global Resiliency Group details

Retrieves a specific Global Resiliency Group details.

path Parameters
id
required
string <uuid>

The UUID of a Global Resiliency Group.

query Parameters
select
string
Examples:
  • select=name,health,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "string",
  • "dns_listener_name": "string",
  • "dns_listener_port": 0,
  • "instance_count": 0,
  • "error_message": "string",
  • "health": "string",
  • "fqdn_count": {
    },
  • "instances": {
    }
}

Delete a Global Resiliency Group

Deletes a Global Resiliency Group.

path Parameters
id
required
string <uuid>

The UUID of a Global Resiliency Group.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "path": "/v1/gslb/gr-groups/4f8cbe8e-6a9b-4a43-a9b7-cf8f7a7b63f9"
}

Update a Global Resiliency Group

Updates a Global Resiliency Group

path Parameters
id
required
string <uuid>

The UUID of a Global Resiliency Group.

Request Body schema: application/json
required
name
required
string

Name of the Global Resiliency group.

dns_listener_name
required
string

Name of the DNS listener

dns_listener_port
required
integer

port on which the DNS instance is listening for DNS requests.

protocols
required
Array of strings non-empty
Items Enum: "tcp" "udp"

Protocols that are supported

required
Array of objects non-empty

instances that are going to be part of the Global Resiliency group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dns_listener_name": "string",
  • "dns_listener_port": 0,
  • "protocols": [
    ],
  • "instances": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "path": "/v1/gslb/gr-groups/4f8cbe8e-6a9b-4a43-a9b7-cf8f7a7b63f9"
}

Retrieve list of FQDNs deployed on Global Resiliency Group

Retrieves a list of Fully Qualified Domain Names(FQDNs) deployed on a specific Global Resiliency Group.

path Parameters
id
required
string <uuid>

The UUID of a Global Resiliency Group.

query Parameters
select
string
Examples:
  • select=name,health,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
{
  • "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  • "group_name": "string",
  • "fqdn_count": 0,
  • "fqdns": {
    }
}

Retrieve Global Resiliency Group Names

Retrieves list of Global Resiliency Group Names.

Responses

Response samples

Content type
application/hal+json
{
  • "values": {
    },
  • "_links": {
    }
}

Retrieve Global Resiliency Group instances

Retrieves list of Global Resiliency Group instances.

Request Body schema: application/json
required
required
object

Responses

Request samples

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

Response samples

Content type
application/hal+json
{
  • "instances": [
    ],
  • "_links": {
    }
}

Files

File APIs may operate on files management resources of the F5® BIG-IP® Next Central Manager.

Retrieve metadata of a file

Retrieves the metadata of a specific file.

path Parameters
id
required
string <uuid>

UUID of file

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "file_name": "abc.txt",
  • "file_size": 12,
  • "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  • "id": "2f08aea1-6c03-439b-a448-0f33a35d294e",
  • "updated": "2021-04-02T23:30:36.594263Z"
}

Update file metadata

Updates a file's metadata. Note that only the file_name and description can be updated.

path Parameters
id
required
string <uuid>

UUID of file

Request Body schema: multipart/form-data
required
file_name
string
description
string

Responses

Request samples

Content type
multipart/form-data
{
  "file_name": "abc.txt",
  "description": "very important file, do not delete"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "file_name": "abc.txt",
  • "file_size": 12,
  • "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  • "id": "2f08aea1-6c03-439b-a448-0f33a35d294e",
  • "updated": "2021-04-02T23:30:36.594263Z"
}

Retrieve file content

Retrieves the content of a file.

path Parameters
id
required
string <uuid>

UUID of file

Responses

Response samples

Content type
application/octet-stream
This is a sample of file content.

Delete file

Deletes a specified file.

path Parameters
id
required
string <uuid>

UUID of file

Responses

Response samples

Content type
application/json
{
  • "status": 403,
  • "message": "user not authorized"
}

Upload a file

Uploads a specified file to the system.

Request Body schema: multipart/form-data
id
string <uuid>
file_name
required
string
file_type
string
hash
string
description
string
updated
string <date-time>
content
string <binary>

Responses

Request samples

Content type
multipart/form-data
{
  "file_name": "abc.txt",
  "content": "/tmp/abc.txt"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "filename": "abc.txt",
  • "id": "2f08aea1-6c03-439b-a448-0f33a35d294e",
  • "message": "File uploaded!"
}

Retrieve metadata of all files

Retrieves a list of metadata for all files.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

page
integer
Examples:
  • page=2 - return page number 2

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=task_type,status - two column ascending sort
  • sort=-task_type - single column descending sort
  • sort=task_type,-status - mixed ascending/descending sort

The column names used to sort the result. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=username startswith 'admin' - query by string
  • filter=file_size gt 1024 - query by numerical condition

The conditions for querying the result.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

iHealth

iHealth APIs may operate on iHealth resources of the F5® BIG-IP® Next Central Manager.

Test iHealth connection

Only tests the iHealth server connection without storing iHealth token details.

Request Body schema: application/json
required
client_id
required
string

iHealth login client ID.

secret
string

iHealth login Client Secret.

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "secret": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "expires": 323434233
}

Authenticate iHealth

Authenticates the iHealth server using client ID and secret and stores and overwrites iHealth token details.

Request Body schema: application/json
required
client_id
required
string

iHealth login client ID.

secret
string

iHealth login Client Secret.

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "secret": "string"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "expires": 323434233
}

Add iHealth configuration

Stores iHealth credentials in BIG-IP Next Central Manager.

Request Body schema: application/json
required
client_id
required
string

iHealth Client ID.

secret
required
string

iHealth Client Secret.

expiry_date
string <date>

iHealth credentials expiry date

Responses

Request samples

Content type
application/json
{
  • "client_id": "test-client-id",
  • "secret": "test-secret",
  • "expiry_date": "2023-11-27"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "message": "Credentials for iHealth have been successfully saved",
  • "status": 200
}

Retrieve iHealth configurations

Retrieves all iHealth configurations.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": { },
  • "clients": [
    ],
  • "total": 1
}

Update iHealth Configuration

Updates iHealth credentials in BIG-IP Next Central Manager.

path Parameters
key
required
string

iHealth login Client ID

Request Body schema: application/json
required
secret
required
string

iHealth Client Secret.

expiry_date
string <date>

iHealth credentials expiry date

Responses

Request samples

Content type
application/json
{
  • "secret": "string",
  • "expiry_date": "2019-08-24"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "message": "Credentials for iHealth have been updated successfully",
  • "status": 200
}

Delete iHealth configuration

Deletes iHealth configuration in BIG-IP Next Central Manager.

path Parameters
key
required
string

iHealth login Client ID

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "message": "Credentials for iHealth have been successfully deleted",
  • "status": 200
}

Publishers

Publisher APIs efficiently sends high-volume traffic logs using TCP and UDP protocols and remote syslog and Splunk formats.

Retrieve High-Speed log publishers

Retrieves a list of High-Speed log publishers.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

page
integer
Examples:
  • page=2 - return page number 2

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=task_type,status - two column ascending sort
  • sort=-task_type - single column descending sort
  • sort=task_type,-status - mixed ascending/descending sort

The column names used to sort the result. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=username startswith 'admin' - query by string
  • filter=file_size gt 1024 - query by numerical condition

The conditions for querying the result.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    },
  • "count": 0,
  • "total": 0
}

Create High-Speed log publisher

Creates a High-Speed log publisher to specify the destination for sending logs.

Request Body schema: application/json
required
id
string <uuid>

Log Publisher ID

type
required
string <= 255 characters
description
string
name
required
string <= 255 characters
required
Array of HSL Remote Syslog Destination (object) or Splunk Over HSL Destination (object) or Splunk Over HSL Remote Syslog Destination (object)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "description": "string",
  • "name": "string",
  • "destinations": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "_links": {
    }
}

Retrieve High-Speed log publisher

Retrieves a High-Speed log publisher by ID.

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "description": "string",
  • "name": "string",
  • "destinations": [
    ]
}

Update High-Speed log publisher

Updates a High-Speed log publisher by ID.

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Log Publisher ID

type
required
string <= 255 characters
description
string
required
Array of HSL Remote Syslog Destination (object) or Splunk Over HSL Destination (object) or Splunk Over HSL Remote Syslog Destination (object)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "description": "string",
  • "destinations": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": "string",
  • "message": "string",
  • "status": 0,
  • "task_type": "string",
  • "task_id": [
    ]
}

Delete High-Speed log publisher

Deletes a High-Speed log publisher by ID.

path Parameters
id
required
string <uuid>

Log Publisher ID

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "message": "string",
  • "status": 0,
  • "_links": {
    }
}

Instances

Instance APIs may operate on instance management resources of the F5® BIG-IP® Next Central Manager.

Proxy a file upload

Proxy a file upload request for a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: multipart/form-data
required
fileName
required
string
name
required
string
description
string
passphrase
string

Responses

Request samples

Content type
multipart/form-data
{
  "fileName": "/Users/bob/tmp/upload/secure-encrypted.key;type=application/pkcs8",
  "name": "mysecure.p8",
  "passphrase": "1234"
}

Response samples

Content type
application/json
{
  • "id": "5f76bac6-716d-4ab5-9e4f-71e55bf2b742",
  • "verb": "POST",
  • "uri": "/files",
  • "request": "{\"id\":\"69c02263-6d69-46f7-bed9-5757a77fa40c\",\"name\":\"Sample file\",\"filename\":\"ThisIsAFile.txt\",\"description\":\"This is an example for file upload\",\"uri\":\"file://opt/f5/mbip/subsystem/csm/shared/persisted/files/69c02263-6d69-46f7-bed9-5757a77fa40c-6822e2fd-abee-4fe8-a499-2e9ad7250a50\",\"hash\":\"7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9\",\"size\":12,\"type\":\"GENERIC\"}",
  • "role": "AGENTCONFIG",
  • "status": "PENDING",
  • "message": "",
  • "creationTime": "2021-04-06T17:25:08.919313Z",
  • "updateTime": "2021-04-06T17:25:08.919313Z",
  • "owner": "admin",
  • "authn": "local",
  • "authz": "global"
}

Get instance BIG-IP Next license details with basic auth

Get license details for a BIG-IP Next instance using basic auth.

Request Body schema: application/json
required
address
required
string
port
required
integer <int> [ 1 .. 65535 ]
username
required
string non-empty
password
required
string <password> non-empty

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "port": 1,
  • "username": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/hal+json
{
  • "isActivated": true,
  • "isActiveUntil": "2006-01-02T15:04:05Z07:00"
}

Discover and bring a BIG-IP Next instance under management

Requests a task to add (discover) a BIG-IP Next instance to BIG-IP Next Central Manager for management.

Request Body schema: application/json
required
address
required
string
port
required
integer <int32> [ 1 .. 65535 ]
device_user
string
device_password
string <password>
device_group
string
management_user
string non-empty
management_password
string <password> non-empty

Responses

Request samples

Content type
application/json
{
  • "address": "10.145.10.1",
  • "port": 5443,
  • "device_user": "admin",
  • "device_password": "admin",
  • "management_user": "sample_mgmt_admin",
  • "management_password": "admin"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/discovery-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Retrieve all managed BIG-IP Next instances

Retrieves a list of all managed BIG-IP Next instances.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

healthcheck
boolean
Examples:
  • healthcheck=true - enable health check requests

Special parameter to request a health check for a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
Example
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 3,
  • "total": 3
}

Retrieve a managed BIG-IP Next instance

Retrieves a specific managed BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
Example
{
  • "_links": {
    },
  • "address": "10.145.10.1",
  • "certificate_validated": "2021-05-04T00:05:43.1025576Z",
  • "certificate_validation_error": "x509: cannot validate certificate for 10.145.10.1 because it doesn't contain any IP SANs",
  • "certificate_validity": false,
  • "hostname": "mbip1-sample-com",
  • "id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "mode": "STANDALONE",
  • "platform_name": "VMware",
  • "platform_type": "VE",
  • "analytics_node_address": "10.10.125.226",
  • "port": 5443,
  • "short_id": "qSRPAm8v",
  • "version": "2022-07.0.7.0-2.1.8"
}

Remove a BIG-IP Next instance Deprecated

Deletes a a BIG-IP Next instance from BIG-IP Next Central Manager. This endpoint is deprecated. Use '/api/v1/spaces/default/instances/{id}/cleanup' instead.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
save_backup
boolean

Responses

Request samples

Content type
application/json
{
  • "save_backup": "true"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/deletion-tasks/ad1f3ccd-d0f9-4bc9-82da-697a0a30069f"
}

Remove a BIG-IP Next instance

Deletes a a BIG-IP Next instance from BIG-IP Next Central Manager.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
save_backup
boolean

Responses

Request samples

Content type
application/json
{
  • "save_backup": "true"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/deletion-tasks/ad1f3ccd-d0f9-4bc9-82da-697a0a30069f"
}

Retrieve health of a BIG-IP Next instance

Retrieves the health of a BIG-IP Next HA or standalone instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "HEALTHY",
  • "mode": "STANDALONE",
  • "nodes": [
    ],
  • "node_count": 0
}

Return an onboarding manifest on a BIG-IP Next Instance

Requests the onboarding manifest on a BIG-IP Next Instance

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "mode": "STANDALONE",
  • "platformType": "VE",
  • "siteInfo": {
    },
  • "defaultCredentials": {
    },
  • "nodes": [
    ],
  • "vlans": [
    ],
  • "l1Networks": [
    ],
  • "cluster": {
    },
  • "users": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
  • "_links": {
    }
}

Provision BIG-IP Next modules

Requests a task to provision BIG-IP Next modules.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
additional property
object (ModuleProvisionState)

Responses

Request samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/v1/module-provision-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Validate instance certificate

Validates the certificate of a BIG-IP Next instance with a TLS handshake.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "address": "10.145.10.1",
  • "certificate_validated": "2021-05-04T01:05:43.1025576Z",
  • "certificate_validity": true,
  • "hostname": "mbip94.sample.com",
  • "id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "port": 5443
}

Upgrade BIG-IP Next instance

Upgrades a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
image_name
required
string
upgrade_type
required
string
signature_name
required
string

Responses

Request samples

Content type
application/json
{
  • "upgrade_type": "velos",
  • "partition_address": "10.144.191.22",
  • "partition_port": 8888,
  • "partition_user": "admin",
  • "partition_password": "site02!",
  • "image_name": "f5-mov-tarball-v1.10.2",
  • "tenant_name": "mbip-on-velos"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/discovery-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Create a BIG-IP Next HA instance from two standalone BIG-IP Next instances

Requests a task to create a BIG-IP Next HA instance from two managed standalone BIG-IP Next instances.

path Parameters
id
required
string <uuid>

The UUID of an active BIG-IP Next instance.

Request Body schema: application/json
required
auto_failback
boolean (Auto Failback)
Default: false

Automatically restore operations to the original active node if it is available, or when it becomes available if it is not.

cluster_management_ip
required
string (Cluster Management IP)

The cluster IP address on management network.

cluster_name
string <= 192 characters

Name of the BIG-IP Next HA instance.

required
object (HA VLAN)

The VLAN used for high availability.

required
object (HA VLAN)

The VLAN used for high availability.

required
Array of objects (HAInstanceCreateRequestForNode) = 2 items

The first item is the configuration for the active node in a BIG-IP Next HA instance. Subsequent items are for other nodes.

standby_instance_id
required
string <uuid>

The UUID of a managed standalone BIG-IP Next instance selected to become the standby node in a BIG-IP Next HA instance.

Array of objects (TrafficVlanRequest)

Responses

Request samples

Content type
application/json
{
  • "auto_failback": false,
  • "cluster_management_ip": "10.192.1.1",
  • "cluster_name": "string",
  • "control_plane_vlan": {
    },
  • "data_plane_vlan": {
    },
  • "nodes": [
    ],
  • "standby_instance_id": "88f2ef19-01ca-49fd-ab76-e55630f65284",
  • "traffic_vlan": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/v1/ha-creation-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Force failover

Requests a task to force failover from the primary to the standby node in a BIG-IP Next HA instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next HA instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/v1/ha-failover-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Back up a BIG-IP Next instance

Requests a backup of a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
file_name
string
file_path
string
encryption_password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "encryption_password": "Hello World!"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/discovery-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Schedule the back up

Schedules the back up of multiple BIG-IP Next instances.

Request Body schema: application/json
required
One of
name
required
string
description
required
string
encryption_password
required
string <password>
instance_ids
required
Array of strings <uuid> [ items <uuid > ]
schedule_type
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "encryption_password": "pa$$word",
  • "instance_ids": [
    ],
  • "schedule_type": "string",
  • "schedule": {
    },
  • "BasicWithInterval": {
    }
}

Response samples

Content type
application/hal+json
{
  • "message": "string",
  • "id": "string",
  • "path": "string",
  • "_links": {
    }
}

Update an instance backup schedule

Updates an instance backup schedule.

path Parameters
id
required
string <uuid>

The UUID of a schedule backup.

Request Body schema: application/json
required
One of
name
required
string
description
required
string
encryption_password
required
string <password>
instance_ids
required
Array of strings <uuid> [ items <uuid > ]
schedule_type
required
string
required
object
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "encryption_password": "pa$$word",
  • "instance_ids": [
    ],
  • "schedule_type": "string",
  • "schedule": {
    },
  • "BasicWithInterval": {
    }
}

Response samples

Content type
application/hal+json
{
  • "message": "00000000-0000-1000-8000-000000000000 failed: unknown instance ID",
  • "status": "completed",
  • "id": "c30cbb1e-899e-4c0e-8969-ace06c62ea82"
}

Delete an instance backup schedule

Requests to delete an instance backup schedule.

path Parameters
id
required
string <uuid>

The UUID of a schedule backup.

Responses

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Retrieve information about a scheduled instance backup

Retrieves the information about a scheduled instance backup

path Parameters
id
required
string <uuid>

The UUID of a schedule backup.

Responses

Response samples

Content type
application/hal+json
{
  • "devices": {
    },
  • "schedule_frequency": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "schedule_id": "8929bb67-0da1-406c-99d2-5447376a4f58",
  • "_links": {
    }
}

Restore a BIG-IP Next instance

Restores a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
file_name
required
string
encryption_password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "file_name": "8035818e-f647-4eac-af19-d3c13b8963cd.2022-10-06.22-37-36.backup.tar.gz",
  • "encryption_password": "Hello World!"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/discovery-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Retrieve BIG-IP Next instance instantiation tasks

Retrieves a list of instantiation tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance instantiation task

Retrieves a specific instantiation task for a vm creation in third party cloud.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance instantiation task.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "completed": "2021-04-02T23:11:19.08911Z",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "failure_reason": "",
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "state": "init",
  • "status": "completed",
  • "task_payload": {
    }
}

Retrieve nodes

Retrieves a list of all nodes

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a node

Retrieves a specified node

path Parameters
id
required
string <uuid>

The UUID of a node.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "id": "86b3edfa-9b70-4b5b-b105-63ef5ba3d7fb",
  • "manifest_id": "f3596c91-1a5d-4701-b128-33b49c35d808",
  • "status": "ONBOARDED",
  • "provider_type": "VSPHERE",
  • "provider_id": "f281f7fc-ab0a-45e9-a750-7b5833f79c95",
  • "vm_id": "4f004523eebf",
  • "payload": { },
  • "management_address": "192.168.52.29",
  • "management_port": 8443,
  • "role": "ACTIVE",
  • "_links": {
    }
}

Retrieve all upgrade instance tasks

Retrieves a list of all upgrade instance tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance upgrade task

Retrieves a specific upgrade task for a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance upgrade task.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "partition_user": "admin",
  • "partition_address": "10.144.191.22",
  • "image_name": "f5-mov-tarball-v1.10.2",
  • "instance_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "tenant_name": "mbip-on-velos",
  • "state": "addingDeviceToGroup",
  • "status": "completed",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "completed": "2021-04-02T23:11:19.08911Z",
  • "failure_reason": ""
}

Update BIG-IP Next instance upgrade task

Updates a specific BIG-IP Next instance upgrade task. As of now, we only accept whether to accept or reject untrusted certificate.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance upgrade task.

Request Body schema: application/json
required
id
string <uuid>
partition_user
string
partition_password
string <password>
partition_address
string
image_name
string
instance_id
string <uuid>
tenant_name
string
state
string
status
string
step
string
details
string
created
string <date-time>
completed
string <date-time>
failure_reason
string
is_user_accepted_untrusted_cert
boolean

Responses

Request samples

Content type
application/json
{
  • "is_user_accepted_untrusted_cert": true
}

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Retrieve all BIG-IP Next instance discovery tasks

Retrieves a list of discovery tasks for all managed BIG-IP Next instances.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance discovery task

Retrieves a specific discovery task for a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance discovery task.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
Example
{
  • "_links": {
    },
  • "address": "10.145.10.1",
  • "completed": "2021-04-02T23:11:19.08911Z",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "device_group": "default",
  • "device_user": "admin",
  • "discovered_device_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "discovered_device_path": "/api/v1/spaces/default/instances/c9796e86-21f7-4182-be1c-c737ed430242",
  • "failure_reason": "",
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "port": 5443,
  • "state": "discoveryDone",
  • "status": "completed"
}

Update BIG-IP Next instance discovery task

Updates a specific BIG-IP Next instance discovery task. As of now, we only accept whether to accept or reject untrusted certificate.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance discovery task.

Request Body schema: application/json
required
is_user_accepted_untrusted_cert
boolean

Responses

Request samples

Content type
application/json
{
  • "is_user_accepted_untrusted_cert": true
}

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Retrieve all BIG-IP Next HA instance creation tasks Deprecated

Retrieves a list of all BIG-IP Next HA instance creation tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve a BIG-IP Next HA instance creation task

Retrieves a specific BIG-IP Next HA instance creation task.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next HA instance creation task.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "task_type": "string",
  • "name": "string",
  • "state": "string",
  • "status": "string",
  • "failure_reason": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "payload": {
    },
  • "_links": {
    }
}

Retrieve all BIG-IP Next HA instance failover tasks Deprecated

Retrieves a list of all BIG-IP Next HA instance failover tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve BIG-IP Next HA instance failover task

Retrieves a specific BIG-IP Next HA instance failover task.

path Parameters
id
required
string <uuid>

The UUID of BIG-IP Next HA instance failover task

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "task_type": "string",
  • "name": "string",
  • "state": "string",
  • "status": "string",
  • "failure_reason": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "completed": "2019-08-24T14:15:22Z",
  • "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366",
  • "_links": {
    }
}

Retrieve all BIG-IP Next instance deletion tasks

Retrieves a list of BIG-IP Next instance deletion tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance deletion task

Retrieves a specific BIG-IP Next instance deletion task.

path Parameters
id
required
string <uuid>

UUID of task

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "address": "10.145.66.196",
  • "completed": "2021-04-07T17:48:45.630172Z",
  • "created": "2021-04-07T17:48:45.113981Z",
  • "device_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "failure_reason": "",
  • "id": "e8dd5c25-3357-4a05-825d-b183f6999b3e",
  • "state": "instanceRemovalDone",
  • "status": "completed"
}

Retrieve all BIG-IP Next instance backup tasks

Retrieves a list of BIG-IP Next instance backup tasks.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance backup task

Retrieves a specific BIG-IP Next instance backup task.

path Parameters
id
required
string <uuid>

The UUID of an instance backup task.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "instance_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "instance_name": "us-west-sea-bigip-2a",
  • "file_name": "c9796e86-21f7-4182-be1c-c737ed430242.2021-04-02.23-11-19.backup",
  • "file_path": "storage/backups",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "completed": "2021-04-02T23:12:18.051859Z",
  • "failure_reason": "",
  • "state": "backupDone",
  • "status": "completed"
}

Retrieve BIG-IP Next module provision tasks

Retrieves a list of all BIG-IP Next HA module provision tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve BIG-IP Next module provision task

Retrieves a specific BIG-IP Next module provision task.

path Parameters
id
required
string <uuid>

UUID of task

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "a8dd5c25-1357-4b05-825d-b183f6999b3e",
  • "instance_id": "d9796e86-31f7-4282-be1c-c737ed430242",
  • "completed": "2023-08-04T17:48:45.630172Z",
  • "created": "2023-08-04T17:48:45.113981Z",
  • "failure_reason": "",
  • "state": "moduleProvisionDone",
  • "status": "completed"
}

Create a new instance group

Creates a new instance group.

Request Body schema: application/json
required
id
string <uuid>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "test-group"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "e92346e4-1b66-4ba6-ab18-5b0a3e113a3d",
  • "name": "test-group"
}

Retrieve all instance groups

Retrieves a list of all instance groups.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve an instance group

Retrieves a specific instance group.

path Parameters
id
required
string <uuid>

The UUID of an instance group.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "e92346e4-1b66-4ba6-ab18-5b0a3e113a3d",
  • "name": "test-group"
}

Update an instance group

Updates a specific instance group.

path Parameters
id
required
string <uuid>

The UUID of an instance group.

Request Body schema: application/json
required
id
string <uuid>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "renamed-group"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "e92346e4-1b66-4ba6-ab18-5b0a3e113a3d",
  • "name": "renamed-group"
}

Remove an instance group

Removes an instance group.

path Parameters
id
required
string <uuid>

The UUID of an instance group.

Responses

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Add an instance to instance group

Adds an instance to an instance group.

path Parameters
id
required
string <uuid>

The UUID of an instance group.

Request Body schema: application/json
required
hostname
string
id
required
string <uuid>
short_id
string
port
integer <int32>
version
string
certificate_validity
boolean
certificate_validation_error
string
certificate_validated
string <date-time>
mode
string
Enum: "STANDALONE" "HA"
platform_name
string <= 16 characters

Specifies the platform name of this BIG-IP Next instance.

platform_type
string <= 16 characters

Specifies the platform type of this BIG-IP Next instance.

analytics_node_address
string
status
string
Enum: "HEALTHY" "UNHEALTHY" "UNKNOWN"

Responses

Request samples

Content type
application/json
{
  • "id": "c30cbb1e-899e-4c0e-8969-ace06c62ea82"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "c30cbb1e-899e-4c0e-8969-ace06c62ea82"
}

Retrieve all instances in instance group

Lists all instances in an instance group.

path Parameters
id
required
string <uuid>

The UUID of an instance group.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve an instance of an instance group

Retrieves a specific BIG-IP Next instance in an instance group.

path Parameters
groupID
required
string <uuid>

The UUID of an instance group.

instanceID
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "address": "10.145.10.1",
  • "id": "c30cbb1e-899e-4c0e-8969-ace06c62ea82",
  • "port": 5443
}

Remove an instance from instance group

Removes a BIG-IP Next instance from an instance group.

path Parameters
groupID
required
string <uuid>

The UUID of an instance group.

instanceID
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/json
{
  • "status": 403,
  • "message": "user not authorized"
}

Back up multiple BIG-IP Next instances

Backs up multiple BIG-IP Next instances.

Request Body schema: application/json
required
encryption_password
required
string <password>
instance_ids
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "encryption_password": "HelloPassword!",
  • "instance_ids": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "created": "2021-04-02T23:11:18.051859Z",
  • "failure_reason": "00000000-0000-1000-8000-000000000000 failed: unknown instance ID",
  • "status": "completed",
  • "tasks": [
    ]
}

Retrieve backup file information

Retrieves a list of backup files for managed BIG-IP Next instances.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve backup information

Retrieves the specified backup file for a managed BIG-IP Next instance.

path Parameters
file_name
required
string

The name of a BIG-IP Next instance backup file.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "instance_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "instance_name": "us-west-sea-bigip-2a",
  • "file_name": "c9796e86-21f7-4182-be1c-c737ed430242.2021-04-02.23-05-03.backup",
  • "file_size": "5368709120",
  • "file_date": "2021-04-02T23:05:03.395725Z"
}

Delete a backup file

Deletes a backup file specified by name.

path Parameters
file_name
required
string

The name of a BIG-IP Next instance backup file.

Responses

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Retrieve all BIG-IP Next instance restore tasks

Retrieves a list of BIG-IP Next instance restore tasks.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance restore task

Retrieves a specific BIG-IP Next instance restore task.

path Parameters
id
required
string <uuid>

The UUID of an instance restore task.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "instance_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "instance_name": "us-west-sea-bigip-2a",
  • "file_name": "c9796e86-21f7-4182-be1c-c737ed430242.2021-04-02.23-11-19.backup",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "completed": "2021-04-02T23:12:18.051859Z",
  • "failure_reason": "",
  • "state": "TriggerRestore",
  • "status": "InProgress"
}

Returns all VLAN tag numbers for both nodes in a BIG-IP Next HA instance

Returns all VLAN tag numbers for both nodes in a BIG-IP Next HA instance. This endpoint is only for VELOS and rSeries instances.

query Parameters
instanceId1
required
string <uuid>

Instance ID of a BIG-IP Next instance that is going to be the active instance for HA.

instanceId2
required
string <uuid>

Instance ID of a BIG-IP Next instance that is going to be the standby instance for HA.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "tags": [
    ]
}

Retrieve all control planes

Retrieves all control planes for both BIG-IP Next instances.

query Parameters
active
required
string <uuid>

The UUID of a BIG-IP Next instance.

standby
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "vlans": [
    ],
  • "_links": {
    }
}

Retrieve all data plane VLANs

Retrieves all data plane VLANs for both BIG-IP Next instances.

query Parameters
active
required
string <uuid>

The UUID of a BIG-IP Next instance.

standby
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "vlans": [
    ],
  • "_links": {
    }
}

Compose an instantiation, onboarding and discovery workflow for a BIG-IP Next

Composes a workflow task which instantiates, onboards and discovers a BIG-IP Next. Depends on payload.

Request Body schema: application/json
required
template_name
required
string

Name of the template.

parameters
required
object

Parameter values for this template.

Responses

Request samples

Content type
application/json
{
  • "template_name": "default-standalone-velos",
  • "parameters": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/initialization/tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Retrieve BIG-IP Next instance creation configuration

Retrieves a specific BIG-IP Next instance creation configuration.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "d8ab1e65-1a13-4512-9826-a4ed8b6eaead",
  • "instance_id": "01721304-eaf8-4aa4-a2ef-d532c4ecd2bd",
  • "onboarding_manifest_id": "fd5450c5-fbac-48cc-b57e-126e8e1dfb44",
  • "parameters": {
    }
}

Update BIG-IP Next instance configuration

Updates a specific BIG-IP Next instance configuration.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
template_name
required
string

Name of the template.

parameters
required
object

Parameter values for this template.

Responses

Request samples

Content type
application/json
{
  • "template_name": "default-standalone-velos",
  • "parameters": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/initialization/tasks/50a7d974-c918-4719-a78e-9330b0dfc559"
}

Update a BIG-IP HA Next instance

Updates a BIG-IP Next HA instance

path Parameters
instance_id
required
string <uuid>

The UUID of the BIG-IP HA Next instance.

Request Body schema: application/json
required
hostname
string

Hostame of the BIG-IP Next instance.

Array of objects (L1 Network)

Array of L1-Networks

Array of IPv4 Address (string) or IPv6 Address (string) (DNS Servers)
Default: []

An array of DNS servers.

Array of (IP Address (IPv4 Address (string) or IPv6 Address (string))) or Domain Name (string) (NTP Servers)
Default: []

Array of NTP servers (e.g., [0.ro.pool.ntp.org, 1.ro.pool.ntp.org]).

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "l1Networks": [
    ],
  • "dnsServers": "[2001:db8:245:245::53, 192.0.2.53]",
  • "ntpServers": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/onboarding-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Retrieve BIG-IP Next instance creation tasks

Retrieves a list of all BIG-IP Next instance creation tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next creation task

Retrieves a specific BIG-IP Next creation task.

path Parameters
id
required
string <uuid>

The UUID of an instance-creation task.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
Example
{
  • "_links": {
    },
  • "completed": "2024-06-03T16:54:20.849371Z",
  • "created": "2024-06-03T16:44:21.935856Z",
  • "failure_reason": "",
  • "id": "0b4b5138-e8ed-40a3-870f-695763d417e1",
  • "name": "instance creation",
  • "payload": {
    },
  • "stage": "Discovery",
  • "state": "discoveryDone",
  • "status": "completed",
  • "task_type": "instance_creation",
  • "updated": "2024-06-03T16:54:20.849371Z"
}

Retrieve all VLANs used for traffic

Retrieves all VLANs used for traffic for a BIG-IP Next HA instance

path Parameters
instanceID
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "vlans": [
    ],
  • "_links": {
    }
}

Retrieve network interfaces

Retrieves the names of all network interfaces (except management interface) on a BIG-IP Next.

path Parameters
instanceID
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "interfaces": [
    ],
  • "_links": {
    }
}

Retrieve BIG-IP Next instance templates

Retrieves a list of all templates used for instantiation, onboarding, and discovery of BIG-IP Next instances.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve the BIG-IP Next instantiation, onboarding, and discovery template

Retrieves a specific template used for instantiation, onboarding, and discovery of BIG-IP Next instances.

path Parameters
name
required
string
Example: default-standalone-ve

The name of the BIG-IP Next instance template.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "7e6a9457-6949-4bcd-b051-4d36d3a31b45",
  • "name": "default-standalone-ve",
  • "description": "Default instance template for standalone BIG-IP Next instances running in a VE (3rd-party virtual environment).",
  • "mode": "STANDALONE",
  • "platformType": "VE",
  • "file_type": "YAML",
  • "body": "definitions:\n provider_type:\n type: string\n management_address:\n title: Management IP Address\n type: string\n # ...more template parameters...\ntemplate: |\n {\n \"instantiation\" : {\n \"provider_type\": \"{{provider_type}}\",\n \"[...other fields\": \"in instantiation payload...]\"\n },\n \"onboarding\": {\n \"mode\": \"STANDALONE\",\n \"platform_type\": \"VE\",\n \"[...other fields\": \"in onboarding payload...]\"\n },\n \"discovery\": {\n \"management_address\": \"{{management_address}}\",\n \"[...other fields\": \"in discovery payload...]\"\n }",
  • "published": true,
  • "last_updated": "2021-04-02T23:11:18.051859Z"
}

Return the schema for the instantiation, onboarding, and discovery template

Requests the JSON schema describing the parameters in the named instantiation, onboarding, and discovery template. Primarily intended for use by the BIG-IP Next Central Manager GUI.

path Parameters
name
required
string
Example: default-standalone-ve

The name of the instantiation, onboarding, and discovery template.

Responses

Response samples

Content type
application/hal+json
{
  • "name": "default-standalone-ve",
  • "schema": "{\n \"type\": \"object\",\n \"properties\": {\n \"management_address\": {\n \"type\": \"string\",\n \"title\": \"Management IP Address\",\n \"[...]\": \"[...]\"\n },\n \"provider_type\": {\n \"[...]\": \"[...]\"\n },\n \"[...]\": \"[...]\"\n },\n \"[...]\": \"[...]\"\n}"
}

Render the instantiation, onboarding, and discovery template

Applies the provided template parameter values to the instantiation, onboarding, and discovery template, and returns the rendered template body.

path Parameters
name
required
string
Example: default-standalone-ve

The name of the instantiation, onboarding, and discovery template.

Request Body schema: application/json
required
object (InstanceTemplateRenderRequest)

Values for any template parameters associated with a given template, to be used when rendering the template.

Responses

Request samples

Content type
application/json
{
  • "provider_type": "VSPHERE",
  • "management_address": "10.2.3.4",
  • "another_parameter": "example template parameters",
  • "ip_address_array_parameter": [
    ],
  • "object_parameter": {
    },
  • "boolean_parameter": true,
  • "numeric_parameter": 7
}

Response samples

Content type
application/hal+json
{
  • "name": "default-standalone-ve",
  • "result": "{\n \"instantiation\": {\n \"provider_type\": \"VSPHERE\",\n \"[...other fields\": \"in instantiation payload...]\"\n },\n \"onboarding\": {\n \"mode\": \"STANDALONE\",\n \"platform_type\": \"VE\",\n \"[...other fields\": \"in onboarding payload...]\"\n },\n \"discovery\": {\n \"management_address\": \"10.2.3.4\",\n \"[...other fields\": \"in discovery payload...]\"\n }"
}

Retrieve onboarding tasks

Retrieves a list of all BIG-IP Next Central Manager onboarding tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve a BIG-IP Next onboarding task

Retrieves a specific BIG-IP Next onboarding task.

path Parameters
id
required
string <uuid>

The UUID of an onboarding task.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "cb15f869-6b21-400e-9f25-3643eba8000b",
  • "manifest_id": "2c5a683d-69d5-43ee-b736-f95e3d40bcbd",
  • "message": "",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "completed": "2021-04-02T23:12:18.051859Z",
  • "failure_reason": "",
  • "state": "onboardDone",
  • "status": "completed"
}

Create a log archive on a BIG-IP Next instance

Creates a log archive on a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/discovery-tasks/43b7bd5b-5b61-4a64-8fe4-68ef8ed910f2"
}

Create an external logger

Creates an external logger on a BIG-IP Next instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
associated_address
required
string
port
required
integer
hostname
required
string
certificate
required
string
private_key
required
string
root_ca
required
string

Responses

Request samples

Content type
application/json
{
  • "associated_address": "string",
  • "port": 0,
  • "hostname": "string",
  • "certificate": "string",
  • "private_key": "string",
  • "root_ca": "string"
}

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "associated_address": "string",
  • "port": 0,
  • "hostname": "string",
  • "_links": {
    }
}

Retrieve external loggers

Retrieves a list of external loggers on an instance.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    },
  • "count": 0,
  • "total": 0
}

Retrieve an external logger

Retrieves a specific external logger.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

logger_id
required
string <uuid>

The UUID of an external logger.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "associated_address": "string",
  • "port": 0,
  • "hostname": "string",
  • "_links": {
    }
}

Delete an external logger

Deletes a specific external logger.

path Parameters
id
required
string <uuid>

The UUID of a BIG-IP Next instance.

logger_id
required
string <uuid>

The UUID of an external logger.

Responses

Response samples

Content type
application/json
Example

When a required field is not present on the request body

{
  • "message": "Request body has an error: failed to decode request body: part filename: undefined"
}

Retrieve BIG-IP Next instance log archive tasks

Retrieves a list of BIG-IP Next instance log archive tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Retrieve a BIG-IP Next instance log archive task

Retrieves a specific BIG-IP Next instance log archive task.

path Parameters
id
required
string <uuid>

The UUID of an instance log archive task.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "918425aa-580b-42f5-9893-9292c6622c8b",
  • "instance_id": "c9796e86-21f7-4182-be1c-c737ed430242",
  • "created": "2021-04-02T23:11:18.051859Z",
  • "completed": "2021-04-02T23:12:18.051859Z",
  • "failure_reason": "",
  • "state": "logArchiveCreated",
  • "status": "completed"
}

Retrieve managed BIG-IP Next instances

Retrieves a list of all managed BIG-IP Next instances and the associated tasks.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_embedded": {
    },
  • "count": 0,
  • "total": 0
}

Retrieve a list of VLANs

Retrieves a list of VLANs on a managed BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
vrf
string

The name of the VRF object

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "vlans": [
    ]
}

Retrieve qkviews

Retrieves a list of all the qkviews in an instance.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 1,
  • "total": 1
}

Run QKView Task

Generates QKView for the BIG-IP Next instance and uploads the QKView file to iHealth Server.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

Request Body schema: application/json
required
instance_id
string <uuid>

The UUID of a BIG-IP Next instance.

filename
required
string

Qkview file name

source
string
Default: "INSTANCE"
Enum: "CM" "INSTANCE"
storage
string
Default: "LOCAL"

Storage of qkview file

ihealth_client_id
required
string

iHealth login client ID.

secret
string

iHealth login Client Secret.

expiry_date
string <date>

iHealth credentials expiry date

save_credentials
boolean
Default: false

Save iHealth login credentials.

user_agent
string
Default: "CM"

User Agent

description
string

Upload description

f5_support_case
string^\s*[0-9]{8}(\s*,{0,1}\s*[0-9]{8}){0,4}\s*$

F5 Support Case Number. Eight digit support case numbers separated by space or comma.Max 5 support cases allowed.

share_with_case_owner
boolean

Share with case owner

visible_in_gui
boolean

Upload visible in gui

ha_node_ips
Array of strings

List of HA Node Control Plane Addresses

Responses

Request samples

Content type
application/json
{
  • "instance_id": "404b7e5e-42e7-4bd8-acb0-a6b57c013b9f",
  • "filename": "qkview_file",
  • "source": "INSTANCE",
  • "ihealth_client_id": "client_id",
  • "secret": "client_secret",
  • "expiry_date": "2023-10-01",
  • "save_credential": true,
  • "user_agent": "CM",
  • "f5_support_case": 909999,
  • "share_with_case_owner": false,
  • "visible_in_gui": false
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "qkview_id": "0368bb51-1b2d-4028-9ebb-a6a4266001f4",
  • "status": 202,
  • "task_id": "3325e40d-d9f2-4ab7-adb3-4ce1b6dbd48e",
  • "task_status": "RUNNING"
}

Retrieve QKView

Retrieves a specific QKView.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>
Example: 0368bb51-1b2d-4028-9ebb-a6a4266001f4

uuid of QKView

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    },
  • "count": 1,
  • "total": 1
}

Update the QKView data

Updates the data in the qkview table.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>
Example: 0368bb51-1b2d-4028-9ebb-a6a4266001f4

uuid of QKView

Request Body schema: application/json
required
ihealth_client_id
required
string

Responses

Request samples

Content type
application/json
{
  • "ihealth_client_id": "new-client-id"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "0368bb51-1b2d-4028-9ebb-a6a4266001f4",
  • "message": "Qkview has been successfully updated",
  • "status": 200
}

Delete QKView

If an instance ID is sent, all QKView files for that instance are deleted; if a QKView ID is sent, all the associated QKView files are deleted, if a file ID is sent, that specific file is deleted.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>
Example: 0368bb51-1b2d-4028-9ebb-a6a4266001f4

uuid of QKView

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Uploads file to iHealth

File is extracted based on the file id and the file data is uploaded to iHealth server

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>

The UUID of QKView File

Request Body schema: application/json
required
ihealth_client_id
required
string
user_agent
required
string
description
string
f5_support_case
string^\s*[0-9]{8}(\s*,{0,1}\s*[0-9]{8}){0,4}\s*$

F5 Support Case Number. Eight digit support case number separated by space or comma.Max 5 support cases allowed.

share_with_case_owner
boolean
visible_in_gui
boolean

Responses

Request samples

Content type
application/json
{
  • "ihealth_id": "client_id",
  • "user_agent": "Chrome",
  • "description": "Description about the request",
  • "f5_support_case": 909889,
  • "share_with_case_owner": false,
  • "visible_in_gui": true
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve file by qkview id

Retrieves the file from storage specified by qkview id.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>

The UUID of QKView

filename
required
string

The file name.

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "request body has an error"
}

Retrieve file by file id

Retrieves the file from storage specified by the file id.

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>

The UUID of QKView File

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "request body has an error"
}

Deletes file of qkview

Deletes the particular file of the mentioned qkview id

path Parameters
instance_id
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

Instance ID of Big IP Next instance

id
required
string <uuid>
Example: 0368bb51-1b2d-4028-9ebb-a6a4266001f4

uuid of file_id of relevant qkview

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "0368bb51-1b2d-4028-9ebb-a6a4266001f4",
  • "message": "Qkview file has been successfully deleted",
  • "status": 200
}

Routing and Forwarding

Routing and forwarding APIs help to configure VRF on an instance and deploy an application with a non-default VRF.

Create a VRF

Creates a VRF on the BIG-IP Next Central Manager and the BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
vlans
Array of strings

The list of vlan names

Request Body schema: application/json
required
id
string <uuid> (ID)

L3 network ID.

name
required
string [ 1 .. 255 ] characters

L3 network name. For example, Carrier-Grade Network Address Translation (CGNAT), Firewall NAT, and so forth.

isDefault
boolean (Default VRF)
Default: false

Determines whether this VRF is the Default VRF. If set to true, this is the Default VRF. The default value is false.

l2Networks
Array of strings (L2 Network List) [ items <= 255 characters ]
Default: []

An array of soft reference names to L2 networks.

any (Config)

L3 network type configuration.

vlans
Array of strings (vlan List) [ items <= 255 characters ]
Default: []

An array vlans.

internal_vlans_only
boolean (Internal VLAN(s) only)
Default: false
is_dynamic_routing_enabled
boolean (Enable Dynamic Routes)
Default: false

Dynamic Routes toggle. Toggling on enables RHI and route creation. Toggling off removes dynamic routes and turns off RHI.

is_rhi_enabled
boolean (Enable Route Health Injection)
Default: false

RHI toggle. Toggling on or off enables or disables RHI.

Responses

Request samples

Content type
application/json
{
  • "name": "ExampleVRF",
  • "vlans": [
    ],
  • "internal_vlans_only": false,
  • "is_dynamic_routing_enabled": false,
  • "is_rhi_enabled": false
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/01721304-eaf8-4aa4-a2ef-d532c4ecd2bd/vrfs/8a12cb99-f829-4f03-9350-1d80445558d1"
}

Retrieve a list of VRFs

Retrieves a list of VRFs on a managed BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
vlans
Array of strings

The list of vlan names

limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    },
  • "_links": {
    }
}

Return a single VRF object

Returns a single VRF object on a managed BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

vrf_id
required
string <uuid>

The UUID of VRF object on a BIG-IP Next instance.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "id": "86d83952-0f73-4ed4-9e48-4b67cc8999c5",
  • "instance_id": "01721304-eaf8-4aa4-a2ef-d532c4ecd2bd",
  • "payload": {
    },
  • "reference_count": 1,
  • "task_id": "59e8be27-d84b-40a6-bee5-f0cf12b3244a",
  • "internal_vlans_only": false,
  • "is_dynamic_routing_enabled": false,
  • "is_rhi_enabled": false
}

Update a VRF

Updates a VRF on the BIG-IP Next Central Manager and the BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

vrf_id
required
string <uuid>

The UUID of VRF object on a BIG-IP Next instance.

Request Body schema: application/json
required
id
string <uuid> (ID)

L3 network ID.

name
required
string [ 1 .. 255 ] characters

L3 network name. For example, Carrier-Grade Network Address Translation (CGNAT), Firewall NAT, and so forth.

isDefault
boolean (Default VRF)
Default: false

Determines whether this VRF is the Default VRF. If set to true, this is the Default VRF. The default value is false.

l2Networks
Array of strings (L2 Network List) [ items <= 255 characters ]
Default: []

An array of soft reference names to L2 networks.

any (Config)

L3 network type configuration.

vlans
Array of strings (vlan List) [ items <= 255 characters ]
Default: []

An array vlans.

internal_vlans_only
boolean (Internal VLAN(s) only)
Default: false
is_dynamic_routing_enabled
boolean (Enable Dynamic Routes)
Default: false

Dynamic Routes toggle. Toggling on enables RHI and route creation. Toggling off removes dynamic routes and turns off RHI.

is_rhi_enabled
boolean (Enable Route Health Injection)
Default: false

RHI toggle. Toggling on or off enables or disables RHI.

Responses

Request samples

Content type
application/json
{
  • "name": "ExampleVRF",
  • "vlans": [
    ],
  • "internal_vlans_only": false,
  • "is_dynamic_routing_enabled": false,
  • "is_rhi_enabled": false
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/01721304-eaf8-4aa4-a2ef-d532c4ecd2bd/vrfs/8a12cb99-f829-4f03-9350-1d80445558d1"
}

Remove a VRF

Removes a VRF from the BIG-IP Next Central Manager and the BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

vrf_id
required
string <uuid>

The UUID of VRF object on a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/system/tasks/7ca0db8f-cee6-47ff-b838-ab7221ffc3cd"
}

Retrieve a list of L3-Forwards

Retrieves a list of L3-Forwards on a managed BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

query Parameters
limit
integer >= 1
Default: 1000
Examples:
  • limit=1000 - return up to 1000 items per page

Limits the number of items to return per page.

page
integer >= 1
Default: 1
Examples:
  • page=1 - return page number 1

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column names used to sort results. Prefix the name with a minus to request a descending order of sort.

select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=hostname startswith 'mbip' - query by string
  • filter=port gte 80 - query by numerical condition

Filter conditions for result queries. You can query by equality, string, or numerical conditions.

Responses

Response samples

Content type
application/hal+json
{
  • "_embedded": {
    }
}

Create a L3-Forward

Create a L3-Forward on BIG-IP Next Central Manager and BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

Request Body schema: application/json
required
id
string <uuid> (ID)

L3 forward ID.

name
required
string (Name) [ 1 .. 255 ] characters

L3 forward name.

vlans
Array of strings (VLAN List) unique [ items <= 255 characters ]
Default: []

L2 network VLANs.

vrf
string (VRF) <= 255 characters

A soft reference, by name, to VRF object.

any (Route Type)

An L3 forward type config.

Responses

Request samples

Content type
application/json
{
  • "name": "staticroute",
  • "vrf": "Default",
  • "config": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/01721304-eaf8-4aa4-a2ef-d532c4ecd2bd/l3forwards/934febd0-97e0-4d65-8454-c5fd21d4f62b"
}

Retrieve L3-Forward object

Retrieves a L3-Forward object on a managed BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

l3forwards_id
required
string <uuid>

The UUID of L3-Forward object on a BIG-IP Next instance.

query Parameters
select
string
Examples:
  • select=name,state,status - selected column names

The names of the specific fields to return.

Responses

Response samples

Content type
{
  • "_links": {
    },
  • "cm_vrf_id": "86d83952-0f73-4ed4-9e48-4b67cc8999c5",
  • "id": "934febd0-97e0-4d65-8454-c5fd21d4f62b",
  • "instance_id": "01721304-eaf8-4aa4-a2ef-d532c4ecd2bd",
  • "payload": {
    },
  • "reference_count": 0,
  • "task_id": "3cee97f5-0b3d-4bd3-9700-3fbab150342",
  • "vlans": [
    ]
}

Update a L3-Forward

Update a L3-Forward on BIG-IP Next Central Manager and BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

l3forwards_id
required
string <uuid>

The UUID of L3-Forward object on a BIG-IP Next instance.

Request Body schema: application/json
required
id
string <uuid> (ID)

L3 forward ID.

name
required
string (Name) [ 1 .. 255 ] characters

L3 forward name.

vlans
Array of strings (VLAN List) unique [ items <= 255 characters ]
Default: []

L2 network VLANs.

vrf
string (VRF) <= 255 characters

A soft reference, by name, to VRF object.

any (Route Type)

An L3 forward type config.

Responses

Request samples

Content type
application/json
{
  • "name": "staticroute-renamed",
  • "vrf": "Default",
  • "config": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/01721304-eaf8-4aa4-a2ef-d532c4ecd2bd/l3forwards/934febd0-97e0-4d65-8454-c5fd21d4f62b"
}

Delete a L3-Forward

Delete a L3-Forward on BIG-IP Next Central Manager and BIG-IP Next instance.

path Parameters
instance_id
required
string <uuid>

The UUID of a BIG-IP Next instance.

l3forwards_id
required
string <uuid>

The UUID of L3-Forward object on a BIG-IP Next instance.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "path": "/api/v1/spaces/default/instances/01721304-eaf8-4aa4-a2ef-d532c4ecd2bd/l3forwards/0eaec85b-7d0e-4f78-9488-cde4014fd074"
}

iRules

iRule APIs may operate on iRule resources of the F5® BIG-IP® Next Central Manager.

Create iRule

Creates an iRule

Request Body schema: multipart/form-data
required
name
required
string <= 190 characters ^[^\d._-][\w\d._-]+$

iRule name

content
required
string

iRule content

description
string

iRule description

staged
string

flag for staged iRules

version_name
string

name of the new version

staged_version
string

version from which the new version is to be staged

new_version
string

flag for creation of new version of the existing iRule

data-groups
Array of strings
log-publishers
Array of strings

Responses

Request samples

Content type
multipart/form-data
{
  "name": "new_iRule",
  "description": "iRule creation",
  "content": "when HTTP_REQUEST {\\n Redirecting client [IP::10.182.10.10] \\n}"
}

Response samples

Content type
application/hal+json
{
  • "id": "404b7e5e-42e7-4bd8-acb0-a6b57c013b9f",
  • "message": "Created iRule successfully",
  • "status": 0,
  • "versions": [
    ]
}

Retrieve iRules details

Retrieves all iRules details

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Update iRule

Update iRule specified by id

path Parameters
nameOrID
required
string <uuid>
Example: 404b7e5e-42e7-4bd8-acb0-a6b57c013b9f

uuid of iRule

Request Body schema: multipart/form-data
required
description
string

iRule description

version
string

version of the iRule

staged
string

flag for staged iRules

data-groups
Array of strings
log-publishers
Array of strings

Responses

Request samples

Content type
multipart/form-data
{
  "description": "update iRule",
  "content": "when HTTP_REQUEST {\\n Redirecting client [IP::10.182.10.10] \\n}"
}

Response samples

Content type
application/hal+json
{
  • "id": "404b7e5e-42e7-4bd8-acb0-a6b57c013b9f",
  • "message": "Created iRule successfully",
  • "status": 0,
  • "versions": [
    ]
}

Delete iRule

Deletes all iRule versions with the specified name.

path Parameters
nameOrID
required
string

Name of iRule.

query Parameters
staged
boolean
Example: staged=true

This flag determines whether the API will delete only the staged version of the iRule or the entire iRule.

Responses

Response samples

Content type
application/hal+json
{
  • "message": "iRule deleted successfully",
  • "status": 0,
  • "records_deleted": 0
}

Retrieve iRule

Retrieves iRule details by iRule name

path Parameters
nameOrID
required
string

name of iRule

Responses

Response samples

Content type
application/hal+json
{
  • "name": "string",
  • "versions": [
    ],
  • "_links": {
    }
}

Retrieve iRule Content

Retrieves iRules content by name and version

path Parameters
nameOrID
required
string

name/id of iRule

version
required
string

version of iRule

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Request body has an error"
}

Run an iRule task

Deploys and runs applications with specified iRule version or reverts applications to a previous iRule version. Before performing this operation, the application must have the corresponding iRule attached.

Request Body schema: application/json
required
irule_name
required
string

iRule name

irule_version
required
number

iRule version

staged
boolean
Default: false

Flag for staged iRule

user_id
string <uuid>

User ID

application_ids_to_attach
Array of strings <uuid> [ items <uuid > ]

Applications IDs to attach

application_ids_to_detach
Array of strings <uuid> [ items <uuid > ]

Application IDs to detach

attach_applications
string
Enum: "ALL" "STAGED"

STAGED - Applications attached to staged version of iRule are added to the new committed version of the iRule. ALL - Applications from all versions of this iRule are attached to the new committed version of the iRule. 'attach_applications' field is only applicable for COMMIT request type.

request_type
required
string
Enum: "DEPLOY" "REVERT" "COMMIT"

DEPLOY - This Request attach or detach applications with the iRule version specified. REVERT - This Request reverts all the applicatiions of a Stgaed iRule to their previous iRule versions and deletes the Staged iRule. COMMIT - This Request attaches all applications to this iRule or specified applications to the new version and deletes the staged iRule.This is based on the option chosen by user in 'attach_application' field.

Responses

Request samples

Content type
application/json
{
  • "example1": {
    },
  • "example2": {
    },
  • "example3": {
    },
  • "example4": {
    }
}

Response samples

Content type
application/hal+json
{
  • "task_id": "string",
  • "task_status": "string",
  • "path": "string"
}

Retrieve iRule tasks

Retrieves the details of all iRule tasks.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "_embedded": {
    }
}

Retrieve an iRule Task

Retrieves the details for the iRule task specified by task ID.

path Parameters
id
required
string <uuid>

UUID of iRule Task.

Responses

Response samples

Content type
application/hal+json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "string",
  • "failure_reason": "string",
  • "failed_count": 0,
  • "completed_count": 0,
  • "total_count": 0,
  • "application_deployments": [
    ],
  • "_links": {
    }
}

Validate iRule

Validates the iRule script.

Request Body schema: multipart/form-data
required
content
string

Responses

Request samples

Content type
multipart/form-data
{
  "content": "when HTTP_REQUEST {\\n Redirecting client [IP::10.182.10.10] \\n}"
}

Response samples

Content type
application/hal+json
{
  • "id": "404b7e5e-42e7-4bd8-acb0-a6b57c013b9f",
  • "message": "Created iRule successfully",
  • "status": 0,
  • "versions": [
    ]
}

Licenses

License APIs may operate on license resources of the F5® BIG-IP® Next Central Manager.

Initiates license activation of multiple instances

Initiates license activation for all the instances identified by their device id.

Request Body schema: application/json
required

list of "device_id" of the instances and corresponding JWT"

Array
digitalAssetId
required
string <uuid>

DigitalAssetId/unique Id of the instance which needs to be activated

jwtId
required
string <uuid>

JWT id of a preloaded jwt

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json+hal
{
  • "property1": {
    },
  • "property2": {
    }
}

Initiate switch license of multiple instances

Initiates switch license for all the instances identified by their device ids.

Request Body schema: application/json
required

list of "device_id and the corresponding JWT to be switched to"

Array
digitalAssetId
required
string <uuid>

DigitalAssetId/unique Id of the instance which needs to be activated

jwtId
required
string <uuid>

JWT id of a preloaded jwt

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json+hal
{
  • "property1": {
    },
  • "property2": {
    }
}

Verifiy the validity of JWT content

Verifies JWT content, checks for the format and validates the jwt signature with the configured certificate bundle. Returns token details if a matching token is found.

Request Body schema: application/json

JWT content to be verified

jwt
required
string non-empty

JWT to be verified

Responses

Request samples

Content type
application/json
{
  • "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL2RldmljZSIsInN1YiI6ImRlZmF1bHQiLCJhdWQiOlsiZGV2aWNlIl0sImlhdCI6MTY"
}

Response samples

Content type
application/json
{
  • "isValid": true
}

Download reports zip file for multiple instances

Retrieves reports archive for multiple instances. This is a multipart response to be sent to F5 for reporting.

Responses

Response samples

Content type
application/json
{
  • "reportDownloadStatus": [
    ],
  • "reportData": "string",
  • "reportName": "string"
}

Upload zipped files of F5 signed acknowledgement of multiple instances

This is a multipart request that involves uploading zipped files of F5 signed acknowledgements for multiple instances.

Request Body schema: multipart/form-data
required
fileList
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "deviceReportStatus": [
    ]
}

Initiate license deactivation of multiple instances

Initiates deactivation of license for a list of instances which were identified by device id.

Request Body schema: application/json
required

list of "device instance UUIDs"

digitalAssetIds
required
Array of strings <uuid> [ items <uuid > ]

DigitalAssetIds/unique Ids of the instances

Responses

Request samples

Content type
application/json
{
  • "digitalAssetIds": [
    ]
}

Response samples

Content type
application/json+hal
{
  • "property1": {
    },
  • "property2": {
    }
}

Retrieve the latest state of the instance license

Retrieves the latest state of the instance license, including all the enabled features.

path Parameters
device_id
required
string <uuid>

Responses

Response samples

Content type
application/json+hal
{
  • "subscriptionType": "paid | eval",
  • "subscriptionSubType": "internal | trial",
  • "deviceId": "94ff6fac-8920-492d-9545-9e837fe31a23",
  • "licenseStatus": "NEW | LICENSED | DEACTIVATED",
  • "licenseSubStatus": "INITIALISE_TERMINATION_IN_PROGRESS | ACK_VERIFICATION_COMPLETE | PROVISIONING_REPORT_ERR",
  • "expiryDate": "2023-09-04T00:00:55.000Z",
  • "enabledFeatures": "string",
  • "licenseToken": {
    },
  • "deviceActions": [
    ],
  • "_links": {
    }
}

Retrieve the latest state of the instance license

Retrieves the latest state of the instance license, including all the features enabled for multiple instances.

Request Body schema: application/json
required

list of "instance_ids"

digitalAssetIds
required
Array of strings <uuid> [ items <uuid > ]

DigitalAssetIds/unique Ids of the instances

Responses

Request samples

Content type
application/json
{
  • "digitalAssetIds": [
    ]
}

Response samples

Content type
application/json+hal
{
  • "00000000-0000-0000-0000-000000000000": {
    },
  • "ac128cb6-ca76-4aae-9c03-19c727fc8ae1": {
    },
  • "c6eea9a1-73c2-4160-a6ca-5f14638479b3": {
    },
  • "ede6352f-c52b-4c1f-9a8f-e2a0715fb94b": {
    }
}

Retrieve the latest state of the license state task

Retrieves the latest state of the license state task.

path Parameters
task_id
required
string <uuid>

Responses

Response samples

Content type
application/json+hal
{
  • "status": "accepted | inprogress | error | completed",
  • "subStatus": "ACTIVATION_INPROGRESS | ACTIVATION_ERR | ACTIVATION_COMPLETE | ...",
  • "errorCode": "1",
  • "failureReason": "request aborted, pls retry",
  • "taskType": "activate | deactivate | change-config | switch-license",
  • "created": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Retrieve bulk status of license tasks

Retrieves the latest status of multiple license state tasks which are identified by task id.

Request Body schema: application/json
required

list of "license task ids"

licenseTaskIds
required
Array of strings <uuid> [ items <uuid > ]

licenseTaskIds/unique Ids of the license tasks

Responses

Request samples

Content type
application/json
{
  • "licenseTaskIds": [
    ]
}

Response samples

Content type
application/json+hal
{
  • "00000000-0000-0000-0000-000000000000": {
    },
  • "ac128cb6-ca76-4aae-9c03-19c727fc8ae1": {
    },
  • "c6eea9a1-73c2-4160-a6ca-5f14638479b3": {
    },
  • "ede6352f-c52b-4c1f-9a8f-e2a0715fb94b": {
    }
}

Retrieve the license configuration

Retrieves the license configuration of the central manager instance.

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Update the LLM configuration

Updates the configuration values set of local license manager (LLM).

Request Body schema: application/json
required
modeOfOperation
string
Enum: "connected" "disconnected"

CM/LLM operating mode connected / disconnected

Responses

Request samples

Content type
application/json
{
  • "modeOfOperation": "connected"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Retrieve details of all the tokens

Retrieves details of multiple tokens.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new token

Creates a new token with the JWT provided.

Request Body schema: application/json
required

JWT

nickName
required
string

unique short name

jwt
required
string

JWT

Responses

Request samples

Content type
application/json
{
  • "nickName": "paid_test_jwt",
  • "jwt": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6InYxIiwiamt1IjoiaHR0cHM6Ly9wcm9kdWN0LXRzdC5hcGlzLmY1bmV0d29ya3MubmV0L2VlL3YxL2tleXMvandrcyJ9.eyJzdWIiOiJUU1QtMjdjMGJmN2EtNTU5OS00NzEwLWE1MzctOTliZDA2ZDRhMzJiIiwiaWF0IjoxNjg2Mjk4NDY0LCJpc3MiOiJGNSBJbmMuIiwiYXVkIjoidXJuOmY1OnRlZW0iLCJqdGkiOiJhNGU1ZjRiMS0wNjlkLTExZWUtYWU5OS02NWU1MGM1YmE3MzYiLCJmNV9vcmRlcl90eXBlIjoiZXZhbCJ9.H4nJTLOgHALpTtg0XdYyVjMbWz0nVzYzbkMHx1vpTq59Ueus3AuvftByJmLD7lcVjBwJ3p5misMHVpRLe_lEpv_79DWtXp0-y-5ZOjCU6Se_pB4RjVeEl291qe6uEnQliEm6e968X2n8hoCiZ5nX9BVptPBHvaXKQmjoEJhZHmdwLkipL67l59PYJcRyZ4IqGf1-IVVwx329isNVGi0TpQ4xX0NggKmrDxyZFL8izy6crFbcAVW3L5QDWIWFwSOLLPZ0FM8IcXtNtgPuy8Z3KhGTbWxd_Pe0k9tU-VyN9tLftC6bqQMsVXYCJoCw7i_eXurOsllTGhrhuQPHlWSvAExAPsx12_WLrX_s3s4iU3wZRi55gILm8CXk_E2LPONAcXlGoPHmksx3_8m89Q558k9dfwUo1DDUKtSLF4RZaaq4-l1ZA8RJVyawauknFpQPdGeW8LxrG7SYkaBrPfAUVv6fZV6ewivr7DLBokFtErisUVB2BFZYJhFCuLovTPjzE1UCY-UkAlcXfj4pbGRC2jwg1_MEL7o4zH_3NMULlBj6eeHbhQvVHqI8E2IqpNjJbRiQwd9S8CLTAL2-zi9Q1VVENK_T-4J10BltHzquNJcTyi4jkRuTi_DNw5Fg2Iqn4o7Y1g7zg-nCgzQ0VGRxQRr_fZuMU84z6fI0qB0fnNA"
}

Response samples

Content type
application/json+hal
{
  • "NewToken": {
    },
  • "DuplicatesTokenValue": {
    },
  • "DuplicatesTokenNickName": {
    },
  • "_links": {
    },
  • "duplicateToken": {
    },
  • "duplicateShortname": {
    }
}

Retrieve details of a token by token id

Retrieves details of a token by token id.

path Parameters
token_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "94ff6fac-8920-492d-9545-9e837fe31a23",
  • "nickName": "paid_test_jwt",
  • "entitlement": "string",
  • "orderType": "string",
  • "orderSubType": "string",
  • "subscriptionExpiry": "string"
}

Delete token

Delete token details.

path Parameters
token_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "description explaining the error cause in short",
  • "help": "help to recover from the error",
  • "code": "LICENSING-2245",
  • "status": 400,
  • "details": "inner details of the error"
}

Retrieve list of instances

Retrieves list of instances for which the report is available for download. Report type could be any one of activation/switch/telemetry/terminate.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Event-Logs

Event-Logs APIs may operate on event-logs resources of the F5® BIG-IP® Next Central Manager.

Retrieve web application traffic logs

Retrieves a list of web application traffic logs.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100
Examples:
  • limit=1000 - return maximum 1000 item from the query

Limits the maximum number of items to return per page.

page
integer
Examples:
  • page=3 - return page number 3

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column name to sort results. Prefix column name with minus sign to sort in descending order.

includedetails
boolean

Should be set to true to see full violation information

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=contains(hostname,'mbip') - query by substring
  • filter=port gte 80 - query by numerical condition
  • filter=contains(all,'http') - query all fields

Filter conditions for result queries. Query by equality, string, or numerical conditions are possible

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "count": 0,
  • "total": 0,
  • "_embedded": {
    }
}

Delete web application traffic logs

Deletes web application WAF traffic logs

Request Body schema: application/json
required
One of
delete_all
required
boolean

Defines whether an action is to be applied to all WAF traffic logs.

Responses

Request samples

Content type
application/json
Example
{
  • "filter": "dest_port eq '8080' or geo_location eq 'MX'"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "bad request"
}

Retrieve a web application traffic log

Retrieves a specific web application traffic log.

path Parameters
support_id
required
string

Web application traffic log support_id

Responses

Response samples

Content type
application/json
{
  • "related_suggestions": [
    ],
  • "violation_information": {
    },
  • "app_name": "Event-Tenant:Event-Application",
  • "attack_type": [
    ],
  • "avr_id": "1",
  • "blocking_exception_reason": "IP is in Whitelist",
  • "bot_anomalies": [
    ],
  • "bot_category": "Spam Bot",
  • "bot_signature_name": "KTXN",
  • "captcha_result": "incorrect",
  • "client_class": "Malicious Bot",
  • "client_type": "Mobile App",
  • "date_time": "2012-09-19 13:52:29",
  • "dest_ip": "192.168.5.11",
  • "dest_port": 80,
  • "device_id": "121564864531",
  • "enforced_bot_anomalies": [
    ],
  • "fragment": "a=7&b=5",
  • "geo_location": "USA/NY",
  • "headers": "Host: myhost.com; Connection: close",
  • "http_class_name": "topaz4-web4",
  • "ip_client": "192.168.5.10",
  • "ip_address_intelligence": [
    ],
  • "ip_with_route_domain": "172.26.36.17/5",
  • "login_result": "Successful Login",
  • "is_truncated": "truncated",
  • "management_ip_address": "192.168.1.246",
  • "management_ip_address_2": "172.26.36.17",
  • "method": "GET",
  • "microservice": "/a.com/index.php",
  • "mobile_application_name": "Shop Ttt",
  • "mobile_application_version": "4.1.5",
  • "policy_apply_date": "2018-08-06 10:17:56",
  • "policy_name": "My_security_policy",
  • "protocol": "HTTPS",
  • "query_string": "key1=val1&key2=val2",
  • "request": "GET / HTTP/1.0\\r\\n User-Agent: Wget/1.12 (linux-gnu)\\r\\n Accept: */*\\r\\n Host: 10.4.1.200\\r\\n Connection: Keep-Alive",
  • "request_status": "Blocked",
  • "response": "HTTP/1.1 200 OK Content-type: text/html Content-Length: 7 <html/>",
  • "response_code": 200,
  • "route_domain": 1,
  • "session_id": "a9141b68ac7b4958",
  • "severity": "Error",
  • "sig_cves": [
    ],
  • "sig_ids": [
    ],
  • "sig_names": [
    ],
  • "sig_set_names": [
    ],
  • "slot_number": 1,
  • "src_port": 52974,
  • "stack_name": "Event-Tenant:Event-Application:serviceMain",
  • "staged_sig_cves": [
    ],
  • "staged_sig_ids": [
    ],
  • "staged_sig_names": [
    ],
  • "staged_sig_set_names": [
    ],
  • "staged_threat_campaign_names": [
    ],
  • "sub_violations": [
    ],
  • "support_id": 18205860747014000000,
  • "threat_campaign_names": [
    ],
  • "unit_hostname": "bigip-4.pme-ds.f5.com",
  • "uri": "/",
  • "username": "Admin",
  • "violation_rating": 4,
  • "violations": [
    ],
  • "virus_name": "Melissa",
  • "vs_name": "string",
  • "web_application_name": "my_app",
  • "websocket_direction": "clientToServer",
  • "websocket_message_type": "Handshake",
  • "x_forwarded_for_header_value": "192.168.5.10",
  • "_links": {
    }
}

Update a web application traffic log

Updates a web application traffic log specified by request support ID

path Parameters
support_id
required
string

Web application traffic log support_id

Request Body schema: application/json
required
tags
Array of strings

Tags for marking policies

comment
string

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "related_suggestions": [
    ],
  • "violation_information": {
    },
  • "app_name": "Event-Tenant:Event-Application",
  • "attack_type": [
    ],
  • "avr_id": "1",
  • "blocking_exception_reason": "IP is in Whitelist",
  • "bot_anomalies": [
    ],
  • "bot_category": "Spam Bot",
  • "bot_signature_name": "KTXN",
  • "captcha_result": "incorrect",
  • "client_class": "Malicious Bot",
  • "client_type": "Mobile App",
  • "date_time": "2012-09-19 13:52:29",
  • "dest_ip": "192.168.5.11",
  • "dest_port": 80,
  • "device_id": "121564864531",
  • "enforced_bot_anomalies": [
    ],
  • "fragment": "a=7&b=5",
  • "geo_location": "USA/NY",
  • "headers": "Host: myhost.com; Connection: close",
  • "http_class_name": "topaz4-web4",
  • "ip_client": "192.168.5.10",
  • "ip_address_intelligence": [
    ],
  • "ip_with_route_domain": "172.26.36.17/5",
  • "login_result": "Successful Login",
  • "is_truncated": "truncated",
  • "management_ip_address": "192.168.1.246",
  • "management_ip_address_2": "172.26.36.17",
  • "method": "GET",
  • "microservice": "/a.com/index.php",
  • "mobile_application_name": "Shop Ttt",
  • "mobile_application_version": "4.1.5",
  • "policy_apply_date": "2018-08-06 10:17:56",
  • "policy_name": "My_security_policy",
  • "protocol": "HTTPS",
  • "query_string": "key1=val1&key2=val2",
  • "request": "GET / HTTP/1.0\\r\\n User-Agent: Wget/1.12 (linux-gnu)\\r\\n Accept: */*\\r\\n Host: 10.4.1.200\\r\\n Connection: Keep-Alive",
  • "request_status": "Blocked",
  • "response": "HTTP/1.1 200 OK Content-type: text/html Content-Length: 7 <html/>",
  • "response_code": 200,
  • "route_domain": 1,
  • "session_id": "a9141b68ac7b4958",
  • "severity": "Error",
  • "sig_cves": [
    ],
  • "sig_ids": [
    ],
  • "sig_names": [
    ],
  • "sig_set_names": [
    ],
  • "slot_number": 1,
  • "src_port": 52974,
  • "stack_name": "Event-Tenant:Event-Application:serviceMain",
  • "staged_sig_cves": [
    ],
  • "staged_sig_ids": [
    ],
  • "staged_sig_names": [
    ],
  • "staged_sig_set_names": [
    ],
  • "staged_threat_campaign_names": [
    ],
  • "sub_violations": [
    ],
  • "support_id": 18205860747014000000,
  • "threat_campaign_names": [
    ],
  • "unit_hostname": "bigip-4.pme-ds.f5.com",
  • "uri": "/",
  • "username": "Admin",
  • "violation_rating": 4,
  • "violations": [
    ],
  • "virus_name": "Melissa",
  • "vs_name": "string",
  • "web_application_name": "my_app",
  • "websocket_direction": "clientToServer",
  • "websocket_message_type": "Handshake",
  • "x_forwarded_for_header_value": "192.168.5.10",
  • "_links": {
    }
}

Delete a web application traffic log

Deletes a specific web application WAF traffic log

path Parameters
support_id
required
string

Web application traffic log support_id

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "bad request"
}

Retrieve Behavioral DOS traffic logs

Retrieves a list of BADOS traffic logs.

query Parameters
limit
integer
Examples:
  • limit=2 - return 2 pages

Limits the number of items to return per page.

page
integer
Examples:
  • page=3 - return page number 3

The number of the page to return. Ignored if limit parameter is absent.

sort
string
Examples:
  • sort=address,hostname - two column ascending sort
  • sort=-hostname - single column descending sort
  • sort=address,-hostname - mixed ascending/descending sort

The column name to sort results. Prefix column name with minus sign to sort in descending order.

filter
string
Examples:
  • filter=status eq 'completed' - query by equality
  • filter=contains(hostname,'mbip') - query by substring
  • filter=port gte 80 - query by numerical condition
  • filter=contains(all,'http') - query all fields

Filter conditions for result queries. Query by equality, string, or numerical conditions are possible

view
string (BadosViewEnum)
Enum: "attack-status" "bad-actors" "attack-signatures" "all"

Condition to filter bados events based on view

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "count": 0,
  • "total": 0,
  • "_embedded": {
    }
}

Retrieve a BADOS traffic log

Retrieves a specific BADOS traffic log

path Parameters
event_id
required
string

Behavioral DOS traffic log bados-event-id

Responses

Response samples

Content type
application/json
{
  • "active_connections": "415",
  • "app_name": "test_tenant:app_test",
  • "attack_event": "Attack started",
  • "bad_actors": "4",
  • "block_bad_actor": "80",
  • "block_bad_actor_rps": 8,
  • "block_global": "90",
  • "block_global_rps": 9,
  • "block_signature": "70",
  • "block_signature_rps": 7,
  • "block_slow": "60",
  • "block_slow_rps": "6",
  • "challenge_bad_actor": "50",
  • "challenge_bad_actor_rps": "5",
  • "challenge_global": "40",
  • "challenge_global_rps": "4",
  • "challenge_signature": "30",
  • "challenge_signature_rps": "3",
  • "challenge_slow": "20",
  • "challenge_slow_rps": "2",
  • "cm_device_id": "123e4567-e89b-12d3-a456-426614174000",
  • "instance_hostname": ".yandex.com",
  • "instance_address": "1.2.3.4",
  • "date_time": "Mar 01 2012 13:52:29",
  • "dos_attack_id": "25",
  • "event_id": "abc25",
  • "geo_location": "IN",
  • "impact_rps": 45,
  • "incoming_requests": "455",
  • "incoming_rps": 1455,
  • "learning_confidence": "129c76",
  • "mitigated_bad_actors": "100",
  • "mitigated_bad_actors_rps": 12,
  • "mitigated_by_global_rate": "200",
  • "mitigated_by_global_rate_rps": 20,
  • "mitigated_by_signatures": "300",
  • "mitigated_by_signatures_rps": 30,
  • "mitigated_connections": "400",
  • "mitigated_connections_rps": "40",
  • "mitigated_slow": "500",
  • "mitigated_slow_rps": "50",
  • "new_bad_actors_detected": "4",
  • "product": "f5-asec-admd",
  • "product_version": "0.9.21",
  • "redirect_bad_actor": "600",
  • "redirect_bad_actor_rps": "60",
  • "redirect_global": "700",
  • "redirect_global_rps": "70",
  • "redirect_signature": "800",
  • "redirect_signature_rps": "80",
  • "redirect_slow": "900",
  • "redirect_slow_rps": "90",
  • "signature": "HTTP /Common/HTTPSig30521245196031376581 (http.accept_encoding_header_exists eq true) and (http.cache_control hashes-to 14) and (http.cache_control_header_exists eq true) and (http.host_header_exists eq true) and (http.unknown_header_exists eq true) and (http.uri_parameters eq 0) and (http.accept_header_exists eq true) and (http.hdrorder hashes-like host:user-agent:accept-encoding:accept:connection) and (http.headers_count eq 10) and (http.accept_charset eq ISO-8859-1) and (http.x_forwarded_for_header_exists eq true) and (http.user_agent_header_exists eq true) and (http.uri_file hashes-like /) and (http.request.method eq GET) and (http.connection_header_exists eq true) and (http.referer_header_exists eq true)",
  • "signature_accuracy": "100.00",
  • "signature_efficiency": "72.00",
  • "signature_id": "809655398",
  • "source_ip": "1.1.1.1",
  • "stack_name": "test_tenant:app_test:serviceMain",
  • "stress_level": 0.5,
  • "successful_responses": "5265",
  • "successful_tps": 100,
  • "threshold_conns": "2121.50",
  • "tls_fp": 0,
  • "unit_hostname": "localhost.localdomain",
  • "unsuccessful_requests": "340",
  • "unsuccessful_rps": 10,
  • "baseline_dps": 12,
  • "mitigated_rps": "55",
  • "vs_name": "VS1",
  • "_links": {
    }
}

Update a Behavioral DOS traffic log

Updates a specific of BADOS traffic log.

path Parameters
event_id
required
string

Behavioral DOS traffic log bados-event-id

Request Body schema: application/json
required
tags
Array of strings

Tags for marking policies

comment
string

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "active_connections": "415",
  • "app_name": "test_tenant:app_test",
  • "attack_event": "Attack started",
  • "bad_actors": "4",
  • "block_bad_actor": "80",
  • "block_bad_actor_rps": 8,
  • "block_global": "90",
  • "block_global_rps": 9,
  • "block_signature": "70",
  • "block_signature_rps": 7,
  • "block_slow": "60",
  • "block_slow_rps": "6",
  • "challenge_bad_actor": "50",
  • "challenge_bad_actor_rps": "5",
  • "challenge_global": "40",
  • "challenge_global_rps": "4",
  • "challenge_signature": "30",
  • "challenge_signature_rps": "3",
  • "challenge_slow": "20",
  • "challenge_slow_rps": "2",
  • "cm_device_id": "123e4567-e89b-12d3-a456-426614174000",
  • "instance_hostname": ".yandex.com",
  • "instance_address": "1.2.3.4",
  • "date_time": "Mar 01 2012 13:52:29",
  • "dos_attack_id": "25",
  • "event_id": "abc25",
  • "geo_location": "IN",
  • "impact_rps": 45,
  • "incoming_requests": "455",
  • "incoming_rps": 1455,
  • "learning_confidence": "129c76",
  • "mitigated_bad_actors": "100",
  • "mitigated_bad_actors_rps": 12,
  • "mitigated_by_global_rate": "200",
  • "mitigated_by_global_rate_rps": 20,
  • "mitigated_by_signatures": "300",
  • "mitigated_by_signatures_rps": 30,
  • "mitigated_connections": "400",
  • "mitigated_connections_rps": "40",
  • "mitigated_slow": "500",
  • "mitigated_slow_rps": "50",
  • "new_bad_actors_detected": "4",
  • "product": "f5-asec-admd",
  • "product_version": "0.9.21",
  • "redirect_bad_actor": "600",
  • "redirect_bad_actor_rps": "60",
  • "redirect_global": "700",
  • "redirect_global_rps": "70",
  • "redirect_signature": "800",
  • "redirect_signature_rps": "80",
  • "redirect_slow": "900",
  • "redirect_slow_rps": "90",
  • "signature": "HTTP /Common/HTTPSig30521245196031376581 (http.accept_encoding_header_exists eq true) and (http.cache_control hashes-to 14) and (http.cache_control_header_exists eq true) and (http.host_header_exists eq true) and (http.unknown_header_exists eq true) and (http.uri_parameters eq 0) and (http.accept_header_exists eq true) and (http.hdrorder hashes-like host:user-agent:accept-encoding:accept:connection) and (http.headers_count eq 10) and (http.accept_charset eq ISO-8859-1) and (http.x_forwarded_for_header_exists eq true) and (http.user_agent_header_exists eq true) and (http.uri_file hashes-like /) and (http.request.method eq GET) and (http.connection_header_exists eq true) and (http.referer_header_exists eq true)",
  • "signature_accuracy": "100.00",
  • "signature_efficiency": "72.00",
  • "signature_id": "809655398",
  • "source_ip": "1.1.1.1",
  • "stack_name": "test_tenant:app_test:serviceMain",
  • "stress_level": 0.5,
  • "successful_responses": "5265",
  • "successful_tps": 100,
  • "threshold_conns": "2121.50",
  • "tls_fp": 0,
  • "unit_hostname": "localhost.localdomain",
  • "unsuccessful_requests": "340",
  • "unsuccessful_rps": 10,
  • "baseline_dps": 12,
  • "mitigated_rps": "55",
  • "vs_name": "VS1",
  • "_links": {
    }
}

Delete a Behavioral DOS traffic log

Deletes a specific BADOS WAF traffic log.

path Parameters
event_id
required
string

Behavioral DOS traffic log bados-event-id

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "bad request"
}

Delete Behavioral DOS traffic logs

Deletes the BADOS traffic logs.

Request Body schema: application/json
required
One of
delete_all
required
boolean

Defines whether an action is to be applied to all BADOS traffic logs.

Responses

Request samples

Content type
application/json
Example
{
  • "filter": "dest_port eq '8080' or app_name eq 'testApp'"
}

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "bad request"
}

Logs

Logs APIs may operate on log resources of the F5® BIG-IP® Next Central Manager.

Retrieve audit logs

Retrieves audit logs.

query Parameters
limit
integer
Default: 100
Examples:
  • limit=10 - returns upto 10 items per page

Limits the number of items to return per page.

page
integer
Examples:
  • page=5 - return page number 5

The number of the page to return. Ignored if limit parameter is absent.

filter
string
Examples:
  • filter=status eq 'Deployed' - query by equality
  • filter=name startswith 'app' - query by string

Filter conditions for result queries. Queries by equality, string, or numerical conditions are possible.

start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

Responses

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "audit_logs": [
    ],
  • "total": 0,
  • "count": 0
}

Retrieve audit log

Retrieves audit log by ID.

path Parameters
audit_id
required
string <uuid>

audit id (unique)

Responses

Response samples

Content type
application/hal+json
{
  • "audit_id": "string",
  • "user": "string",
  • "user_id": "string",
  • "user_role": "string",
  • "timestamp": "string",
  • "source_address": "string",
  • "source_port": 0,
  • "result_code": 0,
  • "response": "string",
  • "resource_reference": "string",
  • "request": "string",
  • "product_version": "string",
  • "latency": 0,
  • "http_method": "string",
  • "host": "string",
  • "feature": "string",
  • "application_id": "string",
  • "application_name": "string",
  • "instance_id": "string",
  • "instance_name": "string",
  • "action": "string",
  • "property": "string",
  • "namespace": "string"
}

Export audit logs

Exports audit logs.

query Parameters
filter
string
Examples:
  • filter=status eq 'Deployed' - query by equality
  • filter=name startswith 'app' - query by string

Filter conditions for result queries. Queries by equality, string, or numerical conditions are possible.

start
required
string

Start time of the API aggregation and listing.

end
required
string

End time of the API aggregation and listing.

Responses

Response samples

Content type
application/json
{
  • "status": 400,
  • "message": "Bad Request"
}

Retrieve audit log records

Retrieves a list of audit log records, filtered based on the query parameters.

query Parameters
limit
integer
Examples:
  • limit=2 - return up to 2 items per page.

Limits the number of items to return per page.

Responses

Response samples

Content type
application/json
{
  • "description": "A response containing two Audit log records",
  • "value": [
    ]
}

Migration Management

Retrieve all migrations

Request a list of all migrations.

query Parameters
page
integer

Page number

limit
integer

Amount of items returned per page.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "_embedded": {
    }
}

Create a new migration

Create a new migration.

Request Body schema: application/json
required

Migration name

name
required
string
description
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "last_update_time": "2021-01-28T15:24:05.029102Z",
  • "id": 0,
  • "_links": {
    },
  • "name": "migration",
  • "description": "description",
  • "grouping_type": "disabled",
  • "task_id": "1223ebd4-f455-4560-82c6-25c504d9edf5"
}

Retrieve migration details

Retrieves specific migration details.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Responses

Response samples

Content type
application/json
{
  • "last_update_time": "2021-01-28T15:24:05.029102Z",
  • "id": 0,
  • "_links": {
    },
  • "name": "migration",
  • "description": "description",
  • "grouping_type": "disabled",
  • "task_id": "1223ebd4-f455-4560-82c6-25c504d9edf5",
  • "schema_version": "3.0.0",
  • "source": {
    },
  • "instructions": {},
  • "output_as3_link": "/v1/migrations/2/root_files/output_all.json",
  • "applications": [
    ],
  • "deployments": [
    ],
  • "last_page": "general_properties",
  • "allow_deployments": true
}

Update migration with current page Deprecated

It also updates visited pages list

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required

Current page

last_page
required
string (Page)
Enum: "general_properties" "source_system" "applications" "summary" "deployment"

Responses

Request samples

Content type
application/json
{
  • "last_page": "general_properties"
}

Response samples

Content type
application/json
{
  • "last_update_time": "2021-01-28T15:24:05.029102Z",
  • "id": 0,
  • "_links": {
    },
  • "name": "migration",
  • "description": "description",
  • "grouping_type": "disabled",
  • "task_id": "1223ebd4-f455-4560-82c6-25c504d9edf5",
  • "schema_version": "3.0.0",
  • "source": {
    },
  • "instructions": {},
  • "output_as3_link": "/v1/migrations/2/root_files/output_all.json",
  • "applications": [
    ],
  • "deployments": [
    ],
  • "last_page": "general_properties",
  • "allow_deployments": true
}

Update migration with current page

Updates migration with current page and updates visited pages list.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required

Current page

last_page
required
string (Page)
Enum: "general_properties" "source_system" "applications" "summary" "deployment"

Responses

Request samples

Content type
application/json
{
  • "last_page": "general_properties"
}

Response samples

Content type
application/json
{
  • "last_update_time": "2021-01-28T15:24:05.029102Z",
  • "id": 0,
  • "_links": {
    },
  • "name": "migration",
  • "description": "description",
  • "grouping_type": "disabled",
  • "task_id": "1223ebd4-f455-4560-82c6-25c504d9edf5",
  • "schema_version": "3.0.0",
  • "source": {
    },
  • "instructions": {},
  • "output_as3_link": "/v1/migrations/2/root_files/output_all.json",
  • "applications": [
    ],
  • "deployments": [
    ],
  • "last_page": "general_properties",
  • "allow_deployments": true
}

Delete migration

Deletes a specific migration.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Responses

Response samples

Content type
application/json
{
  • "detail": "Object not found",
  • "status_code": 404
}

Delete multiple migrations

Deletes multiple migrations.

Request Body schema: application/json
required

Migration name

migrations
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "migrations": [
    ]
}

Delete multiple migrations Deprecated

Deletes multiple migrations.

Responses

Source BIG-IP system

Provide or cancel a BIG-IP Next source in the Migration session (formally called Journeys.)

Upload UCS file for migration

Uploads UCS file for migration.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
async
boolean
Default: true
Example: async=true
Request Body schema: multipart/form-data
required

UCS and Optional passphrase

ucs_file
required
string <binary>
ucs_passphrase
string
master_key
string
grouping_type
required
string (GroupingType)
Enum: "disabled" "ip"

Responses

Response samples

Content type
application/json
{
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  • "path": "string"
}

Cancel UCS upload task

Cancels UCS upload task.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Responses

Response samples

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

Application Management

Migration session operations for applications (formally called Journeys.)

Create a new application

Creates a new application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required
name
required
string

Name of a new application.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/application-services/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "summaries": [
    ],
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "deployed_app_failure_reason": "Unsupported profiles found.",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/application-services/1/preview",
  • "shared_objects_imported": true,
  • "shared_objects_import_failed": false,
  • "waf_policies_count": 1,
  • "certificates_count": 1,
  • "irules_count": 1,
  • "data_groups_count": 1,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "saveable": true,
  • "virtual_servers": [
    ]
}

Retrieve applications list

Retrieves applications list.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
search
string

Search by name, IP address and pool name.

sort
string
Example: sort=-name

Order results by a selection.

select
string
Example: select=id,name

Select only specified fields.

filter
string
Example: filter=status eq 'green' and virtuals/ip_addresses contains '1.2.3.4'

Filter with a query string.

page
integer

Page number

limit
integer

Amount of items returned per page.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Retrieve specified application

Retrieves specified application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/application-services/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "summaries": [
    ],
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "deployed_app_failure_reason": "Unsupported profiles found.",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/application-services/1/preview",
  • "shared_objects_imported": true,
  • "shared_objects_import_failed": false,
  • "waf_policies_count": 1,
  • "certificates_count": 1,
  • "irules_count": 1,
  • "data_groups_count": 1,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "saveable": true,
  • "virtual_servers": [
    ]
}

Update application object

Updates application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "new_application_name"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/application-services/1",
  • "name": "new_application_name",
  • "status": "green",
  • "iapp": false,
  • "summaries": [
    ],
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "deployed_app_failure_reason": "Unsupported profiles found.",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/application-services/1/preview",
  • "shared_objects_imported": true,
  • "shared_objects_import_failed": false,
  • "waf_policies_count": 1,
  • "certificates_count": 1,
  • "irules_count": 1,
  • "data_groups_count": 1,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "saveable": true,
  • "virtual_servers": [
    ]
}

Remove specified application

Removes specified application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "detail": "Object not found",
  • "status_code": 404
}

Move virtual server to another application.

Moves virtual server to another application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer
Request Body schema: application/json
required
virtuals
required
Array of integers

An array of virtual servers' IDs

Responses

Request samples

Content type
application/json
{
  • "virtuals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/application-services/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "summaries": [
    ],
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "deployed_app_failure_reason": "Unsupported profiles found.",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/application-services/1/preview",
  • "shared_objects_imported": true,
  • "shared_objects_import_failed": false,
  • "waf_policies_count": 1,
  • "certificates_count": 1,
  • "irules_count": 1,
  • "data_groups_count": 1,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "saveable": true,
  • "virtual_servers": [
    ]
}

Retrieve AS3 preview for a given application

Retrieves AS3 preview for a given application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "class": "ADC",
  • "Common": {
    }
}

Import application shared objects

Import applications' shared objects onto BIG-IP Next Central Manager.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
async
boolean
Default: true
Example: async=true
Request Body schema: application/json
required
applications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  • "path": "string"
}

Cancel shared objects import task

Cancels shared objects import task.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
async
boolean
Default: true
Example: async=true

Responses

Response samples

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

Import applications

Import applications onto BIG-IP Next Central Manager.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
async
boolean
Default: true
Example: async=true
Request Body schema: application/json
required
applications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  • "path": "string"
}

Cancel applications import task

Cancels applications import task.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
async
boolean
Default: true
Example: async=true

Responses

Response samples

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

Retrieve output AS3 for selected applications

Retrieves output AS3 for selected applications.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required
applications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": "Object not found",
  • "status_code": 404
}

Retrieve virtual servers list

Retrieves Virtual Servers list.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
search
string

Search by name, IP address and pool name.

sort
string
Example: sort=-name

Order results by a selection.

select
string
Example: select=id,name

Select only specified fields.

page
integer

Page number

limit
integer

Amount of items returned per page.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Retrieve specific virtual server

Retrieves a specific virtual server.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

virtual_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "id": 0,
  • "application_id": 1,
  • "name": "virtual_server_1",
  • "description": "Test virtual server",
  • "status": "green",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "summaries": [
    ],
  • "ip_addresses": [
    ],
  • "ports": [
    ],
  • "config_files": {
    },
  • "metadata": [
    ],
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "waf_policies_count": 1,
  • "certificates_count": 1,
  • "irules_count": 1,
  • "data_groups_count": 1,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ]
}

Create a new application Deprecated

Creates a new application. This endpoint is deprecated, use '/api/v1/migrations/{migration_id}/application-services' instead.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required
name
required
string

Name of a new application

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "Test application"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Retrieve applications list Deprecated

Retrieves applications list. This endpoint is deprecated. Use /api/v1/migrations/{migration_id}/application-services instead."

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
search
string

Search by name, IP address and pool name.

page
integer

Page number

limit
integer

Amount of items returned per page.

staged
string
Example: staged=true

Filter list by staged value.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Retrieve specific application Deprecated

Retrieves a specific application. This endpoint is deprecated. Use /api/v1/migrations/{migration_id}/application-services/{application_id} instead.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Update application object Deprecated

Updates application object. This endpoint is deprecated. Use /api/v1/migrations/{migration_id}/application-services/{application_id} instead."

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer
Request Body schema: application/json
required
template_name
string
name
string
description
string
template_parameters
object (FastTemplateParameters)

Must conform template JSON schema

deploy_location
string

Responses

Request samples

Content type
application/json
{
  • "template_name": "template_set/test_template",
  • "name": "new_application_name",
  • "description": "description",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "new_application_name",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Remove specific application Deprecated

Removes a specific application. This endpoint is deprecated. Use /api/v1/migrations/{migration_id}/application-services/{application_id} instead.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "detail": "Object not found",
  • "status_code": 404
}

Set staged applications Deprecated

Sets staged applications.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Unstage the application from output AS3 Deprecated

Unstages the application from output AS3.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": false,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Set staged applications list Deprecated

Sets staged applications list.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required
applications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Install application level referenced objects onto Central Manager Deprecated

Installs application level referenced objects onto Central Manager.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

Request Body schema: application/json
required
applications
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Move virtual server to another application Deprecated

Moves virtual server to another application. This endpoint is deprecated. Use api/v1/migrations/{migration_id}/application-services/{application_id}/assign instead.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer
Request Body schema: application/json
required
virtuals
required
Array of integers

An array of virtual servers' IDs

Responses

Request samples

Content type
application/json
{
  • "virtuals": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "url": "http://localhost/v1/migrations/1/applications/1",
  • "name": "application_1",
  • "status": "green",
  • "iapp": false,
  • "description": "Test application",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "deployed_app_id": "074269c9-7119-441b-ae56-a24cc362dc96",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "as3_preview": "http://localhost/api/v1/migrations/1/applications/1/preview",
  • "referenced_objects_installed": true,
  • "staged": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "readiness": true,
  • "virtual_servers": [
    ]
}

Retrieve preview AS3 for a given application Deprecated

Retrieves preview AS3 for a given application.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

application_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "class": "ADC",
  • "Common": {
    }
}

Retrieve virtual servers list Deprecated

Retrieves virtual servers list. This endpoint is deprecated. Use /api/v1/migrations/{migration_id}/virtual-servers instead..

path Parameters
migration_id
required
integer <uuid>

uuid of migration

query Parameters
search
string

Search by name, IP address and pool name.

sort
string
Example: sort=-name

Order results by a selection.

select
string
Example: select=id,name

Select only specified fields.

page
integer

Page number

limit
integer

Amount of items returned per page.

staged
string
Example: staged=true

Filter list by staged value.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "count": 1,
  • "total": 5,
  • "results": [
    ]
}

Retrieve specific virtual server Deprecated

Retrieves a specific virtual server. This endpoint is deprecated. Use api/v1/migrations/{migration_id}/virtual-servers/{virtual_id} instead.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

virtual_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "_links": {
    },
  • "name": "virtual_server_1",
  • "application": "application_1",
  • "status": "green",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "template_action_required": false,
  • "referenced_objects_installed": true,
  • "irules_count": 0,
  • "virtuals_count": 0,
  • "as3_preview": "/v1/migrations/1/virtuals/1/preview.json",
  • "staged": true,
  • "ip_addresses": [
    ],
  • "ports": [
    ],
  • "ip_name": "string",
  • "readiness": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "config_files": {
    },
  • "metadata": {
    },
  • "as3_unsupported": [
    ],
  • "security_issues": [
    ],
  • "unsupported_properties": {
    }
}

Update virtual server object Deprecated

Updates virtual server object.

path Parameters
migration_id
required
integer <uuid>

uuid of migration

virtual_id
required
integer
Request Body schema: application/json
required
template_name
string
template_parameters
object (FastTemplateParameters)

Must conform template JSON schema

deploy_location
string

Responses

Request samples

Content type
application/json
{
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "_links": {
    },
  • "name": "virtual_server_1",
  • "application": "application_1",
  • "status": "green",
  • "last_modified": "2021-01-28T15:24:05.029102Z",
  • "summaries": [
    ],
  • "template_name": "template_set/test_template",
  • "template_parameters": {
    },
  • "deploy_location": "10.0.0.1",
  • "template_action_required": false,
  • "referenced_objects_installed": true,
  • "irules_count": 0,
  • "virtuals_count": 0,
  • "as3_preview": "/v1/migrations/1/virtuals/1/preview.json",
  • "staged": true,
  • "ip_addresses": [
    ],
  • "ports": [
    ],
  • "ip_name": "string",
  • "readiness": true,
  • "waf_policies": [
    ],
  • "certificates": [
    ],
  • "irules": [
    ],
  • "data_groups": [
    ],
  • "config_files": {