Skip to main content

get-network-by-id

Look up a single ECGrid network by its numeric network ID. Use when the caller already has the integer ID (e.g. from a previous tool result, a ticket, or an admin reference). Returns the network's profile: name, lifecycle status, run status, outage status, primary contacts, associated user-account IDs (owner, routing, errors, interconnects, billing, …), public website URLs, owner-side routing metadata, and audit timestamps. Sensitive infrastructure (server hostnames, VPN secrets, FTP credentials, mailbox config) is deliberately excluded. Returns NOT_FOUND when no network matches the ID. Results are limited to what the caller's APIKey can see; another tenant's network ID will surface as NOT_FOUND.

Tool Name

connectivity_network_get-network-by-id

Auth Level Required

Any (scoped to caller's APIKey)

Parameters

ParameterTypeRequiredDescription
request.networkIdintegerYesThe numeric ECGrid network ID to look up (>= 1)

Response

Returns the network profile including name, lifecycle and run status, primary contacts, public URLs, and audit timestamps.

{
"networkId": 47,
"name": "Acme Logistics EDI Network",
"status": "Active",
"runStatus": "Normal",
"outageStatus": "None",
"ownerUserId": 101,
"ownerLoginName": "admin@acme-logistics.com",
"ownerAuthLevel": "NetworkAdmin",
"errorsUserId": 102,
"errorsLoginName": "edi-errors@acme-logistics.com",
"errorsAuthLevel": "NetworkUser",
"interconnectsUserId": 103,
"interconnectsLoginName": "interconnects@acme-logistics.com",
"interconnectsAuthLevel": "NetworkUser",
"billingUserId": 104,
"billingLoginName": "billing@acme-logistics.com",
"billingAuthLevel": "NetworkUser",
"publicWebsite": "https://www.acme-logistics.com",
"ediWebsite": "https://edi.acme-logistics.com",
"routingNetworkId": 7,
"created": "2020-04-01T00:00:00Z",
"modified": "2026-06-15T10:22:44Z"
}

Response Fields

FieldTypeDescription
networkIdintegerUnique numeric ECGrid network ID
namestringDisplay name of the network
statusstringLifecycle status (see Status enum)
runStatusstringOperational run state of the network
outageStatusstringCurrent outage state (None, Scheduled, Active)
ownerUserIdintegerUser ID of the network owner contact
ownerLoginNamestringLogin name of the network owner contact
ownerAuthLevelstringAuth level of the owner (see AuthLevel enum)
errorsUserIdintegerUser ID of the errors contact
errorsLoginNamestringLogin name of the errors contact
errorsAuthLevelstringAuth level of the errors contact
interconnectsUserIdintegerUser ID of the interconnects contact
interconnectsLoginNamestringLogin name of the interconnects contact
interconnectsAuthLevelstringAuth level of the interconnects contact
billingUserIdintegerUser ID of the billing contact
billingLoginNamestringLogin name of the billing contact
billingAuthLevelstringAuth level of the billing contact
publicWebsitestringPublic-facing website URL for the network owner
ediWebsitestringEDI-specific website URL (partner portal, etc.)
routingNetworkIdintegerNetwork ID used for owner-side routing metadata
createdstringISO 8601 timestamp when the network was created
modifiedstringISO 8601 timestamp of the most recent network update

Example Call

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "connectivity_network_get-network-by-id",
"arguments": {
"request": { "networkId": 47 }
}
}
}

Example Prompts

  • Show me network 47
  • What's the status of my ECGrid network?
  • Who is the owner contact for network 7?

See Also