OpenAPI
OpenAPI Version: 3.0.1
health-check
Info
Title: cnbng-health-check-actions
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Version: 2026-04-18
Servers
- URL: /restconf
tags
- Name: root
Description: root resources
- Name: operations
Description: operations resources
- Name: data
Description: data resources
- Name: get
Description: get resources
- Name: head
Description: head resources
- Name: post
Description: post resources
- Name: patch
Description: patch resources
- Name: put
Description: put resources
- Name: options
Description: options resources
- Name: delete
Description: delete resources
Paths
/
get:
Tags:
- root
- get
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: root_get
Responses:
"200":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/root"
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
head:
Tags:
- root
- head
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: root_head
Responses:
"200":
Description: OK
Content: {}
security:
- basicAuth: []
/operations
get:
Tags:
- operations
- get
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: operations_get
Responses:
"200":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/operations"
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
/yang-library-version
get:
Tags:
- yang-library-version
- get
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: yang_library_version_get
Responses:
"200":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/yang-library-version"
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
head:
Tags:
- yang-library-version
- head
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: yang_library_version_head
Responses:
"200":
Description: OK
Content: {}
security:
- basicAuth: []
/data
get:
Tags:
- data
- get
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: data_get
Responses:
"200":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data"
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
put:
Tags:
- data
- put
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: data_put
Request Body:
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data-put-patch"
Required/Optional: true
Responses:
"201":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: data
Method: Post:
Tags:
- data
- post
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: data_post
Request Body:
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data-post"
Required/Optional: true
Responses:
"201":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: data
head:
Tags:
- data
- head
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: data_head
Responses:
"200":
Description: OK
Content: {}
security:
- basicAuth: []
patch:
Tags:
- data
- patch
Summary: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Operation ID: data_patch
Request Body:
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data-put-patch"
Required/Optional: true
Responses:
"204":
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: data
/data/cnbng-health-check-actions:system-health-check
get:
Tags:
- data
- get
Operation ID: data_cnbng_health_check_actions_system_health_check_get
Parameters:
- Name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: config
enum:
- config
- nonconfig
- all
- Name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: integer
Format: uint16
- Name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: report-all
enum:
- report-all
- trim
- explicit
- report-all-tagged
Responses:
"200":
Description: OK
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check"
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
put:
Tags:
- data
- put
Operation ID: data_cnbng_health_check_actions_system_health_check_put
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check"
Required/Optional: true
Responses:
"201":
Description: container system-health-check created or replaced
Content: {}
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: system-health-check
Method: Post:
Tags:
- data
- post
Operation ID: data_cnbng_health_check_actions_system_health_check_post
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check-post"
Required/Optional: true
Responses:
"201":
Description: container system-health-check created
Content: {}
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: system-health-check
delete:
Tags:
- data
- delete
Operation ID: data_cnbng_health_check_actions_system_health_check_delete
Responses:
"204":
Description: No Content
Content: {}
security:
- basicAuth: []
options:
Tags:
- data
- options
Operation ID: data_cnbng_health_check_actions_system_health_check_options
Responses:
"200":
Description: OK
Content: {}
security:
- basicAuth: []
head:
Tags:
- data
- head
Operation ID: data_cnbng_health_check_actions_system_health_check_head
Parameters:
- Name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: config
enum:
- config
- nonconfig
- all
- Name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: integer
Format: uint16
- Name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: report-all
enum:
- report-all
- trim
- explicit
- report-all-tagged
Responses:
"200":
Description: OK
Content: {}
security:
- basicAuth: []
patch:
Tags:
- data
- patch
Operation ID: data_cnbng_health_check_actions_system_health_check_patch
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check"
Required/Optional: true
Responses:
"204":
Description: container system-health-check updated
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
security:
- basicAuth: []
x-codegen-request-body-name: system-health-check
Components
schemas:
data:
Type: object
Properties:
ietf-restconf:data:
Type: object
Properties: {}
Description: This resource represents the combined configuration and state data resources that can be
accessed by a client and cannot be created or deleted by the client. See RESTCONF RFC 8040
for further information.
x-yang:
Type: datastore
data-post:
Type: object
Properties:
cnbng-health-check-actions:system-health-check:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: false
data-put-patch:
Type: object
Properties:
ietf-restconf:data:
Reference: "#/components/schemas/dataputpatch_ietfrestconfdata"
data_cnbng-health-check-actions_system-health-check:
Type: object
Properties:
cnbng-health-check-actions:system-health-check:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: false
data_cnbng-health-check-actions_system-health-check-post:
Type: object
operations:
Type: object
Properties:
ietf-restconf:operations:
Type: object
Properties: {}
Description: This resource is a container that provides access to the data-model-specific RPC
operations supported by the server. See RESTCONF RFC 8040 for further information.
x-yang:
Type: operations
root:
Type: object
Properties:
ietf-restconf:restconf:
Reference: "#/components/schemas/root_ietfrestconfrestconf"
yang-library-version:
Type: object
Properties:
ietf-restconf:yang-library-version:
Type: object
Properties: {}
Description: This leaf identifies the revision date of the 'ietf-yang-library' YANG module that is
implemented by this server. See RESTCONF RFC 8040 for further information.
x-yang:
Type: leaf
dataputpatch_ietfrestconfdata:
Type: object
Properties:
cnbng-health-check-actions:system-health-check:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: false
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
root_ietfrestconfrestconf:
Type: object
Properties:
data:
Type: object
Properties: {}
operations:
Type: object
Properties: {}
yang-library-version:
Type: string
Description: This is the RESTCONF root resource for the RESTCONF datastore and operation resources. See
RESTCONF RFC 8040 for further information.
Responses:
"200":
Description: OK
Content: {}
"201":
Description: Created
Content: {}
"204":
Description: No Content
Content: {}
"400":
Description: Bad Request
Content: {}
"401":
Description: Unauthorized
Content: {}
"404":
Description: Not Found
Content: {}
"405":
Description: Method Not Allowed
Content: {}
"409":
Description: Conflict
Content: {}
Parameters:
Content:
Name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: config
enum:
- config
- nonconfig
- all
depth:
Name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: integer
Format: uint16
fields:
Name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
filter:
Name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
with-defaults:
Name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: report-all
enum:
- report-all
- trim
- explicit
- report-all-tagged
insert:
Name: insert
In: query
Description: controlling the order when adding new list elements
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
Default: first
enum:
- first
- last
- before
- after
point:
Name: point
In: query
Description: used to specify the insertion point
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
requestBodies:
data-post:
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data-post"
Required/Optional: true
data-put-patch:
Description: Top-level operational action commands for the BNG system health-check feature. Copyright
(c) 2026 by Cisco Systems, Inc. All rights reserved.
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data-put-patch"
Required/Optional: true
data_cnbng-health-check-actions_system-health-check:
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check"
Required/Optional: true
data_cnbng-health-check-actions_system-health-check-post:
Content:
application/yang-data+json:
Schema:
Reference: "#/components/schemas/data_cnbng-health-check-actions_system-health-check-post"
Required/Optional: true
securitySchemes:
basicAuth:
Type: http
scheme: basic
Feedback