Node Availability Reference

This topic covers parameters, properties, and examples of node availability.

Check Node Availability

-X GET and authentication are not required for this method. The curl -v flag provides verbose output.

curl -v https://pce.my-company.com:8443/api/v2/node_available

Or, you can use -i -X GET to return a 200 OK status if the node is available:

curl -i -X GET https://pce.my-company.com:8443/api/v2/node_available

Returns 200 OK if the core node is healthy and can see at least one service running in the PCE cluster.

Otherwise, it returns a 404 error.

For example, if the PCE is healthy and accessible, the response is 200 OK.

Property	Description	Type	Required
`org_id`	Organization ID	Integer	Yes
`ending_at`	Time at which to exclude entries	String	No
`include_logs`	Set to true if logs are to be included	Boolean	No
`starting_at`	Start date for log filtering	String	No
`requested_at`	A time support bundle was requested.	string(date-time)	Yes

Property	Description	Type	Required
`href`	URI of this request Reference to `common/href_object.schema.json`		Yes
`name`	The name of the support bundle	String	Yes
`download_url`	URI of the associated report file Reference to `common/href_object.schema.json`		Yes
`requested_at`	A time support bundle was requested.	String (date-time)	Yes
`completed_at`	Time support bundle completed.	String, Null (date-time)	Yes
`status`	A status annunciator indicating the state of this request	String	Yes
`include_logs`	Set to true if logs are to be included	Boolean	Yes
`starting_at`	(GET, POST) Start date for log filtering	String, Null (date-time)	Yes
`ending_at`	End date for log filtering	String, Null (date-time)	Yes

Example for POST

{
	"include_logs": true,
	"starting_at": null,
	"ending_at": null
}

REST APIs for 24.5