HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/maintenance_mode_profiles/{Maintenance_Mode_Profile.name}/stages/{Maintenance_Stage.stage_id}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference Resource: Maintenance_Mode_Profile
Name of the maintenance node profile. This is used as the primary identifier for the profile in CLI commands like 'maintenance-mode profile '. Must be unique across all maintenance node profiles.

string
required

Reference Resource: Maintenance_Stage
Map of stage IDs to Maintenance_Stage references. Key: Stage ID (1-10) defining execution order. Value: UUID reference to Maintenance_Stage table. Stages are executed in ascending order when the profile is activated.

Body Params
feature_set_bgp
array of strings
length ≤ 10

Reference Resource: Feature_Set_BGP
Set of Feature_Set_BGP UUIDs to be executed during this stage. Each BGP feature-set specifies BGP neighbor sessions for graceful shutdown maintenance. Feature-sets are executed in parallel (unordered) within the stage. Maximum 10 BGP feature-sets per stage to bound operational complexity. Weak reference: Feature-sets can be deleted independently of stages. BGP maintenance uses GSHUT community (65535:0) followed by session teardown after shutdown_delay_timer.

feature_set_bgp
feature_set_ospf
array of strings
length ≤ 10

Reference Resource: Feature_Set_OSPF
Set of Feature_Set_OSPF UUIDs to be executed during this stage. Each OSPF feature-set specifies OSPF processes for max-metric maintenance operations. Feature-sets are executed in parallel (unordered) within the stage. Maximum 10 OSPF feature-sets per stage to bound operational complexity. Weak reference: Feature-sets can be deleted independently of stages. OSPF maintenance uses max-metric (0xFFFF) LSA advertisement for instant traffic redirection. Supports all 4 OSPF variants: OSPFv2, OSPFv3, OSPFv3-AF-IPv4, OSPFv3-AF-IPv6.

feature_set_ospf
integer
required

Reference Resource: Maintenance_Stage
Map of stage IDs to Maintenance_Stage references. Key: Stage ID (1-10) defining execution order. Value: UUID reference to Maintenance_Stage table. Stages are executed in ascending order when the profile is activated.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!