Node (v1) - Retrieve Information About Managed Devices

Introduction

The Superna Eyeglass REST API - v1 Node allows for the retrieval of information about managed devices, access zones, and SyncIQ policies, providing detailed insights and configuration data for effective management of resources.

Endpoints

GET /v1/nodes

Description: Returns all Superna Eyeglass Managed Devices.

Response Class (Status 200):

[
  {
    "id": "string",
    "ip": "string",
    "name": "string"
  }
]

Response Content Type: application/json

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
-	-	No parameters required.	-	-

Response Codes:

• 200 OK: Devices successfully retrieved.
• default: Error payload, see response structure.

Response Messages:

• default (Error Payload):

{
  "code": 0,
  "message": "string"
}

GET /v1/nodes/{id}

Description: Retrieves a specific Superna Eyeglass Managed Device by its ID.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string

Response Codes:

• 200 OK - Returns the node information.
• default - Error payload.

Example Response:

{
  "id": "string",
  "ip": "string",
  "name": "string"
}

GET /v1/nodes/{id}/policies

Description: Returns the syncIQ policies for a specific Superna Eyeglass Managed Device by its ID.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
foReadiness	false (default)	Retrieve also failover readiness status details	query	boolean

Response Codes:

• 200 OK - Returns the syncIQ policies information.
• default - Error payload.

Example Response:

[
  {
    "failoverReadiness": {
      "status": "OK"
    },
    "id": "string",
    "name": "string",
    "readinessDetail": [
      {
        "name": "string",
        "reason": "string",
        "status": {
          "status": "OK"
        },
        "statusChildren": [
          {}
        ]
      }
    ],
    "target": {
      "id": "string",
      "ip": "string",
      "name": "string"
    },
    "zone": {
      "failoverReadiness": {
        "status": "OK"
      },
      "id": "string",
      "name": "string",
      "readinessDetail": [
        {
          "name": "string",
          "reason": "string",
          "status": {
            "status": "OK"
          },
          "statusChildren": [
            {}
          ]
        }
      ]
    }
  }
]

GET /v1/nodes/{id}/policies/{name}

Description: Returns the syncIQ policy for a specific Superna Eyeglass Managed Device by its ID and the policy name.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
name	required	Name of the policy	path	string

Response Codes:

• 200 OK - Returns the syncIQ policy information.
• default - Error payload.

Example Response:

{
  "failoverReadiness": {
    "status": "OK"
  },
  "id": "string",
  "name": "string",
  "readinessDetail": [
    {
      "name": "string",
      "reason": "string",
      "status": {
        "status": "OK"
      },
      "statusChildren": [
        {}
      ]
    }
  ],
  "target": {
    "id": "string",
    "ip": "string",
    "name": "string"
  },
  "zone": {
    "failoverReadiness": {
      "status": "OK"
    },
    "id": "string",
    "name": "string",
    "readinessDetail": [
      {
        "name": "string",
        "reason": "string",
        "status": {
          "status": "OK"
        },
        "statusChildren": [
          {}
        ]
      }
    ]
  }
}

GET /v1/nodes/{id}/pools

Description: Returns the pools for a specific Superna Eyeglass Managed Device by its ID.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
foReadiness	false (default)	Retrieve also failover readiness status details	query	boolean

Response Codes:

• 200 OK - Returns the pool information for the node.
• default - Error payload.

Example Response:

[
  {
    "failoverReadiness": {
      "status": "OK"
    },
    "name": "string",
    "readinessDetail": [
      {
        "name": "string",
        "reason": "string",
        "status": {
          "status": "OK"
        },
        "statusChildren": [
          {}
        ]
      }
    ],
    "zone": "string"
  }
]

GET /v1/nodes/{id}/pools/{name}

Description: Returns the pool by its name on a given Superna Eyeglass Managed Device.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
name	required	Name of the pool (groupName:subnetName:poolName)	path	string

Response Codes:

• 200 OK - Returns the pool information.
• default - Error payload.

Example Response:

{
  "failoverReadiness": {
    "status": "OK"
  },
  "name": "string",
  "readinessDetail": [
    {
      "name": "string",
      "reason": "string",
      "status": {
        "status": "OK"
      },
      "statusChildren": [
        {}
      ]
    }
  ],
  "zone": "string"
}

GET /v1/nodes/{id}/zones

Description: Returns the access zones for a given Superna Eyeglass Managed Device.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
foReadiness	false (default)	Retrieve also failover readiness status details	query	boolean

Response Codes:

• 200 OK - Returns the zones information.
• default - Error payload.

Example Response:

[
  {
    "failoverReadiness": {
      "status": "OK"
    },
    "id": "string",
    "name": "string",
    "readinessDetail": [
      {
        "name": "string",
        "reason": "string",
        "status": {
          "status": "OK"
        },
        "statusChildren": [
          {}
        ]
      }
    ]
  }
]

GET /v1/nodes/{id}/zones/{name}

Description: Find job by zone name for a given Superna Eyeglass Managed Device.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
id	required	ID of the node to retrieve	path	string
name	required	Name of the zone	path	string

Response Codes:

• 200 OK - Returns the zone information.
• default - Error payload.

Example Response:

{
  "failoverReadiness": {
    "status": "OK"
  },
  "id": "string",
  "name": "string",
  "readinessDetail": [
    {
      "name": "string",
      "reason": "string",
      "status": {
        "status": "OK"
      },
      "statusChildren": [
        {}
      ]
    }
  ]
}