# F5 BIG-IP Declarative Onboarding

**Canonical:** https://apis.io/apis/f5/f5-big-ip-declarative-onboarding/  
**Provider:** F5 — https://apis.io/providers/f5/  
**Base URL:** https://{bigip}/mgmt/shared/declarative-onboarding  
**Documentation:** https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/

F5 BIG-IP Declarative Onboarding is one of 22 APIs that [F5](https://apis.io/providers/f5/) publishes on the [APIs.io](https://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.

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}.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | Get status of configuration request |
| POST | `/` | Apply BIG-IP DO configuration |
| GET | `/config` | Return all original configurations |
| GET | `/config/{machineId}` | Return original configuration by machine ID |
| DELETE | `/config/{machineId}` | Delete the stored original configuration by config ID |
| GET | `/info` | /mgmt/shared/appsvcs/info |
| GET | `/inspect` | Return current configuration |
| GET | `/task` | Return status of all configurations |
| GET | `/task/{taskId}` | Return status of configuration by task ID |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/openapi/f5-big-ip-declarative-onboarding-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/overlays/f5-big-ip-declarative-onboarding-overlay.yaml
- **Documentation** — https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/
- **SourceCode** — https://github.com/F5Networks/f5-declarative-onboarding
- **ChangeLog** — https://github.com/F5Networks/f5-declarative-onboarding/releases
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/f5/refs/heads/main/skills/f5-do-onboard-device.md

## Other F5 APIs (12)

- [F5 BIG-IP](https://apis.io/apis/f5/f5-big-ip/)
- [F5 NGINX](https://apis.io/apis/f5/f5-nginx/)
- [F5 Distributed Cloud Services](https://apis.io/apis/f5/f5-distributed-cloud/)
- [F5 BIG-IP iControl REST (Mgmt)](https://apis.io/apis/f5/f5-mgmt-api/)
- [NGINX Plus REST API](https://apis.io/apis/f5/f5-nginx-plus-api/)
- [F5 BIG-IP AS3 (Application Services 3 Extension)](https://apis.io/apis/f5/f5-big-ip-as3/)
- [F5 BIG-IP Application Services Templates (FAST)](https://apis.io/apis/f5/f5-big-ip-fast/)
- [F5 NGINX Management Suite API](https://apis.io/apis/f5/f5-nginx-management-suite-api/)
- [F5 Essential App Protect API](https://apis.io/apis/f5/f5-essential-app-protect-api/)
- [F5 BIG-IQ Centralized Management API](https://apis.io/apis/f5/f5-big-iq-centralized-management-api/)
- [F5 BIG-IP Application Services 3 Extension API](https://apis.io/apis/f5/f5-big-ip-application-services-3-extension-api/)
- [F5 Declarative Onboarding API](https://apis.io/apis/f5/f5-declarative-onboarding-api/)

## Tags

BIG-IP, Provisioning, Declarative, Infrastructure-as-Code, Automation

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/f5/f5-big-ip-declarative-onboarding/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/f5/.