API docs by Redocly

F5 BIG-IP Declarative Onboarding (1.43.0)

Download OpenAPI specification:Download

BIG-IP Declarative Onboarding: solutionsfeedback@f5.com URL: https://github.com/F5Networks/f5-declarative-onboarding License: Apache 2.0

This reference describes the BIG-IP DO API and available endpoints. For more details, see https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/using-do.html.

Configuration

Get status of configuration request

Retrieve the status of the most recently deployed configuration request.

query Parameters
show
string
Value: "full"

Retrieve original and current configuration.

statusCodes
string
Default: "legacy"
Enum: "legacy" "experimental"

Determines how BIG-IP DO returns HTTP status codes.

  • legacy: Returns any errors as the HTTP status.
  • experimental: Returns a 200 HTTP status code unless there is an actual error with the request. The result in the body of the response contains the status of the task.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "selfLink": "https://localhost/mgmt/shared/appsvcs/task/c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "result": {
    },
  • "declaration": {
    }
}

Apply BIG-IP DO configuration

Configure the device per the declaration.

Request Body schema: application/json
required

BIG-IP DO Declaration.

schemaVersion
required
string
Enum: "1.43.0" "1.42.0" "1.41.0" "1.40.0" "1.39.0" "1.38.0" "1.37.0" "1.36.0" "1.35.0" "1.34.0" "1.33.0" "1.32.0" "1.31.0" "1.30.0" "1.29.0" "1.28.0" "1.27.0" "1.26.0" "1.25.0" "1.24.0" "1.23.0" "1.22.0" "1.21.0" "1.20.0" "1.19.0" "1.18.0" "1.17.0" "1.16.0" "1.15.0" "1.14.0" "1.13.0" "1.12.0" "1.11.1" "1.11.0" "1.10.0" "1.9.0" "1.8.0" "1.7.0" "1.6.1" "1.6.0" "1.5.1" "1.5.0" "1.4.1" "1.4.0" "1.3.0" "1.2.0" "1.1.0" "1.0.0"

Version of BIG-IP Declarative Onboarding schema this declaration uses.

class
required
string

Indicates this JSON document is a Device declaration

Value: "Device"
$schema
string <uri>

URL of schema against which to validate. Used by validation in your local environment only (via Visual Studio Code, for example)

async
boolean
Default: false

Tells the API to return a 202 HTTP status before processing is complete. User must then poll for status.

webhook
string <uri>

URL to post results to

label
string

Optional friendly name for this declaration

Array of objects

Credentials which can be referenced from other parts of the declaration or the remote wrapper.

object
Default: {"class":"Tenant"}

Special tenant Common holds objects other tenants can share

object

Options to control configuration process

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "1.43.0",
  • "class": "Device",
  • "$schema": "http://example.com",
  • "async": false,
  • "webhook": "http://example.com",
  • "label": "string",
  • "Credentials": [
    ],
  • "Common": {
    },
  • "controls": {
    }
}

Response samples

Content type
application/json
{
  • "id": "c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "selfLink": "https://localhost/mgmt/shared/appsvcs/task/c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "result": {
    },
  • "declaration": {
    }
}

Return all original configurations

Retrieve the original configuration of all devices.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return original configuration by machine ID

Retrieve the original configuration of a device by machine ID.

path Parameters
machineId
required
string <uuid>

The machine ID that is returned by the /shared/identified-devices/config/device-info endpoint.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "selfLink": "http://example.com",
  • "result": {
    },
  • "Common": { }
}

Delete the stored original configuration by config ID

Delete the stored original configuration by config ID. This can be used in some cases when BIG-IP DO has gotten into an unusable state.

path Parameters
configId
required
string <uuid>

The config ID that was returned by a GET to /config

Responses

Response samples

Content type
application/json
[ ]

Information

/mgmt/shared/appsvcs/info

This returns version and release information for the instance of BIG-IP DO you are using. It also shows current and minimum required versions of the BIG-IP DO schema.

Responses

Response samples

Content type
application/json
{}

Inspect

Return current configuration

Retrieve the current configuration of a device.

query Parameters
targetHost
string
Default: "localhost"

The IP address or domain name of the host from which to retrieve the current configuration.

targetPort
integer [ 0 .. 65535 ]

The port that is used with the targetHost to establish a connection to the device. By default, BIG-IP DO tries to establish a connection to the device using ports 443 and 8443.

targetUsername
string
Default: "admin"

The username for the targetHost.

targetPassword
string
Default: "admin"

The password for the targetHost.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "selfLink": "http://example.com",
  • "result": {
    },
  • "declaration": {
    }
}

Task

Return status of all configurations

Retrieve the status of all previously deployed configurations.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return status of configuration by task ID

Retrieve the status of a previously deployed configuration by task ID.

path Parameters
taskId
required
string <uuid>

The task ID.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "selfLink": "https://localhost/mgmt/shared/appsvcs/task/c098f4f1-d2a4-4c53-8728-7d1ce5567a4",
  • "result": {
    },
  • "declaration": {
    }
}