F5 BIG-IP Declarative Onboarding
Declarative Onboarding sets up the BIG-IP device itself — hostname, licensing, DNS and NTP, VLANs, self-IPs, routes, user accounts and module provisioning — from a single declaration. 9 operations over /mgmt/shared/declarative-onboarding. It is the layer beneath AS3 and the highest-consequence write surface F5 publishes: there is no dry-run mode, a 200 on POST does not mean the declaration succeeded (the outcome is on the task), and a declaration can restart services and change the management addressing you are calling it on. DO does store the device's original pre-onboarding configuration and will return it from GET /config/{machineId}.
F5 BIG-IP Declarative Onboarding is one of 22 APIs that F5 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BIG-IP, Provisioning, Declarative, Infrastructure-as-Code, and Automation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a changelog.
This API exposes 9 operations across 7 paths, organized into 4 resource areas, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.47.0.
Requests are made against a single base URL, https://192.0.2.1:443/mgmt/shared/declarative-onboarding.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 7 GET, 1 POST. They span 4 resource areas: Configuration, Information, Inspect, Task. Each is listed below with its method, path, parameters, and response codes.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are task (8 properties), errorConfig (8 properties), result (5 properties), errorProcessing (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from F5 12
Other APIs F5 publishes across the network.
This is an independent, third-party profile of F5 BIG-IP Declarative Onboarding, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.