get__organization_{orgId}_nodes

GET /organization/{orgId}/nodes

List Organization Nodes

Get all private nodes belonging to the specified organization. This endpoint requires the user to be a member of the organization and returns only active (non-deleted) nodes.

Important Notes:

  • Only users belonging to the specified organization can access this endpoint

  • Returns only active nodes (deleted nodes are excluded)

  • Nodes are ordered by ID in descending order (newest first)

  • The lastUpdated field is set to the current timestamp for all nodes

Path Parameters

Name
Type
Required
Description

» orgId

string

true

Unique identifier of the organization

TypeScript Client Library

// Using the Flashback TypeScript client
import { FlashbackClient } from '@flashback/client';

const client = new FlashbackClient({
  accessToken: 'your-access-token'
});

// Get all organization nodes
try {
  const result = await client.getPrivateNodeInfo('org-id');
  console.log('Organization nodes:', result);
} catch (error) {
  console.error('Failed to retrieve organization nodes:', error);
}

Code Samples

# You can also use wget
curl -X GET https://backend.flashback.tech/organization/550e8400-e29b-41d4-a716-446655440000/nodes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "ip": "192.168.1.100",
      "region": "us-west-2",
      "version": "1.2.3",
      "status": "active",
      "url": "https://node1.flashback.tech",
      "id_org": "550e8400-e29b-41d4-a716-446655440000",
      "lastUpdated": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440002",
      "ip": "192.168.1.101",
      "region": "us-east-1",
      "version": "1.2.3",
      "status": "active",
      "url": "https://node2.flashback.tech",
      "id_org": "550e8400-e29b-41d4-a716-446655440000",
      "lastUpdated": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 2
}

403 Response

{
  "success": false,
  "data": [],
  "total": 0,
  "message": "Access denied: you can only view nodes in your own organization"
}

500 Response

{
  "success": false,
  "data": [],
  "total": 0,
  "message": "Internal server error"
}

Responses

Status
Meaning
Description
Schema

200

Organization nodes retrieved successfully

Inline

403

Access denied - user not in organization

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

[NodeInfo]

false

none

Array of organization nodes

» total

number

false

none

Total number of nodes returned

NodeInfo Object

Name
Type
Required
Restrictions
Description

» id

string

false

none

Unique identifier of the node

» ip

string

false

none

IP address of the node

» region

string

false

none

Geographic region of the node

» version

string

false

none

Version of the node software

» status

string

false

none

Current status of the node

» url

string

false

none

Endpoint URL of the node

» id_org

string

false

none

Organization ID the node belongs to

» lastUpdated

string(date-time)

false

none

Last update timestamp

Status Code 403

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

[NodeInfo]

false

none

Empty array of nodes

» total

number

false

none

Total number of nodes (0)

» message

string

false

none

Error message describing the access issue

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

[NodeInfo]

false

none

Empty array of nodes

» total

number

false

none

Total number of nodes (0)

» message

string

false

none

Error message describing the server issue

Security

  • BearerAuth: Bearer token authentication required

  • Organization Access: User must belong to the specified organization

  • Data Privacy: Users can only view nodes within their own organization

Notes

  • Only active (non-deleted) nodes are returned

  • Nodes are ordered by ID in descending order (newest first)

  • Deleted nodes are automatically excluded from the results

  • The response includes both individual node data and a total count

  • Empty organization will return an empty data array with total count of 0

Last updated

Was this helpful?