--- title: "GET | List the Network Connector" slug: "api-v2-get-list-the-network-connector" updated: 2026-10-14T16:24:29Z published: 2026-10-14T16:24:29Z canonical: "docs.senhasegura.io/api-v2-get-list-the-network-connector" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.senhasegura.io/llms.txt > Use this file to discover all available pages before exploring further. # GET | List the Network Connector ## Description Retrieve the Network Connector configuration and the list of its active agents. Segura® has a single Network Connector, so this endpoint takes no identifier. The response also lists the connector's active agents with their identification codes and names. Attention The `network_connector_id` field of a device takes the identification code of an **agent**, not of the connector. Use an `id` from `data.network_connector.agents`, never `data.id`. To list each agent's port as well, access [GET | List all Network Connector agents](/v4-2/docs/api-v2-get-list-all-network-connector-agents). --- ## Prerequisites - An application with the **PAM resource permission** set to **Read-only** or **Read and write**, granted by the administrator in A2A. For more information, access [How to manage authorizations in A2A for API v2](/v4-2/docs/api-v2-how-to-manage-authorizations-in-a2a). - A valid OAuth 2.0 access token. For more information, access [How to authenticate an application in A2A](/v4-2/docs/how-to-authenticate-an-application-in-a2a). --- ## Request `GET` `/api/v2/platform/network-connector` ### Query parameters This endpoint accepts only the `fields` parameter. It does not support pagination, filters, sorting, or search. Any other query parameter returns `400`. | Field | Type | Description | | --- | --- | --- | | `fields` | string | Restricts the response to the listed fields. Accepts `id`, `network_connector` for the whole object, or any `network_connector.*` field from [Response body fields](/docs/api-v2-get-list-the-network-connector#response-body-fields). The `id` field is always returned. Send `fields` only once per request. | For the full field projection syntax, access [API v2 - Conventions and shared behaviors](/v4-2/docs/api-v2-conventions-and-shared-behaviors). --- ### Example request `GET` `{{url}}/api/v2/platform/network-connector` --- ## Response ``` HTTP/1.1 200 OK ``` The endpoint supports conditional reads. Send the `ETag` value from a previous response in the `If-None-Match` header. If the connector has not changed, the response is `304 Not Modified` with no body. ### Example response body ``` { "data": { "id": "1", "network_connector": { "name": "Network Connector", "ip": "192.0.2.10", "port": "30000", "active": true, "username": "nc-service", "has_password": true, "created_at": null, "updated_at": "2026-09-15T14:32:10+00:00", "agents": [ { "id": "2", "name": "agent-rj-01" }, { "id": "5", "name": "agent-sp-01" } ] } }, "meta": { "links": { "self": "/api/v2/platform/network-connector" } } } ``` --- ## Response body fields | Field | Type | Description | | --- | --- | --- | | `data` | object | The Network Connector. | | `data.id` | string | Unique identification code of the Network Connector, returned as a string. This is not the value that the `network_connector_id` field of a device accepts. | | `data.network_connector` | object | Attributes of the Network Connector. | | `data.network_connector.name` | string | Name of the Network Connector. | | `data.network_connector.ip` | string | IP address of the Network Connector. | | `data.network_connector.port` | string | Port of the Network Connector, returned as a string. Can be `null`. | | `data.network_connector.active` | boolean | Indicates whether the Network Connector is active. | | `data.network_connector.username` | string | Username of the Network Connector. | | `data.network_connector.has_password` | boolean | Returns `true` when the Network Connector has a password set. The password itself is never returned. | | `data.network_connector.created_at` | string | Creation date and time, in ISO 8601 format and UTC. Example: `2026-09-15T14:32:10+00:00`. Can be `null`. | | `data.network_connector.updated_at` | string | Date and time of the last change, in ISO 8601 format and UTC. Can be `null`. | | `data.network_connector.agents` | array of objects | Active agents of the Network Connector, sorted by name and then by identification code. Returns an empty array when there is no active agent, never `null`. | | `data.network_connector.agents[].id` | string | Unique identification code of the agent, returned as a string. Use this value in the `network_connector_id` field of a device. | | `data.network_connector.agents[].name` | string | Name of the agent. | | `meta` | object | Response metadata. | | `meta.links.self` | string | URL of the current request. | --- ## Errors | HTTP code | Message | Possible cause | Solution | | --- | --- | --- | --- | | `400` | `api.request.invalid_param` | The request sent a query parameter other than `fields`, or sent `fields` more than once. | Remove the extra parameters and send `fields` only once. | | `403` | `api.fields.sensitive.not_allowed` | The `fields` parameter requested `network_connector.password`, which is never returned. | Remove the field from `fields`. To check whether a password is set, request `network_connector.has_password`. | | `404` | No specific code | The Network Connector does not exist in the environment. | Check that the Network Connector is set up in Segura®. | | `422` | `api.fields.invalid` | The `fields` parameter requested a field that does not exist. | Check the field names in [Response body fields](/docs/api-v2-get-list-the-network-connector#response-body-fields). | For authentication and permission errors and the `403` versus `404` policy, access [API v2 - Conventions and shared behaviors](/v4-2/docs/api-v2-conventions-and-shared-behaviors). --- ## Related documents - [GET | List all Network Connector agents](/v4-2/docs/api-v2-get-list-all-network-connector-agents) - [GET | List a Network Connector agent by [id]](/v4-2/docs/api-v2-get-list-a-network-connector-agent) - [API v2 - Conventions and shared behaviors](/v4-2/docs/api-v2-conventions-and-shared-behaviors) - [About applications and authorizations in A2A](/v4-2/docs/a2a-about-applications-and-authorizations)