Skip to content

List Nodes Endpoint

POST
/user/list-nodes

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
ListNodesRequest
object
tenant_id
required
Tenant Id
string
update_pipeline_warnings
Update Pipeline Warnings
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ListNodesResponse
object
nodes
required
Nodes
Array<object>
NodeStatus

Describes the current status of a node

This object represents both the internal connection state of the Node domain object and the result of a live connectivity check.

DEPRECATED: connected is deprecated, use lifecycle_state instead.

object
name
required
Name
string
node_id
required
Node Id
string
create_date_time
required
Create Date Time
string
destroy_date_time
required
Any of:
string
last_known_version
required
Any of:
string
last_known_features
required
Last Known Features
Array<string>
demo
required
Demo
boolean
ephemeral
Ephemeral
boolean
connected
required
Connected

DEPRECATED: Use lifecycle_state field instead

boolean
lifecycle_state
required
NodeLifecycleState
string
Allowed values: created connected disconnected
has_failed_pipelines
required
Has Failed Pipelines
boolean

403

Section titled “403 ”

{"detail": "Invalid API Key"} {"detail": "Not permitted to access this tenant"}

404

Section titled “404 ”

{"detail": "Tenant not found"}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string