AWaws-samples
Target Nodes

Retrieve target node sessions for the authenticated user

Changed on

Returns a list of target node sessions with detailed information including connection strings and instance details

get/api/target_nodes/list

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Query parameters

is_active'true' | 'false' required

Filter by active status (true/false)

session_uuidstring uuid

Filter by specific session UUID

state'pending' | 'running' | 'stopped' | 'terminated' | 'error'

Filter by session state

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

Authentication token for the SOCA user

Response

Target node sessions retrieved successfully

successboolean
messageobject

Dictionary of session UUIDs mapped to session details

Example response

{
  "success": true
}

Changes

  • v1058396b8f0f1Revision changes
    • warning

      changed the pattern of the query request parameter session_uuid from f'^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' to ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API